0 follower

Abstract Class yii\console\controllers\BaseMigrateController

Inheritanceyii\console\controllers\BaseMigrateController » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implementsyii\base\Configurable, yii\base\ViewContextInterface
Subclassesyii\console\controllers\MigrateController
Available since version2.0
Source Code https://github.com/yiisoft/yii2/blob/master/framework/console/controllers/BaseMigrateController.php

BaseMigrateController is the base class for migrate controllers.

Public Properties

Hide inherited properties

Property Type Description Defined By
$action yii\base\Action|null The action that is currently being executed. yii\base\Controller
$behaviors yii\base\Behavior[] List of behaviors attached to this component. yii\base\Component
$color boolean|null Whether to enable ANSI color in the output. yii\console\Controller
$compact boolean Indicates whether the console output should be compacted. yii\console\controllers\BaseMigrateController
$defaultAction string The default command action. yii\console\controllers\BaseMigrateController
$help boolean Whether to display help information about current command. yii\console\Controller
$helpSummary string The one-line short summary describing this controller. yii\console\Controller
$id string The ID of this controller. yii\base\Controller
$interactive boolean Whether to run the command interactively. yii\console\Controller
$layout string|null|false The name of the layout to be applied to this controller's views. yii\base\Controller
$migrationNamespaces array List of namespaces containing the migration classes. yii\console\controllers\BaseMigrateController
$migrationPath string|array|null The directory containing the migration classes. yii\console\controllers\BaseMigrateController
$module yii\base\Module The module that this controller belongs to. yii\base\Controller
$modules yii\base\Module[] All ancestor modules that this controller is located within. yii\base\Controller
$newFileMode integer|null The permission to be set for newly generated migration files. yii\console\controllers\BaseMigrateController
$newFileOwnership string|integer|null The user and/or group ownership to be set for newly generated migration files. yii\console\controllers\BaseMigrateController
$passedOptionValues array The properties corresponding to the passed options. yii\console\Controller
$passedOptions array The names of the options passed during execution. yii\console\Controller
$request yii\console\Request yii\console\Controller
$response yii\console\Response yii\console\Controller
$route string The route (module ID, controller ID and action ID) of the current request. yii\base\Controller
$silentExitOnException boolean|null If true - script finish with ExitCode::OK in case of exception. yii\console\Controller
$templateFile string The template file for generating new migrations. yii\console\controllers\BaseMigrateController
$uniqueId string The controller ID that is prefixed with the module ID (if any). yii\base\Controller
$view yii\base\View|yii\web\View The view object that can be used to render views or view files. yii\base\Controller
$viewPath string The directory containing the view files for this controller. yii\base\Controller

Public Methods

Hide inherited methods

Method Description Defined By
__call() Calls the named method which is not a class method. yii\base\Component
__clone() This method is called after the object is created by cloning an existing one. yii\base\Component
__construct() yii\base\Controller
__get() Returns the value of a component property. yii\base\Component
__isset() Checks if a property is set, i.e. defined and not null. yii\base\Component
__set() Sets the value of a component property. yii\base\Component
__unset() Sets a component property to be null. yii\base\Component
actionCreate() Creates a new migration. yii\console\controllers\BaseMigrateController
actionDown() Downgrades the application by reverting old migrations. yii\console\controllers\BaseMigrateController
actionFresh() Drops all tables and related constraints. Starts the migration from the beginning. yii\console\controllers\BaseMigrateController
actionHistory() Displays the migration history. yii\console\controllers\BaseMigrateController
actionMark() Modifies the migration history to the specified version. yii\console\controllers\BaseMigrateController
actionNew() Displays the un-applied new migrations. yii\console\controllers\BaseMigrateController
actionRedo() Redoes the last few migrations. yii\console\controllers\BaseMigrateController
actionTo() Upgrades or downgrades till the specified version. yii\console\controllers\BaseMigrateController
actionUp() Upgrades the application by applying new migrations. yii\console\controllers\BaseMigrateController
actions() Declares external actions for the controller. yii\base\Controller
afterAction() This method is invoked right after an action is executed. yii\base\Controller
ansiFormat() Formats a string with ANSI codes. yii\console\Controller
attachBehavior() Attaches a behavior to this component. yii\base\Component
attachBehaviors() Attaches a list of behaviors to the component. yii\base\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. yii\console\controllers\BaseMigrateController
behaviors() Returns a list of behaviors that this component should behave as. yii\base\Component
bindActionParams() Binds the parameters to the action. yii\console\Controller
canGetProperty() Returns a value indicating whether a property can be read. yii\base\Component
canSetProperty() Returns a value indicating whether a property can be set. yii\base\Component
className() Returns the fully qualified name of this class. yii\base\BaseObject
confirm() Asks user to confirm by typing y or n. yii\console\Controller
createAction() Creates an action based on the given action ID. yii\base\Controller
detachBehavior() Detaches a behavior from the component. yii\base\Component
detachBehaviors() Detaches all behaviors from the component. yii\base\Component
ensureBehaviors() Makes sure that the behaviors declared in behaviors() are attached to this component. yii\base\Component
findLayoutFile() Finds the applicable layout file. yii\base\Controller
getActionArgsHelp() Returns the help information for the anonymous arguments for the action. yii\console\Controller
getActionHelp() Returns the detailed help information for the specified action. yii\console\Controller
getActionHelpSummary() Returns a one-line short summary describing the specified action. yii\console\Controller
getActionOptionsHelp() Returns the help information for the options for the action. yii\console\Controller
getBehavior() Returns the named behavior object. yii\base\Component
getBehaviors() Returns all behaviors attached to this component. yii\base\Component
getHelp() Returns help information for this controller. yii\console\Controller
getHelpSummary() Returns one-line short summary describing this controller. yii\console\Controller
getModules() Returns all ancestor modules of this controller. yii\base\Controller
getOptionValues() Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties. yii\console\Controller
getPassedOptionValues() Returns the properties corresponding to the passed options. yii\console\Controller
getPassedOptions() Returns the names of valid options passed during execution. yii\console\Controller
getRoute() Returns the route of the current request. yii\base\Controller
getUniqueId() Returns the unique ID of the controller. yii\base\Controller
getView() Returns the view object that can be used to render views or view files. yii\base\Controller
getViewPath() Returns the directory containing view files for this controller. yii\base\Controller
hasEventHandlers() Returns a value indicating whether there is any handler attached to the named event. yii\base\Component
hasMethod() Returns a value indicating whether a method is defined. yii\base\Component
hasProperty() Returns a value indicating whether a property is defined for this component. yii\base\Component
init() Initializes the object. yii\base\Controller
isColorEnabled() Returns a value indicating whether ANSI color is enabled. yii\console\Controller
off() Detaches an existing event handler from this component. yii\base\Component
on() Attaches an event handler to an event. yii\base\Component
optionAliases() Returns option alias names. yii\console\Controller
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. yii\console\controllers\BaseMigrateController
prompt() Prompts the user for input and validates it. yii\console\Controller
render() Renders a view and applies layout if available. yii\base\Controller
renderContent() Renders a static string by applying a layout. yii\base\Controller
renderFile() Renders a view file. yii\base\Controller
renderPartial() Renders a view without applying layout. yii\base\Controller
run() Runs a request specified in terms of a route. yii\base\Controller
runAction() Runs an action with the specified action ID and parameters. yii\console\Controller
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. yii\console\Controller
setView() Sets the view object to be used by this controller. yii\base\Controller
setViewPath() Sets the directory that contains the view files. yii\base\Controller
stderr() Prints a string to STDERR. yii\console\Controller
stdout() Prints a string to STDOUT. yii\console\Controller
trigger() Triggers an event. yii\base\Component

Protected Methods

Hide inherited methods

Method Description Defined By
addMigrationHistory() Adds new migration entry to the history. yii\console\controllers\BaseMigrateController
bindInjectedParams() Fills parameters based on types and names in action method signature. yii\base\Controller
createMigration() Creates a new migration instance. yii\console\controllers\BaseMigrateController
generateMigrationSourceCode() Generates new migration source PHP code. yii\console\controllers\BaseMigrateController
getActionMethodReflection() yii\console\Controller
getMigrationHistory() Returns the migration history. yii\console\controllers\BaseMigrateController
getMigrationNameLimit() Return the maximum name length for a migration. yii\console\controllers\BaseMigrateController
getNewMigrations() Returns the migrations that are not applied. yii\console\controllers\BaseMigrateController
includeMigrationFile() Includes the migration file for a given migration class name. yii\console\controllers\BaseMigrateController
migrateDown() Downgrades with the specified migration class. yii\console\controllers\BaseMigrateController
migrateToTime() Migrates to the specified apply time in the past. yii\console\controllers\BaseMigrateController
migrateToVersion() Migrates to the certain version. yii\console\controllers\BaseMigrateController
migrateUp() Upgrades with the specified migration class. yii\console\controllers\BaseMigrateController
parseDocCommentDetail() Returns full description from the docblock. yii\console\Controller
parseDocCommentSummary() Returns the first line of docblock. yii\console\Controller
parseDocCommentTags() Parses the comment block into tags. yii\console\Controller
removeMigrationHistory() Removes existing migration from the history. yii\console\controllers\BaseMigrateController
truncateDatabase() Truncates the database. yii\console\controllers\BaseMigrateController

Events

Hide inherited events

Event Type Description Defined By
EVENT_AFTER_ACTION yii\base\ActionEvent An event raised right after executing a controller action. yii\base\Controller
EVENT_BEFORE_ACTION yii\base\ActionEvent An event raised right before executing a controller action. yii\base\Controller

Constants

Hide inherited constants

Constant Value Description Defined By
BASE_MIGRATION 'm000000_000000_base' The name of the dummy migration that marks the beginning of the whole migration history. yii\console\controllers\BaseMigrateController
EXIT_CODE_ERROR 1 Deprecated since 2.0.13. Use yii\console\ExitCode::UNSPECIFIED_ERROR instead. yii\console\Controller
EXIT_CODE_NORMAL 0 Deprecated since 2.0.13. Use yii\console\ExitCode::OK instead. yii\console\Controller

Property Details

Hide inherited properties

$compact public property (available since version 2.0.13)

