W3cubDocs

/Yii 1.1

CQueueIterator

Package system.collections
Inheritance class CQueueIterator
Implements Iterator, Traversable
Since 1.0
Source Code framework/collections/CQueueIterator.php
CQueueIterator implements an iterator for CQueue.

It allows CQueue to return a new iterator for traversing the items in the queue.

Public Methods

Method Description Defined By
__construct() Constructor. CQueueIterator
current() Returns the current array item. CQueueIterator
key() Returns the key of the current array item. CQueueIterator
next() Moves the internal pointer to the next array item. CQueueIterator
rewind() Rewinds internal array pointer. CQueueIterator
valid() Returns whether there is an item at current position. CQueueIterator

Method Details

__construct() method

public void __construct(array &$data)
$data array the data to be iterated through
Source Code: framework/collections/CQueueIterator.php#39 (show)
public function __construct(&$data)
{
    
$this->_d=&$data;
    
$this->_i=0;
    
$this->_c=count($this->_d);
}

Constructor.

current() method

public mixed current()
{return} mixed the current array item
Source Code: framework/collections/CQueueIterator.php#70 (show)
public function current()
{
    return 
$this->_d[$this->_i];
}

Returns the current array item. This method is required by the interface Iterator.

key() method

public integer key()
{return} integer the key of the current array item
Source Code: framework/collections/CQueueIterator.php#60 (show)
public function key()
{
    return 
$this->_i;
}

Returns the key of the current array item. This method is required by the interface Iterator.

next() method

public void next()
Source Code: framework/collections/CQueueIterator.php#79 (show)
public function next()
{
    
$this->_i++;
}

Moves the internal pointer to the next array item. This method is required by the interface Iterator.

rewind() method

public void rewind()
Source Code: framework/collections/CQueueIterator.php#50 (show)
public function rewind()
{
    
$this->_i=0;
}

Rewinds internal array pointer. This method is required by the interface Iterator.

valid() method

public boolean valid()
{return} boolean
Source Code: framework/collections/CQueueIterator.php#89 (show)
public function valid()
{
    return 
$this->_i<$this->_c;
}

Returns whether there is an item at current position. This method is required by the interface Iterator.

© 2008–2017 by Yii Software LLC
Licensed under the three clause BSD license.
http://www.yiiframework.com/doc/api/1.1/CQueueIterator