Zend_Queue_Message Class Reference

Public Member Functions
	__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 Attributes
	$_data = array()
	$_connected = true
	$_queue = null
	$_queueClass = null

Constructor & Destructor Documentation

__construct

(

array

$options = array()

)

Constructor.

Parameters

array

$options

Exceptions

Zend_Queue_Exception

Member Function Documentation

__get

(

$key

)

Retrieve message field value.

Parameters

string

$key

The user-specified key name.

Returns

string The corresponding key value.

Exceptions

Zend_Queue_Exception

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

__isset

(

$key

)

Test existence of message field.

Parameters

string

$key

The column key.

Returns

boolean

__set	(		$key,
			$value
	)

Set message field value.

Parameters

string	$key	The message key.
mixed	$value	The value for the property.

Returns

void

Exceptions

Zend_Queue_Exception

__sleep

(

)

Store queue and data in serialized object.

Returns

array

__wakeup

(

)

Setup to do on wakeup.

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

Returns

void

getQueue

(

)

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

Returns

Zend_Queue|null

getQueueClass

(

)

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

Returns

string

setFromArray

(

array

$data

)

Sets all data in the row from an array.

Parameters

array

$data

Returns

Zend_Queue_Message Provides a fluent interface

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.

Parameters

Zend_Queue

$queue

Returns

boolean

toArray

(

)

Returns the column/value data as an array.

Returns

array

Member Data Documentation

$_connected = true

protected

$_data = array()

protected

$_queue = null

protected

$_queueClass = null

protected