MigrateController

Type

Class

Namespace

craft\console\controllers

Inherits

craft\console\controllers\MigrateController » yii\console\controllers\BaseMigrateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject

Implements

yii\base\Configurable, yii\base\ViewContextInterface

Uses traits

craft\console\ControllerTrait, craft\console\controllers\BackupTrait

Since

3.0.0

Manages Craft and plugin migrations.

A migration means a set of persistent changes to the application environment that is shared among different developers. For example, in an application backed by a database, a migration may refer to a set of changes to the database, such as creating a new table, adding a new table column. This controller provides support for tracking the migration history, updating migrations, and creating new migration skeleton files. The migration history is stored in a database table named migrations. The table will be automatically created the first time this controller is executed, if it does not exist. Below are some common usages of this command:

# creates a new migration named 'create_user_table' for a plugin with the handle pluginHandle.
craft migrate/create create_user_table --plugin=pluginHandle
# applies ALL new migrations for a plugin with the handle pluginHandle
craft migrate up --plugin=pluginHandle

View source

Public Properties

Property	Description
action	yii\base\Action, null – The action that is currently being executed.
behaviors	yii\base\Behavior – List of behaviors attached to this component.
color	boolean, null – Whether to enable ANSI color in the output.
compact	boolean – Indicates whether the console output should be compacted.
defaultAction	string – The default command action.
help	boolean – Whether to display help information about current command.
helpSummary	string – The one-line short summary describing this controller.
id	string – The ID of this controller.
interactive	boolean – Whether to run the command interactively.
isolated	– Whether the command should ensure it is only being run once at a time.
layout	string, null, false – The name of the layout to be applied to this controller's views.
migrationNamespaces	array – List of namespaces containing the migration classes.
migrationPath	string, array, null – The directory containing the migration classes.
migrator	craft\db\MigrationManager
module	yii\base\Module – The module that this controller belongs to.
modules	yii\base\Module – All ancestor modules that this controller is located within.
newFileMode	integer, null – The permission to be set for newly generated migration files.
newFileOwnership	string, integer, null – The user and/or group ownership to be set for newly generated migration files.
noBackup	boolean – Skip backing up the database.
noContent	boolean – Exclude pending content migrations.
passedOptionValues	array – The properties corresponding to the passed options.
passedOptions	array – The names of the options passed during execution.
plugin	string, craft\base\PluginInterface, null – The handle of the plugin to use during migration operations, or the plugin itself.
request	yii\base\Request, array, string – The request.
response	yii\base\Response, array, string – The response.
route	string – The route (module ID, controller ID and action ID) of the current request.
silentExitOnException	boolean, null – If true - script finish with ExitCode::OK in case of exception.
templateFile	string – The template file for generating new migrations.
track	string, null – The migration track to work with (e.g. craft, content, plugin:commerce, etc.) Defaults to content, or automatically set to the plugin’s track when --plugin is passed.
type	string, null – DEPRECATED.
uniqueId	string – The controller ID that is prefixed with the module ID (if any).
view	yii\base\View, yii\web\View – The view object that can be used to render views or view files.
viewPath	string – The directory containing the view files for this controller.

migrator

Type

craft\db\MigrationManager

Default value

null

Access

Read-only

View source

noBackup

Type

boolean

Default value

false

Since

3.4.3

Skip backing up the database.

View source

noContent

Type

boolean

Default value

false

Exclude pending content migrations.

View source

plugin

Type

string, craft\base\PluginInterface, null

Default value

null

The handle of the plugin to use during migration operations, or the plugin itself.

View source

track

Type

string, null

Default value

\craft\db\MigrationManager::TRACK_CONTENT

Since

3.5.0

The migration track to work with (e.g. craft, content, plugin:commerce, etc.)

Defaults to content, or automatically set to the plugin’s track when --plugin is passed.

View source

type

DEPRECATED

Deprecated in 3.5.0. Use track instead.

Type

string, null

Default value

null

DEPRECATED. Use --track instead.

View source

Protected Properties

Property	Description
backupPath	string, null – The path to the database backup

Public Methods

