Queue/Message/Iterator.php
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 license@zend.com 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: Iterator.php 24593 2012-01-05 20:35:02Z matthew $
\Zend_Queue_Message_Iterator
- Implements
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties


boolean $_connected = true
This is false after the Message has been deserialized.
true
Details- Type
- boolean


string $_messageClass = 'Zend_Queue_Message'
'Zend_Queue_Message'
Details- Type
- string


\Zend_Queue_Adapter_AdapterInterface $_queue = null
null
DetailsMethods


__construct(array $options = array()) : void
Constructor
Name | Type | Description |
---|---|---|
$options | array | ('queue', 'messageClass', 'data'=>array()); |


__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.


count() : integer
Returns the number of elements in the collection.
Implements Countable::count()
Type | Description |
---|---|
integer |


current() : \Zend_Queue_Message
Return the current element.
Similar to the current() function for arrays in PHP Required by interface Iterator.
Type | Description |
---|---|
\Zend_Queue_Message | current element from the collection |


getQueue() : \Zend_Queue | null
Returns the queue object, or null if this is disconnected message set
Type | Description |
---|---|
\Zend_Queue | null |


getQueueClass() : string
Query the class name of the Queue object for which this Message was created.
Type | Description |
---|---|
string |


key() : integer
Return the identifying key of the current element.
Similar to the key() function for arrays in PHP. Required by interface Iterator.
Type | Description |
---|---|
integer |


next() : void
Move forward to next element.
Similar to the next() function for arrays in PHP. Required by interface Iterator.


rewind() : void
Rewind the Iterator to the first element.
Similar to the reset() function for arrays in PHP. Required by interface Iterator.


setQueue(\Zend_Queue_Adapter_AdapterInterface $queue) : boolean
Set 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_Adapter_AdapterInterface |
Type | Description |
---|---|
boolean |
Exception | Description |
---|---|
\Zend_Queue_Exception |