Indicates whether the console output should be compacted. If this is set to true, the individual commands ran within the migration will not be output to the console. Default is false, in other words the output is fully verbose by default.

public boolean $compact false
$defaultAction public property

The default command action.

public string $defaultAction 'up'
$migrationNamespaces public property (available since version 2.0.10)

List of namespaces containing the migration classes.

Migration namespaces should be resolvable as a path alias if prefixed with @, e.g. if you specify the namespace app\migrations, the code Yii::getAlias('@app/migrations') should be able to return the file path to the directory this namespace refers to. This corresponds with the autoloading conventions of Yii.

For example:

[
    'app\migrations',
    'some\extension\migrations',
]

See also $migrationPath.

$migrationPath public property

The directory containing the migration classes. This can be either a path alias or a directory path.

Migration classes located at this path should be declared without a namespace. Use $migrationNamespaces property in case you are using namespaced migrations.

If you have set up $migrationNamespaces, you may set this field to null in order to disable usage of migrations that are not namespaced.

Since version 2.0.12 you may also specify an array of migration paths that should be searched for migrations to load. This is mainly useful to support old extensions that provide migrations without namespace and to adopt the new feature of namespaced migrations while keeping existing migrations.

In general, to load migrations from different locations, $migrationNamespaces is the preferable solution as the migration name contains the origin of the migration in the history, which is not the case when using multiple migration paths.

See also $migrationNamespaces.

public string|array|null $migrationPath = [
    
'@app/migrations',
]
$newFileMode public property (available since version 2.0.43)

The permission to be set for newly generated migration files. This value will be used by PHP chmod() function. No umask will be applied. If not set, the permission will be determined by the current environment.

public integer|null $newFileMode null
$newFileOwnership public property (available since version 2.0.43)

The user and/or group ownership to be set for newly generated migration files. If not set, the ownership will be determined by the current environment.

See also yii\helpers\FileHelper::changeOwnership().

$templateFile public property

The template file for generating new migrations. This can be either a path alias (e.g. "@app/migrations/template.php") or a file path.

public string $templateFile null

Method Details

Hide inherited methods

__call() public method

Defined in: yii\base\Component::__call()

Calls the named method which is not a class method.

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

public mixed __call ( $name, $params )
$name string

The method name

$params array

Method parameters

return mixed

The method return value

throws yii\base\UnknownMethodException

when calling unknown method

                public function __call($name, $params)
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $object) {
        if ($object->hasMethod($name)) {
            return call_user_func_array([$object, $name], $params);
        }
    }
    throw new UnknownMethodException('Calling unknown method: ' . get_class($this) . "::$name()");
}

            
__clone() public method

Defined in: yii\base\Component::__clone()

This method is called after the object is created by cloning an existing one.

It removes all behaviors because they are attached to the old object.

public void __clone ( )

                public function __clone()
{
    $this->_events = [];
    $this->_eventWildcards = [];
    $this->_behaviors = null;
}

            
__construct() public method
public void __construct ( $id, $module, $config = [] )
$id string

The ID of this controller.

$module yii\base\Module

The module that this controller belongs to.

$config array

Name-value pairs that will be used to initialize the object properties.

                public function __construct($id, $module, $config = [])
{
    $this->id = $id;
    $this->module = $module;
    parent::__construct($config);
}

            
__get() public method

Defined in: yii\base\Component::__get()

Returns the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

See also __set().

public mixed __get ( $name )
$name string

The property name

return mixed

The property value or the value of a behavior's property

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is write-only.

                public function __get($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        // read property, e.g. getName()
        return $this->$getter();
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name;
        }
    }
    if (method_exists($this, 'set' . $name)) {
        throw new InvalidCallException('Getting write-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Getting unknown property: ' . get_class($this) . '::' . $name);
}

            
__isset() public method

Defined in: yii\base\Component::__isset()

Checks if a property is set, i.e. defined and not null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

See also https://www.php.net/manual/en/function.isset.php.

public boolean __isset ( $name )
$name string

The property name or the event name

return boolean

Whether the named property is set

                public function __isset($name)
{
    $getter = 'get' . $name;
    if (method_exists($this, $getter)) {
        return $this->$getter() !== null;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canGetProperty($name)) {
            return $behavior->$name !== null;
        }
    }
    return false;
}

            
__set() public method

Defined in: yii\base\Component::__set()

Sets the value of a component property.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

See also __get().

public void __set ( $name, $value )
$name string

The property name or the event name

$value mixed

The property value

throws yii\base\UnknownPropertyException

if the property is not defined

throws yii\base\InvalidCallException

if the property is read-only.

                public function __set($name, $value)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        // set property
        $this->$setter($value);
        return;
    } elseif (strncmp($name, 'on ', 3) === 0) {
        // on event: attach event handler
        $this->on(trim(substr($name, 3)), $value);
        return;
    } elseif (strncmp($name, 'as ', 3) === 0) {
        // as behavior: attach behavior
        $name = trim(substr($name, 3));
        $this->attachBehavior($name, $value instanceof Behavior ? $value : Yii::createObject($value));
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = $value;
            return;
        }
    }
    if (method_exists($this, 'get' . $name)) {
        throw new InvalidCallException('Setting read-only property: ' . get_class($this) . '::' . $name);
    }
    throw new UnknownPropertyException('Setting unknown property: ' . get_class($this) . '::' . $name);
}

            
__unset() public method

Defined in: yii\base\Component::__unset()

Sets a component property to be null.

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

See also https://www.php.net/manual/en/function.unset.php.

public void __unset ( $name )
$name string

The property name

throws yii\base\InvalidCallException

if the property is read only.

                public function __unset($name)
{
    $setter = 'set' . $name;
    if (method_exists($this, $setter)) {
        $this->$setter(null);
        return;
    }
    // behavior property
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $behavior) {
        if ($behavior->canSetProperty($name)) {
            $behavior->$name = null;
            return;
        }
    }
    throw new InvalidCallException('Unsetting an unknown or read-only property: ' . get_class($this) . '::' . $name);
}

            
actionCreate() public method

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.

yii migrate/create create_user_table

In order to generate a namespaced migration, you should specify a namespace before the migration's name. Note that backslash (\) is usually considered a special character in the shell, so you need to escape it properly to avoid shell errors or incorrect behavior. For example:

yii migrate/create app\\migrations\\createUserTable

In case $migrationPath is not set and no namespace is provided, the first entry of $migrationNamespaces will be used.

public void actionCreate ( $name )
$name string

The name of the new migration. This should only contain letters, digits, underscores and/or backslashes.

Note: If the migration name is of a special form, for example create_xxx or drop_xxx, then the generated migration file will contain extra code, in this case for creating/dropping tables.

throws yii\console\Exception

