API Documentation

Zend/Queue/Message/PlatformJob.php

Show: inherited
Table of Contents

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.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Queue  
Subpackage
Message  
Version
$Id: PlatformJob.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Queue_Message_PlatformJob

Package: Zend\Queue\Message

Class for managing Zend Platform JobQueue jobs via Zend_Queue

Parent(s)
\Zend_Queue_Message
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_id= 'null'

Job identifier

Default valuenullDetails
Type
string
Propertyprotected\ZendApi_Job  $_job= ''

Details
Type
\ZendApi_Job

Methods

methodpublic__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.

Parameters
Name Type Description
$options array
Throws
Exception Description
\Zend_Queue_Exception
methodpublic__sleep( ) : array

Store queue and data in serialized object

Returns
Type Description
array
methodprotected_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.

methodpublicgetJob( ) : \ZendApi_Job

Retrieve the internal ZendApi_Job instance

Returns
Type Description
\ZendApi_Job
methodpublicgetJobId( ) : string

Retrieve the job identifier

Returns
Type Description
string
methodpublicgetQueueClass( ) : string

Query the class name of the Queue object for which this Message was created.

Returns
Type Description
string
methodpublicsetJobId( string $id ) : \Zend_Queue_Message_PlatformJob

Set the job identifier

Used within Zend_Queue only.

Parameters
Name Type Description
$id string
Returns
Type Description
\Zend_Queue_Message_PlatformJob
Documentation was generated by DocBlox 0.15.1.