| Category | Zend |
| Package | Zend_Queue |
| Subpackage | Message |
| Copyright | Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com) |
| License | http://framework.zend.com/license/new-bsd New BSD License |
Class Zend_Queue_Message
Defined in line 32 of file Queue/Message.php.
Subclasses : Zend_Queue_Message_PlatformJob
Class for managing queue messages
Summary
Instance fields
| # $_connected | Connected is true if we have a reference to a live |
| # $_data | The data for the queue message |
| # $_queue | Zend_Queue parent class or instance |
| # $_queueClass | Name of the class of the Zend_Queue |
Instance methods
| + __construct() | Constructor |
| + __get() | Retrieve message field value |
| + __isset() | Test existence of message field |
| + __set() | Set message field value |
| + __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 |
| + getQueueClass() | Query the class name of the Queue object for which this |
| + setFromArray() | Sets all data in the row from an array |
| + setQueue() | Set the queue object, to re-establish a live connection |
| + toArray() | Returns the column/value data as an array |
Details
Instance fields
protected $_connected = trueConnected is true if we have a reference to a live
Zend_Queue_Adapter_Abstract object.
This is false after the Message has been deserialized.
Zend_Queue_Adapter_Abstract object.
This is false after the Message has been deserialized.
Var
boolean
Defined in Queue/Message.php, line 48
protected $_data = array()The data for the queue message
Var
array
Defined in Queue/Message.php, line 39
protected $_queue = nullZend_Queue parent class or instanceVar
Zend_QueueDefined in Queue/Message.php, line 55
protected $_queueClass = nullName of the class of the
Zend_QueueVar
string
Defined in Queue/Message.php, line 62
Instance methods
public function __construct( |
array $options = array())
|
Overriden by __construct() in class : Zend_Queue_Message_PlatformJob
Defined in Queue/Message.php, line 70
public function __get( |
$key)
|
Retrieve message field value
Parameters
string $key |
The user-specified key name. |
Returns
string The corresponding key value.
Throws
Zend_Queue_Exception if the $key is not a column in the message.Defined in Queue/Message.php, line 106
public function __isset( |
$key)
|
Test existence of message field
Parameters
string $key |
The column key. |
Returns
boolean
Defined in Queue/Message.php, line 138
public function __set( |
$key)
|
Set message field value
Parameters
string $key |
The message key. |
mixed $value |
The value for the property. |
Returns
void
Throws
Zend_Queue_ExceptionDefined in Queue/Message.php, line 123
public function __sleep( |
|
Store queue and data in serialized object
Returns
array
Overriden by __sleep() in class : Zend_Queue_Message_PlatformJob
Defined in Queue/Message.php, line 152
public function __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.
A de-serialized Message should not be assumed to have access to a live
queue connection, so set _connected = false.
Returns
void
Defined in Queue/Message.php, line 164
public function getQueue( |
|
Returns the queue object, or null if this is disconnected message
Returns
Zend_Queue|nullDefined in Queue/Message.php, line 174
public function getQueueClass( |
|
Query the class name of the Queue object for which this
Message was created.
Message was created.
Returns
string
Overriden by getQueueClass() in class : Zend_Queue_Message_PlatformJob
Defined in Queue/Message.php, line 201
public function setFromArray( |
array $data)
|
Sets all data in the row from an array.
Parameters
array $data |
Returns
Zend_Queue_Message Provides a fluent interfaceDefined in Queue/Message.php, line 222
public function setQueue( |
|
Set the queue object, to re-establish a live connection
to the queue for a Message that has been de-serialized.
Parameters
to the queue for a Message that has been de-serialized.
|
Returns
boolean
Defined in Queue/Message.php, line 186
public function toArray( |
|
Returns the column/value data as an array.
Returns
array
Defined in Queue/Message.php, line 211