Queue/Message/Iterator.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Queue
subpackage: Message
version: $Id: Iterator.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes: Zend_Queue_Message_Iterator

Description

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 license@zend.com so we can send you a copy immediately.

Zend_Queue_Message_Iterator
jump to top

Implements
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Queue
subpackage: Message
Properties: $_data; $_connected; $_queue; $_queueClass; $_messageClass; $_pointer
Methods: __construct; __sleep; __wakeup; toArray; getQueue; setQueue; getQueueClass; rewind; current; key; next; valid; count

Description

Properties

$_connected
jump to class

boolean $_connected = 'true'

Connected is true if we have a reference to a live Zend_Queue_Adapter_AdapterInterface object.

This is false after the Message has been deserialized.

Details

$_connected: boolean
visibility: protected
default: true
final: false
static: false

$_data
jump to class

array $_data = 'array'

The data for the queue message

Details

$_data: array
visibility: protected
default: array
final: false
static: false

$_messageClass
jump to class

string $_messageClass = 'Zend_Queue_Message'

Zend_Queue_Message class name

Details

$_messageClass: string
visibility: protected
default: Zend_Queue_Message
final: false
static: false

$_pointer
jump to class

integer $_pointer = '0'

Iterator pointer.

Details

$_pointer: integer
visibility: protected
default: 0
final: false
static: false

$_queue
jump to class

Zend_Queue_Adapter_AdapterInterface $_queue = 'null'

Zend_Queue_Adapter_AdapterInterface parent class or instance

Details

$_queue: Zend_Queue_Adapter_AdapterInterface
visibility: protected
default: null
final: false
static: false

$_queueClass
jump to class

string $_queueClass = 'null'

Name of the class of the Zend_Queue_Adapter_AdapterInterface object.

Details

$_queueClass: string
visibility: protected
default: null
final: false
static: false

Methods

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :
        void

Constructor

Arguments

$options: array
('queue', 'messageClass', 'data'=>array());

Details

visibility: public
final: false
static: false

__sleep
jump to class

__sleep(
          
          )
        
        :
        array

Store queue and data in serialized object

Output

array

Details

visibility: public
final: false
static: false

__wakeup
jump to class

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

Details

visibility: public
final: false
static: false

count
jump to class

count(
          
          )
        
        :
        integer

Returns the number of elements in the collection.

Implements Countable::count()

Output

integer

Details

visibility: public
final: false
static: false

current
jump to class

current(
          
          )
        
        :
        Zend_Queue_Message

Return the current element.

Similar to the current() function for arrays in PHP Required by interface Iterator.

Output

Zend_Queue_Message: current element from the collection

Details

visibility: public
final: false
static: false

getQueue
jump to class

getQueue(
          
          )
        
        :
        Zend_Queue|null

Returns the queue object, or null if this is disconnected message set

Output

Zend_Queue|null

Details

visibility: public
final: false
static: false

getQueueClass
jump to class

getQueueClass(
          
          )
        
        :
        string

Query the class name of the Queue object for which this Message was created.

Output

string

Details

visibility: public
final: false
static: false

key
jump to class

key(
          
          )
        
        :
        integer

Return the identifying key of the current element.

Similar to the key() function for arrays in PHP. Required by interface Iterator.

Output

integer

Details

visibility: public
final: false
static: false

next
jump to class

Move forward to next element.

Similar to the next() function for arrays in PHP. Required by interface Iterator.

Details

visibility: public
final: false
static: false

rewind
jump to class

rewind(
          
          )
        
        :
        void

Rewind the Iterator to the first element.

Similar to the reset() function for arrays in PHP. Required by interface Iterator.

Details

visibility: public
final: false
static: false

setQueue
jump to class

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.

Arguments

$queue: Zend_Queue_Adapter_AdapterInterface

Output

boolean

Details

visibility: public
final: false
static: false
throws

toArray
jump to class

toArray(
          
          )
        
        :
        array

Returns all data as an array.

Used for debugging.

Output

array

Details

visibility: public
final: false
static: false

valid
jump to class

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

Output

bool: False if there's nothing more to iterate over

Details

visibility: public
final: false
static: false

API Documentation

Queue/Message/Iterator.php

Description

Zend_Queue_Message_Iteratorjump to top

Description

Properties

$_connectedjump to class

Details

$_datajump to class

Details

$_messageClassjump to class

Details

$_pointerjump to class

Details

$_queuejump to class

Details

$_queueClassjump to class

Details

Methods

__constructjump to class

Arguments

Details

__sleepjump to class

Output

Details

__wakeupjump to class

Details

countjump to class

Output

Details

currentjump to class

Output

Details

getQueuejump to class

Output

Details

getQueueClassjump to class

Output

Details

keyjump to class

Output

Details

nextjump to class

Details

rewindjump to class

Details

setQueuejump to class

Arguments

Output

Details

toArrayjump to class

Output

Details

validjump to class

Output

Details

Zend_Queue_Message_Iterator
jump to top

$_connected
jump to class

$_data
jump to class

$_messageClass
jump to class

$_pointer
jump to class

$_queue
jump to class

$_queueClass
jump to class

__construct
jump to class

__sleep
jump to class

__wakeup
jump to class

count
jump to class

current
jump to class

getQueue
jump to class

getQueueClass
jump to class

key
jump to class

next
jump to class

rewind
jump to class

setQueue
jump to class

toArray
jump to class

valid
jump to class