HumHub Documentation (unofficial)

BaseMigrateController extends Controller
in package

Application

AbstractYes

BaseMigrateController is the base class for migrate controllers.

Constants

BASE_MIGRATION = 'm000000_000000_base': The name of the dummy migration that marks the beginning of the whole migration history.
EVENT_AFTER_ACTION = 'afterAction'
EVENT_BEFORE_ACTION = 'beforeAction'
EXIT_CODE_ERROR = 1
EXIT_CODE_NORMAL = 0

Properties

$action : Action|null
$behaviors : array<string|int, Behavior>
$color : bool|null
$compact : bool
$defaultAction : string
$help : bool
$help : string
$helpSummary : string
$id : string
$interactive : bool
$layout : string|null|false
$migrationNamespaces : array<string|int, mixed>
$migrationPath : string|array<string|int, mixed>|null
$module : Module
$modules : array<string|int, Module>
$newFileMode : int|null
$newFileOwnership : string|int|null
$passedOptions : array<string|int, mixed>
$passedOptionValues : array<string|int, mixed>
$request : Request|array<string|int, mixed>|string
$response : Response|array<string|int, mixed>|string
$route : string
$silentExitOnException : bool|null
$templateFile : string
$uniqueId : string
$view : View|View
$viewPath : string
$_behaviors : array<string|int, Behavior>|null
$_events : array<string|int, mixed>
$_eventWildcards : array<string|int, mixed>
$_passedOptions : array<string|int, mixed>
$_reflections : mixed
$_view : View|null
$_viewPath : string|null

Methods

