Controller

Type: Class
Namespace: craft\console
Inherits: craft\console\Controller » yii\console\Controller (opens new window) » yii\base\Controller (opens new window) » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
Implements: yii\base\Configurable (opens new window), yii\base\ViewContextInterface (opens new window)
Uses traits: craft\console\ControllerTrait
Extended by: craft\console\controllers\BackupController, craft\console\controllers\BaseSystemStatusController, craft\console\controllers\ClearCachesController, craft\console\controllers\ClearDeprecationsController, craft\console\controllers\DbController, craft\console\controllers\ElementsController, craft\console\controllers\EntrifyController, craft\console\controllers\ExecController, craft\console\controllers\GcController, craft\console\controllers\GraphqlController, craft\console\controllers\IndexAssetsController, craft\console\controllers\InstallController, craft\console\controllers\InvalidateTagsController, craft\console\controllers\MailerController, craft\console\controllers\OffController, craft\console\controllers\OnController, craft\console\controllers\PluginController, craft\console\controllers\ProjectConfigController, craft\console\controllers\ResaveController, craft\console\controllers\RestoreController, craft\console\controllers\SectionsController, craft\console\controllers\SetupController, craft\console\controllers\TestsController, craft\console\controllers\UpController, craft\console\controllers\UpdateController, craft\console\controllers\UsersController, craft\console\controllers\utils\AsciiFilenamesController, craft\console\controllers\utils\FixElementUidsController, craft\console\controllers\utils\FixFieldLayoutUidsController, craft\console\controllers\utils\PruneProvisionalDraftsController, craft\console\controllers\utils\PruneRevisionsController, craft\console\controllers\utils\RepairController, craft\console\controllers\utils\UpdateUsernamesController
Since: 3.2.0

Base console controller

# Public Properties

Property	Description
action (opens new window)	yii\base\Action (opens new window), null (opens new window) – The action that is currently being executed.
behaviors (opens new window)	yii\base\Behavior (opens new window) – List of behaviors attached to this component.
color (opens new window)	boolean (opens new window), null (opens new window) – Whether to enable ANSI color in the output.
defaultAction (opens new window)	string (opens new window) – The ID of the action that is used when the action ID is not specified in the request.
help (opens new window)	boolean (opens new window) – Whether to display help information about current command.
helpSummary (opens new window)	string (opens new window) – The one-line short summary describing this controller.
id (opens new window)	string (opens new window) – The ID of this controller.
interactive (opens new window)	boolean (opens new window) – Whether to run the command interactively.
isolated	– Whether the command should ensure it is only being run once at a time.
layout (opens new window)	string (opens new window), null (opens new window), false (opens new window) – The name of the layout to be applied to this controller's views.
module (opens new window)	yii\base\Module (opens new window) – The module that this controller belongs to.
modules (opens new window)	yii\base\Module (opens new window) – All ancestor modules that this controller is located within.
passedOptionValues (opens new window)	array (opens new window) – The properties corresponding to the passed options.
passedOptions (opens new window)	array (opens new window) – The names of the options passed during execution.
request	craft\console\Request
response (opens new window)	yii\base\Response (opens new window), array (opens new window), string (opens new window) – The response.
route (opens new window)	string (opens new window) – The route (module ID, controller ID and action ID) of the current request.
silentExitOnException (opens new window)	boolean (opens new window), null (opens new window) – If true - script finish with `ExitCode::OK` in case of exception.
uniqueId (opens new window)	string (opens new window) – The controller ID that is prefixed with the module ID (if any).
view (opens new window)	yii\base\View (opens new window), yii\web\View (opens new window) – The view object that can be used to render views or view files.
viewPath (opens new window)	string (opens new window) – The directory containing the view files for this controller.

# `request`

Type: craft\console\Request
Default value: null

