Inheritance diagram for SAML2\Utilities\Collection:
Collaboration diagram for SAML2\Utilities\Collection:
Public Member Functions | |
| add ($element) | |
| Add an element to the collection. More... | |
| getOnlyElement () | |
| Shorthand for getting a single element that also must be the only element in the collection. More... | |
| first () | |
| Return the first element from the collection. More... | |
| last () | |
| Return the last element from the collection. More... | |
| map (\Closure $function) | |
| Applies the given function to each element in the collection and returns a new collection with the elements returned by the function. More... | |
| filter (\Closure $filterFunction) | |
| get ($key) | |
| Get the element at index. More... | |
| remove ($element) | |
| set ($key, $value) | |
| Set the value for index. More... | |
Detailed Description
Definition at line 5 of file Collection.php.
Member Function Documentation
◆ add()
| SAML2\Utilities\Collection::add | ( | $element | ) |
Add an element to the collection.
- Parameters
-
$element
- Returns
- $this|\SAML2\Utilities\Collection
Implemented in SAML2\Utilities\ArrayCollection, SAML2\Certificate\FingerprintCollection, and SAML2\Certificate\KeyCollection.
◆ filter()
| SAML2\Utilities\Collection::filter | ( | \Closure | $filterFunction | ) |
- Parameters
-
callable $filterFunction
- Returns
- \SAML2\Utilities\Collection
Implemented in SAML2\Utilities\ArrayCollection.
◆ first()
| SAML2\Utilities\Collection::first | ( | ) |
Return the first element from the collection.
- Returns
- mixed
Implemented in SAML2\Utilities\ArrayCollection.
◆ get()
| SAML2\Utilities\Collection::get | ( | $key | ) |
Get the element at index.
- Parameters
-
mixed $key
- Returns
- mixed
Implemented in SAML2\Utilities\ArrayCollection.
◆ getOnlyElement()
| SAML2\Utilities\Collection::getOnlyElement | ( | ) |
Shorthand for getting a single element that also must be the only element in the collection.
- Returns
- mixed
- Exceptions
-
SAML2\Exception\RuntimeException if the element was not the only element
Implemented in SAML2\Utilities\ArrayCollection.
◆ last()
| SAML2\Utilities\Collection::last | ( | ) |
Return the last element from the collection.
- Returns
- mixed
Implemented in SAML2\Utilities\ArrayCollection.
◆ map()
| SAML2\Utilities\Collection::map | ( | \Closure | $function | ) |
Applies the given function to each element in the collection and returns a new collection with the elements returned by the function.
- Parameters
-
callable $function
- Returns
- mixed
Implemented in SAML2\Utilities\ArrayCollection.
◆ remove()
| SAML2\Utilities\Collection::remove | ( | $element | ) |
- Parameters
-
$element
Implemented in SAML2\Utilities\ArrayCollection.
◆ set()
| SAML2\Utilities\Collection::set | ( | $key, | |
| $value | |||
| ) |
Set the value for index.
- Parameters
-
mixed $key mixed $value
Implemented in SAML2\Utilities\ArrayCollection.
The documentation for this interface was generated from the following file:
- libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Utilities/Collection.php
