Class CQueue

CQueue implements a queue.

The typical queue operations are implemented, which include CQueue::enqueue(), CQueue::dequeue() and CQueue::peek(). In addition, CQueue::contains() can be used to check if an item is contained in the queue. To obtain the number of the items in the queue, check the getCount Count property.

Items in the queue may be traversed using foreach as follows,

foreach($queue as $item) ...

CComponent

CQueue implements IteratorAggregate, Countable

Package: system\collections
Copyright: 2008-2013 Yii Software LLC
License: http://www.yiiframework.com/license/
Author: Qiang Xue <qiang.xue@gmail.com>
Since: 1.0
Located at x2engine/framework/collections/CQueue.php

Methods summary
`public`	# `__construct( array $data = null )` Constructor. Initializes the queue with an array or an iterable object. Constructor. Initializes the queue with an array or an iterable object. Parameters `$data` `array` $data the initial data. Default is null, meaning no initialization. Throws `CException` If data is not null and neither an array nor an iterator.
`public array`	# `toArray( )` Returns `array` the list of items in queue
`public`	# `copyFrom( mixed $data )` Copies iterable data into the queue. Note, existing data in the list will be cleared first. Copies iterable data into the queue. Note, existing data in the list will be cleared first. Parameters `$data` `mixed` $data the data to be copied from, must be an array or object implementing Traversable Throws `CException` If data is neither an array nor a Traversable.
`public`	# `clear( )` Removes all items in the queue. Removes all items in the queue.
`public boolean`	# `contains( mixed $item )` Parameters `$item` `mixed` $item the item Returns `boolean` whether the queue contains the item
`public mixed`	# `peek( )` Returns the item at the top of the queue. Returns the item at the top of the queue. Returns `mixed` item at the top of the queue Throws `CException` if the queue is empty
`public mixed`	# `dequeue( )` Removes and returns the object at the beginning of the queue. Removes and returns the object at the beginning of the queue. Returns `mixed` the item at the beginning of the queue Throws `CException` if the queue is empty
`public`	# `enqueue( mixed $item )` Adds an object to the end of the queue. Adds an object to the end of the queue. Parameters `$item` `mixed` $item the item to be appended into the queue
`public Iterator`	# `getIterator( )` Returns an iterator for traversing the items in the queue. This method is required by the interface IteratorAggregate. Returns an iterator for traversing the items in the queue. This method is required by the interface IteratorAggregate. Returns `Iterator` an iterator for traversing the items in the queue. Implementation of `IteratorAggregate::getIterator()`
`public integer`	# `getCount( )` Returns the number of items in the queue. Returns the number of items in the queue. Returns `integer` the number of items in the queue
`public integer`	# `count( )` Returns the number of items in the queue. This method is required by Countable interface. Returns the number of items in the queue. This method is required by Countable interface. Returns `integer` number of items in the queue. Implementation of `Countable::count()`

Methods inherited from CComponent
`__call(), __get(), __isset(), __set(), __unset(), asa(), attachBehavior(), attachBehaviors(), attachEventHandler(), canGetProperty(), canSetProperty(), detachBehavior(), detachBehaviors(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), getEventHandlers(), hasEvent(), hasEventHandler(), hasProperty(), raiseEvent()`

Magic properties summary
`public Iterator`	`$iterator`	# An iterator for traversing the items in the queue. An iterator for traversing the items in the queue.
`public integer`	`$count`	# The number of items in the queue. The number of items in the queue.

Packages

Classes

Class CQueue

Parameters

Throws

Returns

Parameters

Throws

Parameters

Returns

Returns

Throws

Returns

Throws

Parameters

Returns

Implementation of

Returns

Returns

Implementation of