Method	Description
__call()	Calls the named method which is not a class method.
__clone()	This method is called after the object is created by cloning an existing one.
__construct()
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset()	Sets a component property to be null.
actionAll()	Runs all pending Craft, plugin, and content migrations.
actionCreate()	Creates a new migration.
actionDown()	Downgrades the application by reverting old migrations.
actionFresh()	Not supported.
actionHistory()	Displays the migration history.
actionMark()	Modifies the migration history to the specified version.
actionNew()	Displays the un-applied new migrations.
actionRedo()	Redoes the last few migrations.
actionTo()	Upgrades or downgrades till the specified version.
actionUp()	Upgrades Craft by applying new migrations.
actions()	Declares external actions for the controller.
afterAction()	This method is invoked right after an action is executed.
ansiFormat()	Formats a string with ANSI codes.
attachBehavior()	Attaches a behavior to this component.
attachBehaviors()	Attaches a list of behaviors to the component.
beforeAction()	This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the migrationPath.
behaviors()	Returns a list of behaviors that this component should behave as.
bindActionParams()	Binds the parameters to the action.
canGetProperty()	Returns a value indicating whether a property can be read.
canSetProperty()	Returns a value indicating whether a property can be set.
className()	Returns the fully qualified name of this class.
confirm()	Asks user to confirm by typing y or n.
createAction()	Creates an action based on the given action ID.
detachBehavior()	Detaches a behavior from the component.
detachBehaviors()	Detaches all behaviors from the component.
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.
failure()	Outputs a failure message to the console.
findLayoutFile()	Finds the applicable layout file.
getActionArgsHelp()	Returns the help information for the anonymous arguments for the action.
getActionHelp()	Returns the detailed help information for the specified action.
getActionHelpSummary()	Returns a one-line short summary describing the specified action.
getActionOptionsHelp()	Returns the help information for the options for the action.
getBehavior()	Returns the named behavior object.
getBehaviors()	Returns all behaviors attached to this component.
getHelp()	Returns help information for this controller.
getHelpSummary()	Returns one-line short summary describing this controller.
getMigrator()	Returns a migration manager.
getModules()	Returns all ancestor modules of this controller.
getOptionValues()	Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.
getPassedOptionValues()	Returns the properties corresponding to the passed options.
getPassedOptions()	Returns the names of valid options passed during execution.
getRoute()	Returns the route of the current request.
getUniqueId()	Returns the unique ID of the controller.
getView()	Returns the view object that can be used to render views or view files.
getViewPath()	Returns the directory containing view files for this controller.
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.
hasMethod()	Returns a value indicating whether a method is defined.
hasProperty()	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
isColorEnabled()	Returns a value indicating whether ANSI color is enabled.
markdownToAnsi()	Converts Markdown to be better readable in console environments by applying some ANSI format.
note()	Outputs a note to the console.
off()	Detaches an existing event handler from this component.
on()	Attaches an event handler to an event.
optionAliases()	Returns option alias names.
options()	Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.
prompt()	Prompts the user for input and validates it.
render()	Renders a view and applies layout if available.
renderContent()	Renders a static string by applying a layout.
renderFile()	Renders a view file.
renderPartial()	Renders a view without applying layout.
run()	Runs a request specified in terms of a route.
runAction()	Runs an action with the specified action ID and parameters.
select()	Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.
setView()	Sets the view object to be used by this controller.
setViewPath()	Sets the directory that contains the view files.
stderr()	Prints a string to STDERR.
stdout()	Prints a string to STDOUT.
success()	Outputs a success message to the console.
tip()	Outputs a tip to the console.
trigger()	Triggers an event.
warning()	Outputs a warning to the console.

actionAll()

Runs all pending Craft, plugin, and content migrations.

View source

Returns

integer

Throws

• craft\errors\MigrateException

actionCreate()

Creates a new migration.

This command creates a new migration using the available migration template. After using this command, developers should modify the created migration skeleton by filling up the actual migration logic.

craft migrate/create create_news_section

By default, the migration is created in the project’s migrations/ folder (as a “content migration”).
Use --plugin=<plugin-handle> to create a new plugin migration.
Use --type=app to create a new Craft CMS app migration.

View source

Arguments

• $name (string) – The name of the new migration. This should only contain letters, digits, and underscores.

Returns

integer

Throws

• yii\console\Exception
  if the name argument is invalid.

actionFresh()

Not supported.

View source

actionUp()

Upgrades Craft by applying new migrations.

Example:

php craft migrate     # apply all new migrations
php craft migrate 3   # apply the first 3 new migrations

View source

Arguments

• $limit (integer) – The number of new migrations to be applied. If 0, every new migration will be applied.

Returns

integer – The status of the action execution. 0 means normal, other values mean abnormal.

beforeAction()

This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the migrationPath.

View source

Arguments

• $action (yii\base\Action) – The action to be executed.

Returns

boolean – Whether the action should continue to be executed.

Throws

• yii\base\InvalidConfigException
  if directory specified in migrationPath doesn't exist and action isn't "create".

getMigrator()

Returns a migration manager.

View source

Arguments

• $track (string, null)

Returns

craft\db\MigrationManager

Throws

