PHP Класс CI_Migration, TastyIgniter

All migrations should implement this, forces up() and down() and gives access to the CI super-global.
См. ссылку:
Автор: Reactor Engineers
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$_error_string string Error message
$_migration_auto_latest boolean Whether to automatically run migrations
$_migration_enabled boolean Whether the library is enabled
$_migration_path string Path to migration classes
$_migration_regex string Migration basename regex
$_migration_table string Database table with migration info
$_migration_type boolean Migration numbering type
$_migration_version mixed Current migration version

Открытые методы

Метод Описание
__construct ( array $config = [] ) : void Initialize Migration Class
__get ( string $var ) : mixed Enable the use of CI super-global
current ( ) : mixed Sets the schema to the migration version set in config
error_string ( ) : string Error string
find_migrations ( ) : array Retrieves list of available migration scripts
latest ( ) : mixed Sets the schema to the latest migration
version ( string $target_version ) : mixed Migrate to a schema version

Защищенные методы

Метод Описание
_get_migration_name ( string $migration ) : string Extracts the migration class name from a filename
_get_migration_number ( string $migration ) : string Extracts the migration number from a filename
_get_version ( ) : string Retrieves current schema version
_update_version ( string $migration ) : void Stores the current schema version

Описание методов

__construct() публичный Метод

Initialize Migration Class
public __construct ( array $config = [] ) : void
$config array
Результат void

__get() публичный Метод

Enable the use of CI super-global
public __get ( string $var ) : mixed
$var string
Результат mixed

_get_migration_name() защищенный Метод

Extracts the migration class name from a filename
protected _get_migration_name ( string $migration ) : string
$migration string
Результат string text portion of a migration filename

_get_migration_number() защищенный Метод

Extracts the migration number from a filename
protected _get_migration_number ( string $migration ) : string
$migration string
Результат string Numeric portion of a migration filename

_get_version() защищенный Метод

Retrieves current schema version
protected _get_version ( ) : string
Результат string Current migration version

_update_version() защищенный Метод

Stores the current schema version
protected _update_version ( string $migration ) : void
$migration string Migration reached
Результат void

current() публичный Метод

Sets the schema to the migration version set in config
public current ( ) : mixed
Результат mixed TRUE if no migrations are found, current version string on success, FALSE on failure

error_string() публичный Метод

Error string
public error_string ( ) : string
Результат string Error message returned as a string

find_migrations() публичный Метод

Retrieves list of available migration scripts
public find_migrations ( ) : array
Результат array list of migration file paths sorted by version

latest() публичный Метод

Sets the schema to the latest migration
public latest ( ) : mixed
Результат mixed Current version string on success, FALSE on failure

version() публичный Метод

Calls each migration step required to get to the schema version of choice
public version ( string $target_version ) : mixed
$target_version string Target schema version
Результат mixed TRUE if no migrations are found, current version string on success, FALSE on failure

Описание свойств

$_error_string защищенное свойство

Error message
protected string $_error_string
Результат string

$_migration_auto_latest защищенное свойство

Whether to automatically run migrations
protected bool $_migration_auto_latest
Результат boolean

$_migration_enabled защищенное свойство

Whether the library is enabled
protected bool $_migration_enabled
Результат boolean

$_migration_path защищенное свойство

Path to migration classes
protected string $_migration_path
Результат string

$_migration_regex защищенное свойство

Migration basename regex
protected string $_migration_regex
Результат string

$_migration_table защищенное свойство

Database table with migration info
protected string $_migration_table
Результат string

$_migration_type защищенное свойство

Migration numbering type
protected bool $_migration_type
Результат boolean

$_migration_version защищенное свойство

Current migration version
protected mixed $_migration_version
Результат mixed