function CollectionInterface::add

Ensures that this collection contains the specified element (optional operation).

Returns `true` if this collection changed as a result of the call. (Returns `false` if this collection does not permit duplicates and already contains the specified element.)

Collections that support this operation may place limitations on what elements may be added to this collection. In particular, some collections will refuse to add `null` elements, and others will impose restrictions on the type of elements that may be added. Collection classes should clearly specify in their documentation any restrictions on what elements may be added.

If a collection refuses to add a particular element for any reason other than that it already contains the element, it must throw an exception (rather than returning `false`). This preserves the invariant that a collection always contains the specified element after this call returns.

Parameters

T $element The element to add to the collection.:

Return value

bool `true` if this collection changed as a result of the call.

Throws

InvalidArgumentException if the collection refuses to add the $element for any reason other than that it already contains the element.

1 method overrides CollectionInterface::add()

AbstractCollection::add in vendor/ramsey/collection/src/AbstractCollection.php

File

vendor/ramsey/collection/src/CollectionInterface.php, line 61

Class

CollectionInterface

A collection represents a group of values, known as its elements.

Namespace

Ramsey\Collection

Code

public function add(mixed $element) : bool;