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 |

_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 |

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

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 |