Class ilBuddySystemArrayCollection A generic array based collection class. More...

Inheritance diagram for ilBuddySystemArrayCollection:

Collaboration diagram for ilBuddySystemArrayCollection:

Public Member Functions
	__construct (private array $elements=[])

	getIterator ()

	offsetExists (mixed $offset)

	offsetGet (mixed $offset)

	offsetSet (mixed $offset, mixed $value)

	offsetUnset (mixed $offset)

	count ()

	add (mixed $element)
	Adds an element at the end of the collection. More...

	remove (string\|int $key)

	removeElement (mixed $element)

	containsKey (string\|int $key)
	isset is used for performance reasons (array_key_exists is much slower). More...

	getKey ($element)

	clear ()
	Clears the list. More...

	contains (mixed $element)
	@phpstan-param T $element More...

	get (string\|int $key)

	set (string\|int $key, mixed $value)

	isEmpty ()

	getKeys ()
	Gets all indices of the collection. More...

	getValues ()
	Gets all values of the collection. More...

	filter (callable $callable)
	Returns all the elements of this collection that satisfy the predicate $callable. More...

	slice (int $offset, ?int $length=null)
	Extracts a slice of $length elements starting at position $offset from the Collection. More...

	toArray ()

	equals (mixed $other)

Public Member Functions inherited from ilBuddySystemCollection
	add (mixed $element)
	Adds an element at the end of the collection. More...

	remove (string\|int $key)

	removeElement (mixed $element)

	containsKey (string\|int $key)

	getKey (mixed $element)

	clear ()
	Clears the list. More...

	contains (mixed $element)
	@phpstan-param T $element More...

	get (string\|int $key)

	set (string\|int $key, mixed $value)

	isEmpty ()

	getKeys ()
	Gets all indices of the collection. More...

	getValues ()
	Gets all values of the collection. More...

	filter (callable $callable)
	Returns all the elements of this collection that satisfy the predicate $callable. More...

	slice (int $offset, ?int $length=null)
	Extracts a slice of $length elements starting at position $offset from the Collection. More...

	toArray ()

	equals (mixed $other)

Detailed Description

Class ilBuddySystemArrayCollection A generic array based collection class.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de @template T @template TKey @template-implements ilBuddySystemCollection<TKey,T>

Definition at line 29 of file class.ilBuddySystemArrayCollection.php.

Constructor & Destructor Documentation

◆ __construct()

ilBuddySystemArrayCollection::__construct ( private array $elements = [] )

Parameters

array<string|int,mixed> $elements @phpstan-param array<TKey, T> $elements

Definition at line 35 of file class.ilBuddySystemArrayCollection.php.

36 {

37 }

Member Function Documentation

◆ add()

ilBuddySystemArrayCollection::add ( mixed $element )

Adds an element at the end of the collection.

@phpstan-param T $element

Implements ilBuddySystemCollection.

Definition at line 75 of file class.ilBuddySystemArrayCollection.php.

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

Referenced by offsetSet().

Here is the caller graph for this function:

◆ clear()

ilBuddySystemArrayCollection::clear ( )

Clears the list.

Implements ilBuddySystemCollection.

Definition at line 113 of file class.ilBuddySystemArrayCollection.php.

                           : void
    {
        $this->elements = [];
    }

◆ contains()

ilBuddySystemArrayCollection::contains ( mixed $element )

@phpstan-param T $element

Returns: bool true if the collection contains the element, false otherwise.

Implements ilBuddySystemCollection.

Definition at line 118 of file class.ilBuddySystemArrayCollection.php.

                                            : bool
    {
        return in_array($element, $this->elements, true);
    }

◆ containsKey()

ilBuddySystemArrayCollection::containsKey ( string|int $key )

isset is used for performance reasons (array_key_exists is much slower).

