Queue/Message/PlatformJob.php

Show:

inherited

Classes
- \Zend_Queue_Message_PlatformJob

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 24593 2012-01-05 20:35:02Z matthew $

\Zend_Queue_Message_PlatformJob
jump to top

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

boolean $_connected = true

inherited

Connected is true if we have a reference to a live Zend_Queue_Adapter_Abstract object.

Inherited from: \Zend_Queue_Message::$$_connected

This is false after the Message has been deserialized.

Default valuetrueDetails

Type: boolean
Inherited_from: \Zend_Queue_Message::$$_connected

array $_data = array()

inherited

The data for the queue message

Inherited from: \Zend_Queue_Message::$$_data

Default valuearray()Details

Type: array
Inherited_from: \Zend_Queue_Message::$$_data

string $_id = null

Job identifier

Default valuenullDetails

Type: string

\ZendApi_Job $_job

Details

Type: \ZendApi_Job

\Zend_Queue $_queue = null

inherited

Zend_Queue parent class or instance

Inherited from: \Zend_Queue_Message::$$_queue

Default valuenullDetails

Type: \Zend_Queue
Inherited_from: \Zend_Queue_Message::$$_queue

string $_queueClass = null

inherited

Name of the class of the Zend_Queue

Inherited from: \Zend_Queue_Message::$$_queueClass

Default valuenullDetails

Type: string
Inherited_from: \Zend_Queue_Message::$$_queueClass

Methods

__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

__get(string $key) : string

inherited

Retrieve message field value

Inherited from: \Zend_Queue_Message::__get()

Parameters

Name	Type	Description
$key	string	The user-specified key name.

Returns

Type	Description
string	The corresponding key value.

Throws

Exception	Description
\Zend_Queue_Exception	if the $key is not a column in the message.

__isset(string $key) : boolean

inherited

Test existence of message field

Inherited from: \Zend_Queue_Message::__isset()

Parameters

Name	Type	Description
$key	string	The column key.

Returns

Type	Description
boolean

__set(string $key, mixed $value) : void

inherited

Set message field value

Inherited from: \Zend_Queue_Message::__set()

Parameters

Name	Type	Description
$key	string	The message key.
$value	mixed	The value for the property.

Throws

Exception	Description
\Zend_Queue_Exception

__sleep() : array

Store queue and data in serialized object

Returns

Type	Description
array

__wakeup() : void

inherited

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

Returns

Type	Description
\ZendApi_Job

getJobId() : string

Retrieve the job identifier

Returns

Type	Description
string

getQueue() : \Zend_Queue | null

inherited

Returns the queue object, or null if this is disconnected message

Inherited from: \Zend_Queue_Message::getQueue()

Returns

Type	Description
\Zend_Queue \| null

getQueueClass() : string

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

Returns

Type	Description
string

setFromArray(array $data) : \Zend_Queue_Message

inherited

Sets all data in the row from an array.

Inherited from: \Zend_Queue_Message::setFromArray()

Parameters

Name	Type	Description
$data	array

Returns

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.

Parameters

Name	Type	Description
$id	string

Returns

Type	Description
\Zend_Queue_Message_PlatformJob

setQueue(\Zend_Queue $queue) : boolean

inherited

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()

Parameters

Name	Type	Description
$queue	\Zend_Queue

Returns

Type	Description
boolean

toArray() : array

inherited

Returns the column/value data as an array.

Inherited from: \Zend_Queue_Message::toArray()

Returns

Type	Description
array

Queue/Message/PlatformJob.php

\Zend_Queue_Message_PlatformJobjump to top

Properties

Methods

\Zend_Queue_Message_PlatformJob
jump to top