Class EMigrateCommand

EMigrateCommand manages the database migrations.

CComponent

CConsoleCommand

MigrateCommand

EMigrateCommand

Author: Carsten Brandt <mail@cebe.cc>
Version: 0.7.1
Located at yiiext/migrate-command/EMigrateCommand.php

Methods summary

`public array`	# `getModulePaths( )` Returns `array` list of all modules
`public`	# `setModulePaths( mixed $modulePaths )` Var array\|null list of all modules If set to null, which is default, yii applications module config will be used If modules are taken from yii application config, all entries will be 'moduleName' => 'application.modules.<moduleName>.migrations', You can change the subpath name by setting `EMigrateCommand::$migrationSubPath` which is 'migrations' per default. If 'class' or 'basePath' are set in module config the above path alias is adjusted to class/basePath with Yii::setPathOfAlias(). example: array( 'moduleName' => 'application.modules.moduleName.db.migrations', )
`public array`	# `getDisabledModules( )` Returns `array` list of all disabled modules names
`public`	# `setDisabledModules( array $modules )` Parameters `$modules` `array` $modules list of all disabled modules names you can add modules here to temporarily disable them array( 'examplemodule1', 'examplemodule2', ... )
`public array`	# `getEnabledModulePaths( )` Returns `array` list of all enabled modules
`public boolean`	# `beforeAction( mixed $action, mixed $params )` prepare paths before any action prepare paths before any action Parameters `$action` `mixed` $action `$params` `mixed` $params Returns `boolean` Overrides `MigrateCommand::beforeAction`
`public`	# `actionCreate( mixed $args )` Overrides `MigrateCommand::actionCreate`
`public`	# `actionUp( mixed $args )` Overrides `MigrateCommand::actionUp`
`public`	# `actionDown( mixed $args )` Overrides `MigrateCommand::actionDown`
`public`	# `actionTo( mixed $args )` Overrides `MigrateCommand::actionTo`
`public`	# `actionMark( mixed $args )` Overrides `MigrateCommand::actionMark`
`protected`	# `instantiateMigration( mixed $class )` Overrides `MigrateCommand::instantiateMigration`
`protected`	# `getNewMigrations( )` Overrides `MigrateCommand::getNewMigrations`
`protected`	# `getMigrationHistory( mixed $limit )` Overrides `MigrateCommand::getMigrationHistory`
`protected`	# `ensureBaseMigration( mixed $module )` create base migration for module if none exists create base migration for module if none exists Parameters `$module` `mixed` $module
`protected`	# `migrateUp( mixed $class )` Overrides `MigrateCommand::migrateUp`
`protected`	# `migrateDown( mixed $class )` Overrides `MigrateCommand::migrateDown`
`public string`	# `getHelp( )` Provides the command description. This method may be overridden to return the actual command description. Provides the command description. This method may be overridden to return the actual command description. Returns `string` the command description. Defaults to 'Usage: php entry-script.php command-name'. Overrides `MigrateCommand::getHelp`
`protected`	# `getTemplate( )` Overrides `MigrateCommand::getTemplate`

Methods inherited from MigrateCommand

actionHistory(), actionNew(), actionRedo(), confirm(), createMigrationHistoryTable(), getDbConnection()

Methods inherited from CConsoleCommand

__construct(), afterAction(), behaviors(), buildFileList(), copyFiles(), ensureDirectory(), getCommandRunner(), getName(), getOptionHelp(), init(), onAfterAction(), onBeforeAction(), pluralize(), prompt(), renderFile(), resolveRequest(), run(), usageError()

Methods inherited from CComponent

__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()

Magic methods summary

Constants summary

Constants inherited from MigrateCommand

BASE_MIGRATION

Properties summary

`public string\|null`	`$module`	# the current module(s) to use for current command (comma separated list) defaults to null which means all modules are used examples: --module=core --module=core,user,admin the current module(s) to use for current command (comma separated list) defaults to null which means all modules are used examples: --module=core --module=core,user,admin
`public string`	`$applicationModuleName`	# the application core is handled as a module named 'core' by default the application core is handled as a module named 'core' by default
`public string`	`$moduleDelimiter`	# delimiter for modulename and migration name for display delimiter for modulename and migration name for display
`public string`	`$migrationSubPath`	# subdirectory to use for migrations in Yii alias format this is only used if you do not set modulePath explicitly `EMigrateCommand::setModulePaths()` subdirectory to use for migrations in Yii alias format this is only used if you do not set modulePath explicitly `EMigrateCommand::setModulePaths()`

Properties inherited from MigrateCommand

$connectionID, $defaultAction, $interactive, $migrationPath, $migrationTable, $templateFile

Magic properties

`public array\|null`	`$modulePaths`	# list of all modules list of all modules
`public array`	`$enabledModulePaths`	# list of all enabled modules list of all enabled modules
`public array`	`$disabledModules`	# list of all disabled modules names list of all disabled modules names

Magic properties inherited from CConsoleCommand

$commandRunner, $help, $name, $optionHelp

Packages

Classes

Class EMigrateCommand

Methods summary

Returns

Var

Returns

Parameters

Returns

Parameters

Returns

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Overrides

Parameters

Overrides

Overrides

Returns

Overrides

Overrides

Methods inherited from MigrateCommand

Methods inherited from CConsoleCommand

Methods inherited from CComponent

Magic methods summary

Constants summary

Constants inherited from MigrateCommand

Properties summary

Properties inherited from MigrateCommand

Magic properties

Magic properties inherited from CConsoleCommand