PHP Класс yupe\components\Migrator

Наследование: extends CApplicationComponent
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$connectionID string
$migrationTable string

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

Метод Описание
checkForBadMigration ( string $module, boolean $class = false ) : boolean Проверяем на незавершённые миграции:
checkForUpdates ( array $modules ) : mixed Check each modules for new migrations
getInstalledModulesList ( ) : array Return installed modules id
getMigrationHistory ( string $module, integer $limit = 20 ) : mixed Check each modules for new migrations
getModulesWithDBInstalled ( ) : mixed Return db-installed modules list
init ( ) : parent:init() Инициализируем класс:
migrateDown ( string $module, string $class ) : boolean Даунгрейд миграции:
updateToLatest ( string $module ) : boolean Обновление до актуальной миграции:

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

Метод Описание
createMigrationHistoryTable ( ) : nothing Create migration history table
getDbConnection ( ) : db Connect to DB
getNewMigrations ( string $module ) : mixed Check for new migrations for module
instantiateMigration ( string $module, string $class ) : mixed Check each modules for new migrations
migrateUp ( string $module, string $class ) : boolean Обновляем миграцию:

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

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

Проверяем на незавершённые миграции:
public checkForBadMigration ( string $module, boolean $class = false ) : boolean
$module string - required module
$class boolean - migration class
Результат boolean is updated to migration

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

Check each modules for new migrations
public checkForUpdates ( array $modules ) : mixed
$modules array - list of modules
Результат mixed new migrations

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

Create migration history table
protected createMigrationHistoryTable ( ) : nothing
Результат nothing

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

Connect to DB
protected getDbConnection ( ) : db
Результат db connection or make exception

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

Return installed modules id
public getInstalledModulesList ( ) : array
Результат array

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

Check each modules for new migrations
public getMigrationHistory ( string $module, integer $limit = 20 ) : mixed
$module string - required module
$limit integer - limit of array
Результат mixed version and apply time

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

Return db-installed modules list
public getModulesWithDBInstalled ( ) : mixed
Результат mixed db-installed

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

Check for new migrations for module
protected getNewMigrations ( string $module ) : mixed
$module string - required module
Результат mixed new migrations

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

Инициализируем класс:
public init ( ) : parent:init()
Результат parent:init()

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

Check each modules for new migrations
protected instantiateMigration ( string $module, string $class ) : mixed
$module string - required module
$class string - class of migration
Результат mixed version and apply time

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

Даунгрейд миграции:
public migrateDown ( string $module, string $class ) : boolean
$module string - required module
$class string - name of migration class
Результат boolean is downgraded from migration

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

Обновляем миграцию:
protected migrateUp ( string $module, string $class ) : boolean
$module string - required module
$class string - name of migration class
Результат boolean is updated to migration

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

Обновление до актуальной миграции:
public updateToLatest ( string $module ) : boolean
$module string - required module
Результат boolean if migration updated

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

$connectionID публичное свойство

public string $connectionID
Результат string

$migrationTable публичное свойство

public string $migrationTable
Результат string