Abstract Class yii\queue\JobEvent
| Inheritance | yii\queue\JobEvent » yii\base\Event » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Subclasses | yii\queue\ErrorEvent, yii\queue\ExecEvent, yii\queue\PushEvent |
| Source Code | https://github.com/yiisoft/yii2-queue/blob/master/JobEvent.php |
Job Event.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $data | mixed | The data that is passed to yii\base\Component::on() when attaching an event handler. | yii\base\Event |
| $handled | boolean | Whether the event is handled. | yii\base\Event |
| $id | string|null | Unique id of a job | yii\queue\JobEvent |
| $job | yii\queue\JobInterface|null | yii\queue\JobEvent | |
| $name | string | The event name. | yii\base\Event |
| $sender | yii\queue\Queue | The sender of this event. | yii\queue\JobEvent |
| $ttr | integer | Time to reserve in seconds of the job | yii\queue\JobEvent |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\BaseObject |
| __construct() | Constructor. | yii\base\BaseObject |
| __get() | Returns the value of an object property. | yii\base\BaseObject |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
| __set() | Sets value of an object property. | yii\base\BaseObject |
| __unset() | Sets an object property to null. | yii\base\BaseObject |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\BaseObject |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\BaseObject |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| hasHandlers() | Returns a value indicating whether there is any handler attached to the specified class-level event. | yii\base\Event |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\BaseObject |
| hasProperty() | Returns a value indicating whether a property is defined. | yii\base\BaseObject |
| init() | Initializes the object. | yii\base\BaseObject |
| off() | Detaches an event handler from a class-level event. | yii\base\Event |
| offAll() | Detaches all registered class-level event handlers. | yii\base\Event |
| on() | Attaches an event handler to a class-level event. | yii\base\Event |
| trigger() | Triggers a class-level event. | yii\base\Event |
Property Details
Unique id of a job
The sender of this event. If not set, this property will be
set as the object whose trigger() method is called.
This property may also be a null when this event is a
class-level event which is triggered in a static context.
Time to reserve in seconds of the job