if the name argument is invalid.

                public function actionCreate($name)
{
    if (!preg_match('/^[\w\\\\]+$/', $name)) {
        throw new Exception('The migration name should contain letters, digits, underscore and/or backslash characters only.');
    }
    list($namespace, $className) = $this->generateClassName($name);
    // Abort if name is too long
    $nameLimit = $this->getMigrationNameLimit();
    if ($nameLimit !== null && strlen($className) > $nameLimit) {
        throw new Exception('The migration name is too long.');
    }
    $migrationPath = $this->findMigrationPath($namespace);
    $file = $migrationPath . DIRECTORY_SEPARATOR . $className . '.php';
    if ($this->confirm("Create new migration '$file'?")) {
        $content = $this->generateMigrationSourceCode([
            'name' => $name,
            'className' => $className,
            'namespace' => $namespace,
        ]);
        FileHelper::createDirectory($migrationPath);
        if (file_put_contents($file, $content, LOCK_EX) === false) {
            $this->stdout("Failed to create new migration.\n", Console::FG_RED);
            return ExitCode::IOERR;
        }
        FileHelper::changeOwnership($file, $this->newFileOwnership, $this->newFileMode);
        $this->stdout("New migration created successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}

            
actionDown() public method

Downgrades the application by reverting old migrations.

For example,

yii migrate/down     # revert the last migration
yii migrate/down 3   # revert the last 3 migrations
yii migrate/down all # revert all migrations
public integer actionDown ( $limit 1 )
$limit integer|string

The number of migrations to be reverted. Defaults to 1, meaning the last applied migration will be reverted. When value is "all", all migrations will be reverted.

return integer

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

throws yii\console\Exception

if the number of the steps specified is less than 1.

                public function actionDown($limit = 1)
{
    if ($limit === 'all') {
        $limit = null;
    } else {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The step argument must be greater than 0.');
        }
    }
    $migrations = $this->getMigrationHistory($limit);
    if (empty($migrations)) {
        $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
        return ExitCode::OK;
    }
    $migrations = array_keys($migrations);
    $n = count($migrations);
    $this->stdout("Total $n " . ($n === 1 ? 'migration' : 'migrations') . " to be reverted:\n", Console::FG_YELLOW);
    foreach ($migrations as $migration) {
        $this->stdout("\t$migration\n");
    }
    $this->stdout("\n");
    $reverted = 0;
    if ($this->confirm('Revert the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
        foreach ($migrations as $migration) {
            if (!$this->migrateDown($migration)) {
                $this->stdout("\n$reverted from $n " . ($reverted === 1 ? 'migration was' : 'migrations were') . " reverted.\n", Console::FG_RED);
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
            $reverted++;
        }
        $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') . " reverted.\n", Console::FG_GREEN);
        $this->stdout("\nMigrated down successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}

            
actionFresh() public method (available since version 2.0.13)

Drops all tables and related constraints. Starts the migration from the beginning.

yii migrate/fresh
public void actionFresh ( )

                public function actionFresh()
{
    if (YII_ENV_PROD) {
        $this->stdout("YII_ENV is set to 'prod'.\nRefreshing migrations is not possible on production systems.\n");
        return ExitCode::OK;
    }
    if ($this->confirm("Are you sure you want to drop all tables and related constraints and start the migration from the beginning?\nAll data will be lost irreversibly!")) {
        $this->truncateDatabase();
        return $this->actionUp();
    }
    $this->stdout('Action was cancelled by user. Nothing has been performed.');
    return ExitCode::OK;
}

            
actionHistory() public method

Displays the migration history.

This command will show the list of migrations that have been applied so far. For example,

yii migrate/history     # showing the last 10 migrations
yii migrate/history 5   # showing the last 5 migrations
yii migrate/history all # showing the whole history
public void actionHistory ( $limit 10 )
$limit integer|string

The maximum number of migrations to be displayed. If it is "all", the whole migration history will be displayed.

throws yii\console\Exception

if invalid limit value passed

                public function actionHistory($limit = 10)
{
    if ($limit === 'all') {
        $limit = null;
    } else {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The limit must be greater than 0.');
        }
    }
    $migrations = $this->getMigrationHistory($limit);
    if (empty($migrations)) {
        $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
    } else {
        $n = count($migrations);
        if ($limit > 0) {
            $this->stdout("Showing the last $n applied " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
        } else {
            $this->stdout("Total $n " . ($n === 1 ? 'migration has' : 'migrations have') . " been applied before:\n", Console::FG_YELLOW);
        }
        foreach ($migrations as $version => $time) {
            $this->stdout("\t(" . date('Y-m-d H:i:s', $time) . ') ' . $version . "\n");
        }
    }
    return ExitCode::OK;
}

            
actionMark() public method

Modifies the migration history to the specified version.

No actual migration will be performed.

yii migrate/mark 101129_185401                        # using timestamp
yii migrate/mark m101129_185401_create_user_table     # using full name
yii migrate/mark app\migrations\M101129185401CreateUser # using full namespace name
yii migrate/mark m000000_000000_base # reset the complete migration history
public integer actionMark ( $version )
$version string

The version at which the migration history should be marked. This can be either the timestamp or the full name of the migration. You may specify the name m000000_000000_base to set the migration history to a state where no migration has been applied.

return integer

CLI exit code

throws yii\console\Exception

if the version argument is invalid or the version cannot be found.

                public function actionMark($version)
{
    $originalVersion = $version;
    if (($namespaceVersion = $this->extractNamespaceMigrationVersion($version)) !== false) {
        $version = $namespaceVersion;
    } elseif (($migrationName = $this->extractMigrationVersion($version)) !== false) {
        $version = $migrationName;
    } elseif ($version !== static::BASE_MIGRATION) {
        throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401)\nor the full name of a migration (e.g. m101129_185401_create_user_table)\nor the full name of a namespaced migration (e.g. app\\migrations\\M101129185401CreateUserTable).");
    }
    // try mark up
    $migrations = $this->getNewMigrations();
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            if ($this->confirm("Set migration history at $originalVersion?")) {
                for ($j = 0; $j <= $i; ++$j) {
                    $this->addMigrationHistory($migrations[$j]);
                }
                $this->stdout("The migration history is set at $originalVersion.\nNo actual migration was performed.\n", Console::FG_GREEN);
            }
            return ExitCode::OK;
        }
    }
    // try mark down
    $migrations = array_keys($this->getMigrationHistory(null));
    $migrations[] = static::BASE_MIGRATION;
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            if ($i === 0) {
                $this->stdout("Already at '$originalVersion'. Nothing needs to be done.\n", Console::FG_YELLOW);
            } elseif ($this->confirm("Set migration history at $originalVersion?")) {
                for ($j = 0; $j < $i; ++$j) {
                    $this->removeMigrationHistory($migrations[$j]);
                }
                $this->stdout("The migration history is set at $originalVersion.\nNo actual migration was performed.\n", Console::FG_GREEN);
            }
            return ExitCode::OK;
        }
    }
    throw new Exception("Unable to find the version '$originalVersion'.");
}

            
actionNew() public method

Displays the un-applied new migrations.

This command will show the new migrations that have not been applied. For example,

yii migrate/new     # showing the first 10 new migrations
yii migrate/new 5   # showing the first 5 new migrations
yii migrate/new all # showing all new migrations
public void actionNew ( $limit 10 )
$limit integer|string

The maximum number of new migrations to be displayed. If it is all, all available new migrations will be displayed.

throws yii\console\Exception

if invalid limit value passed

                public function actionNew($limit = 10)
{
    if ($limit !== 'all') {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The limit must be greater than 0.');
        }
    }
    $migrations = $this->getNewMigrations();
    if (empty($migrations)) {
        $this->stdout("No new migrations found. Your system is up-to-date.\n", Console::FG_GREEN);
    } else {
        $n = count($migrations);
        if ($limit !== 'all' && $n > $limit) {
            $migrations = array_slice($migrations, 0, $limit);
            $this->stdout("Showing $limit out of $n new " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
        } else {
            $this->stdout("Found $n new " . ($n === 1 ? 'migration' : 'migrations') . ":\n", Console::FG_YELLOW);
        }
        foreach ($migrations as $migration) {
            $this->stdout("\t" . $migration . "\n");
        }
    }
    return ExitCode::OK;
}

            
actionRedo() public method

Redoes the last few migrations.

This command will first revert the specified migrations, and then apply them again. For example,

yii migrate/redo     # redo the last applied migration
yii migrate/redo 3   # redo the last 3 applied migrations
yii migrate/redo all # redo all migrations
public integer actionRedo ( $limit 1 )
$limit integer|string

The number of migrations to be redone. Defaults to 1, meaning the last applied migration will be redone. When equals "all", all migrations will be redone.

return integer

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

throws yii\console\Exception

if the number of the steps specified is less than 1.

                public function actionRedo($limit = 1)
{
    if ($limit === 'all') {
        $limit = null;
    } else {
        $limit = (int) $limit;
        if ($limit < 1) {
            throw new Exception('The step argument must be greater than 0.');
        }
    }
    $migrations = $this->getMigrationHistory($limit);
    if (empty($migrations)) {
        $this->stdout("No migration has been done before.\n", Console::FG_YELLOW);
        return ExitCode::OK;
    }
    $migrations = array_keys($migrations);
    $n = count($migrations);
    $this->stdout("Total $n " . ($n === 1 ? 'migration' : 'migrations') . " to be redone:\n", Console::FG_YELLOW);
    foreach ($migrations as $migration) {
        $this->stdout("\t$migration\n");
    }
    $this->stdout("\n");
    if ($this->confirm('Redo the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
        foreach ($migrations as $migration) {
            if (!$this->migrateDown($migration)) {
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
        }
        foreach (array_reverse($migrations) as $migration) {
            if (!$this->migrateUp($migration)) {
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
        }
        $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') . " redone.\n", Console::FG_GREEN);
        $this->stdout("\nMigration redone successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}

            
actionTo() public method

Upgrades or downgrades till the specified version.

Can also downgrade versions to the certain apply time in the past by providing a UNIX timestamp or a string parseable by the strtotime() function. This means that all the versions applied after the specified certain time would be reverted.

This command will first revert the specified migrations, and then apply them again. For example,

yii migrate/to 101129_185401                          # using timestamp
yii migrate/to m101129_185401_create_user_table       # using full name
yii migrate/to 1392853618                             # using UNIX timestamp
yii migrate/to "2014-02-15 13:00:50"                  # using strtotime() parseable string
yii migrate/to app\migrations\M101129185401CreateUser # using full namespace name
public void actionTo ( $version )
$version string

Either the version name or the certain time value in the past that the application should be migrated to. This can be either the timestamp, the full name of the migration, the UNIX timestamp, or the parseable datetime string.

throws yii\console\Exception

if the version argument is invalid.

                public function actionTo($version)
{
    if (($namespaceVersion = $this->extractNamespaceMigrationVersion($version)) !== false) {
        return $this->migrateToVersion($namespaceVersion);
    } elseif (($migrationName = $this->extractMigrationVersion($version)) !== false) {
        return $this->migrateToVersion($migrationName);
    } elseif ((string) (int) $version == $version) {
        return $this->migrateToTime($version);
    } elseif (($time = strtotime($version)) !== false) {
        return $this->migrateToTime($time);
    } else {
        throw new Exception("The version argument must be either a timestamp (e.g. 101129_185401),\n the full name of a migration (e.g. m101129_185401_create_user_table),\n the full namespaced name of a migration (e.g. app\\migrations\\M101129185401CreateUserTable),\n a UNIX timestamp (e.g. 1392853000), or a datetime string parseable\nby the strtotime() function (e.g. 2014-02-15 13:00:50).");
    }
}

            
actionUp() public method

Upgrades the application by applying new migrations.

For example,

yii migrate     # apply all new migrations
yii migrate 3   # apply the first 3 new migrations
public integer actionUp ( $limit 0 )
$limit integer

The number of new migrations to be applied. If 0, it means applying all available new migrations.

return integer

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

                public function actionUp($limit = 0)
{
    $migrations = $this->getNewMigrations();
    if (empty($migrations)) {
        $this->stdout("No new migrations found. Your system is up-to-date.\n", Console::FG_GREEN);
        return ExitCode::OK;
    }
    $total = count($migrations);
    $limit = (int) $limit;
    if ($limit > 0) {
        $migrations = array_slice($migrations, 0, $limit);
    }
    $n = count($migrations);
    if ($n === $total) {
        $this->stdout("Total $n new " . ($n === 1 ? 'migration' : 'migrations') . " to be applied:\n", Console::FG_YELLOW);
    } else {
        $this->stdout("Total $n out of $total new " . ($total === 1 ? 'migration' : 'migrations') . " to be applied:\n", Console::FG_YELLOW);
    }
    foreach ($migrations as $migration) {
        $nameLimit = $this->getMigrationNameLimit();
        if ($nameLimit !== null && strlen($migration) > $nameLimit) {
            $this->stdout("\nThe migration name '$migration' is too long. Its not possible to apply this migration.\n", Console::FG_RED);
            return ExitCode::UNSPECIFIED_ERROR;
        }
        $this->stdout("\t$migration\n");
    }
    $this->stdout("\n");
    $applied = 0;
    if ($this->confirm('Apply the above ' . ($n === 1 ? 'migration' : 'migrations') . '?')) {
        foreach ($migrations as $migration) {
            if (!$this->migrateUp($migration)) {
                $this->stdout("\n$applied from $n " . ($applied === 1 ? 'migration was' : 'migrations were') . " applied.\n", Console::FG_RED);
                $this->stdout("\nMigration failed. The rest of the migrations are canceled.\n", Console::FG_RED);
                return ExitCode::UNSPECIFIED_ERROR;
            }
            $applied++;
        }
        $this->stdout("\n$n " . ($n === 1 ? 'migration was' : 'migrations were') . " applied.\n", Console::FG_GREEN);
        $this->stdout("\nMigrated up successfully.\n", Console::FG_GREEN);
    }
    return ExitCode::OK;
}

            
actions() public method

Defined in: yii\base\Controller::actions()

Declares external actions for the controller.

This method is meant to be overwritten to declare external actions for the controller. It should return an array, with array keys being action IDs, and array values the corresponding action class names or action configuration arrays. For example,

return [
    'action1' => 'app\components\Action1',
    'action2' => [
        'class' => 'app\components\Action2',
        'property1' => 'value1',
        'property2' => 'value2',
    ],
];

Yii::createObject() will be used later to create the requested action using the configuration provided here.

public array actions ( )

                public function actions()
{
    return [];
}

            
addMigrationHistory() protected abstract method

Adds new migration entry to the history.

protected abstract void addMigrationHistory ( $version )
$version string

Migration version name.

                abstract protected function addMigrationHistory($version);

            
afterAction() public method

Defined in: yii\base\Controller::afterAction()

This method is invoked right after an action is executed.

The method will trigger the EVENT_AFTER_ACTION event. The return value of the method will be used as the action return value.

If you override this method, your code should look like the following:

public function afterAction($action, $result)
{
    $result = parent::afterAction($action, $result);
    // your custom code here
    return $result;
}
public mixed afterAction ( $action, $result )
$action yii\base\Action

The action just executed.

$result mixed

The action return result.

return mixed

The processed action result.

                public function afterAction($action, $result)
{
    $event = new ActionEvent($action);
    $event->result = $result;
    $this->trigger(self::EVENT_AFTER_ACTION, $event);
    return $event->result;
}

            
ansiFormat() public method

Defined in: yii\console\Controller::ansiFormat()

Formats a string with ANSI codes.

You may pass additional parameters using the constants defined in yii\helpers\Console.

Example:

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

The string to be formatted

                public function ansiFormat($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return $string;
}

            
attachBehavior() public method

Defined in: yii\base\Component::attachBehavior()

Attaches a behavior to this component.

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the yii\base\Behavior::attach() method.

See also detachBehavior().

public yii\base\Behavior attachBehavior ( $name, $behavior )
$name string

The name of the behavior.

$behavior string|array|yii\base\Behavior

The behavior configuration. This can be one of the following:

return yii\base\Behavior

The behavior object

                public function attachBehavior($name, $behavior)
{
    $this->ensureBehaviors();
    return $this->attachBehaviorInternal($name, $behavior);
}

            
attachBehaviors() public method

Defined in: yii\base\Component::attachBehaviors()

Attaches a list of behaviors to the component.

Each behavior is indexed by its name and should be a yii\base\Behavior object, a string specifying the behavior class, or an configuration array for creating the behavior.

See also attachBehavior().

public void attachBehaviors ( $behaviors )
$behaviors array

List of behaviors to be attached to the component

                public function attachBehaviors($behaviors)
{
    $this->ensureBehaviors();
    foreach ($behaviors as $name => $behavior) {
        $this->attachBehaviorInternal($name, $behavior);
    }
}

            
beforeAction() public method

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

public boolean beforeAction ( $action )
$action yii\base\Action

The action to be executed.

return 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".

                public function beforeAction($action)
{
    if (parent::beforeAction($action)) {
        if (empty($this->migrationNamespaces) && empty($this->migrationPath)) {
            throw new InvalidConfigException('At least one of `migrationPath` or `migrationNamespaces` should be specified.');
        }
        $this->migrationNamespaces = (array) $this->migrationNamespaces;
        foreach ($this->migrationNamespaces as $key => $value) {
            $this->migrationNamespaces[$key] = trim($value, '\\');
        }
        if (is_array($this->migrationPath)) {
            foreach ($this->migrationPath as $i => $path) {
                $this->migrationPath[$i] = Yii::getAlias($path);
            }
        } elseif ($this->migrationPath !== null) {
            $path = Yii::getAlias($this->migrationPath);
            if (!is_dir($path)) {
                if ($action->id !== 'create') {
                    throw new InvalidConfigException("Migration failed. Directory specified in migrationPath doesn't exist: {$this->migrationPath}");
                }
                FileHelper::createDirectory($path);
            }
            $this->migrationPath = $path;
        }
        $version = Yii::getVersion();
        $this->stdout("Yii Migration Tool (based on Yii v{$version})\n\n");
        return true;
    }
    return false;
}

            
behaviors() public method

Defined in: yii\base\Component::behaviors()

Returns a list of behaviors that this component should behave as.

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from yii\base\Behavior. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using getBehavior() or be detached using detachBehavior(). Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

public array behaviors ( )
return array

The behavior configurations.

                public function behaviors()
{
    return [];
}

            
bindActionParams() public method

Defined in: yii\console\Controller::bindActionParams()

Binds the parameters to the action.

This method is invoked by yii\base\Action when it begins to run with the given parameters. This method will first bind the parameters with the options available to the action. It then validates the given arguments.

public array bindActionParams ( $action, $params )
$action yii\base\Action

The action to be bound with parameters

$params array

The parameters to be bound to the action

return array

The valid parameters that the action can run with.

throws yii\console\Exception

if there are unknown options or missing arguments

                public function bindActionParams($action, $params)
{
    if ($action instanceof InlineAction) {
        $method = new \ReflectionMethod($this, $action->actionMethod);
    } else {
        $method = new \ReflectionMethod($action, 'run');
    }
    $args = [];
    $missing = [];
    $actionParams = [];
    $requestedParams = [];
    foreach ($method->getParameters() as $i => $param) {
        $name = $param->getName();
        $key = null;
        if (array_key_exists($i, $params)) {
            $key = $i;
        } elseif (array_key_exists($name, $params)) {
            $key = $name;
        }
        if ($key !== null) {
            if (PHP_VERSION_ID >= 80000) {
                $isArray = ($type = $param->getType()) instanceof \ReflectionNamedType && $type->getName() === 'array';
            } else {
                $isArray = $param->isArray();
            }
            if ($isArray) {
                $params[$key] = $params[$key] === '' ? [] : preg_split('/\s*,\s*/', $params[$key]);
            }
            $args[] = $actionParams[$key] = $params[$key];
            unset($params[$key]);
        } elseif (
            PHP_VERSION_ID >= 70100
            && ($type = $param->getType()) !== null
            && $type instanceof \ReflectionNamedType
            && !$type->isBuiltin()
        ) {
            try {
                $this->bindInjectedParams($type, $name, $args, $requestedParams);
            } catch (\yii\base\Exception $e) {
                throw new Exception($e->getMessage());
            }
        } elseif ($param->isDefaultValueAvailable()) {
            $args[] = $actionParams[$i] = $param->getDefaultValue();
        } else {
            $missing[] = $name;
        }
    }
    if (!empty($missing)) {
        throw new Exception(Yii::t('yii', 'Missing required arguments: {params}', ['params' => implode(', ', $missing)]));
    }
    // We use a different array here, specifically one that doesn't contain service instances but descriptions instead.
    if (\Yii::$app->requestedParams === null) {
        \Yii::$app->requestedParams = array_merge($actionParams, $requestedParams);
    }
    return array_merge($args, $params);
}

            
bindInjectedParams() protected method (available since version 2.0.36)

Defined in: yii\base\Controller::bindInjectedParams()

Fills parameters based on types and names in action method signature.

protected void bindInjectedParams ( ReflectionType $type, $name, &$args, &$requestedParams )
$type ReflectionType

The reflected type of the action parameter.

$name string

The name of the parameter.

$args array

The array of arguments for the action, this function may append items to it.

$requestedParams array

The array with requested params, this function may write specific keys to it.

throws yii\base\ErrorException

when we cannot load a required service.

throws yii\base\InvalidConfigException

Thrown when there is an error in the DI configuration.

throws yii\di\NotInstantiableException

Thrown when a definition cannot be resolved to a concrete class (for example an interface type hint) without a proper definition in the container.

                final protected function bindInjectedParams(\ReflectionType $type, $name, &$args, &$requestedParams)
{
    // Since it is not a builtin type it must be DI injection.
    $typeName = $type->getName();
    if (($component = $this->module->get($name, false)) instanceof $typeName) {
        $args[] = $component;
        $requestedParams[$name] = "Component: " . get_class($component) . " \$$name";
    } elseif ($this->module->has($typeName) && ($service = $this->module->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = 'Module ' . get_class($this->module) . " DI: $typeName \$$name";
    } elseif (\Yii::$container->has($typeName) && ($service = \Yii::$container->get($typeName)) instanceof $typeName) {
        $args[] = $service;
        $requestedParams[$name] = "Container DI: $typeName \$$name";
    } elseif ($type->allowsNull()) {
        $args[] = null;
        $requestedParams[$name] = "Unavailable service: $name";
    } else {
        throw new Exception('Could not load required service: ' . $name);
    }
}

            
canGetProperty() public method

Defined in: yii\base\Component::canGetProperty()

Returns a value indicating whether a property can be read.

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).

See also canSetProperty().

public boolean canGetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be read

                public function canGetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'get' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canGetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
canSetProperty() public method

Defined in: yii\base\Component::canSetProperty()

Returns a value indicating whether a property can be set.

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).

See also canGetProperty().

public boolean canSetProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property can be written

                public function canSetProperty($name, $checkVars = true, $checkBehaviors = true)
{
    if (method_exists($this, 'set' . $name) || $checkVars && property_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->canSetProperty($name, $checkVars)) {
                return true;
            }
        }
    }
    return false;
}

            
className() public static method
Deprecated since 2.0.14. On PHP >=5.5, use ::class instead.

Defined in: yii\base\BaseObject::className()

Returns the fully qualified name of this class.

public static string className ( )
return string

The fully qualified name of this class.

                public static function className()
{
    return get_called_class();
}

            
confirm() public method

Defined in: yii\console\Controller::confirm()

Asks user to confirm by typing y or n.

A typical usage looks like the following:

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}
public boolean confirm ( $message, $default false )
$message string

To echo out before waiting for user input

$default boolean

This value is returned if no selection is made.

return boolean

Whether user confirmed. Will return true if $interactive is false.

                public function confirm($message, $default = false)
{
    if ($this->interactive) {
        return Console::confirm($message, $default);
    }
    return true;
}

            
createAction() public method

Defined in: yii\base\Controller::createAction()

Creates an action based on the given action ID.

The method first checks if the action ID has been declared in actions(). If so, it will use the configuration declared there to create the action object. If not, it will look for a controller method whose name is in the format of actionXyz where xyz is the action ID. If found, an yii\base\InlineAction representing that method will be created and returned.

public yii\base\Action|null createAction ( $id )
$id string

The action ID.

return yii\base\Action|null

The newly created action instance. Null if the ID doesn't resolve into any action.

                public function createAction($id)
{
    if ($id === '') {
        $id = $this->defaultAction;
    }
    $actionMap = $this->actions();
    if (isset($actionMap[$id])) {
        return Yii::createObject($actionMap[$id], [$id, $this]);
    }
    if (preg_match('/^(?:[a-z0-9_]+-)*[a-z0-9_]+$/', $id)) {
        $methodName = 'action' . str_replace(' ', '', ucwords(str_replace('-', ' ', $id)));
        if (method_exists($this, $methodName)) {
            $method = new \ReflectionMethod($this, $methodName);
            if ($method->isPublic() && $method->getName() === $methodName) {
                return new InlineAction($id, $this, $methodName);
            }
        }
    }
    return null;
}

            
createMigration() protected method

Creates a new migration instance.

protected yii\db\MigrationInterface createMigration ( $class )
$class string

The migration class name

return yii\db\MigrationInterface

The migration instance

                protected function createMigration($class)
{
    $this->includeMigrationFile($class);
    /** @var MigrationInterface $migration */
    $migration = Yii::createObject($class);
    if ($migration instanceof BaseObject && $migration->canSetProperty('compact')) {
        $migration->compact = $this->compact;
    }
    return $migration;
}

            
detachBehavior() public method

Defined in: yii\base\Component::detachBehavior()

Detaches a behavior from the component.

The behavior's yii\base\Behavior::detach() method will be invoked.

public yii\base\Behavior|null detachBehavior ( $name )
$name string

The behavior's name.

return yii\base\Behavior|null

The detached behavior. Null if the behavior does not exist.

                public function detachBehavior($name)
{
    $this->ensureBehaviors();
    if (isset($this->_behaviors[$name])) {
        $behavior = $this->_behaviors[$name];
        unset($this->_behaviors[$name]);
        $behavior->detach();
        return $behavior;
    }
    return null;
}

            
detachBehaviors() public method

Defined in: yii\base\Component::detachBehaviors()

Detaches all behaviors from the component.

public void detachBehaviors ( )

                public function detachBehaviors()
{
    $this->ensureBehaviors();
    foreach ($this->_behaviors as $name => $behavior) {
        $this->detachBehavior($name);
    }
}

            
ensureBehaviors() public method

Defined in: yii\base\Component::ensureBehaviors()

Makes sure that the behaviors declared in behaviors() are attached to this component.

public void ensureBehaviors ( )

                public function ensureBehaviors()
{
    if ($this->_behaviors === null) {
        $this->_behaviors = [];
        foreach ($this->behaviors() as $name => $behavior) {
            $this->attachBehaviorInternal($name, $behavior);
        }
    }
}

            
findLayoutFile() public method

Defined in: yii\base\Controller::findLayoutFile()

Finds the applicable layout file.

public string|boolean findLayoutFile ( $view )
$view yii\base\View

The view object to render the layout file.

return string|boolean

The layout file path, or false if layout is not needed. Please refer to render() on how to specify this parameter.

throws yii\base\InvalidArgumentException

if an invalid path alias is used to specify the layout.

                public function findLayoutFile($view)
{
    $module = $this->module;
    $layout = null;
    if (is_string($this->layout)) {
        $layout = $this->layout;
    } elseif ($this->layout === null) {
        while ($module !== null && $module->layout === null) {
            $module = $module->module;
        }
        if ($module !== null && is_string($module->layout)) {
            $layout = $module->layout;
        }
    }
    if ($layout === null) {
        return false;
    }
    if (strncmp($layout, '@', 1) === 0) {
        $file = Yii::getAlias($layout);
    } elseif (strncmp($layout, '/', 1) === 0) {
        $file = Yii::$app->getLayoutPath() . DIRECTORY_SEPARATOR . substr($layout, 1);
    } else {
        $file = $module->getLayoutPath() . DIRECTORY_SEPARATOR . $layout;
    }
    if (pathinfo($file, PATHINFO_EXTENSION) !== '') {
        return $file;
    }
    $path = $file . '.' . $view->defaultExtension;
    if ($view->defaultExtension !== 'php' && !is_file($path)) {
        $path = $file . '.php';
    }
    return $path;
}

            
generateMigrationSourceCode() protected method (available since version 2.0.8)

Generates new migration source PHP code.

Child class may override this method, adding extra logic or variation to the process.

protected string generateMigrationSourceCode ( $params )
$params array

Generation parameters, usually following parameters are present:

  • name: string migration base name
  • className: string migration class name
return string

Generated PHP code.

                protected function generateMigrationSourceCode($params)
{
    return $this->renderFile(Yii::getAlias($this->templateFile), $params);
}

            
getActionArgsHelp() public method

Defined in: yii\console\Controller::getActionArgsHelp()

Returns the help information for the anonymous arguments for the action.

The returned value should be an array. The keys are the argument names, and the values are the corresponding help information. Each value must be an array of the following structure:

  • required: bool, whether this argument is required
  • type: string|null, the PHP type(s) of this argument
  • default: mixed, the default value of this argument
  • comment: string, the description of this argument

The default implementation will return the help information extracted from the Reflection or DocBlock of the parameters corresponding to the action method.

public array getActionArgsHelp ( $action )
$action yii\base\Action

The action instance

return array

The help information of the action arguments

                public function getActionArgsHelp($action)
{
    $method = $this->getActionMethodReflection($action);
    $tags = $this->parseDocCommentTags($method);
    $tags['param'] = isset($tags['param']) ? (array) $tags['param'] : [];
    $phpDocParams = [];
    foreach ($tags['param'] as $i => $tag) {
        if (preg_match('/^(?<type>\S+)(\s+\$(?<name>\w+))?(?<comment>.*)/us', $tag, $matches) === 1) {
            $key = empty($matches['name']) ? $i : $matches['name'];
            $phpDocParams[$key] = ['type' => $matches['type'], 'comment' => $matches['comment']];
        }
    }
    unset($tags);
    $args = [];
    /** @var \ReflectionParameter $parameter */
    foreach ($method->getParameters() as $i => $parameter) {
        $type = null;
        $comment = '';
        if (PHP_MAJOR_VERSION > 5 && $parameter->hasType()) {
            $reflectionType = $parameter->getType();
            if (PHP_VERSION_ID >= 70100) {
                $types = method_exists($reflectionType, 'getTypes') ? $reflectionType->getTypes() : [$reflectionType];
                foreach ($types as $key => $reflectionType) {
                    $types[$key] = $reflectionType->getName();
                }
                $type = implode('|', $types);
            } else {
                $type = (string) $reflectionType;
            }
        }
        // find PhpDoc tag by property name or position
        $key = isset($phpDocParams[$parameter->name]) ? $parameter->name : (isset($phpDocParams[$i]) ? $i : null);
        if ($key !== null) {
            $comment = $phpDocParams[$key]['comment'];
            if ($type === null && !empty($phpDocParams[$key]['type'])) {
                $type = $phpDocParams[$key]['type'];
            }
        }
        // if type still not detected, then using type of default value
        if ($type === null && $parameter->isDefaultValueAvailable() && $parameter->getDefaultValue() !== null) {
            $type = gettype($parameter->getDefaultValue());
        }
        $args[$parameter->name] = [
            'required' => !$parameter->isOptional(),
            'type' => $type,
            'default' => $parameter->isDefaultValueAvailable() ? $parameter->getDefaultValue() : null,
            'comment' => $comment,
        ];
    }
    return $args;
}

            
getActionHelp() public method

Defined in: yii\console\Controller::getActionHelp()

Returns the detailed help information for the specified action.

public string getActionHelp ( $action )
$action yii\base\Action

Action to get help for

return string

The detailed help information for the specified action.

                public function getActionHelp($action)
{
    return $this->parseDocCommentDetail($this->getActionMethodReflection($action));
}

            
getActionHelpSummary() public method

Defined in: yii\console\Controller::getActionHelpSummary()

Returns a one-line short summary describing the specified action.

public string getActionHelpSummary ( $action )
$action yii\base\Action

Action to get summary for

return string

A one-line short summary describing the specified action.

                public function getActionHelpSummary($action)
{
    if ($action === null) {
        return $this->ansiFormat(Yii::t('yii', 'Action not found.'), Console::FG_RED);
    }
    return $this->parseDocCommentSummary($this->getActionMethodReflection($action));
}

            
getActionMethodReflection() protected method
protected ReflectionMethod getActionMethodReflection ( $action )
$action yii\base\Action

                protected function getActionMethodReflection($action)
{
    if (!isset($this->_reflections[$action->id])) {
        if ($action instanceof InlineAction) {
            $this->_reflections[$action->id] = new \ReflectionMethod($this, $action->actionMethod);
        } else {
            $this->_reflections[$action->id] = new \ReflectionMethod($action, 'run');
        }
    }
    return $this->_reflections[$action->id];
}

            
getActionOptionsHelp() public method

Defined in: yii\console\Controller::getActionOptionsHelp()

Returns the help information for the options for the action.

The returned value should be an array. The keys are the option names, and the values are the corresponding help information. Each value must be an array of the following structure:

  • type: string, the PHP type of this argument.
  • default: string, the default value of this argument
  • comment: string, the comment of this argument

The default implementation will return the help information extracted from the doc-comment of the properties corresponding to the action options.

public array getActionOptionsHelp ( $action )
$action yii\base\Action
return array

The help information of the action options

                public function getActionOptionsHelp($action)
{
    $optionNames = $this->options($action->id);
    if (empty($optionNames)) {
        return [];
    }
    $class = new \ReflectionClass($this);
    $options = [];
    foreach ($class->getProperties() as $property) {
        $name = $property->getName();
        if (!in_array($name, $optionNames, true)) {
            continue;
        }
        $defaultValue = $property->getValue($this);
        $tags = $this->parseDocCommentTags($property);
        // Display camelCase options in kebab-case
        $name = Inflector::camel2id($name, '-', true);
        if (isset($tags['var']) || isset($tags['property'])) {
            $doc = isset($tags['var']) ? $tags['var'] : $tags['property'];
            if (is_array($doc)) {
                $doc = reset($doc);
            }
            if (preg_match('/^(\S+)(.*)/s', $doc, $matches)) {
                $type = $matches[1];
                $comment = $matches[2];
            } else {
                $type = null;
                $comment = $doc;
            }
            $options[$name] = [
                'type' => $type,
                'default' => $defaultValue,
                'comment' => $comment,
            ];
        } else {
            $options[$name] = [
                'type' => null,
                'default' => $defaultValue,
                'comment' => '',
            ];
        }
    }
    return $options;
}

            
getBehavior() public method

Defined in: yii\base\Component::getBehavior()

Returns the named behavior object.

public yii\base\Behavior|null getBehavior ( $name )
$name string

The behavior name

return yii\base\Behavior|null

The behavior object, or null if the behavior does not exist

                public function getBehavior($name)
{
    $this->ensureBehaviors();
    return isset($this->_behaviors[$name]) ? $this->_behaviors[$name] : null;
}

            
getBehaviors() public method

Defined in: yii\base\Component::getBehaviors()

Returns all behaviors attached to this component.

public yii\base\Behavior[] getBehaviors ( )
return yii\base\Behavior[]

List of behaviors attached to this component

                public function getBehaviors()
{
    $this->ensureBehaviors();
    return $this->_behaviors;
}

            
getHelp() public method

Defined in: yii\console\Controller::getHelp()

Returns help information for this controller.

You may override this method to return customized help. The default implementation returns help information retrieved from the PHPDoc comment.

public string getHelp ( )

                public function getHelp()
{
    return $this->parseDocCommentDetail(new \ReflectionClass($this));
}

            
getHelpSummary() public method

Defined in: yii\console\Controller::getHelpSummary()

Returns one-line short summary describing this controller.

You may override this method to return customized summary. The default implementation returns first line from the PHPDoc comment.

public string getHelpSummary ( )

                public function getHelpSummary()
{
    return $this->parseDocCommentSummary(new \ReflectionClass($this));
}

            
getMigrationHistory() protected abstract method

Returns the migration history.

protected abstract array getMigrationHistory ( $limit )
$limit integer|null

The maximum number of records in the history to be returned. null for "no limit".

return array

The migration history

                abstract protected function getMigrationHistory($limit);

            
getMigrationNameLimit() protected method (available since version 2.0.13)

Return the maximum name length for a migration.

Subclasses may override this method to define a limit.

protected integer|null getMigrationNameLimit ( )
return integer|null

The maximum name length for a migration or null if no limit applies.

                protected function getMigrationNameLimit()
{
    return null;
}

            
getModules() public method

Defined in: yii\base\Controller::getModules()

Returns all ancestor modules of this controller.

The first module in the array is the outermost one (i.e., the application instance), while the last is the innermost one.

public yii\base\Module[] getModules ( )
return yii\base\Module[]

All ancestor modules that this controller is located within.

                public function getModules()
{
    $modules = [$this->module];
    $module = $this->module;
    while ($module->module !== null) {
        array_unshift($modules, $module->module);
        $module = $module->module;
    }
    return $modules;
}

            
getNewMigrations() protected method

Returns the migrations that are not applied.

protected array getNewMigrations ( )
return array

List of new migrations

                protected function getNewMigrations()
{
    $applied = [];
    foreach ($this->getMigrationHistory(null) as $class => $time) {
        $applied[trim($class, '\\')] = true;
    }
    $migrationPaths = [];
    if (is_array($this->migrationPath)) {
        foreach ($this->migrationPath as $path) {
            $migrationPaths[] = [$path, ''];
        }
    } elseif (!empty($this->migrationPath)) {
        $migrationPaths[] = [$this->migrationPath, ''];
    }
    foreach ($this->migrationNamespaces as $namespace) {
        $migrationPaths[] = [$this->getNamespacePath($namespace), $namespace];
    }
    $migrations = [];
    foreach ($migrationPaths as $item) {
        list($migrationPath, $namespace) = $item;
        if (!file_exists($migrationPath)) {
            continue;
        }
        $handle = opendir($migrationPath);
        while (($file = readdir($handle)) !== false) {
            if ($file === '.' || $file === '..') {
                continue;
            }
            $path = $migrationPath . DIRECTORY_SEPARATOR . $file;
            if (preg_match('/^(m(\d{6}_?\d{6})\D.*?)\.php$/is', $file, $matches) && is_file($path)) {
                $class = $matches[1];
                if (!empty($namespace)) {
                    $class = $namespace . '\\' . $class;
                }
                $time = str_replace('_', '', $matches[2]);
                if (!isset($applied[$class])) {
                    $migrations[$time . '\\' . $class] = $class;
                }
            }
        }
        closedir($handle);
    }
    ksort($migrations);
    return array_values($migrations);
}

            
getOptionValues() public method

Defined in: yii\console\Controller::getOptionValues()

Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.

public array getOptionValues ( $actionID )
$actionID string

The action id of the current request

return array

Properties corresponding to the options for the action

                public function getOptionValues($actionID)
{
    // $actionId might be used in subclasses to provide properties specific to action id
    $properties = [];
    foreach ($this->options($this->action->id) as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptionValues() public method

Defined in: yii\console\Controller::getPassedOptionValues()

Returns the properties corresponding to the passed options.

public array getPassedOptionValues ( )
return array

The properties corresponding to the passed options

                public function getPassedOptionValues()
{
    $properties = [];
    foreach ($this->_passedOptions as $property) {
        $properties[$property] = $this->$property;
    }
    return $properties;
}

            
getPassedOptions() public method

Defined in: yii\console\Controller::getPassedOptions()

Returns the names of valid options passed during execution.

public array getPassedOptions ( )
return array

The names of the options passed during execution

                public function getPassedOptions()
{
    return $this->_passedOptions;
}

            
getRoute() public method

Defined in: yii\base\Controller::getRoute()

Returns the route of the current request.

public string getRoute ( )
return string

The route (module ID, controller ID and action ID) of the current request.

                public function getRoute()
{
    return $this->action !== null ? $this->action->getUniqueId() : $this->getUniqueId();
}

            
getUniqueId() public method

Defined in: yii\base\Controller::getUniqueId()

Returns the unique ID of the controller.

public string getUniqueId ( )
return string

The controller ID that is prefixed with the module ID (if any).

                public function getUniqueId()
{
    return $this->module instanceof Application ? $this->id : $this->module->getUniqueId() . '/' . $this->id;
}

            
getView() public method

Defined in: yii\base\Controller::getView()

Returns the view object that can be used to render views or view files.

The render(), renderPartial() and renderFile() methods will use this view object to implement the actual view rendering. If not set, it will default to the "view" application component.

public yii\base\View|yii\web\View getView ( )
return yii\base\View|yii\web\View

The view object that can be used to render views or view files.

                public function getView()
{
    if ($this->_view === null) {
        $this->_view = Yii::$app->getView();
    }
    return $this->_view;
}

            
getViewPath() public method

Defined in: yii\base\Controller::getViewPath()

Returns the directory containing view files for this controller.

The default implementation returns the directory named as controller $id under the $module's $viewPath directory.

public string getViewPath ( )
return string

The directory containing the view files for this controller.

                public function getViewPath()
{
    if ($this->_viewPath === null) {
        $this->_viewPath = $this->module->getViewPath() . DIRECTORY_SEPARATOR . $this->id;
    }
    return $this->_viewPath;
}

            
hasEventHandlers() public method

Defined in: yii\base\Component::hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public boolean hasEventHandlers ( $name )
$name string

The event name

return boolean

Whether there is any handler attached to the event.

                public function hasEventHandlers($name)
{
    $this->ensureBehaviors();
    if (!empty($this->_events[$name])) {
        return true;
    }
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (!empty($handlers) && StringHelper::matchWildcard($wildcard, $name)) {
            return true;
        }
    }
    return Event::hasHandlers($this, $name);
}

            
hasMethod() public method

Defined in: yii\base\Component::hasMethod()

Returns a value indicating whether a method is defined.

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
public boolean hasMethod ( $name, $checkBehaviors true )
$name string

The property name

$checkBehaviors boolean

Whether to treat behaviors' methods as methods of this component

return boolean

Whether the method is defined

                public function hasMethod($name, $checkBehaviors = true)
{
    if (method_exists($this, $name)) {
        return true;
    } elseif ($checkBehaviors) {
        $this->ensureBehaviors();
        foreach ($this->_behaviors as $behavior) {
            if ($behavior->hasMethod($name)) {
                return true;
            }
        }
    }
    return false;
}

            
hasProperty() public method

Defined in: yii\base\Component::hasProperty()

Returns a value indicating whether a property is defined for this component.

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).

See also:

public boolean hasProperty ( $name, $checkVars true, $checkBehaviors true )
$name string

The property name

$checkVars boolean

Whether to treat member variables as properties

$checkBehaviors boolean

Whether to treat behaviors' properties as properties of this component

return boolean

Whether the property is defined

                public function hasProperty($name, $checkVars = true, $checkBehaviors = true)
{
    return $this->canGetProperty($name, $checkVars, $checkBehaviors) || $this->canSetProperty($name, false, $checkBehaviors);
}

            
includeMigrationFile() protected method (available since version 2.0.12)

Includes the migration file for a given migration class name.

This function will do nothing on namespaced migrations, which are loaded by autoloading automatically. It will include the migration file, by searching $migrationPath for classes without namespace.

protected void includeMigrationFile ( $class )
$class string

The migration class name.

                protected function includeMigrationFile($class)
{
    $class = trim($class, '\\');
    if (strpos($class, '\\') === false) {
        if (is_array($this->migrationPath)) {
            foreach ($this->migrationPath as $path) {
                $file = $path . DIRECTORY_SEPARATOR . $class . '.php';
                if (is_file($file)) {
                    require_once $file;
                    break;
                }
            }
        } else {
            $file = $this->migrationPath . DIRECTORY_SEPARATOR . $class . '.php';
            require_once $file;
        }
    }
}

            
init() public method (available since version 2.0.36)

Defined in: yii\base\Controller::init()

Initializes the object.

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

public void init ( )

                public function init()
{
    parent::init();
    $this->request = Instance::ensure($this->request, Request::className());
    $this->response = Instance::ensure($this->response, Response::className());
}

            
isColorEnabled() public method

Defined in: yii\console\Controller::isColorEnabled()

Returns a value indicating whether ANSI color is enabled.

ANSI color is enabled only if $color is set true or is not set and the terminal supports ANSI color.

public boolean isColorEnabled ( $stream = \STDOUT )
$stream resource

The stream to check.

return boolean

Whether to enable ANSI style in output.

                public function isColorEnabled($stream = \STDOUT)
{
    return $this->color === null ? Console::streamSupportsAnsiColors($stream) : $this->color;
}

            
migrateDown() protected method

Downgrades with the specified migration class.

protected boolean migrateDown ( $class )
$class string

The migration class name

return boolean

Whether the migration is successful

                protected function migrateDown($class)
{
    if ($class === self::BASE_MIGRATION) {
        return true;
    }
    $this->stdout("*** reverting $class\n", Console::FG_YELLOW);
    $start = microtime(true);
    $migration = $this->createMigration($class);
    if ($migration->down() !== false) {
        $this->removeMigrationHistory($class);
        $time = microtime(true) - $start;
        $this->stdout("*** reverted $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_GREEN);
        return true;
    }
    $time = microtime(true) - $start;
    $this->stdout("*** failed to revert $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_RED);
    return false;
}

            
migrateToTime() protected method

Migrates to the specified apply time in the past.

protected void migrateToTime ( $time )
$time integer

UNIX timestamp value.

                protected function migrateToTime($time)
{
    $count = 0;
    $migrations = array_values($this->getMigrationHistory(null));
    while ($count < count($migrations) && $migrations[$count] > $time) {
        ++$count;
    }
    if ($count === 0) {
        $this->stdout("Nothing needs to be done.\n", Console::FG_GREEN);
    } else {
        return $this->actionDown($count);
    }
    return ExitCode::OK;
}

            
migrateToVersion() protected method

Migrates to the certain version.

protected integer migrateToVersion ( $version )
$version string

Name in the full format.

return integer

CLI exit code

throws yii\console\Exception

if the provided version cannot be found.

                protected function migrateToVersion($version)
{
    $originalVersion = $version;
    // try migrate up
    $migrations = $this->getNewMigrations();
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            return $this->actionUp($i + 1);
        }
    }
    // try migrate down
    $migrations = array_keys($this->getMigrationHistory(null));
    foreach ($migrations as $i => $migration) {
        if (strpos($migration, $version) === 0) {
            if ($i === 0) {
                $this->stdout("Already at '$originalVersion'. Nothing needs to be done.\n", Console::FG_YELLOW);
            } else {
                return $this->actionDown($i);
            }
            return ExitCode::OK;
        }
    }
    throw new Exception("Unable to find the version '$originalVersion'.");
}

            
migrateUp() protected method

Upgrades with the specified migration class.

protected boolean migrateUp ( $class )
$class string

The migration class name

return boolean

Whether the migration is successful

                protected function migrateUp($class)
{
    if ($class === self::BASE_MIGRATION) {
        return true;
    }
    $this->stdout("*** applying $class\n", Console::FG_YELLOW);
    $start = microtime(true);
    $migration = $this->createMigration($class);
    if ($migration->up() !== false) {
        $this->addMigrationHistory($class);
        $time = microtime(true) - $start;
        $this->stdout("*** applied $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_GREEN);
        return true;
    }
    $time = microtime(true) - $start;
    $this->stdout("*** failed to apply $class (time: " . sprintf('%.3f', $time) . "s)\n\n", Console::FG_RED);
    return false;
}

            
off() public method

Defined in: yii\base\Component::off()

Detaches an existing event handler from this component.

This method is the opposite of on().

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

See also on().

public boolean off ( $name, $handler null )
$name string

Event name

$handler callable|null

The event handler to be removed. If it is null, all handlers attached to the named event will be removed.

return boolean

If a handler is found and detached

                public function off($name, $handler = null)
{
    $this->ensureBehaviors();
    if (empty($this->_events[$name]) && empty($this->_eventWildcards[$name])) {
        return false;
    }
    if ($handler === null) {
        unset($this->_events[$name], $this->_eventWildcards[$name]);
        return true;
    }
    $removed = false;
    // plain event names
    if (isset($this->_events[$name])) {
        foreach ($this->_events[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_events[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_events[$name] = array_values($this->_events[$name]);
            return true;
        }
    }
    // wildcard event names
    if (isset($this->_eventWildcards[$name])) {
        foreach ($this->_eventWildcards[$name] as $i => $event) {
            if ($event[0] === $handler) {
                unset($this->_eventWildcards[$name][$i]);
                $removed = true;
            }
        }
        if ($removed) {
            $this->_eventWildcards[$name] = array_values($this->_eventWildcards[$name]);
            // remove empty wildcards to save future redundant regex checks:
            if (empty($this->_eventWildcards[$name])) {
                unset($this->_eventWildcards[$name]);
            }
        }
    }
    return $removed;
}

            
on() public method

Defined in: yii\base\Component::on()

Attaches an event handler to an event.

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an yii\base\Event object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});

See also off().

public void on ( $name, $handler, $data null, $append true )
$name string

The event name

$handler callable

The event handler

$data mixed

The data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via yii\base\Event::$data.

$append boolean

Whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

                public function on($name, $handler, $data = null, $append = true)
{
    $this->ensureBehaviors();
    if (strpos($name, '*') !== false) {
        if ($append || empty($this->_eventWildcards[$name])) {
            $this->_eventWildcards[$name][] = [$handler, $data];
        } else {
            array_unshift($this->_eventWildcards[$name], [$handler, $data]);
        }
        return;
    }
    if ($append || empty($this->_events[$name])) {
        $this->_events[$name][] = [$handler, $data];
    } else {
        array_unshift($this->_events[$name], [$handler, $data]);
    }
}

            
optionAliases() public method (available since version 2.0.8)

Defined in: yii\console\Controller::optionAliases()

Returns option alias names.

Child classes may override this method to specify alias options.

See also options().

public array optionAliases ( )
return array

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

                public function optionAliases()
{
    return [
        'h' => 'help',
    ];
}

            
options() public method

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.

public string[] options ( $actionID )
$actionID string

The action id of the current request

return string[]

The names of the options valid for the action

                public function options($actionID)
{
    return array_merge(
        parent::options($actionID),
        ['migrationPath', 'migrationNamespaces', 'compact'], // global for all actions
        $actionID === 'create' ? ['templateFile'] : [] // action create
    );
}

            
parseDocCommentDetail() protected method

Defined in: yii\console\Controller::parseDocCommentDetail()

Returns full description from the docblock.

protected string parseDocCommentDetail ( $reflection )
$reflection Reflector

                protected function parseDocCommentDetail($reflection)
{
    $comment = strtr(trim(preg_replace('/^\s*\**( |\t)?/m', '', trim($reflection->getDocComment(), '/'))), "\r", '');
    if (preg_match('/^\s*@\w+/m', $comment, $matches, PREG_OFFSET_CAPTURE)) {
        $comment = trim(substr($comment, 0, $matches[0][1]));
    }
    if ($comment !== '') {
        return rtrim(Console::renderColoredString(Console::markdownToAnsi($comment)));
    }
    return '';
}

            
parseDocCommentSummary() protected method

Defined in: yii\console\Controller::parseDocCommentSummary()

Returns the first line of docblock.

protected string parseDocCommentSummary ( $reflection )
$reflection Reflector

                protected function parseDocCommentSummary($reflection)
{
    $docLines = preg_split('~\R~u', $reflection->getDocComment());
    if (isset($docLines[1])) {
        return trim($docLines[1], "\t *");
    }
    return '';
}

            
parseDocCommentTags() protected method

Defined in: yii\console\Controller::parseDocCommentTags()

Parses the comment block into tags.

protected array parseDocCommentTags ( $reflection )
$reflection Reflector

The comment block

return array

The parsed tags

                protected function parseDocCommentTags($reflection)
{
    $comment = $reflection->getDocComment();
    $comment = "@description \n" . strtr(trim(preg_replace('/^\s*\**( |\t)?/m', '', trim($comment, '/'))), "\r", '');
    $parts = preg_split('/^\s*@/m', $comment, -1, PREG_SPLIT_NO_EMPTY);
    $tags = [];
    foreach ($parts as $part) {
        if (preg_match('/^(\w+)(.*)/ms', trim($part), $matches)) {
            $name = $matches[1];
            if (!isset($tags[$name])) {
                $tags[$name] = trim($matches[2]);
            } elseif (is_array($tags[$name])) {
                $tags[$name][] = trim($matches[2]);
            } else {
                $tags[$name] = [$tags[$name], trim($matches[2])];
            }
        }
    }
    return $tags;
}

            
prompt() public method

Defined in: yii\console\Controller::prompt()

Prompts the user for input and validates it.

public string prompt ( $text, $options = [] )
$text string

Prompt string

$options array

The options to validate the input:

  • required: whether it is required or not
  • default: default value if no input is inserted by the user
  • pattern: regular expression pattern to validate user input
  • validator: a callable function to validate input. The function must accept two parameters:
    • $input: the user input to validate
    • $error: the error value passed by reference if validation failed.

An example of how to use the prompt method with a validator function.

$code = $this->prompt('Enter 4-Chars-Pin', ['required' => true, 'validator' => function($input, &$error) {
    if (strlen($input) !== 4) {
        $error = 'The Pin must be exactly 4 chars!';
        return false;
    }
    return true;
}]);
return string

The user input

                public function prompt($text, $options = [])
{
    if ($this->interactive) {
        return Console::prompt($text, $options);
    }
    return isset($options['default']) ? $options['default'] : '';
}

            
removeMigrationHistory() protected abstract method

Removes existing migration from the history.

protected abstract void removeMigrationHistory ( $version )
$version string

Migration version name.

                abstract protected function removeMigrationHistory($version);

            
render() public method

Defined in: yii\base\Controller::render()

Renders a view and applies layout if available.

The view to be rendered can be specified in one of the following formats:

  • path alias (e.g. "@app/views/site/index");
  • absolute path within application (e.g. "//site/index"): the view name starts with double slashes. The actual view file will be looked for under the view path of the application.
  • absolute path within module (e.g. "/site/index"): the view name starts with a single slash. The actual view file will be looked for under the view path of $module.
  • relative path (e.g. "index"): the actual view file will be looked for under $viewPath.

To determine which layout should be applied, the following two steps are conducted:

  1. In the first step, it determines the layout name and the context module:
  • If $layout is specified as a string, use it as the layout name and $module as the context module;
  • If $layout is null, search through all ancestor modules of this controller and find the first module whose layout is not null. The layout and the corresponding module are used as the layout name and the context module, respectively. If such a module is not found or the corresponding layout is not a string, it will return false, meaning no applicable layout.
  1. In the second step, it determines the actual layout file according to the previously found layout name and context module. The layout name can be:
  • a path alias (e.g. "@app/views/layouts/main");
  • an absolute path (e.g. "/main"): the layout name starts with a slash. The actual layout file will be looked for under the layout path of the application;
  • a relative path (e.g. "main"): the actual layout file will be looked for under the layout path of the context module.

If the layout name does not contain a file extension, it will use the default one .php.

public string render ( $view, $params = [] )
$view string

The view name.

$params array

The parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file or the layout file does not exist.

                public function render($view, $params = [])
{
    $content = $this->getView()->render($view, $params, $this);
    return $this->renderContent($content);
}

            
renderContent() public method (available since version 2.0.1)

Defined in: yii\base\Controller::renderContent()

Renders a static string by applying a layout.

public string renderContent ( $content )
$content string

The static string being rendered

return string

The rendering result of the layout with the given static string as the $content variable. If the layout is disabled, the string will be returned back.

                public function renderContent($content)
{
    $layoutFile = $this->findLayoutFile($this->getView());
    if ($layoutFile !== false) {
        return $this->getView()->renderFile($layoutFile, ['content' => $content], $this);
    }
    return $content;
}

            
renderFile() public method

Defined in: yii\base\Controller::renderFile()

Renders a view file.

public string renderFile ( $file, $params = [] )
$file string

The view file to be rendered. This can be either a file path or a path alias.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file does not exist.

                public function renderFile($file, $params = [])
{
    return $this->getView()->renderFile($file, $params, $this);
}

            
renderPartial() public method

Defined in: yii\base\Controller::renderPartial()

Renders a view without applying layout.

This method differs from render() in that it does not apply any layout.

public string renderPartial ( $view, $params = [] )
$view string

The view name. Please refer to render() on how to specify a view name.

$params array

The parameters (name-value pairs) that should be made available in the view.

return string

The rendering result.

throws yii\base\InvalidArgumentException

if the view file does not exist.

                public function renderPartial($view, $params = [])
{
    return $this->getView()->render($view, $params, $this);
}

            
run() public method

Defined in: yii\base\Controller::run()

Runs a request specified in terms of a route.

The route can be either an ID of an action within this controller or a complete route consisting of module IDs, controller ID and action ID. If the route starts with a slash '/', the parsing of the route will start from the application; otherwise, it will start from the parent module of this controller.

See also runAction().

public mixed run ( $route, $params = [] )
$route string

The route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.

$params array

The parameters to be passed to the action.

return mixed

The result of the action.

                public function run($route, $params = [])
{
    $pos = strpos($route, '/');
    if ($pos === false) {
        return $this->runAction($route, $params);
    } elseif ($pos > 0) {
        return $this->module->runAction($route, $params);
    }
    return Yii::$app->runAction(ltrim($route, '/'), $params);
}

            
runAction() public method

Defined in: yii\console\Controller::runAction()

Runs an action with the specified action ID and parameters.

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

See also createAction().

public integer runAction ( $id, $params = [] )
$id string

The ID of the action to be executed.

$params array

The parameters (name-value pairs) to be passed to the action.

return 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.

throws yii\console\Exception

if there are unknown options or missing arguments

                public function runAction($id, $params = [])
{
    if (!empty($params)) {
        // populate options here so that they are available in beforeAction().
        $options = $this->options($id === '' ? $this->defaultAction : $id);
        if (isset($params['_aliases'])) {
            $optionAliases = $this->optionAliases();
            foreach ($params['_aliases'] as $name => $value) {
                if (array_key_exists($name, $optionAliases)) {
                    $params[$optionAliases[$name]] = $value;
                } else {
                    $message = Yii::t('yii', 'Unknown alias: -{name}', ['name' => $name]);
                    if (!empty($optionAliases)) {
                        $aliasesAvailable = [];
                        foreach ($optionAliases as $alias => $option) {
                            $aliasesAvailable[] = '-' . $alias . ' (--' . $option . ')';
                        }
                        $message .= '. ' . Yii::t('yii', 'Aliases available: {aliases}', [
                            'aliases' => implode(', ', $aliasesAvailable)
                        ]);
                    }
                    throw new Exception($message);
                }
            }
            unset($params['_aliases']);
        }
        foreach ($params as $name => $value) {
            // Allow camelCase options to be entered in kebab-case
            if (!in_array($name, $options, true) && strpos($name, '-') !== false) {
                $kebabName = $name;
                $altName = lcfirst(Inflector::id2camel($kebabName));
                if (in_array($altName, $options, true)) {
                    $name = $altName;
                }
            }
            if (in_array($name, $options, true)) {
                $default = $this->$name;
                if (is_array($default) && is_string($value)) {
                    $this->$name = preg_split('/\s*,\s*(?![^()]*\))/', $value);
                } elseif ($default !== null) {
                    settype($value, gettype($default));
                    $this->$name = $value;
                } else {
                    $this->$name = $value;
                }
                $this->_passedOptions[] = $name;
                unset($params[$name]);
                if (isset($kebabName)) {
                    unset($params[$kebabName]);
                }
            } elseif (!is_int($name)) {
                $message = Yii::t('yii', 'Unknown option: --{name}', ['name' => $name]);
                if (!empty($options)) {
                    $message .= '. ' . Yii::t('yii', 'Options available: {options}', ['options' => '--' . implode(', --', $options)]);
                }
                throw new Exception($message);
            }
        }
    }
    if ($this->help) {
        $route = $this->getUniqueId() . '/' . $id;
        return Yii::$app->runAction('help', [$route]);
    }
    return parent::runAction($id, $params);
}

            
select() public method

Defined in: yii\console\Controller::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.

public string select ( $prompt, $options = [] )
$prompt string

The prompt message

$options array

Key-value array of options to choose from

return string

An option character the user chose

                public function select($prompt, $options = [])
{
    return Console::select($prompt, $options);
}

            
setView() public method

Defined in: yii\base\Controller::setView()

Sets the view object to be used by this controller.

public void setView ( $view )
$view yii\base\View|yii\web\View

The view object that can be used to render views or view files.

                public function setView($view)
{
    $this->_view = $view;
}

            
setViewPath() public method (available since version 2.0.7)

Defined in: yii\base\Controller::setViewPath()

Sets the directory that contains the view files.

public void setViewPath ( $path )
$path string

The root directory of view files.

throws yii\base\InvalidArgumentException

if the directory is invalid

                public function setViewPath($path)
{
    $this->_viewPath = Yii::getAlias($path);
}

            
stderr() public method

Defined in: yii\console\Controller::stderr()

Prints a string to STDERR.

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

Example:

$this->stderr('This will be red and underlined.', Console::FG_RED, Console::UNDERLINE);
public integer|boolean stderr ( $string )
$string string

The string to print

return integer|boolean

Number of bytes printed or false on error

                public function stderr($string)
{
    if ($this->isColorEnabled(\STDERR)) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return fwrite(\STDERR, $string);
}

            
stdout() public method

Defined in: yii\console\Controller::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);
public integer|boolean stdout ( $string )
$string string

The string to print

return integer|boolean

Number of bytes printed or false on error

                public function stdout($string)
{
    if ($this->isColorEnabled()) {
        $args = func_get_args();
        array_shift($args);
        $string = Console::ansiFormat($string, $args);
    }
    return Console::stdout($string);
}

            
trigger() public method

Defined in: yii\base\Component::trigger()

Triggers an event.

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

public void trigger ( $name, yii\base\Event $event null )
$name string

The event name

$event yii\base\Event|null

The event instance. If not set, a default yii\base\Event object will be created.

                public function trigger($name, Event $event = null)
{
    $this->ensureBehaviors();
    $eventHandlers = [];
    foreach ($this->_eventWildcards as $wildcard => $handlers) {
        if (StringHelper::matchWildcard($wildcard, $name)) {
            $eventHandlers[] = $handlers;
        }
    }
    if (!empty($this->_events[$name])) {
        $eventHandlers[] = $this->_events[$name];
    }
    if (!empty($eventHandlers)) {
        $eventHandlers = call_user_func_array('array_merge', $eventHandlers);
        if ($event === null) {
            $event = new Event();
        }
        if ($event->sender === null) {
            $event->sender = $this;
        }
        $event->handled = false;
        $event->name = $name;
        foreach ($eventHandlers as $handler) {
            $event->data = $handler[1];
            call_user_func($handler[0], $event);
            // stop further handling if the event is handled
            if ($event->handled) {
                return;
            }
        }
    }
    // invoke class-level attached handlers
    Event::trigger($this, $name, $event);
}

            
truncateDatabase() protected method (available since version 2.0.13)

Truncates the database.

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

protected void truncateDatabase ( )
throws yii\base\NotSupportedException

if not overridden

                protected function truncateDatabase()
{
    throw new NotSupportedException('This command is not implemented in ' . get_class($this));
}