__call() : mixed: Calls the named method which is not a class method.
__clone() : mixed: This method is called after the object is created by cloning an existing one.
__construct() : mixed: Constructor.
__get() : mixed: Returns the value of a component property.
__isset() : bool: Checks if a property is set, i.e. defined and not null.
__set() : mixed: Sets the value of a component property.
__unset() : mixed: Sets a component property to be null.
actionCreate() : mixed: Creates a new migration.
actionDown() : int: Downgrades the application by reverting old migrations.
actionFresh() : mixed: Drops all tables and related constraints. Starts the migration from the beginning.
actionHistory() : mixed: Displays the migration history.
actionMark() : int: Modifies the migration history to the specified version.
actionNew() : mixed: Displays the un-applied new migrations.
actionRedo() : int: Redoes the last few migrations.
actions() : array<string|int, mixed>: Declares external actions for the controller.
actionTo() : mixed: Upgrades or downgrades till the specified version.
actionUp() : int: Upgrades the application by applying new migrations.
afterAction() : mixed: This method is invoked right after an action is executed.
ansiFormat() : string: Formats a string with ANSI codes.
attachBehavior() : Behavior: Attaches a behavior to this component.
attachBehaviors() : mixed: Attaches a list of behaviors to the component.
beforeAction() : bool: This method is invoked right before an action is to be executed (after all possible filters.) It checks the existence of the [[migrationPath]].
behaviors() : array<string|int, mixed>: Returns a list of behaviors that this component should behave as.
bindActionParams() : array<string|int, mixed>: Binds the parameters to the action.
canGetProperty() : bool: Returns a value indicating whether a property can be read.
canSetProperty() : bool: Returns a value indicating whether a property can be set.
className() : string: Returns the fully qualified name of this class.
confirm() : bool: Asks user to confirm by typing y or n.
createAction() : Action|null: Creates an action based on the given action ID.
detachBehavior() : Behavior|null: Detaches a behavior from the component.
detachBehaviors() : mixed: Detaches all behaviors from the component.
ensureBehaviors() : mixed: Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
findLayoutFile() : string|bool: Finds the applicable layout file.
getActionArgsHelp() : array<string|int, mixed>: Returns the help information for the anonymous arguments for the action.
getActionHelp() : string: Returns the detailed help information for the specified action.
getActionHelpSummary() : string: Returns a one-line short summary describing the specified action.
getActionOptionsHelp() : array<string|int, mixed>: Returns the help information for the options for the action.
getBehavior() : Behavior|null: Returns the named behavior object.
getBehaviors() : array<string|int, Behavior>: Returns all behaviors attached to this component.
getHelp() : string: Returns help information for this controller.
getHelpSummary() : string: Returns one-line short summary describing this controller.
getModules() : array<string|int, Module>: Returns all ancestor modules of this controller.
getOptionValues() : array<string|int, mixed>: Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.
getPassedOptions() : array<string|int, mixed>: Returns the names of valid options passed during execution.
getPassedOptionValues() : array<string|int, mixed>: Returns the properties corresponding to the passed options.
getRoute() : string: Returns the route of the current request.
getUniqueId() : string: Returns the unique ID of the controller.
getView() : View|View: Returns the view object that can be used to render views or view files.
getViewPath() : string: Returns the directory containing view files for this controller.
hasEventHandlers() : bool: Returns a value indicating whether there is any handler attached to the named event.
hasMethod() : bool: Returns a value indicating whether a method is defined.
hasProperty() : bool: Returns a value indicating whether a property is defined for this component.
init() : mixed: Initializes the object.
isColorEnabled() : bool: Returns a value indicating whether ANSI color is enabled.
off() : bool: Detaches an existing event handler from this component.
on() : mixed: Attaches an event handler to an event.
optionAliases() : array<string|int, mixed>: Returns option alias names.
options() : array<string|int, string>: Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.
prompt() : string: Prompts the user for input and validates it.
render() : string: Renders a view and applies layout if available.
renderContent() : string: Renders a static string by applying a layout.
renderFile() : string: Renders a view file.
renderPartial() : string: Renders a view without applying layout.
run() : mixed: Runs a request specified in terms of a route.
runAction() : int: Runs an action with the specified action ID and parameters.
select() : string: Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.
setView() : mixed: Sets the view object to be used by this controller.
setViewPath() : mixed: Sets the directory that contains the view files.
stderr() : int|bool: Prints a string to STDERR.
stdout() : int|bool: Prints a string to STDOUT.
trigger() : mixed: Triggers an event.
addMigrationHistory() : mixed: Adds new migration entry to the history.
bindInjectedParams() : mixed: Fills parameters based on types and names in action method signature.
createMigration() : MigrationInterface: Creates a new migration instance.
generateMigrationSourceCode() : string: Generates new migration source PHP code.
getActionMethodReflection() : ReflectionFunctionAbstract
getMigrationHistory() : array<string|int, mixed>: Returns the migration history.
getMigrationNameLimit() : int|null: Return the maximum name length for a migration.
getNewMigrations() : array<string|int, mixed>: Returns the migrations that are not applied.
includeMigrationFile() : mixed: Includes the migration file for a given migration class name.
migrateDown() : bool: Downgrades with the specified migration class.
migrateToTime() : mixed: Migrates to the specified apply time in the past.
migrateToVersion() : int: Migrates to the certain version.
migrateUp() : bool: Upgrades with the specified migration class.
parseDocCommentDetail() : string: Returns full description from the docblock.
parseDocCommentSummary() : string: Returns the first line of docblock.
parseDocCommentTags() : array<string|int, mixed>: Parses the comment block into tags.
removeMigrationHistory() : mixed: Removes existing migration from the history.
truncateDatabase() : mixed: Truncates the database.
attachBehaviorInternal() : Behavior: Attaches a behavior to this component.
extractMigrationVersion() : string|false: Checks if given migration version specification matches migration base name.
extractNamespaceMigrationVersion() : string|false: Checks if given migration version specification matches namespaced migration name.
findMigrationPath() : string: Finds the file path for the specified migration namespace.
generateClassName() : array<string|int, mixed>: Generates class base name and namespace from migration name from user input.
getNamespacePath() : string: Returns the file path matching the give namespace.

BASE_MIGRATION

The name of the dummy migration that marks the beginning of the whole migration history.


    public
        mixed
    BASE_MIGRATION
    = 'm000000_000000_base'

EVENT_AFTER_ACTION


    public
        mixed
    EVENT_AFTER_ACTION
    = 'afterAction'

