Queue/Message.php
inherited
Classes
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 [email protected] 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: Message.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Queue_Message
Class for managing queue messages
- Children
- \Zend_Queue_Message_PlatformJob
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
boolean $_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.
trueDetails- Type
- boolean
array $_data = array()The data for the queue message
array()Details- Type
- array
\Zend_Queue $_queue = nullZend_Queue parent class or instance
nullDetails- Type
- \Zend_Queue
string $_queueClass = nullName of the class of the Zend_Queue
nullDetails- Type
- string
Methods
__construct(array $options = array()) : voidConstructor
| Name | Type | Description |
|---|---|---|
| $options | array |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
__get(string $key) : stringRetrieve message field value
| Name | Type | Description |
|---|---|---|
| $key | string | The user-specified key name. |
| Type | Description |
|---|---|
| string | The corresponding key value. |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception | if the $key is not a column in the message. |
__isset(string $key) : booleanTest existence of message field
| Name | Type | Description |
|---|---|---|
| $key | string | The column key. |
| Type | Description |
|---|---|
| boolean |
__set(string $key, mixed $value) : voidSet message field value
| Name | Type | Description |
|---|---|---|
| $key | string | The message key. |
| $value | mixed | The value for the property. |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
__sleep() : arrayStore queue and data in serialized object
| Type | Description |
|---|---|
| array |
__wakeup() : voidSetup to do on wakeup.
A de-serialized Message should not be assumed to have access to a live queue connection, so set _connected = false.
getQueue() : \Zend_Queue | nullReturns the queue object, or null if this is disconnected message
| Type | Description |
|---|---|
| \Zend_Queue | null |
getQueueClass() : stringQuery the class name of the Queue object for which this Message was created.
| Type | Description |
|---|---|
| string |
setFromArray(array $data) : \Zend_Queue_MessageSets all data in the row from an array.
| Name | Type | Description |
|---|---|---|
| $data | array |
| Type | Description |
|---|---|
| \Zend_Queue_Message | Provides a fluent interface |
setQueue(\Zend_Queue $queue) : booleanSet the queue object, to re-establish a live connection to the queue for a Message that has been de-serialized.
| Name | Type | Description |
|---|---|---|
| $queue | \Zend_Queue |
| Type | Description |
|---|---|
| boolean |
toArray() : arrayReturns the column/value data as an array.
| Type | Description |
|---|---|
| array |