InfoAction ​
- Type
- Class
- Namespace
- craft\queue
- Inherits
- craft\queue\InfoAction » yii\queue\cli\Action » yii\base\Action » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Since
- 3.0.0
Info about queue status.
Public Properties ​
| Property | Description |
|---|---|
| behaviors | yii\base\Behavior – List of behaviors attached to this component. |
| controller | yii\queue\cli\Command, yii\console\Controller |
| id | string – ID of the action |
| queue | craft\queue\Queue |
| uniqueId | string – The unique ID of this action among the whole application. |
queue ​
- Type
- craft\queue\Queue
- Default value
null
Public Methods ​
| Method | Description |
|---|---|
| __call() | Calls the named method which is not a class method. |
| __clone() | This method is called after the object is created by cloning an existing one. |
| __construct() | Constructor. |
| __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() | Sets a component property to be null. |
| attachBehavior() | Attaches a behavior to this component. |
| attachBehaviors() | Attaches a list of behaviors to the component. |
| behaviors() | Returns a list of behaviors that this component should behave as. |
| canGetProperty() | Returns a value indicating whether a property can be read. |
| canSetProperty() | Returns a value indicating whether a property can be set. |
| className() | Returns the fully qualified name of this class. |
| detachBehavior() | Detaches a behavior from the component. |
| detachBehaviors() | Detaches all behaviors from the component. |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. |
| getBehavior() | Returns the named behavior object. |
| getBehaviors() | Returns all behaviors attached to this component. |
| getUniqueId() | Returns the unique ID of this action among the whole application. |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() | Returns a value indicating whether a method is defined. |
| hasProperty() | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() | Detaches an existing event handler from this component. |
| on() | Attaches an event handler to an event. |
| run() | Info about queue status. |
| runWithParams() | Runs this action with the specified parameters. |
| trigger() | Triggers an event. |
run() ​
Info about queue status.
Protected Methods ​
| Method | Description |
|---|---|
| afterRun() | This method is called right after run() is executed. |
| beforeRun() | This method is called right before run() is executed. |
| format() |