EVENT_BEFORE_ACTION


    public
        mixed
    EVENT_BEFORE_ACTION
    = 'beforeAction'

EXIT_CODE_ERROR


    public
        mixed
    EXIT_CODE_ERROR
    = 1

EXIT_CODE_NORMAL


    public
        mixed
    EXIT_CODE_NORMAL
    = 0

$action


    public
        Action|null
    $action

the action that is currently being executed. This property will be set by [[run()]] when it is called by [[Application]] to run an action.

$behaviors read-only


    public
        array<string|int, Behavior>
    $behaviors

List of behaviors attached to this component.

$color


    public
        bool|null
    $color

whether to enable ANSI color in the output. If not set, ANSI color will only be enabled for terminals that support it.

$compact


    public
        bool
    $compact
     = false

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.

$defaultAction


    public
        string
    $defaultAction
     = 'up'

the default command action.

$help


    public
        bool
    $help
     = false

whether to display help information about current command.

$help read-only


    public
        string
    $help

$helpSummary read-only


    public
        string
    $helpSummary

$id


    public
        string
    $id

the ID of this controller.

$interactive


    public
        bool
    $interactive
     = true

whether to run the command interactively.

$layout


    public
        string|null|false
    $layout

the name of the layout to be applied to this controller's views. This property mainly affects the behavior of [[render()]]. Defaults to null, meaning the actual layout value should inherit that from [[module]]'s layout value. If false, no layout will be applied.

$migrationNamespaces


    public
        array<string|int, mixed>
    $migrationNamespaces
     = []

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',
]

$migrationPath


    public
        string|array<string|int, mixed>|null
    $migrationPath
     = ['@app/migrations']

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.

$module


    public
        Module
    $module

the module that this controller belongs to.

$modules read-only


    public
        array<string|int, Module>
    $modules

All ancestor modules that this controller is located within.

$newFileMode


    public
        int|null
    $newFileMode

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.

$newFileOwnership


    public
        string|int|null
    $newFileOwnership

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.

$passedOptions read-only


    public
        array<string|int, mixed>
    $passedOptions

The names of the options passed during execution.

$passedOptionValues read-only


    public
        array<string|int, mixed>
    $passedOptionValues

The properties corresponding to the passed options.

$request


    public
        Request|array<string|int, mixed>|string
    $request
     = 'request'

The request.

$response


    public
        Response|array<string|int, mixed>|string
    $response
     = 'response'

The response.

$route read-only


    public
        string
    $route

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

$silentExitOnException


    public
        bool|null
    $silentExitOnException

if true - script finish with ExitCode::OK in case of exception. false - ExitCode::UNSPECIFIED_ERROR. Default: YII_ENV_TEST

$templateFile


    public
        string
    $templateFile

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

$uniqueId read-only


    public
        string
    $uniqueId

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

$view


    public
        View|View
    $view

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

$viewPath


    public
        string
    $viewPath

The directory containing the view files for this controller.

$_behaviors


    private
        array<string|int, Behavior>|null
    $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events


    private
        array<string|int, mixed>
    $_events
     = []

the attached event handlers (event name => handlers)

$_eventWildcards


    private
        array<string|int, mixed>
    $_eventWildcards
     = []

the event handlers attached for wildcard patterns (event name wildcard => handlers)

$_passedOptions


    private
        array<string|int, mixed>
    $_passedOptions
     = []

the options passed during execution.

$_reflections


    private
        mixed
    $_reflections
     = []

$_view


    private
        View|null
    $_view

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

$_viewPath


    private
        string|null
    $_viewPath

the root directory that contains view files for this controller.

__call()

Calls the named method which is not a class method.


    public
                    __call(string $name, array<string|int, mixed> $params) : mixed

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.

Parameters

$name : string: the method name
$params : array<string|int, mixed>: method parameters

Return values

mixed —

the method return value

__clone()

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


    public
                    __clone() : mixed

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

__construct()

Constructor.


    public
                    __construct(string $id, Module $module[, array<string|int, mixed> $config = [] ]) : mixed