View source (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__clone() (opens new window)	This method is called after the object is created by cloning an existing one.
__construct() (opens new window)
__get()	Returns the value of a component property.
__isset()	Checks if a property is set, i.e. defined and not null.
__set()	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
actions()	Declares external actions for the controller.
afterAction() (opens new window)	This method is invoked right after an action is executed.
ansiFormat() (opens new window)	Formats a string with ANSI codes.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
beforeAction()	This method is invoked right before an action is executed.
behaviors() (opens new window)	Returns a list of behaviors that this component should behave as.
bindActionParams() (opens new window)	Binds the parameters to the action.
canGetProperty() (opens new window)	Returns a value indicating whether a property can be read.
canSetProperty() (opens new window)	Returns a value indicating whether a property can be set.
className() (opens new window)	Returns the fully qualified name of this class.
confirm() (opens new window)	Asks user to confirm by typing y or n.
createAction() (opens new window)	Creates an action based on the given action ID.
createDirectory()	Creates a directory, and outputs to the console.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
do()	Performs an action with descriptive output.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
failure()	Outputs a failure message to the console.
findLayoutFile() (opens new window)	Finds the applicable layout file.
getActionArgsHelp()	Returns the help information for the anonymous arguments for the action.
getActionHelp()	Returns the detailed help information for the specified action.
getActionHelpSummary()	Returns a one-line short summary describing the specified action.
getActionOptionsHelp()	Returns the help information for the options for the action.
getBehavior() (opens new window)	Returns the named behavior object.
getBehaviors() (opens new window)	Returns all behaviors attached to this component.
getHelp() (opens new window)	Returns help information for this controller.
getHelpSummary() (opens new window)	Returns one-line short summary describing this controller.
getModules() (opens new window)	Returns all ancestor modules of this controller.
getOptionValues() (opens new window)	Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.
getPassedOptionValues() (opens new window)	Returns the properties corresponding to the passed options.
getPassedOptions() (opens new window)	Returns the names of valid options passed during execution.
getRoute() (opens new window)	Returns the route of the current request.
getUniqueId() (opens new window)	Returns the unique ID of the controller.
getView() (opens new window)	Returns the view object that can be used to render views or view files.
getViewPath() (opens new window)	Returns the directory containing view files for this controller.
hasEventHandlers() (opens new window)	Returns a value indicating whether there is any handler attached to the named event.
hasMethod() (opens new window)	Returns a value indicating whether a method is defined.
hasProperty() (opens new window)	Returns a value indicating whether a property is defined for this component.
init()	Initializes the object.
isColorEnabled() (opens new window)	Returns a value indicating whether ANSI color is enabled.
markdownToAnsi()	Converts Markdown to be better readable in console environments by applying some ANSI format.
note()	Outputs a note to the console.
off() (opens new window)	Detaches an existing event handler from this component.
on() (opens new window)	Attaches an event handler to an event.
optionAliases() (opens new window)	Returns option alias names.
options()	Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.
passwordPrompt()	Prompts the user for a password and validates it.
prompt() (opens new window)	Prompts the user for input and validates it.
render() (opens new window)	Renders a view and applies layout if available.
renderContent() (opens new window)	Renders a static string by applying a layout.
renderFile() (opens new window)	Renders a view file.
renderPartial() (opens new window)	Renders a view without applying layout.
run()	Runs a request specified in terms of a route.
runAction()	Runs an action with the specified action ID and parameters.
select() (opens new window)	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() (opens new window)	Sets the view object to be used by this controller.
setViewPath() (opens new window)	Sets the directory that contains the view files.
stderr() (opens new window)	Prints a string to STDERR.
stdout() (opens new window)	Prints a string to STDOUT.
success()	Outputs a success message to the console.
table()	Outputs a table via craft\helpers\Console::table().
tip()	Outputs a tip to the console.
trigger() (opens new window)	Triggers an event.
warning()	Outputs a warning to the console.
writeJson()	JSON-encodes a value and writes it to a file.
writeToFile()	Writes contents to a file, and outputs to the console.

# `__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;.

View source (opens new window)

Arguments

$name (string (opens new window)) – The property name

Returns

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

Throws

yii\base\UnknownPropertyException (opens new window)
if the property is not defined
yii\base\InvalidCallException (opens new window)
if the property is write-only.

# `__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).

View source (opens new window)

Arguments

$name (string (opens new window)) – The property name or the event name

Returns

boolean (opens new window) – Whether the named property is set

# `__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;.

View source (opens new window)

Arguments

$name (string (opens new window)) – The property name or the event name
$value (mixed) – The property value

Throws

yii\base\UnknownPropertyException (opens new window)
if the property is not defined
yii\base\InvalidCallException (opens new window)
if the property is read-only.

# `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.

View source (opens new window)

Returns

array (opens new window)

# `createDirectory()`

Since: 4.3.5

Creates a directory, and outputs to the console.

View source (opens new window)

Arguments

$path (string (opens new window)) – The path to the directory

# `do()`

Since: 4.3.5

Performs an action with descriptive output.

View source (opens new window)

Arguments

$description (string (opens new window)) – The action description. Supports Markdown formatting.
$action (callable (opens new window)) – The action callable
$withDuration (boolean (opens new window)) – Whether to output the action duration upon completion

# `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.

View source (opens new window)

Arguments

$action (yii\base\Action (opens new window)) – The action instance

Returns

array (opens new window) – The help information of the action arguments

# `getActionHelp()`

Returns the detailed help information for the specified action.

View source (opens new window)

Arguments

$action (yii\base\Action (opens new window)) – Action to get help for

Returns

string (opens new window) – The detailed help information for the specified action.

# `getActionHelpSummary()`

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

View source (opens new window)

Arguments

$action (yii\base\Action (opens new window)) – Action to get summary for

Returns

string (opens new window) – A one-line short summary describing the specified action.

# `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.

View source (opens new window)

Arguments

$action (yii\base\Action (opens new window))

Returns

array (opens new window) – The help information of the action options

# `init()`

Initializes the object.

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

View source (opens new window)

Throws

yii\base\InvalidConfigException (opens new window)

# `options()`

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

Child classes may override this method to specify possible options.

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

View source (opens new window)

Arguments

$actionID (string (opens new window)) – The action id of the current request

Returns

string (opens new window)[] – The names of the options valid for the action

# `passwordPrompt()`

Since: 3.6.0

Prompts the user for a password and validates it.

View source (opens new window)

Arguments

$options (array (opens new window)) – Options to customize the behavior of the prompt:
label: the prompt label
required: whether it is required or not (true by default)
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
error: the error message to show if the password is invalid
confirm: whether the user should be prompted for the password a second time to confirm their input (true by default)

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

$code = $this->passwordPrompt('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;
}]);

