\phpDocumentor\DescriptorCollection

__construct()

__construct(\phpDocumentor\Descriptor\T[]  $items = []) : mixed

Constructs a new collection object with optionally a series of items, generally Descriptors.

Parameters

Returns

add()

add(\phpDocumentor\Descriptor\T  $item) : void

Adds a new item to this collection, generally a Descriptor.

Parameters

set()

set(array-key  $index, \phpDocumentor\Descriptor\T  $item) : void

Sets a new object onto the collection or clear it using null.

Parameters

get()

get(array-key  $index) : \phpDocumentor\Descriptor\T

Retrieves a specific item from the Collection with its index. If index is not found, an exception is thrown

Parameters

Returns

The contents of the element with the given index

fetch()

fetch(array-key  $index, ?\phpDocumentor\Descriptor\TChild  $valueIfEmpty = null) : \phpDocumentor\Descriptor\TChild

Retrieves a specific item from the Collection with its index.

Please note that this method (intentionally) has the side effect that whenever a key does not exist that it will be created with the value provided by the $valueIfEmpty argument. This will allow for easy initialization during tree building operations.

Parameters

Returns

The contents of the element with the given index and the provided default if the key doesn't exist.

first()

first() : ?\phpDocumentor\Descriptor\T

Returns

getAll()

getAll() : \phpDocumentor\Descriptor\T[]

Retrieves all items from this collection as PHP Array.

Returns

getIterator()

getIterator() : \ArrayIterator<array-key,\phpDocumentor\Descriptor\T>

Retrieves an iterator to traverse this object.

Returns

count()

count() : int

Returns a count of the number of elements in this collection.

Returns

clear()

clear() : void

Empties the collection.

__get()

__get(string  $name) : mixed

Retrieves an item as if it were a property of the collection.

Parameters

Returns

offsetExists()

offsetExists(array-key  $offset) : bool

Checks whether an item in this collection exists.

Parameters

Returns

offsetGet()

offsetGet(array-key  $offset) : ?\phpDocumentor\Descriptor\T

Retrieves an item from the collection with the given index.

Parameters

Returns

offsetSet()

offsetSet((array-key)|null  $offset, \phpDocumentor\Descriptor\T  $value) : void

Sets an item at the given index.

Parameters

Throws

\InvalidArgumentException

If the key is null or an empty string.

offsetUnset()

offsetUnset(array-key  $offset) : void

Removes an item with the given index from the collection.

Parameters

merge()

merge(\phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\T>  $collection) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\T>

Returns a new collection with the items from this collection and the provided combined.

Parameters

Returns

filter()

filter(class-string<\phpDocumentor\Descriptor\F>  $className) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\F>

Parameters

Returns

fromClassString()

fromClassString(class-string<\phpDocumentor\Descriptor\C>  $classString, \phpDocumentor\Descriptor\C[]  $elements = []) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\C>

Parameters

Returns

fromInterfaceString()

fromInterfaceString(class-string<\phpDocumentor\Descriptor\C>  $interfaceString, \phpDocumentor\Descriptor\C[]  $elements = []) : \phpDocumentor\Descriptor\Collection<\phpDocumentor\Descriptor\C>

Parameters

Returns