Parameters

$id : string: the ID of this controller.
$module : Module: the module that this controller belongs to.
$config : array<string|int, mixed> = []: name-value pairs that will be used to initialize the object properties.

__get()

Returns the value of a component property.


    public
                    __get(string $name) : mixed

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

Parameters

$name : string: the property name

Return values

mixed —

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

__isset()

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


    public
                    __isset(string $name) : bool

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

Parameters

$name : string: the property name or the event name

Return values

bool —

whether the named property is set

__set()

Sets the value of a component property.


    public
                    __set(string $name, mixed $value) : mixed

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

Parameters

$name : string: the property name or the event name
$value : mixed: the property value

__unset()

Sets a component property to be null.


    public
                    __unset(string $name) : mixed

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

Parameters

$name : string: the property name

actionCreate()

Creates a new migration.


    public
                    actionCreate(string $name) : mixed

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.

Parameters

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

actionDown()

Downgrades the application by reverting old migrations.


    public
                    actionDown([int|string $limit = 1 ]) : int

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

Parameters

$limit : int|string = 1: 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 values

int —

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

actionFresh()

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


    public
                    actionFresh() : mixed

yii migrate/fresh

actionHistory()

Displays the migration history.


    public
                    actionHistory([int|string $limit = 10 ]) : mixed

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

Parameters

$limit : int|string = 10: the maximum number of migrations to be displayed. If it is "all", the whole migration history will be displayed.

actionMark()

Modifies the migration history to the specified version.


    public
                    actionMark(string $version) : int

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

Parameters

$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 values

int —

CLI exit code

actionNew()

Displays the un-applied new migrations.


    public
                    actionNew([int|string $limit = 10 ]) : mixed

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

Parameters

$limit : int|string = 10: the maximum number of new migrations to be displayed. If it is all, all available new migrations will be displayed.

actionRedo()

Redoes the last few migrations.


    public
                    actionRedo([int|string $limit = 1 ]) : int

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

Parameters

$limit : int|string = 1: 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 values

int —

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

actions()

Declares external actions for the controller.


    public
                    actions() : array<string|int, mixed>

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.

Return values

array<string|int, mixed>

actionTo()

Upgrades or downgrades till the specified version.


    public
                    actionTo(string $version) : mixed

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

Parameters

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

actionUp()

Upgrades the application by applying new migrations.


    public
                    actionUp([int $limit = 0 ]) : int

For example,

yii migrate     # apply all new migrations
yii migrate 3   # apply the first 3 new migrations

Parameters

$limit : int = 0: the number of new migrations to be applied. If 0, it means applying all available new migrations.

Return values

int —

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

afterAction()

This method is invoked right after an action is executed.


    public
                    afterAction(Action $action, mixed $result) : mixed

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;
}

Parameters

$action : Action: the action just executed.
$result : mixed: the action return result.

Return values

mixed —

the processed action result.

ansiFormat()

Formats a string with ANSI codes.


    public
                    ansiFormat(string $string) : string

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);

Parameters

$string : string: the string to be formatted

Return values

string

attachBehavior()

Attaches a behavior to this component.


    public
                    attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

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 [[Behavior::attach()]] method.

Parameters

$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

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

a [[Behavior]] object
a string specifying the behavior class
an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.

Return values

Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.


    public
                    attachBehaviors(array<string|int, mixed> $behaviors) : mixed

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

Parameters

$behaviors : array<string|int, mixed>: list of behaviors to be attached to the component

beforeAction()

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


    public
                    beforeAction(Action $action) : bool

Parameters

$action : Action: the action to be executed.

Return values

bool —

whether the action should continue to be executed.