Returns

string (opens new window) – The user input

# `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.

View source (opens new window)

Arguments

$route (string (opens new window)) – The route to be handled, e.g., 'view', 'comment/view', '/admin/comment/view'.
$params (array (opens new window)) – The parameters to be passed to the action.

Returns

mixed – The result of the action.

# `runAction()`

Runs an action with the specified action ID and parameters.

If the action ID is empty, the method will use defaultAction (opens new window).

View source (opens new window)

Arguments

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

Returns

integer (opens new window) – The status of the action execution. 0 means normal, other values mean abnormal.

Throws

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

# `table()`

Since: 3.7.23

Outputs a table via craft\helpers\Console::table().

View source (opens new window)

Arguments

$headers (string (opens new window)[], array (opens new window)[]) – The table headers
$data (array (opens new window)[]) – The table data
$options (array (opens new window))

# `writeJson()`

Since: 4.3.5

JSON-encodes a value and writes it to a file.

View source (opens new window)

Arguments

$file (string (opens new window)) – The path to the file to write to
$value (mixed) – The value to be JSON-encoded and written out

# `writeToFile()`

Since: 4.3.5

Writes contents to a file, and outputs to the console.

View source (opens new window)

Arguments

$file (string (opens new window)) – The path to the file to write to
$contents (string (opens new window)) – The file contents
$options (array (opens new window)) – Options for craft\helpers\FileHelper::writeToFile()

