Queue/Message.php
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-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Queue
- Subpackage
- Message
- Version
- $Id$
\Zend_Queue_Message
Package: Zend_Queue\Message![>](../images/icons/arrow_right.png)
![>](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
![](../images/icons/arrow_right.png)
Class for managing queue messages
- Children
- \Zend_Queue_Message_PlatformJob
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
![>](../images/icons/arrow_right.png)
![Property](../images/icons/property.png)
boolean $_connected = true
Connected is true if we have a reference to a live
Zend_Queue_Adapter_Abstract object.
This is false after the Message has been deserialized.
Default valuetrue
Details- Type
- boolean
![>](../images/icons/arrow_right.png)
![Property](../images/icons/property.png)
\Zend_Queue $_queue = null
Zend_Queue parent class or instance
Default value
null
Details- Type
- \Zend_Queue
Methods
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
__construct(array $options = array()) : void
Constructor
Parameters
Throws
Name | Type | Description |
---|---|---|
$options | array |
Exception | Description |
---|---|
\Zend_Queue_Exception |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
__get(string $key) : string
Retrieve message field value
Parameters
Returns
Throws
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. |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
__isset(string $key) : boolean
Test existence of message field
Parameters
Returns
Name | Type | Description |
---|---|---|
$key | string | The column key. |
Type | Description |
---|---|
boolean |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
__set(string $key, mixed $value) : void
Set message field value
Parameters
Throws
Name | Type | Description |
---|---|---|
$key | string | The message key. |
$value | mixed | The value for the property. |
Exception | Description |
---|---|
\Zend_Queue_Exception |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
__wakeup() : void
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.
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
getQueue() : \Zend_Queue | null
Returns the queue object, or null if this is disconnected message
Returns
Type | Description |
---|---|
\Zend_Queue | null |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
getQueueClass() : string
Query the class name of the Queue object for which this Message was created.
Returns
Type | Description |
---|---|
string |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
setFromArray(array $data) : \Zend_Queue_Message
Sets all data in the row from an array.
Parameters
Returns
Name | Type | Description |
---|---|---|
$data | array |
Type | Description |
---|---|
\Zend_Queue_Message | Provides a fluent interface |
![](../images/icons/arrow_right.png)
![method method](../images/icons/method.png)
setQueue(\Zend_Queue $queue) : boolean
Set the queue object, to re-establish a live connection to the queue for a Message that has been de-serialized.
Parameters
Returns
Name | Type | Description |
---|---|---|
$queue | \Zend_Queue |
Type | Description |
---|---|
boolean |