behaviors()

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


    public
                    behaviors() : array<string|int, mixed>

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 [[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).

Return values

array<string|int, mixed> —

the behavior configurations.

bindActionParams()

Binds the parameters to the action.


    public
                    bindActionParams(Action $action, array<string|int, mixed> $params) : array<string|int, mixed>

This method is invoked by [[Action]] when it begins to run with the given parameters. This method will first bind the parameters with the [[options()|options]] available to the action. It then validates the given arguments.

Parameters

$action : Action: the action to be bound with parameters
$params : array<string|int, mixed>: the parameters to be bound to the action

Return values

array<string|int, mixed> —

the valid parameters that the action can run with.

canGetProperty()

Returns a value indicating whether a property can be read.


    public
                    canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.


    public
                    canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property can be written

className()

Returns the fully qualified name of this class.


    public
            static        className() : string

Return values

string —

the fully qualified name of this class.

confirm()

Asks user to confirm by typing y or n.


    public
                    confirm(string $message[, bool $default = false ]) : bool

A typical usage looks like the following:

if ($this->confirm("Are you sure?")) {
    echo "user typed yes\n";
} else {
    echo "user typed no\n";
}

Parameters

$message : string: to echo out before waiting for user input
$default : bool = false: this value is returned if no selection is made.

Return values

bool —

whether user confirmed. Will return true if [[interactive]] is false.

createAction()

Creates an action based on the given action ID.


    public
                    createAction(string $id) : Action|null

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 [[InlineAction]] representing that method will be created and returned.

Parameters

$id : string: the action ID.

Return values

Action|null —

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

detachBehavior()

Detaches a behavior from the component.


    public
                    detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters

$name : string: the behavior's name.

Return values

Behavior|null —

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

detachBehaviors()

Detaches all behaviors from the component.


    public
                    detachBehaviors() : mixed

ensureBehaviors()

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


    public
                    ensureBehaviors() : mixed

findLayoutFile()

Finds the applicable layout file.


    public
                    findLayoutFile(View $view) : string|bool

Parameters

$view : View: the view object to render the layout file.

Return values

string|bool —

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

getActionArgsHelp()

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


    public
                    getActionArgsHelp(Action $action) : array<string|int, mixed>

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.

Parameters

$action : Action: the action instance

Return values

array<string|int, mixed> —

the help information of the action arguments

getActionHelp()

Returns the detailed help information for the specified action.


    public
                    getActionHelp(Action $action) : string

Parameters

$action : Action: action to get help for

Return values

string —

the detailed help information for the specified action.

getActionHelpSummary()

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


    public
                    getActionHelpSummary(Action $action) : string

Parameters

$action : Action: action to get summary for

Return values

string —

a one-line short summary describing the specified action.

getActionOptionsHelp()

Returns the help information for the options for the action.


    public
                    getActionOptionsHelp(Action $action) : array<string|int, mixed>

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.

Parameters

$action : Action

Return values

array<string|int, mixed> —

the help information of the action options

getBehavior()

Returns the named behavior object.


    public
                    getBehavior(string $name) : Behavior|null

Parameters

$name : string: the behavior name

Return values

Behavior|null —

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

getBehaviors()

Returns all behaviors attached to this component.


    public
                    getBehaviors() : array<string|int, Behavior>

Return values

array<string|int, Behavior> —

list of behaviors attached to this component

getHelp()

Returns help information for this controller.


    public
                    getHelp() : string

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

Return values

string

getHelpSummary()

Returns one-line short summary describing this controller.


    public
                    getHelpSummary() : string

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

Return values

string

getModules()

Returns all ancestor modules of this controller.


    public
                    getModules() : array<string|int, Module>

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

Return values

array<string|int, Module> —

all ancestor modules that this controller is located within.

getOptionValues()

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


    public
                    getOptionValues(string $actionID) : array<string|int, mixed>

Parameters

$actionID : string: the action id of the current request

Return values

array<string|int, mixed> —

properties corresponding to the options for the action

getPassedOptions()

Returns the names of valid options passed during execution.


    public
                    getPassedOptions() : array<string|int, mixed>

Return values

array<string|int, mixed> —

the names of the options passed during execution

getPassedOptionValues()

Returns the properties corresponding to the passed options.


    public
                    getPassedOptionValues() : array<string|int, mixed>

Return values

array<string|int, mixed> —

the properties corresponding to the passed options

getRoute()

Returns the route of the current request.


    public
                    getRoute() : string

Return values

string —

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

getUniqueId()

Returns the unique ID of the controller.


    public
                    getUniqueId() : string

Return values

string —

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

getView()

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


    public
                    getView() : View|View

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.

Return values

View|View —

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

getViewPath()

Returns the directory containing view files for this controller.


    public
                    getViewPath() : string

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

Return values

string —

the directory containing the view files for this controller.

hasEventHandlers()

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


    public
                    hasEventHandlers(string $name) : bool

Parameters

$name : string: the event name

Return values

bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.


    public
                    hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkBehaviors : bool = true: whether to treat behaviors' methods as methods of this component

Return values

bool —

whether the method is defined

hasProperty()

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


    public
                    hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

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

Parameters

$name : string: the property name
$checkVars : bool = true: whether to treat member variables as properties
$checkBehaviors : bool = true: whether to treat behaviors' properties as properties of this component

Return values

bool —

whether the property is defined

init()

Initializes the object.


    public
                    init() : mixed

isColorEnabled()

Returns a value indicating whether ANSI color is enabled.


    public
                    isColorEnabled([resource $stream = STDOUT ]) : bool

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

Parameters

$stream : resource = STDOUT: the stream to check.

Return values

bool —

Whether to enable ANSI style in output.

off()

Detaches an existing event handler from this component.


    public
                    off(string $name[, callable|null $handler = null ]) : bool

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.

Parameters

$name : string: event name
$handler : callable|null = null: the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Return values

bool —

if a handler is found and detached

on()

Attaches an event handler to an event.


    public
                    on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

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 [[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.');
});

Parameters

$name : string: the event name
$handler : callable: the event handler
$data : mixed = null: 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 [[Event::data]].
$append : bool = true: 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.

optionAliases()

Returns option alias names.


    public
                    optionAliases() : array<string|int, mixed>

Child classes may override this method to specify alias options.

Return values

array<string|int, mixed> —

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

options()

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


    public
                    options(mixed $actionID) : array<string|int, string>

Parameters

$actionID : mixed: the action id of the current request

Return values

array<string|int, string> —

the names of the options valid for the action

prompt()

Prompts the user for input and validates it.


    public
                    prompt(string $text[, array<string|int, mixed> $options = [] ]) : string

Parameters

$text : string

prompt string

$options : array<string|int, mixed> = []

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 values

string —

the user input

render()

Renders a view and applies layout if available.


    public
                    render(string $view[, array<string|int, mixed> $params = [] ]) : string

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 [[Application::viewPath|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 [[Module::viewPath|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:

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 [[Module::layout|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.

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 [[Application::layoutPath|layout path]] of the application;
a relative path (e.g. "main"): the actual layout file will be looked for under the [[Module::layoutPath|layout path]] of the context module.

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

Parameters

$view : string: the view name.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view. These parameters will not be available in the layout.

Return values

string —

the rendering result.

renderContent()

Renders a static string by applying a layout.


    public
                    renderContent(string $content) : string

Parameters

$content : string: the static string being rendered

Return values

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.

renderFile()

Renders a view file.


    public
                    renderFile(string $file[, array<string|int, mixed> $params = [] ]) : string

Parameters

$file : string: the view file to be rendered. This can be either a file path or a path alias.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

renderPartial()

Renders a view without applying layout.


    public
                    renderPartial(string $view[, array<string|int, mixed> $params = [] ]) : string

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

Parameters

$view : string: the view name. Please refer to [[render()]] on how to specify a view name.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) that should be made available in the view.

Return values

string —

the rendering result.

run()

Runs a request specified in terms of a route.


    public
                    run(string $route[, array<string|int, mixed> $params = [] ]) : mixed

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.

Parameters

$route : string: the route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.
$params : array<string|int, mixed> = []: the parameters to be passed to the action.

Return values

mixed —

the result of the action.

runAction()

Runs an action with the specified action ID and parameters.


    public
                    runAction(string $id[, array<string|int, mixed> $params = [] ]) : int

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

Parameters

$id : string: the ID of the action to be executed.
$params : array<string|int, mixed> = []: the parameters (name-value pairs) to be passed to the action.

Return values

int —

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

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
                    select(string $prompt[, array<string|int, mixed> $options = [] ][, string|null $default = null ]) : string

Parameters

$prompt : string: the prompt message
$options : array<string|int, mixed> = []: Key-value array of options to choose from
$default : string|null = null: value to use when the user doesn't provide an option. If the default is null, the user is required to select an option.

Return values

string —

An option character the user chose

setView()

Sets the view object to be used by this controller.


    public
                    setView(View|View $view) : mixed

Parameters

$view : View|View: the view object that can be used to render views or view files.

setViewPath()

Sets the directory that contains the view files.


    public
                    setViewPath(string $path) : mixed

Parameters

$path : string: the root directory of view files.

stderr()

Prints a string to STDERR.


    public
                    stderr(string $string, int ...$args) : int|bool

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);

Parameters

$string : string: the string to print
$args : int: additional parameters to decorate the output

Return values

int|bool —

Number of bytes printed or false on error

stdout()

Prints a string to STDOUT.


    public
                    stdout(string $string, int ...$args) : int|bool

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);

Parameters

$string : string: the string to print
$args : int: additional parameters to decorate the output

Return values

int|bool —

Number of bytes printed or false on error

trigger()

Triggers an event.


    public
                    trigger(string $name[, Event|null $event = null ]) : mixed

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

Parameters

$name : string: the event name
$event : Event|null = null: the event instance. If not set, a default [[Event]] object will be created.

addMigrationHistory()

Adds new migration entry to the history.


    protected
    abstract                addMigrationHistory(string $version) : mixed

Parameters

$version : string: migration version name.

bindInjectedParams()

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


    protected
        final            bindInjectedParams(ReflectionType $type, string $name, array<string|int, mixed> &$args, array<string|int, mixed> &$requestedParams) : mixed

Parameters

$type : ReflectionType: The reflected type of the action parameter.
$name : string: The name of the parameter.
$args : array<string|int, mixed>: The array of arguments for the action, this function may append items to it.
$requestedParams : array<string|int, mixed>: The array with requested params, this function may write specific keys to it.

createMigration()

Creates a new migration instance.


    protected
                    createMigration(string $class) : MigrationInterface

Parameters

$class : string: the migration class name

Return values

MigrationInterface —

the migration instance

generateMigrationSourceCode()

Generates new migration source PHP code.


    protected
                    generateMigrationSourceCode(array<string|int, mixed> $params) : string

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

Parameters

$params : array<string|int, mixed>

generation parameters, usually following parameters are present:

name: string migration base name
className: string migration class name

Return values

string —

generated PHP code.

getActionMethodReflection()


    protected
                    getActionMethodReflection(Action $action) : ReflectionFunctionAbstract

Parameters

$action : Action

Return values

ReflectionFunctionAbstract

getMigrationHistory()

Returns the migration history.


    protected
    abstract                getMigrationHistory(int|null $limit) : array<string|int, mixed>

Parameters

$limit : int|null: the maximum number of records in the history to be returned. null for "no limit".

Return values

array<string|int, mixed> —

the migration history

getMigrationNameLimit()

Return the maximum name length for a migration.


    protected
                    getMigrationNameLimit() : int|null

Subclasses may override this method to define a limit.

Return values

int|null —

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

getNewMigrations()

Returns the migrations that are not applied.


    protected
                    getNewMigrations() : array<string|int, mixed>

Return values

array<string|int, mixed> —

list of new migrations

includeMigrationFile()

Includes the migration file for a given migration class name.


    protected
                    includeMigrationFile(string $class) : mixed

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.

Parameters

$class : string: the migration class name.

migrateDown()

Downgrades with the specified migration class.


    protected
                    migrateDown(string $class) : bool

Parameters

$class : string: the migration class name

Return values

bool —

whether the migration is successful

migrateToTime()

Migrates to the specified apply time in the past.


    protected
                    migrateToTime(int $time) : mixed

Parameters

$time : int: UNIX timestamp value.

migrateToVersion()

Migrates to the certain version.


    protected
                    migrateToVersion(string $version) : int

Parameters

$version : string: name in the full format.

Return values

int —

CLI exit code

migrateUp()

Upgrades with the specified migration class.


    protected
                    migrateUp(string $class) : bool

Parameters

$class : string: the migration class name

Return values

bool —

whether the migration is successful

parseDocCommentDetail()

Returns full description from the docblock.


    protected
                    parseDocCommentDetail(ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract $reflection) : string

Parameters

$reflection : ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

Return values

string

parseDocCommentSummary()

Returns the first line of docblock.


    protected
                    parseDocCommentSummary(ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract $reflection) : string

Parameters

$reflection : ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract

Return values

string

parseDocCommentTags()

Parses the comment block into tags.


    protected
                    parseDocCommentTags(ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract $reflection) : array<string|int, mixed>

Parameters

$reflection : ReflectionClass|ReflectionProperty|ReflectionFunctionAbstract: the comment block

Return values

array<string|int, mixed> —

the parsed tags

removeMigrationHistory()

Removes existing migration from the history.


    protected
    abstract                removeMigrationHistory(string $version) : mixed

Parameters

$version : string: migration version name.

truncateDatabase()

Truncates the database.


    protected
                    truncateDatabase() : mixed

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

attachBehaviorInternal()

Attaches a behavior to this component.


    private
                    attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

Parameters

$name : string|int: the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.
$behavior : string|array<string|int, mixed>|Behavior: the behavior to be attached

Return values

Behavior —

the attached behavior.

extractMigrationVersion()

Checks if given migration version specification matches migration base name.


    private
                    extractMigrationVersion(string $rawVersion) : string|false

Parameters

$rawVersion : string: raw version specification received from user input.

Return values

string|false —

actual migration version, false - if not match.

extractNamespaceMigrationVersion()

Checks if given migration version specification matches namespaced migration name.


    private
                    extractNamespaceMigrationVersion(string $rawVersion) : string|false

Parameters

$rawVersion : string: raw version specification received from user input.

Return values

string|false —

actual migration version, false - if not match.

findMigrationPath()

Finds the file path for the specified migration namespace.


    private
                    findMigrationPath(string|null $namespace) : string

Parameters

$namespace : string|null: migration namespace.

Return values

string —

migration file path.

generateClassName()

Generates class base name and namespace from migration name from user input.


    private
                    generateClassName(string $name) : array<string|int, mixed>

Parameters

$name : string: migration name from user input.

Return values

array<string|int, mixed> —

list of 2 elements: 'namespace' and 'class base name'

getNamespacePath()

Returns the file path matching the give namespace.


    private
                    getNamespacePath(string $namespace) : string

Parameters

$namespace : string: namespace.

Return values

string —

file path.

BaseMigrateController extends Controller in package Application

Tags

Table of Contents

Constants

Properties

Methods

Constants

BASE_MIGRATION

EVENT_AFTER_ACTION

Tags

EVENT_BEFORE_ACTION

Tags

EXIT_CODE_ERROR

Tags

EXIT_CODE_NORMAL

Tags

Properties

$action

$behaviors read-only

$color

$compact

Tags

$defaultAction

$help

Tags

$help read-only

$helpSummary read-only

$id

$interactive

$layout

$migrationNamespaces

Tags

$migrationPath

Tags

$module

$modules read-only

$newFileMode

Tags

$newFileOwnership

Tags

$passedOptions read-only

$passedOptionValues read-only

$request

Tags

$response

Tags

$route read-only

$silentExitOnException

Tags

$templateFile

$uniqueId read-only

$view

$viewPath

$_behaviors

$_events

$_eventWildcards

Tags

$_passedOptions

$_reflections

$_view

$_viewPath

Methods

__call()

Parameters

Tags

Return values

__clone()

__construct()

Parameters

__get()

Parameters

Tags

Return values

BaseMigrateController extends Controller
in package

Application