Command

Type: Class
Namespace: craft\queue
Inherits: craft\queue\Command » yii\queue\cli\Command (opens new window) » 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)
Since: 3.0.0

Manages the queue.

# 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	string (opens new window)
help (opens new window)	boolean (opens new window) – Whether to display help information about current command.
helpSummary (opens new window)	string (opens new window)
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.
isolate (opens new window)	boolean (opens new window) – Isolate mode.
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.
phpBinary (opens new window)	string (opens new window) – Path to php interpreter that uses to run child processes.
queue	craft\queue\Queue
request (opens new window)	yii\base\Request (opens new window), array (opens new window), string (opens new window) – The 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).
verbose (opens new window)	boolean (opens new window) – Verbose mode of a job execute.
verboseConfig	array (opens new window) – Additional options to the verbose behavior.
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.

# `defaultAction`

Type: string (opens new window)
Default value: 'info'

View source (opens new window)

# `queue`

Type: craft\queue\Queue
Default value: null

View source (opens new window)

# `verboseConfig`

Type: array (opens new window)
Default value: [ 'class' => \craft\queue\VerboseBehavior::class, ]

Additional options to the verbose behavior.

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() (opens new window)	Returns the value of a component property.
__isset() (opens new window)	Checks if a property is set, i.e. defined and not null.
__set() (opens new window)	Sets the value of a component property.
__unset() (opens new window)	Sets a component property to be null.
actionListen()	Listens for new jobs added to the queue and runs them.
actionRelease()	Releases job(s) from the queue.
actionRetry()	Re-adds a failed job(s) to the queue.
actionRun()	Runs all jobs in the queue.
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.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
ensureBehaviors() (opens new window)	Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component.
findLayoutFile() (opens new window)	Finds the applicable layout file.
getActionArgsHelp() (opens new window)	Returns the help information for the anonymous arguments for the action.
getActionHelp() (opens new window)	Returns the detailed help information for the specified action.
getActionHelpSummary() (opens new window)	Returns a one-line short summary describing the specified action.
getActionOptionsHelp() (opens new window)	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() (opens new window)	Initializes the object.
isColorEnabled() (opens new window)	Returns a value indicating whether ANSI color is enabled.
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() (opens new window)	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() (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() (opens new window)	Runs a request specified in terms of a route.
runAction() (opens new window)	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.
trigger() (opens new window)	Triggers an event.

# `actionListen()`

Listens for new jobs added to the queue and runs them.

View source (opens new window)

Arguments

$timeout (integer (opens new window)) – The number of seconds to wait between cycles.

Returns

integer (opens new window)

# `actionRelease()`

Since: 3.4.0

Releases job(s) from the queue.

Example:

php craft queue/release all

View source (opens new window)

Arguments

$job (string (opens new window)) – The job ID to release. Pass all to release all jobs.

Returns

integer (opens new window)

Throws

yii\db\Exception (opens new window)

# `actionRetry()`

Since: 3.1.21

Re-adds a failed job(s) to the queue.

View source (opens new window)

Arguments

$job (integer (opens new window), string (opens new window)) – The job ID that should be retried, or all to retry all failed jobs.

Returns

integer (opens new window)

# `actionRun()`

Runs all jobs in the queue.

View source (opens new window)

Returns

integer (opens new window)

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

# `beforeAction()`

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION (opens new window) event. The return value of the method will determine whether the action should continue to run.

In case the action should not run, the request should be handled inside of the beforeAction code by either providing the necessary output or redirecting the request. Otherwise the response will be empty.

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

public function beforeAction($action)
{
    // your custom code here, if you want the code to run before action filters,
    // which are triggered on the [EVENT_BEFORE_ACTION](https://www.yiiframework.com/doc/api/2.0/yii-base-controller#EVENT_BEFORE_ACTION-detail) event, e.g. PageCache or AccessControl

    if (!parent::beforeAction($action)) {
        return false;
    }

    // other custom code here

    return true; // or false to not run the action
}

View source (opens new window)

Arguments

$action (yii\base\Action (opens new window)) – The action to be executed.

Returns

boolean (opens new window) – Whether the action should continue to run.

# Protected Methods

Method	Description
bindInjectedParams() (opens new window)	Fills parameters based on types and names in action method signature.
canIsolate() (opens new window)
canVerbose() (opens new window)
getActionMethodReflection() (opens new window)
handleMessage() (opens new window)	Handles message using child process.
isWorkerAction()
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.

# Constants

Constant	Description
`EXEC_DONE`	The exit code of the exec action which is returned when job was done.
`EXEC_RETRY`	The exit code of the exec action which is returned when job wasn't done and wanted next attempt.
`EXIT_CODE_ERROR`
`EXIT_CODE_NORMAL`

← BaseJob InfoAction →

Command

# Public Properties

# defaultAction

# queue

# verboseConfig

# Public Methods

# actionListen()

Arguments

Returns

# actionRelease()

Arguments

Returns

Throws

# actionRetry()

Arguments

Returns

# actionRun()

Returns

# actions()

Returns

# beforeAction()

Arguments

Returns

# Protected Methods

# isWorkerAction()

Arguments

Returns

# Constants

# `defaultAction`

# `queue`

# `verboseConfig`

# `actionListen()`

# `actionRelease()`

# `actionRetry()`

# `actionRun()`

# `actions()`

# `beforeAction()`

# `isWorkerAction()`