Class for managing Zend Platform JobQueue jobs via Zend_Queue
category | Zend |
---|---|
package | Zend_Queue |
subpackage | Message |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
inherited_from | \Zend_Queue_Message |
__construct(array $options = array()
) : void
The constructor should be an array of options.
If the option 'data' is provided, and is an instance of ZendApi_Job, that object will be used as the internal job; if that option is not a ZendApi_Job instance, an exception will be thrown.
Alternately, you may specify the 'script' parameter, which should be a JobQueue script the job will request. A new ZendApi_Job object will then be created using that script and any options you provide.
inherited_from | \Zend_Queue_Message::__construct() |
---|
array
\Zend_Queue_Exception |
---|
__construct(array $options = array()
)
array
\Zend_Queue_Exception |
---|
__get(string $key) : string
string
The user-specified key name.
\Zend_Queue_Exception |
if the $key is not a column in the message. |
---|
string
The corresponding key value.__isset(string $key) : boolean
string
The column key.
boolean
__set(string $key, mixed $value) : void
string
The message key.
mixed
The value for the property.
\Zend_Queue_Exception |
---|
__sleep() : array
inherited_from | \Zend_Queue_Message::__sleep() |
---|
array
__sleep() : array
array
__wakeup() : void
A de-serialized Message should not be assumed to have access to a live queue connection, so set _connected = false.
getJob() : \ZendApi_Job
\ZendApi_Job
getJobId() : string
string
getQueue() : \Zend_Queue | null
\Zend_Queue
null
getQueueClass() : string
inherited_from | \Zend_Queue_Message::getQueueClass() |
---|
string
getQueueClass() : string
string
setFromArray(array $data) : \Zend_Queue_Message
array
\Zend_Queue_Message
Provides a fluent interfacesetJobId(string $id) : \Zend_Queue_Message_PlatformJob
Used within Zend_Queue only.
string
\Zend_Queue_Message_PlatformJob
setQueue(\Zend_Queue $queue) : boolean
\Zend_Queue
boolean
toArray() : array
array
_setJobProperties() : void
Any options in the \$_data array will be checked. Those matching options in ZendApi_Job will be used to set those options in that instance.
$_connected : boolean
true
This is false after the Message has been deserialized.
$_data : array
array()
$_id : string
null
$_job : \ZendApi_Job
$_queue : \Zend_Queue
null
$_queueClass : string
null