array_key_exists is only used in case of a null value (see https://www.php.net/manual/en/function.array-key-exists.php Example #2 array_key_exists() vs isset()).

@inheritDoc

Implements ilBuddySystemCollection.

Definition at line 103 of file class.ilBuddySystemArrayCollection.php.

                                                : bool
    {
        return isset($this->elements[$key]) || array_key_exists($key, $this->elements);
    }

Referenced by offsetExists(), and remove().

Here is the caller graph for this function:

◆ count()

ilBuddySystemArrayCollection::count ( )

Definition at line 70 of file class.ilBuddySystemArrayCollection.php.

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

References count().

Referenced by count().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ equals()

ilBuddySystemArrayCollection::equals ( mixed $other )

Implements ilBuddySystemCollection.

Definition at line 163 of file class.ilBuddySystemArrayCollection.php.

                                        : bool
    {
        if (!($other instanceof self)) {
            return false;
        }
 
        $self = $this->toArray();
        $other = $other->toArray();
 
        sort($self);
        sort($other);
 
        return $self == $other;
    }

References ILIAS\UI\examples\Symbol\Glyph\Sort\sort(), and toArray().

Here is the call graph for this function:

◆ filter()

ilBuddySystemArrayCollection::filter ( callable $callable )

Returns all the elements of this collection that satisfy the predicate $callable.

Implements ilBuddySystemCollection.

Definition at line 148 of file class.ilBuddySystemArrayCollection.php.

                                              : self
    {
        return new static(array_filter($this->elements, $callable));
    }

◆ get()

ilBuddySystemArrayCollection::get ( string|int $key )

Parameters

string | int $key The index of the element to get. @phpstan-param TKey $key @phpstan-return T|null

Implements ilBuddySystemCollection.

Definition at line 123 of file class.ilBuddySystemArrayCollection.php.

                                        : mixed
    {
        return $this->elements[$key] ?? null;
    }

◆ getIterator()

ilBuddySystemArrayCollection::getIterator ( )

Definition at line 39 of file class.ilBuddySystemArrayCollection.php.

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

◆ getKey()

ilBuddySystemArrayCollection::getKey ( $element )

Definition at line 108 of file class.ilBuddySystemArrayCollection.php.

                                    : string|int
    {
        return array_search($element, $this->elements, true);
    }

Referenced by ILIAS\Contact\BuddySystem\Tables\RelationsTable\filter().

Here is the caller graph for this function:

◆ getKeys()

ilBuddySystemArrayCollection::getKeys ( )

Gets all indices of the collection.

Returns: string[]|int[] The indices of the collection, in the order of the corresponding elements in the collection. @phpstan-return list<TKey>

Implements ilBuddySystemCollection.

Definition at line 138 of file class.ilBuddySystemArrayCollection.php.

                             : array
    {
        return array_keys($this->elements);
    }

◆ getValues()

ilBuddySystemArrayCollection::getValues ( )

Gets all values of the collection.

Returns: list<mixed> The values of all elements in the collection, in the order they appear in the collection. @phpstan-return list<T>

Implements ilBuddySystemCollection.

Definition at line 143 of file class.ilBuddySystemArrayCollection.php.

                               : array
    {
        return array_values($this->elements);
    }

◆ isEmpty()

ilBuddySystemArrayCollection::isEmpty ( )

Returns: bool true if the collection is empty, false otherwise.

Implements ilBuddySystemCollection.

Definition at line 133 of file class.ilBuddySystemArrayCollection.php.

                             : bool
    {
        return empty($this->elements);
    }

◆ offsetExists()

ilBuddySystemArrayCollection::offsetExists ( mixed $offset )

Definition at line 44 of file class.ilBuddySystemArrayCollection.php.

                                               : bool
    {
        return $this->containsKey($offset);
    }

References containsKey().

Here is the call graph for this function:

◆ offsetGet()

ilBuddySystemArrayCollection::offsetGet ( mixed $offset )

Definition at line 49 of file class.ilBuddySystemArrayCollection.php.

                                            : mixed
    {
        return $this->get($offset);
    }

◆ offsetSet()

ilBuddySystemArrayCollection::offsetSet	(	mixed	$offset,
		mixed	$value
	)

Definition at line 54 of file class.ilBuddySystemArrayCollection.php.

                                                          : void
    {
        if (!isset($offset)) {
            $this->add($value);
 
            return;
        }
 
        $this->set($offset, $value);
    }

References add().

Here is the call graph for this function:

◆ offsetUnset()

ilBuddySystemArrayCollection::offsetUnset ( mixed $offset )

Definition at line 65 of file class.ilBuddySystemArrayCollection.php.

                                              : void
    {
        $this->remove($offset);
    }

◆ remove()

ilBuddySystemArrayCollection::remove ( string|int $key )

Parameters

string | int $key The index of the element to remove. @phpstan-param TKey $key

Exceptions

InvalidArgumentException

Implements ilBuddySystemCollection.

Definition at line 80 of file class.ilBuddySystemArrayCollection.php.

                                           : void
    {
        if (!$this->containsKey($key)) {
            throw new InvalidArgumentException(sprintf('Could not find an element for key: %s', $key));
        }
        unset($this->elements[$key]);
    }

References containsKey().

Here is the call graph for this function:

◆ removeElement()

ilBuddySystemArrayCollection::removeElement ( mixed $element )

Parameters

mixed $element The element to remove. @phpstan-param T $element

Exceptions

InvalidArgumentException

Implements ilBuddySystemCollection.

Definition at line 88 of file class.ilBuddySystemArrayCollection.php.

                                                 : void
    {
        $key = array_search($element, $this->elements, true);
        if (false === $key) {
            throw new InvalidArgumentException('Could not find an key for the passed element.');
        }
        unset($this->elements[$key]);
    }

◆ set()

ilBuddySystemArrayCollection::set	(	string\|int	$key,
		mixed	$value
	)

Parameters

string | int $key The index of the element to set. @phpstan-param TKey $key @phpstan-param T $value

Implements ilBuddySystemCollection.

Definition at line 128 of file class.ilBuddySystemArrayCollection.php.

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

◆ slice()

ilBuddySystemArrayCollection::slice	(	int	$offset,
		?int	$length = `null`
	)

Extracts a slice of $length elements starting at position $offset from the Collection.

If $length is null it returns all elements from $offset to the end of the Collection. Calling this method will only return the selected slice and NOT change the elements contained in the collection slice is called on.

Parameters

int	$offset	The offset to start from.
int \| null	$length	The maximum number of elements to return, or null for no limit.

Implements ilBuddySystemCollection.

Definition at line 153 of file class.ilBuddySystemArrayCollection.php.

                                                           : self
    {
        return new static(array_slice($this->elements, $offset, $length, true));
    }

◆ toArray()

ilBuddySystemArrayCollection::toArray ( )

Returns: array<int|string, mixed> @psalm-return array<TKey, T>

Implements ilBuddySystemCollection.

Definition at line 158 of file class.ilBuddySystemArrayCollection.php.

                             : array
    {
        return $this->elements;
    }

Referenced by equals().

Here is the caller graph for this function:

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

components/ILIAS/Contact/BuddySystem/classes/class.ilBuddySystemArrayCollection.php

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ add()

◆ clear()

◆ contains()

◆ containsKey()

◆ count()

◆ equals()

◆ filter()

◆ get()

◆ getIterator()

◆ getKey()

◆ getKeys()

◆ getValues()

◆ isEmpty()

◆ offsetExists()

◆ offsetGet()

◆ offsetSet()

◆ offsetUnset()

◆ remove()

◆ removeElement()

◆ set()

◆ slice()

◆ toArray()