Class:Collection - Superclass: Countable Countable
⌊ Collection
public interface Collection
extends Countable
www.doctrine-project.org| Method Summary | |
|---|---|
| boolean | add(mixed element) Adds an element at the end of the collection. |
| void | clear() Clears the collection, removing all elements. |
| boolean | contains(mixed element) Checks whether an element is contained in the collection. |
| boolean | containsKey(string|integer key) Checks whether the collection contains an element with the specified key/index. |
| void | current() Gets the element of the collection at the current iterator position. |
| boolean | exists(Closure p) Tests for the existence of an element that satisfies the given predicate. |
| Collection | filter(Closure p) Returns all the elements of this collection that satisfy the predicate p. |
| mixed | first() Sets the internal iterator to the first element in the collection and returns this element. |
| boolean | forAll(Closure p) Applies the given predicate p to all elements of this collection, returning true, if the predicate yields true for all elements. |
| mixed | get(string|integer key) Gets the element at the specified key/index. |
| array | getKeys() Gets all keys/indices of the collection. |
| array | Gets all values of the collection. |
| mixed | indexOf(mixed element) Gets the index/key of a given element. |
| boolean | isEmpty() Checks whether the collection is empty (contains no elements). |
| void | key() Gets the key/index of the element at the current iterator position. |
| mixed | last() Sets the internal iterator to the last element in the collection and returns this element. |
| Collection | map(Closure func) Applies the given function to each element in the collection and returns a new collection with the elements returned by the function. |
| void | next() Moves the internal iterator position to the next element. |
| array | partition(Closure p) Partitions this collection in two collections according to a predicate. |
| mixed | remove(string|integer key) Removes the element at the specified index from the collection. |
| mixed | removeElement(mixed element) Removes an element from the collection. |
| void | set(string|integer key, mixed value) Sets an element in the collection at the specified key/index. |
| array | toArray() Gets a native PHP array representation of the collection. |
public boolean add(mixed element)
Adds an element at the end of the collection.
public void clear()
Clears the collection, removing all elements.
public boolean contains(mixed element)
Checks whether an element is contained in the collection. This is an O(n) operation, where n is the size of the collection.
public boolean containsKey(string|integer key)
Checks whether the collection contains an element with the specified key/index.
public void current()
Gets the element of the collection at the current iterator position.
public boolean exists(Closure p)
Tests for the existence of an element that satisfies the given predicate.
public Collection filter(Closure p)
Returns all the elements of this collection that satisfy the predicate p. The order of the elements is preserved.
public mixed first()
Sets the internal iterator to the first element in the collection and returns this element.
public boolean forAll(Closure p)
Applies the given predicate p to all elements of this collection, returning true, if the predicate yields true for all elements.
public mixed get(string|integer key)
Gets the element at the specified key/index.
public array getKeys()
Gets all keys/indices of the collection.
public array getValues()
Gets all values of the collection.
public mixed indexOf(mixed element)
Gets the index/key of a given element. The comparison of two elements is strict, that means not only the value but also the type must match. For objects this means reference equality.
public boolean isEmpty()
Checks whether the collection is empty (contains no elements).
public void key()
Gets the key/index of the element at the current iterator position.
public mixed last()
Sets the internal iterator to the last element in the collection and returns this element.
public Collection map(Closure func)
Applies the given function to each element in the collection and returns a new collection with the elements returned by the function.
public void next()
Moves the internal iterator position to the next element.
public array partition(Closure p)
Partitions this collection in two collections according to a predicate. Keys are preserved in the resulting collections.
public mixed remove(string|integer key)
Removes the element at the specified index from the collection.
public mixed removeElement(mixed element)
Removes an element from the collection.
public void set(string|integer key, mixed value)
Sets an element in the collection at the specified key/index.
public array toArray()
Gets a native PHP array representation of the collection.
The missing (SPL) Collection/Array/OrderedMap interface.
A Collection resembles the nature of a regular PHP array. That is, it is essentially an ordered map that can also be used like a list.
A Collection has an internal iterator just like a PHP array. In addition, a Collection can be iterated with external iterators, which is preferrable. To use an external iterator simply use the foreach language construct to iterate over the collection (which calls
getIterator()internally) or explicitly retrieve an iterator thoughgetIterator()which can then be used to iterate over the collection. You can not rely on the internal iterator of the collection being at a certain position unless you explicitly positioned it before. Prefer iteration with external iterators.