system system.base system.caching system.caching.dependencies system.collections system.console system.db system.db.ar system.db.schema system.db.schema.mssql system.db.schema.mysql system.db.schema.oci system.db.schema.pgsql system.db.schema.sqlite system.i18n system.i18n.gettext system.logging system.utils system.validators system.web system.web.actions system.web.auth system.web.filters system.web.helpers system.web.renderers system.web.services system.web.widgets system.web.widgets.captcha system.web.widgets.pagers

CQueue

system.collections
继承 class CQueue » CComponent
实现 IteratorAggregate, Traversable, Countable
可用自 1.0
版本 $Id$
CQueue implements a queue.

The typical queue operations are implemented, which include enqueue(), dequeue() and peek(). In addition, 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 Count property.

Items in the queue may be traversed using foreach as follows,
foreach($queue as $item) ...

公共属性

隐藏继承的属性

属性类型描述被定义在
count integer the number of items in the queue CQueue
iterator Iterator Returns an iterator for traversing the items in the queue. CQueue

公共方法

隐藏继承的方法

方法描述被定义在
__call() Calls the named method which is not a class method. CComponent
__construct() Constructor. CQueue
__get() Returns a property value, an event handler list or a behavior based on its name. CComponent
__isset() Checks if a property value is null. CComponent
__set() Sets value of a component property. CComponent
__unset() Sets a component property to be null. CComponent
asa() Returns the named behavior object. CComponent
attachBehavior() Attaches a behavior to this component. CComponent
attachBehaviors() Attaches a list of behaviors to the component. CComponent
attachEventHandler() Attaches an event handler to an event. CComponent
canGetProperty() Determines whether a property can be read. CComponent
canSetProperty() Determines whether a property can be set. CComponent
clear() Removes all items in the queue. CQueue
contains() CQueue
copyFrom() Copies iterable data into the queue. CQueue
count() Returns the number of items in the queue. CQueue
dequeue() Removes and returns the object at the beginning of the queue. CQueue
detachBehavior() Detaches a behavior from the component. CComponent
detachBehaviors() Detaches all behaviors from the component. CComponent
detachEventHandler() Detaches an existing event handler. CComponent
disableBehavior() Disables an attached behavior. CComponent
disableBehaviors() Disables all behaviors attached to this component. CComponent
enableBehavior() Enables an attached behavior. CComponent
enableBehaviors() Enables all behaviors attached to this component. CComponent
enqueue() Adds an object to the end of the queue. CQueue
getCount() CQueue
getEventHandlers() Returns the list of attached event handlers for an event. CComponent
getIterator() Returns an iterator for traversing the items in the queue. CQueue
hasEvent() Determines whether an event is defined. CComponent
hasEventHandler() Checks whether the named event has attached handlers. CComponent
hasProperty() Determines whether a property is defined. CComponent
peek() Returns the item at the top of the queue. CQueue
raiseEvent() Raises an event. CComponent
toArray() CQueue

属性详情

count 属性 只读
public integer getCount()

the number of items in the queue

iterator 属性 只读
public Iterator getIterator()

Returns an iterator for traversing the items in the queue. This method is required by the interface IteratorAggregate.

方法详情

__construct() 方法
public void __construct(array $data=NULL)
$data array the intial data. Default is null, meaning no initialization.

Constructor. Initializes the queue with an array or an iterable object.

clear() 方法
public void clear()

Removes all items in the queue.

contains() 方法
public boolean contains(mixed $item)
$item mixed the item
{return} boolean whether the queue contains the item

copyFrom() 方法
public void copyFrom(mixed $data)
$data mixed the data to be copied from, must be an array or object implementing Traversable

Copies iterable data into the queue. Note, existing data in the list will be cleared first.

count() 方法
public integer count()
{return} integer number of items in the queue.

Returns the number of items in the queue. This method is required by Countable interface.

dequeue() 方法
public mixed dequeue()
{return} mixed the item at the beginning of the queue

Removes and returns the object at the beginning of the queue.

enqueue() 方法
public void enqueue(mixed $item)
$item mixed the item to be appended into the queue

Adds an object to the end of the queue.

getCount() 方法
public integer getCount()
{return} integer the number of items in the queue

getIterator() 方法
public Iterator getIterator()
{return} Iterator an iterator for traversing the items in the queue.

Returns an iterator for traversing the items in the queue. This method is required by the interface IteratorAggregate.

peek() 方法
public mixed peek()
{return} mixed item at the top of the queue

Returns the item at the top of the queue.

toArray() 方法
public array toArray()
{return} array the list of items in queue