yii\queue\cli\WorkerEvent - Yii2 类参考手册
Class yii\queue\cli\WorkerEvent
Inheritance | yii\queue\cli\WorkerEvent » yii\base\Event » yii\base\BaseObject |
---|---|
Implements | yii\base\Configurable |
Available since version | 2.0.2 |
Class WorkerEvent
Public Properties
隐藏继承的属性 Hide inherited 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 |
$exitCode | null|integer | Exit code | yii\queue\cli\WorkerEvent |
$handled | boolean | Whether the event is handled. | yii\base\Event |
$loop | yii\queue\cli\LoopInterface | yii\queue\cli\WorkerEvent | |
$name | string | The event name. | yii\base\Event |
$sender | yii\queue\cli\Queue | The sender of this event. | yii\queue\cli\WorkerEvent |
Public Methods
隐藏继承的方法 Hide inherited 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
Exit code
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.