Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Class for managing Zend Platform JobQueue jobs via Zend_Queue

__construct(
array $options
=
array
)
:
void
Constructor
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.
Name | Type | Description |
---|---|---|
$options | array |
Exception | Description |
---|---|
\Zend_Queue_Exception |

__get(
string $key
)
:
string
Retrieve message field value
Inherited from: \Zend_Queue_Message::__get()Name | Type | Description |
---|---|---|
$key | string | The user-specified key name. |
Type | Description |
---|---|
string | The corresponding key value. |
Exception | Description |
---|---|
\Zend_Queue_Exception | if the $key is not a column in the message. |

__isset(
string $key
)
:
boolean
Test existence of message field
Inherited from: \Zend_Queue_Message::__isset()Name | Type | Description |
---|---|---|
$key | string | The column key. |
Type | Description |
---|---|
boolean |

__set(
string $key, mixed $value
)
:
void
Set message field value
Inherited from: \Zend_Queue_Message::__set()Name | Type | Description |
---|---|---|
$key | string | The message key. |
$value | mixed | The value for the property. |
Exception | Description |
---|---|
\Zend_Queue_Exception |

__wakeup(
)
:
void
Setup to do on wakeup.
Inherited from: \Zend_Queue_Message::__wakeup()A de-serialized Message should not be assumed to have access to a live queue connection, so set _connected = false.

_setJobProperties(
)
:
void
Sets properties on the ZendApi_Job instance
Any options in the {@link $_data} array will be checked. Those matching options in ZendApi_Job will be used to set those options in that instance.

getJob(
)
:
\ZendApi_Job
Retrieve the internal ZendApi_Job instance
Type | Description |
---|---|
\ZendApi_Job |

getQueue(
)
:
\Zend_Queue|null
Returns the queue object, or null if this is disconnected message
Inherited from: \Zend_Queue_Message::getQueue()Type | Description |
---|---|
\Zend_Queuenull |

getQueueClass(
)
:
string
Query the class name of the Queue object for which this Message was created.
Type | Description |
---|---|
string |

setFromArray(
array $data
)
:
\Zend_Queue_Message
Sets all data in the row from an array.
Inherited from: \Zend_Queue_Message::setFromArray()Name | Type | Description |
---|---|---|
$data | array |
Type | Description |
---|---|
\Zend_Queue_Message | Provides a fluent interface |

setJobId(
string $id
)
:
\Zend_Queue_Message_PlatformJob
Set the job identifier
Used within Zend_Queue only.
Name | Type | Description |
---|---|---|
$id | string |
Type | Description |
---|---|
\Zend_Queue_Message_PlatformJob |

setQueue(
\Zend_Queue $queue
)
:
boolean
Set the queue object, to re-establish a live connection to the queue for a Message that has been de-serialized.
Inherited from: \Zend_Queue_Message::setQueue()
toArray(
)
:
array
Returns the column/value data as an array.
Inherited from: \Zend_Queue_Message::toArray()Type | Description |
---|---|
array |