Zend_Queue_Message_PlatformJob Class Reference

Public Member Functions
	__construct (array $options=array())
	Constructor.
	setJobId ($id)
	Set the job identifier.
	getJobId ()
	Retrieve the job identifier.
	getJob ()
	Retrieve the internal ZendApi_Job instance.
	__sleep ()
	Store queue and data in serialized object.
	getQueueClass ()
	Query the class name of the Queue object for which this Message was created.
Public Member Functions inherited from Zend_Queue_Message
	__construct (array $options=array())
	Constructor.
	__get ($key)
	Retrieve message field value.
	__set ($key, $value)
	Set message field value.
	__isset ($key)
	Test existence of message field.
	__sleep ()
	Store queue and data in serialized object.
	__wakeup ()
	Setup to do on wakeup.
	getQueue ()
	Returns the queue object, or null if this is disconnected message.
	setQueue (Zend_Queue $queue)
	Set the queue object, to re-establish a live connection to the queue for a Message that has been de-serialized.
	getQueueClass ()
	Query the class name of the Queue object for which this Message was created.
	toArray ()
	Returns the column/value data as an array.
	setFromArray (array $data)
	Sets all data in the row from an array.

Protected Member Functions
	_setJobProperties ()
	Sets properties on the ZendApi_Job instance.

Protected Attributes
	$_job
	$_id = null
Protected Attributes inherited from Zend_Queue_Message
	$_data = array()
	$_connected = true
	$_queue = null
	$_queueClass = null

Constructor & Destructor Documentation

__construct

(

array

$options = array()

)

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

array

$options

Returns

void

Exceptions

Zend_Queue_Exception

Member Function Documentation

__sleep

(

)

Store queue and data in serialized object.

Returns

array

_setJobProperties ( )

protected

Sets properties on the ZendApi_Job instance.

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.

Returns

void

getJob

(

)

Retrieve the internal ZendApi_Job instance.

Returns

ZendApi_Job

getJobId

(

)

Retrieve the job identifier.

Returns

string

getQueueClass

(

)

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

Returns

string

setJobId

(

$id

)

Set the job identifier.

Used within Zend_Queue only.

Parameters

string

$id

Returns

Zend_Queue_Message_PlatformJob

Member Data Documentation

$_id = null

protected

$_job

protected