100 lines
3.1 KiB
PHP
100 lines
3.1 KiB
PHP
|
<?php
|
||
|
|
|
||
|
|
namespace Doctrine\Common\Collections;
|
||
|
|
|
||
|
|
use ArrayAccess;
|
||
|
|
use Closure;
|
||
|
|
|
||
|
|
/**
|
||
|
|
* The missing (SPL) Collection/Array/OrderedMap interface.
|
||
|
|
*
|
||
|
|
* A Collection resembles the nature of a regular PHP array. That is,
|
||
|
|
* it is essentially an <b>ordered map</b> 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 preferable.
|
||
|
|
* To use an external iterator simply use the foreach language construct to
|
||
|
|
* iterate over the collection (which calls {@link getIterator()} internally) or
|
||
|
|
* explicitly retrieve an iterator though {@link getIterator()} 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.
|
||
|
|
*
|
||
|
|
* @psalm-template TKey of array-key
|
||
|
|
* @psalm-template T
|
||
|
|
* @template-extends ReadableCollection<TKey, T>
|
||
|
|
* @template-extends ArrayAccess<TKey, T>
|
||
|
|
*/
|
||
|
|
interface Collection extends ReadableCollection, ArrayAccess
|
||
|
|
{
|
||
|
|
/**
|
||
|
|
* Adds an element at the end of the collection.
|
||
|
|
*
|
||
|
|
* @param mixed $element The element to add.
|
||
|
|
* @psalm-param T $element
|
||
|
|
*
|
||
|
|
* @return true Always TRUE.
|
||
|
|
*/
|
||
|
|
public function add($element);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Clears the collection, removing all elements.
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function clear();
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes the element at the specified index from the collection.
|
||
|
|
*
|
||
|
|
* @param string|int $key The key/index of the element to remove.
|
||
|
|
* @psalm-param TKey $key
|
||
|
|
*
|
||
|
|
* @return mixed The removed element or NULL, if the collection did not contain the element.
|
||
|
|
* @psalm-return T|null
|
||
|
|
*/
|
||
|
|
public function remove($key);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Removes the specified element from the collection, if it is found.
|
||
|
|
*
|
||
|
|
* @param mixed $element The element to remove.
|
||
|
|
* @psalm-param T $element
|
||
|
|
*
|
||
|
|
* @return bool TRUE if this collection contained the specified element, FALSE otherwise.
|
||
|
|
*/
|
||
|
|
public function removeElement($element);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* Sets an element in the collection at the specified key/index.
|
||
|
|
*
|
||
|
|
* @param string|int $key The key/index of the element to set.
|
||
|
|
* @param mixed $value The element to set.
|
||
|
|
* @psalm-param TKey $key
|
||
|
|
* @psalm-param T $value
|
||
|
|
*
|
||
|
|
* @return void
|
||
|
|
*/
|
||
|
|
public function set($key, $value);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return Collection<mixed> A collection with the results of the filter operation.
|
||
|
|
* @psalm-return Collection<TKey, T>
|
||
|
|
*/
|
||
|
|
public function filter(Closure $p);
|
||
|
|
|
||
|
|
/**
|
||
|
|
* {@inheritdoc}
|
||
|
|
*
|
||
|
|
* @return Collection<mixed>[] An array with two elements. The first element contains the collection
|
||
|
|
* of elements where the predicate returned TRUE, the second element
|
||
|
|
* contains the collection of elements where the predicate returned FALSE.
|
||
|
|
* @psalm-return array{0: Collection<TKey, T>, 1: Collection<TKey, T>}
|
||
|
|
*/
|
||
|
|
public function partition(Closure $p);
|
||
|
|
}
|