Abstract Class yii\queue\cli\Command

All Classes | Properties | Methods | Events | Constants

Inheritance	yii\queue\cli\Command » yii\console\Controller » yii\base\Controller » yii\base\Component » yii\base\BaseObject
Implements	yii\base\Configurable, yii\base\ViewContextInterface
Subclasses	yii\queue\amqp\Command, yii\queue\amqp_interop\Command, yii\queue\beanstalk\Command, yii\queue\db\Command, yii\queue\file\Command, yii\queue\gearman\Command, yii\queue\redis\Command, yii\queue\sqs\Command, yii\queue\stomp\Command
Source Code	https://github.com/yiisoft/yii2-queue/blob/master/cli/Command.php

Base Command.

Public Properties

Hide inherited properties

Property	Type	Description	Defined By
$action	yii\base\Action\|null	The action that is currently being executed.	yii\base\Controller
$behaviors	yii\base\Behavior[]	List of behaviors attached to this component.	yii\base\Component
$color	boolean\|null	Whether to enable ANSI color in the output.	yii\console\Controller
$defaultAction	string	The ID of the action that is used when the action ID is not specified in the request.	yii\base\Controller
$help	boolean	Whether to display help information about current command.	yii\console\Controller
$helpSummary	string	The one-line short summary describing this controller.	yii\console\Controller
$id	string	The ID of this controller.	yii\base\Controller
$interactive	boolean	Whether to run the command interactively.	yii\console\Controller
$isolate	boolean	Isolate mode.	yii\queue\cli\Command
$layout	string\|null\|false	The name of the layout to be applied to this controller's views.	yii\base\Controller
$module	yii\base\Module	The module that this controller belongs to.	yii\base\Controller
$modules	yii\base\Module[]	All ancestor modules that this controller is located within.	yii\base\Controller
$passedOptionValues	array	The properties corresponding to the passed options.	yii\console\Controller
$passedOptions	array	The names of the options passed during execution.	yii\console\Controller
$phpBinary	string	Path to php interpreter that uses to run child processes.	yii\queue\cli\Command
$queue	yii\queue\cli\Queue		yii\queue\cli\Command
$request	yii\console\Request		yii\console\Controller
$response	yii\console\Response		yii\console\Controller
$route	string	The route (module ID, controller ID and action ID) of the current request.	yii\base\Controller
$silentExitOnException	boolean\|null	If true - script finish with `ExitCode::OK` in case of exception.	yii\console\Controller
$uniqueId	string	The controller ID that is prefixed with the module ID (if any).	yii\base\Controller
$verbose	boolean	Verbose mode of a job execute.	yii\queue\cli\Command
$verboseConfig	array	Additional options to the verbose behavior.	yii\queue\cli\Command
$view	yii\base\View\|yii\web\View	The view object that can be used to render views or view files.	yii\base\Controller
$viewPath	string	The directory containing the view files for this controller.	yii\base\Controller

Public Methods

Hide inherited methods

Method	Description	Defined By
__call()	Calls the named method which is not a class method.	yii\base\Component
__clone()	This method is called after the object is created by cloning an existing one.	yii\base\Component
__construct()		yii\base\Controller
__get()	Returns the value of a component property.	yii\base\Component
__isset()	Checks if a property is set, i.e. defined and not null.	yii\base\Component
__set()	Sets the value of a component property.	yii\base\Component
__unset()	Sets a component property to be null.	yii\base\Component
actionExec()	Executes a job.	yii\queue\cli\Command
actions()	Declares external actions for the controller.	yii\base\Controller
afterAction()	This method is invoked right after an action is executed.	yii\base\Controller
ansiFormat()	Formats a string with ANSI codes.	yii\console\Controller
attachBehavior()	Attaches a behavior to this component.	yii\base\Component
attachBehaviors()	Attaches a list of behaviors to the component.	yii\base\Component
beforeAction()	This method is invoked right before an action is executed.	yii\queue\cli\Command
behaviors()	Returns a list of behaviors that this component should behave as.	yii\base\Component
bindActionParams()	Binds the parameters to the action.	yii\console\Controller
canGetProperty()	Returns a value indicating whether a property can be read.	yii\base\Component
canSetProperty()	Returns a value indicating whether a property can be set.	yii\base\Component
className()	Returns the fully qualified name of this class.	yii\base\BaseObject
confirm()	Asks user to confirm by typing y or n.	yii\console\Controller
createAction()	Creates an action based on the given action ID.	yii\base\Controller
detachBehavior()	Detaches a behavior from the component.	yii\base\Component
detachBehaviors()	Detaches all behaviors from the component.	yii\base\Component
ensureBehaviors()	Makes sure that the behaviors declared in behaviors() are attached to this component.	yii\base\Component
findLayoutFile()	Finds the applicable layout file.	yii\base\Controller
getActionArgsHelp()	Returns the help information for the anonymous arguments for the action.	yii\console\Controller
getActionHelp()	Returns the detailed help information for the specified action.	yii\console\Controller
getActionHelpSummary()	Returns a one-line short summary describing the specified action.	yii\console\Controller
getActionOptionsHelp()	Returns the help information for the options for the action.	yii\console\Controller
getBehavior()	Returns the named behavior object.	yii\base\Component
getBehaviors()	Returns all behaviors attached to this component.	yii\base\Component
getHelp()	Returns help information for this controller.	yii\console\Controller
getHelpSummary()	Returns one-line short summary describing this controller.	yii\console\Controller
getModules()	Returns all ancestor modules of this controller.	yii\base\Controller
getOptionValues()	Returns properties corresponding to the options for the action id Child classes may override this method to specify possible properties.	yii\console\Controller
getPassedOptionValues()	Returns the properties corresponding to the passed options.	yii\console\Controller
getPassedOptions()	Returns the names of valid options passed during execution.	yii\console\Controller
getRoute()	Returns the route of the current request.	yii\base\Controller
getUniqueId()	Returns the unique ID of the controller.	yii\base\Controller
getView()	Returns the view object that can be used to render views or view files.	yii\base\Controller
getViewPath()		yii\base\ViewContextInterface
hasEventHandlers()	Returns a value indicating whether there is any handler attached to the named event.	yii\base\Component
hasMethod()	Returns a value indicating whether a method is defined.	yii\base\Component
hasProperty()	Returns a value indicating whether a property is defined for this component.	yii\base\Component
init()	Initializes the object.	yii\base\Controller
isColorEnabled()	Returns a value indicating whether ANSI color is enabled.	yii\console\Controller
off()	Detaches an existing event handler from this component.	yii\base\Component
on()	Attaches an event handler to an event.	yii\base\Component
optionAliases()	Returns option alias names.	yii\queue\cli\Command
options()	Returns the names of valid options for the action (id) An option requires the existence of a public member variable whose name is the option name.	yii\queue\cli\Command
prompt()	Prompts the user for input and validates it.	yii\console\Controller
render()	Renders a view and applies layout if available.	yii\base\Controller
renderContent()	Renders a static string by applying a layout.	yii\base\Controller
renderFile()	Renders a view file.	yii\base\Controller
renderPartial()	Renders a view without applying layout.	yii\base\Controller
run()	Runs a request specified in terms of a route.	yii\base\Controller
runAction()	Runs an action with the specified action ID and parameters.	yii\console\Controller
select()	Gives the user an option to choose from. Giving '?' as an input will show a list of options to choose from and their explanations.	yii\console\Controller
setView()	Sets the view object to be used by this controller.	yii\base\Controller
setViewPath()	Sets the directory that contains the view files.	yii\base\Controller
stderr()	Prints a string to STDERR.	yii\console\Controller
stdout()	Prints a string to STDOUT.	yii\console\Controller
trigger()	Triggers an event.	yii\base\Component

