Class \Prado\Collections\TQueue

TQueue class

TQueue 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 \Prado\Collections\getCount property.

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

foreach($queue as $item) ...

Class hierarchy

\Prado\Collections\TQueue implements IteratorAggregate, Countable

\Prado\TComponent

Author: Qiang Xue <qiang.xue@gmail.com>
Author: Knut Urdalen <knut.urdalen@gmail.com>
Since: 3.1

Methods summary
`public`	`__construct([null\|array<string\|int, mixed>\|Iterator $data = null ]) : mixed` Constructor. Initializes the queue with an array or an iterable object.
`public`	`clear() : mixed` Removes all items in the queue.
`public`	`contains(mixed $item) : bool`
`public`	`copyFrom(mixed $data) : mixed` Copies iterable data into the queue. Note, existing data in the list will be cleared first.
`public`	`count() : int` Returns the number of items in the queue. This method is required by \Countable interface.
`public`	`dequeue() : mixed` Removes and returns the object at the beginning of the queue.
`public`	`enqueue(mixed $item) : mixed` Adds an object to the end of the queue.
`public`	`getCount() : int`
`public`	`getIterator() : Iterator` Returns an iterator for traversing the items in the queue. This method is required by the interface \IteratorAggregate.
`public`	`peek() : mixed` Returns the first item at the front of the queue. Unlike dequeue(), this method does not remove the item from the queue.
`public`	`toArray() : array<string\|int, mixed>`

Inherited methods
__call, __callStatic, __clone, __construct, __destruct, __get, __isset, __set, __sleep, __unset, __wakeup, addParsedObject, asa, attachBehavior, attachBehaviors, attachClassBehavior, attachEventHandler, callBehaviorsMethod, canGetProperty, canSetProperty, clearBehaviors, createdOnTemplate, detachBehavior, detachBehaviors, detachClassBehavior, detachEventHandler, disableBehavior, disableBehaviors, enableBehavior, enableBehaviors, evaluateExpression, evaluateStatements, fxAttachClassBehavior, fxDetachClassBehavior, getAutoGlobalListen, getBehaviors, getBehaviorsEnabled, getClassHierarchy, getEventHandlers, getListeningToGlobalEvents, getSubProperty, hasEvent, hasEventHandler, hasMethod, hasProperty, isa, listen, raiseEvent, setSubProperty, unlisten, _getZappableSleepProps, getCallChain, getClassFxEvents, instanceBehavior, filter_prado_fx

Inherited constants
`\Prado\TComponent::GLOBAL_RAISE_EVENT_LISTENER`