QueueLogBehavior

Type
Class
Namespace
craft\queue
Inherits
craft\queue\QueueLogBehavior » craft\queue\VerboseBehavior » yii\queue\cli\VerboseBehavior » yii\base\Behavior » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Queue Log Behavior

View source

Public Properties

PropertyDescription
$commandyii\console\Controller
$owneryii\base\Component, null – The owner of this behavior

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
afterError()
afterExec()
attach()Attaches the behavior object to the component.
beforeExec()
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.
detach()Detaches the behavior object from the component.
events()Declares event handlers for the $owner's events.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
workerStart()
workerStop()

afterError()

Signature

public void afterError ( yii\queue\ErrorEvent $event )

afterExec()

Signature

public void afterExec ( yii\queue\ExecEvent $event )

beforeExec()

Signature

public void beforeExec ( yii\queue\ExecEvent $event )

events()

Declares event handlers for the $owner's events.

Child classes may override this method to declare what PHP callbacks should be attached to the events of the $owner component.

The callbacks will be attached to the $owner's events when the behavior is attached to the owner; and they will be detached from the events when the behavior is detached from the component.

The callbacks can be any of the following:

  • method in this behavior: 'handleClick', equivalent to [$this, 'handleClick']
  • object method: [$object, 'handleClick']
  • static method: ['Page', 'handleClick']
  • anonymous function: function ($event) { ... }

The following is an example:

[
    Model::EVENT_BEFORE_VALIDATE => 'myBeforeValidate',
    Model::EVENT_AFTER_VALIDATE => 'myAfterValidate',
]

View source

Returns

array – Events (array keys) and the corresponding event handler methods (array values).

Signature

public array events ( )

Protected Methods