Queue/Message/Iterator.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: 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 = trueConnected is true if we have a reference to a live Zend_Queue_Adapter_AdapterInterface 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
string $_messageClass = 'Zend_Queue_Message'Zend_Queue_Message class name
'Zend_Queue_Message'Details- Type
- string
integer $_pointer = 0Iterator pointer.
0Details- Type
- integer
\Zend_Queue_Adapter_AdapterInterface $_queue = nullZend_Queue_Adapter_AdapterInterface parent class or instance
nullDetails
string $_queueClass = nullName of the class of the Zend_Queue_Adapter_AdapterInterface object.
nullDetails- Type
- string
Methods
__construct(array $options = array()) : voidConstructor
| Name | Type | Description |
|---|---|---|
| $options | array | ('queue', 'messageClass', 'data'=>array()); |
__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.
count() : integerReturns the number of elements in the collection.
Implements Countable::count()
| Type | Description |
|---|---|
| integer |
current() : \Zend_Queue_MessageReturn 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 | nullReturns the queue object, or null if this is disconnected message set
| Type | Description |
|---|---|
| \Zend_Queue | null |
getQueueClass() : stringQuery the class name of the Queue object for which this Message was created.
| Type | Description |
|---|---|
| string |
key() : integerReturn the identifying key of the current element.
Similar to the key() function for arrays in PHP. Required by interface Iterator.
| Type | Description |
|---|---|
| integer |
next() : voidMove forward to next element.
Similar to the next() function for arrays in PHP. Required by interface Iterator.
rewind() : voidRewind 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) : 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_Adapter_AdapterInterface |
| Type | Description |
|---|---|
| boolean |
| Exception | Description |
|---|---|
| \Zend_Queue_Exception |
toArray() : arrayReturns all data as an array.
Used for debugging.
| Type | Description |
|---|---|
| array |
valid() : boolCheck if there is a current element after calls to rewind() or next().
Used to check if we've iterated to the end of the collection. Required by interface Iterator.
| Type | Description |
|---|---|
| bool | False if there's nothing more to iterate over |