Class ilBuddySystemArrayCollection A collection which contains all entries of a buddy list. More...

Inheritance diagram for ilBuddySystemArrayCollection:

Collaboration diagram for ilBuddySystemArrayCollection:

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

	getIterator ()
	@inheritDoc More...

	offsetExists ($offset)
	@inheritDoc More...

	offsetGet ($offset)
	@inheritDoc More...

	offsetSet ($offset, $value)
	@inheritDoc More...

	offsetUnset ($offset)
	@inheritDoc More...

	count ()
	@inheritDoc More...

	add ($element)
	@inheritDoc More...

	remove ($key)
	@inheritDoc More...

	removeElement ($element)
	@inheritDoc More...

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

	getKey ($element)
	@inheritDoc More...

	clear ()
	@inheritDoc More...

	contains ($element)
	@inheritDoc More...

	get ($key)
	@inheritDoc More...

	set ($key, $value)
	@inheritDoc More...

	isEmpty ()
	@inheritDoc More...

	getKeys ()
	@inheritDoc More...

	getValues ()
	@inheritDoc More...

	filter (callable $callable)
	@inheritDoc More...

	slice (int $offset, int $length=null)
	@inheritDoc More...

	toArray ()
	@inheritDoc More...

	equals ($other)

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

	remove ($key)

	removeElement ($element)

	containsKey ($key)

	getKey ($element)

	clear ()
	Clears the list. More...

	contains ($element)

	get ($key)

	set ($key, $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 ($other)

Private Attributes
array	$elements

Detailed Description

Class ilBuddySystemArrayCollection A collection which contains all entries of a buddy list.

Author: Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

◆ __construct()

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

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

    {
        $this->elements = $elements;
    }

References $elements.

Member Function Documentation

◆ add()

ilBuddySystemArrayCollection::add ( $element )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

Referenced by offsetSet().

Here is the caller graph for this function:

◆ clear()

ilBuddySystemArrayCollection::clear ( )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

◆ contains()

ilBuddySystemArrayCollection::contains ( $element )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

◆ containsKey()

ilBuddySystemArrayCollection::containsKey ( $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 126 of file class.ilBuddySystemArrayCollection.php.

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

References ILIAS\LTI\ToolProvider\$key.

Referenced by offsetExists(), and remove().

Here is the caller graph for this function:

◆ count()

ilBuddySystemArrayCollection::count ( )

@inheritDoc

Definition at line 84 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 ( $other )

Parameters

mixed $other

Returns: bool

Implements ilBuddySystemCollection.

Definition at line 219 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 toArray().

Here is the call graph for this function:

◆ filter()

ilBuddySystemArrayCollection::filter ( callable $callable )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

Referenced by ilBuddySystemRelationStateFilterRule\getStates().

Here is the caller graph for this function:

◆ get()

ilBuddySystemArrayCollection::get ( $key )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

References ILIAS\LTI\ToolProvider\$key.

◆ getIterator()

ilBuddySystemArrayCollection::getIterator ( )

@inheritDoc

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

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

◆ getKey()

ilBuddySystemArrayCollection::getKey ( $element )

@inheritDoc

Implements ilBuddySystemCollection.

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

    {
        return array_search($element, $this->elements, true);
    }

◆ getKeys()

ilBuddySystemArrayCollection::getKeys ( )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

◆ getValues()

ilBuddySystemArrayCollection::getValues ( )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

◆ isEmpty()

ilBuddySystemArrayCollection::isEmpty ( )

@inheritDoc

Implements ilBuddySystemCollection.

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

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

◆ offsetExists()

ilBuddySystemArrayCollection::offsetExists ( $offset )

@inheritDoc

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

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

References containsKey().

Here is the call graph for this function:

◆ offsetGet()

ilBuddySystemArrayCollection::offsetGet ( $offset )

@inheritDoc

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

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

◆ offsetSet()

ilBuddySystemArrayCollection::offsetSet	(	$offset,
		$value
	)

@inheritDoc

Definition at line 62 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 ( $offset )

@inheritDoc

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

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

◆ remove()

ilBuddySystemArrayCollection::remove ( $key )

@inheritDoc

Implements ilBuddySystemCollection.

Definition at line 100 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 ILIAS\LTI\ToolProvider\$key, and containsKey().

Here is the call graph for this function:

◆ removeElement()

ilBuddySystemArrayCollection::removeElement ( $element )

@inheritDoc

Implements ilBuddySystemCollection.

Definition at line 111 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]);
    }

References ILIAS\LTI\ToolProvider\$key.

◆ set()

ilBuddySystemArrayCollection::set	(	$key,
		$value
	)

@inheritDoc

Implements ilBuddySystemCollection.

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

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

References ILIAS\LTI\ToolProvider\$key.

◆ slice()

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

@inheritDoc

Implements ilBuddySystemCollection.

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

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

◆ toArray()

ilBuddySystemArrayCollection::toArray ( )

@inheritDoc

Implements ilBuddySystemCollection.

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

                             : array
    {
        return $this->elements;
    }

References $elements.

Referenced by equals().

Here is the caller graph for this function:

Field Documentation

◆ $elements

array ilBuddySystemArrayCollection::$elements

private

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

Referenced by __construct(), and toArray().

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

Services/Contact/BuddySystem/classes/class.ilBuddySystemArrayCollection.php

Public Member Functions

Private Attributes

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()

Field Documentation

◆ $elements