Simple Array implementation of Collection. More...

Inheritance diagram for SAML2\Utilities\ArrayCollection:

Collaboration diagram for SAML2\Utilities\ArrayCollection:

Public Member Functions
	__construct (array $elements=array())

	add ($element)
	Add an element to the collection. More...

	get ($key)
	Get the element at index. More...

	filter (\Closure $f)

	set ($key, $value)
	Set the value for index. More...

	remove ($element)

	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...

	count ()

	getIterator ()

	offsetExists ($offset)

	offsetGet ($offset)

	offsetSet ($offset, $value)

	offsetUnset ($offset)

	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...

Protected Attributes
	$elements

Detailed Description

Simple Array implementation of Collection.

@SuppressWarnings(PHPMD.TooManyMethods) - it just has a large api.

Definition at line 12 of file ArrayCollection.php.

Constructor & Destructor Documentation

◆ __construct()

SAML2\Utilities\ArrayCollection::__construct ( array $elements = array() )

Definition at line 19 of file ArrayCollection.php.

    {
        $this->elements = $elements;
    }

References SAML2\Utilities\ArrayCollection\$elements.

Member Function Documentation

◆ add()

SAML2\Utilities\ArrayCollection::add ( $element )

Add an element to the collection.

Parameters

$element

Returns: $this|\SAML2\Utilities\Collection

Implements SAML2\Utilities\Collection.

Reimplemented in SAML2\Certificate\FingerprintCollection, and SAML2\Certificate\KeyCollection.

Definition at line 24 of file ArrayCollection.php.

    {
        $this->elements[] = $element;
    }

◆ count()

SAML2\Utilities\ArrayCollection::count ( )

Definition at line 86 of file ArrayCollection.php.

    {
        return count($this->elements);
    }

References SAML2\Utilities\ArrayCollection\count().

Referenced by SAML2\Utilities\ArrayCollection\count(), and SAML2\Utilities\ArrayCollection\getOnlyElement().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ filter()

SAML2\Utilities\ArrayCollection::filter ( \Closure $filterFunction )

Parameters

callable $filterFunction

Returns: \SAML2\Utilities\Collection

Implements SAML2\Utilities\Collection.

Definition at line 34 of file ArrayCollection.php.

    {
        return new self(array_filter($this->elements, $f));
    }

◆ first()

SAML2\Utilities\ArrayCollection::first ( )

Return the first element from the collection.

Returns: mixed

Implements SAML2\Utilities\Collection.

Definition at line 71 of file ArrayCollection.php.

    {
        return reset($this->elements);
    }

◆ get()

SAML2\Utilities\ArrayCollection::get ( $key )

Get the element at index.

Parameters

mixed $key

Returns: mixed

Implements SAML2\Utilities\Collection.

Definition at line 29 of file ArrayCollection.php.

    {
        return isset($this->elements[$key]) ? $this->elements[$key] : null;
    }

References $key.

◆ getIterator()

SAML2\Utilities\ArrayCollection::getIterator ( )

Definition at line 91 of file ArrayCollection.php.

    {
        return new \ArrayIterator($this->elements);
    }

◆ getOnlyElement()

SAML2\Utilities\ArrayCollection::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

Implements SAML2\Utilities\Collection.

Definition at line 58 of file ArrayCollection.php.

    {
        if ($this->count() !== 1) {
            throw new RuntimeException(sprintf(
                __CLASS__ . '::' . __METHOD__ . ' requires that the collection has exactly one element, '
                . '"%d" elements found',
                $this->count()
            ));
        }
 
        return reset($this->elements);
    }

References SAML2\Utilities\ArrayCollection\count(), and sprintf.

Here is the call graph for this function:

◆ last()

SAML2\Utilities\ArrayCollection::last ( )

Return the last element from the collection.

Returns: mixed

Implements SAML2\Utilities\Collection.

Definition at line 76 of file ArrayCollection.php.

    {
        return end($this->elements);
    }

◆ map()

SAML2\Utilities\ArrayCollection::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

Implements SAML2\Utilities\Collection.

Definition at line 81 of file ArrayCollection.php.

    {
        return new self(array_map($function, $this->elements));
    }

References $function.

◆ offsetExists()

SAML2\Utilities\ArrayCollection::offsetExists ( $offset )

Definition at line 96 of file ArrayCollection.php.

    {
        return isset($this->elements[$offset]);
    }

◆ offsetGet()

SAML2\Utilities\ArrayCollection::offsetGet ( $offset )

Definition at line 101 of file ArrayCollection.php.

    {
        return $this->elements[$offset];
    }

◆ offsetSet()

SAML2\Utilities\ArrayCollection::offsetSet	(	$offset,
		$value
	)

Definition at line 106 of file ArrayCollection.php.

    {
        $this->elements[$offset] = $value;
    }

◆ offsetUnset()

SAML2\Utilities\ArrayCollection::offsetUnset ( $offset )

Definition at line 111 of file ArrayCollection.php.

    {
        unset($this->elements[$offset]);
    }

◆ remove()

SAML2\Utilities\ArrayCollection::remove ( $element )

Parameters

$element

Implements SAML2\Utilities\Collection.

Definition at line 44 of file ArrayCollection.php.

    {
        $key = array_search($element, $this->elements);
 
        if ($key === false) {
            return false;
        }
 
        $removed = $this->elements[$key];
        unset($this->elements[$key]);
 
        return $removed;
    }

References $key.

◆ set()

SAML2\Utilities\ArrayCollection::set	(	$key,
		$value
	)

Set the value for index.

Parameters

mixed	$key
mixed	$value

Implements SAML2\Utilities\Collection.

Definition at line 39 of file ArrayCollection.php.

    {
        $this->elements[$key] = $value;
    }

References $key.

Field Documentation

◆ $elements

SAML2\Utilities\ArrayCollection::$elements

protected

Definition at line 17 of file ArrayCollection.php.

Referenced by SAML2\Utilities\ArrayCollection\__construct().

The documentation for this class was generated from the following file:

libs/composer/vendor/simplesamlphp/saml2/src/SAML2/Utilities/ArrayCollection.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ count()

◆ filter()

◆ first()

◆ get()

◆ getIterator()

◆ getOnlyElement()

◆ last()

◆ map()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ remove()

◆ set()

Field Documentation

◆ $elements