CodeIgniter v3.0.0 API
\

\CI_Migration

Migration Class

All migrations should implement this, forces up() and down() and gives access to the CI super-global.

Summary

Methods
Properties
Constants
__construct()
version()
latest()
current()
error_string()
find_migrations()
__get()
No public properties found
No constants found
_get_migration_number()
_get_migration_name()
_get_version()
_update_version()
$_migration_enabled
$_migration_type
$_migration_path
$_migration_version
$_migration_table
$_migration_auto_latest
$_migration_regex
$_error_string
N/A
No private methods found
No private properties found
N/A

Properties

$_migration_enabled

$_migration_enabled : boolean

Whether the library is enabled

Type

boolean

$_migration_type

$_migration_type : boolean

Migration numbering type

Type

boolean

$_migration_path

$_migration_path : string

Path to migration classes

Type

string

$_migration_version

$_migration_version : mixed

Current migration version

Type

mixed

$_migration_table

$_migration_table : string

Database table with migration info

Type

string

$_migration_auto_latest

$_migration_auto_latest : boolean

Whether to automatically run migrations

Type

boolean

$_migration_regex

$_migration_regex : string

Migration basename regex

Type

string

$_error_string

$_error_string : string

Error message

Type

string

Methods

__construct()

__construct(array  $config = array()) : void

Initialize Migration Class

Parameters

array $config

version()

version(string  $target_version) : mixed

Migrate to a schema version

Calls each migration step required to get to the schema version of choice

Parameters

string $target_version

Target schema version

Returns

mixed —

TRUE if no migrations are found, current version string on success, FALSE on failure

latest()

latest() : mixed

Sets the schema to the latest migration

Returns

mixed —

Current version string on success, FALSE on failure

current()

current() : mixed

Sets the schema to the migration version set in config

Returns

mixed —

TRUE if no migrations are found, current version string on success, FALSE on failure

error_string()

error_string() : string

Error string

Returns

string —

Error message returned as a string

find_migrations()

find_migrations() : array

Retrieves list of available migration scripts

Returns

array —

list of migration file paths sorted by version

__get()

__get(string  $var) : mixed

Enable the use of CI super-global

Parameters

string $var

Returns

mixed

_get_migration_number()

_get_migration_number(string  $migration) : string

Extracts the migration number from a filename

Parameters

string $migration

Returns

string —

Numeric portion of a migration filename

_get_migration_name()

_get_migration_name(string  $migration) : string

Extracts the migration class name from a filename

Parameters

string $migration

Returns

string —

text portion of a migration filename

_get_version()

_get_version() : string

Retrieves current schema version

Returns

string —

Current migration version

_update_version()

_update_version(string  $migration) : void

Stores the current schema version

Parameters

string $migration

Migration reached