• craft\errors\InvalidPluginException
• yii\base\InvalidConfigException

init()

Initializes the object.

This method is invoked at the end of the constructor after the object is initialized with the given configuration.

View source

optionAliases()

Returns option alias names.

Child classes may override this method to specify alias options.

View source

Returns

array – The options alias names valid for the action where the keys is alias name for option and value is option name.

options()

Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.

Child classes may override this method to specify possible options.

Note that the values setting via options are not available until beforeAction() is being called.

View source

Arguments

• $actionID (string) – The action ID of the current request

Returns

string[] – The names of the options valid for the action

runAction()

Runs an action with the specified action ID and parameters.

If the action ID is empty, the method will use defaultAction.

View source

Arguments

• $id (string) – The ID of the action to be executed.
• $params (array) – The parameters (name-value pairs) to be passed to the action.

Returns

integer – The status of the action execution. 0 means normal, other values mean abnormal.

Throws

• yii\base\InvalidRouteException
  if the requested action ID cannot be resolved into an action successfully.
• yii\console\Exception
  if there are unknown options or missing arguments

stdout()

Prints a string to STDOUT.

You may optionally format the string with ANSI codes by passing additional parameters using the constants defined in yii\helpers\Console.

Example:

$this->stdout('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);

View source

Arguments

• $string (string) – The string to print

Returns

integer, boolean – Number of bytes printed or false on error

Protected Methods

Method	Description
addMigrationHistory()	Adds new migration entry to the history.
backup()	Attempts to backup the database.
bindInjectedParams()	Fills parameters based on types and names in action method signature.
checkRootUser()	Returns whether a command should be executed depending on whether it's being run as a root user, and whether they're OK with that.
checkTty()	Sets yii\console\Controller::$interactive to false if this isn’t a TTY shell.
createAttributeValidator()	Creates a function for the validator option of Controller::prompt.
createMigration()	Creates a new migration instance.
generateMigrationSourceCode()	Generates new migration source PHP code.
getActionMethodReflection()
getMigrationHistory()	Returns the migration history.
getMigrationNameLimit()	Return the maximum name length for a migration.
getNewMigrations()	Returns the migrations that are not applied.
includeMigrationFile()	Includes the migration file for a given migration class name.
migrateDown()	Downgrades with the specified migration class.
migrateToTime()	Migrates to the specified apply time in the past.
migrateToVersion()	Migrates to the certain version.
migrateUp()	Upgrades with the specified migration class.
outputCommand()
parseDocCommentDetail()	Returns full description from the docblock.
parseDocCommentSummary()	Returns the first line of docblock.
parseDocCommentTags()	Parses the comment block into tags.
removeMigrationHistory()	Removes existing migration from the history.
restore()	Attempts to restore the database after a migration failure.
truncateDatabase()	Truncates the database.

addMigrationHistory()

Adds new migration entry to the history.

View source

Arguments

• $version (string) – Migration version name.

createMigration()

Creates a new migration instance.

View source

Arguments

• $class (string) – The migration class name

Returns

yii\db\MigrationInterface – The migration instance

getMigrationHistory()

Returns the migration history.

View source

Arguments

• $limit (integer, null) – The maximum number of records in the history to be returned. null for "no limit".

Returns

array – The migration history

getNewMigrations()

Returns the migrations that are not applied.

View source

Returns

array – List of new migrations

removeMigrationHistory()

Removes existing migration from the history.

View source

Arguments

• $version (string) – Migration version name.

truncateDatabase()

Truncates the database.

This method should be overwritten in subclasses to implement the task of clearing the database.

View source

Throws

• yii\base\NotSupportedException
  if not overridden

Constants

Constant	Description
BASE_MIGRATION	The name of the dummy migration that marks the beginning of the whole migration history.
EXIT_CODE_ERROR
EXIT_CODE_NORMAL

Events

EVENT_REGISTER_MIGRATOR

Type

craft\events\RegisterMigratorEvent

Since

3.5.0

The event that is triggered when resolving an unknown migration track.

use craft\console\controllers\MigrateController;
use craft\db\MigrationManager;
use craft\events\RegisterMigratorEvent;
use yii\base\Event;

Event::on(
    MigrateController::class,
    MigrateController::EVENT_REGISTER_MIGRATOR,
    function(RegisterMigratorEvent $event) {
        if ($event->track === 'myCustomTrack') {
            $event->migrator = Craft::createObject([
                'class' => MigrationManager::class,
                'track' => 'myCustomTrack',
                'migrationNamespace' => 'my\migration\namespace',
                'migrationPath' => '/path/to/migrations',
            ]);
            $event->handled = true;
        }
    }
);

---