Class for managing queue messages

category Zend
package Zend_Queue
subpackage Message
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Constructor

__construct(array $options = array()

Parameters

$options

array

Exceptions

\Zend_Queue_Exception

Retrieve message field value

__get(string $key) : string

Parameters

$key

string

The user-specified key name.

Exceptions

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

Returns

stringThe corresponding key value.

Test existence of message field

__isset(string $key) : boolean

Parameters

$key

string

The column key.

Returns

boolean

Set message field value

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

Parameters

$key

string

The message key.

$value

mixed

The value for the property.

Exceptions

\Zend_Queue_Exception

Store queue and data in serialized object

__sleep() : array

Returns

array

Setup to do on wakeup.

__wakeup() : void

A de-serialized Message should not be assumed to have access to a live queue connection, so set _connected = false.

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

getQueue() : \Zend_Queue | null

Returns

\Zend_Queuenull

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

getQueueClass() : string

Returns

string

Sets all data in the row from an array.

setFromArray(array $data) : \Zend_Queue_Message

Parameters

$data

array

Returns

\Zend_Queue_MessageProvides a fluent interface

Set the queue object, to re-establish a live connection to the queue for a Message that has been de-serialized.

setQueue(\Zend_Queue $queue) : boolean

Parameters

$queue

\Zend_Queue

Returns

boolean

Returns the column/value data as an array.

toArray() : array

Returns

array

 Properties

 

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

$_connected : boolean

Default

true

This is false after the Message has been deserialized.

 

The data for the queue message

$_data : array

Default

array()
 

Zend_Queue parent class or instance

$_queue : \Zend_Queue

Default

null
 

Name of the class of the Zend_Queue

$_queueClass : string

Default

null