Protected Methods

Hide inherited methods

Method	Description	Defined By
bindInjectedParams()	Fills parameters based on types and names in action method signature.	yii\base\Controller
canIsolate()		yii\queue\cli\Command
canVerbose()		yii\queue\cli\Command
getActionMethodReflection()		yii\console\Controller
handleMessage()	Handles message using child process.	yii\queue\cli\Command
isWorkerAction()		yii\queue\cli\Command
parseDocCommentDetail()	Returns full description from the docblock.	yii\console\Controller
parseDocCommentSummary()	Returns the first line of docblock.	yii\console\Controller
parseDocCommentTags()	Parses the comment block into tags.	yii\console\Controller

Events

Hide inherited events

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

Constants

Hide inherited constants

Constant	Value	Description	Defined By
EXEC_DONE	0	The exit code of the exec action which is returned when job was done.	yii\queue\cli\Command
EXEC_RETRY	3	The exit code of the exec action which is returned when job wasn't done and wanted next attempt.	yii\queue\cli\Command
EXIT_CODE_ERROR	1	Deprecated since 2.0.13. Use yii\console\ExitCode::UNSPECIFIED_ERROR instead.	yii\console\Controller
EXIT_CODE_NORMAL	0	Deprecated since 2.0.13. Use yii\console\ExitCode::OK instead.	yii\console\Controller

Property Details

$isolate public property

Isolate mode. It executes a job in a child process.

public boolean $isolate = true

$phpBinary public property (available since version 2.0.3)

Path to php interpreter that uses to run child processes. If it is undefined, PHP_BINARY will be used.

public string $phpBinary = null

$queue public property

public yii\queue\cli\Queue $queue = null

$verbose public property

Verbose mode of a job execute. If enabled, execute result of each job will be printed.

public boolean $verbose = false

$verboseConfig public property (available since version 2.0.2)

Additional options to the verbose behavior.

public array $verboseConfig = [
'class' => \yii\queue\cli\VerboseBehavior::class]

Method Details

actionExec() public method

Executes a job.

The command is internal, and used to isolate a job execution. Manual usage is not provided.

public integer actionExec ( $id, $ttr, $attempt, $pid )
$id	string\|null	Of a message
$ttr	integer	Time to reserve
$attempt	integer	Number
$pid	integer	Of a worker
return	integer	Exit code

beforeAction() public method

This method is invoked right before an action is executed.

The method will trigger the EVENT_BEFORE_ACTION 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]] 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
}

public boolean beforeAction ( $action )
$action	yii\base\Action	The action to be executed.
return	boolean	Whether the action should continue to run.

canIsolate() protected method

protected boolean canIsolate ( $actionID )
$actionID	string

canVerbose() protected method

protected boolean canVerbose ( $actionID )
$actionID	string

handleMessage() protected method

Handles message using child process.

public string[] options ( $actionID )
$actionID	string	The action id of the current request
return	string[]	The names of the options valid for the action

protected boolean handleMessage ( $id, $message, $ttr, $attempt )
$id	string\|null	Of a message
$message	string
$ttr	integer	Time to reserve
$attempt	integer	Number
throws

protected abstract boolean isWorkerAction ( $actionID )
$actionID	string

public array optionAliases ( )
return	array	The options alias names valid for the action where the keys is alias name for option and value is option name.