# Protected Methods

Method	Description
bindInjectedParams() (opens new window)	Fills parameters based on types and names in action method signature.
checkRootUser()	Returns whether a command should be executed depending on whether it's being run as a root user, and whether they're OK with that.
checkTty()	Sets yii\console\Controller::$interactive (opens new window) to `false` if this isn’t a TTY shell.
createAttributeValidator()	Creates a function for the `validator` option of `Controller::prompt`.
defineActions()	Returns an array of custom actions that should be available on the controller.
getActionMethodReflection()
outputCommand()
parseDocCommentDetail() (opens new window)	Returns full description from the docblock.
parseDocCommentSummary() (opens new window)	Returns the first line of docblock.
parseDocCommentTags() (opens new window)	Parses the comment block into tags.

# `defineActions()`

Returns an array of custom actions that should be available on the controller.

The keys of this array should be the action IDs, and the values can be callables or sub-arrays with the following keys:

action – A callable that is responsible for running the action
options – An array of options that should be available to the command. Options can either be defined as strings (['option1', 'option2']) or key/value pairs (['option1' => 'defaultValue']).
helpSummary – Help summary text for the action (shown when running craft help controller-id)
help – Help text for the action (shown when running craft help controller-id/action-id)
argsHelp – Sub-array that defines help text for the arguments, indexed by argument names (shown when running craft help controller-id/action-id)
optionsHelp – Sub-array that defines help text for the options, indexed by option names (shown when running craft help controller-id/action-id)

View source (opens new window)

# Constants

Constant	Description
`EXIT_CODE_ERROR`
`EXIT_CODE_NORMAL`

# Events

# EVENT_DEFINE_ACTIONS

Type: craft\events\DefineConsoleActionsEvent

The event that is triggered when defining custom actions for this controller.

See defineActions() for details on what to set on $event->actions.

Example

use craft\events\DefineConsoleActionsEvent;
use craft\console\Controller;
use craft\console\controllers\ResaveController;
use yii\base\Event;

Event::on(ResaveController::class,
    Controller::EVENT_DEFINE_ACTIONS,
    function(DefineConsoleActionsEvent $event) {
        $event->actions['products'] = [
            'options' => ['type'],
            'helpSummary' => 'Re-saves products.',
            'action' => function($params): int {
                // @var ResaveController $controller
                $controller = Craft::$app->controller;
                $criteria = [];
                if ($controller->type) {
                    $criteria['type'] = explode(',', $controller->type);
                }
                return $controller->resaveElements(Product::class, $criteria);
            }
        ];
    }
);

← CallableAction ControllerTrait →

Controller

# Public Properties

# request

# Public Methods

# __get()

Arguments

Returns

Throws

# __isset()

Arguments

Returns

# __set()

Arguments

Throws

# actions()

Returns

# createDirectory()

Arguments

# do()

Arguments

# getActionArgsHelp()

Arguments

Returns

# getActionHelp()

Arguments

Returns

# getActionHelpSummary()

Arguments

Returns

# getActionOptionsHelp()

Arguments

Returns

# init()

Throws

# options()

Arguments

Returns

# passwordPrompt()

Arguments

Returns

# run()

Arguments

Returns

# runAction()

Arguments

Returns

Throws

# table()

Arguments

# writeJson()

Arguments

# writeToFile()

Arguments

# Protected Methods

# defineActions()

Returns

# getActionMethodReflection()

Arguments

Returns

# Constants

# Events

# EVENT_DEFINE_ACTIONS

Example

# `request`

# `__get()`

# `__isset()`

# `__set()`

# `actions()`

# `createDirectory()`

# `do()`

# `getActionArgsHelp()`

# `getActionHelp()`

# `getActionHelpSummary()`

# `getActionOptionsHelp()`

# `init()`

# `options()`

# `passwordPrompt()`

# `run()`

# `runAction()`

# `table()`

# `writeJson()`

# `writeToFile()`

# `defineActions()`

# `getActionMethodReflection()`