ilBuddySystemArrayCollection Class Reference

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=[])
	ilBuddySystemArrayCollection constructor. More...
	getIterator ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	count ()
	add ($element)
	remove ($key)
	removeElement ($element)
	containsKey ($key)
	getKey ($element)
	clear ()
	contains ($element)
	get ($key)
	set ($key, $value)
	isEmpty ()
	getKeys ()
	getValues ()
	filter (callable $callable)
	slice ($offset, $length=null)
	toArray ()

Private Attributes
	$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 9 of file class.ilBuddySystemArrayCollection.php.

Constructor & Destructor Documentation

__construct()

ilBuddySystemArrayCollection::__construct

(

array

$elements = []

)

ilBuddySystemArrayCollection constructor.

Parameters

array

$elements

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

References $elements.

    {
        $this->elements = $elements;
    }

Member Function Documentation

add()

ilBuddySystemArrayCollection::add

(

$element

)

Implements ilBuddySystemCollection.

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

Referenced by offsetSet().

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

Here is the caller graph for this function:

clear()

ilBuddySystemArrayCollection::clear

(

)

Implements ilBuddySystemCollection.

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

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

contains()

ilBuddySystemArrayCollection::contains

(

$element

)

Implements ilBuddySystemCollection.

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

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

containsKey()

ilBuddySystemArrayCollection::containsKey

(

$key

)

Implements ilBuddySystemCollection.

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

Referenced by offsetExists().

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

Here is the caller graph for this function:

count()

ilBuddySystemArrayCollection::count

(

)

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

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

filter()

ilBuddySystemArrayCollection::filter

(

callable

$callable

)

Implements ilBuddySystemCollection.

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

Referenced by ilBuddySystemRelationStateFilterRule\getStates().

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

Here is the caller graph for this function:

get()

ilBuddySystemArrayCollection::get

(

$key

)

Implements ilBuddySystemCollection.

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

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

getIterator()

ilBuddySystemArrayCollection::getIterator

(

)

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

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

getKey()

ilBuddySystemArrayCollection::getKey

(

$element

)

Implements ilBuddySystemCollection.

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

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

getKeys()

ilBuddySystemArrayCollection::getKeys

(

)

Implements ilBuddySystemCollection.

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

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

getValues()

ilBuddySystemArrayCollection::getValues

(

)

Implements ilBuddySystemCollection.

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

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

isEmpty()

ilBuddySystemArrayCollection::isEmpty

(

)

Implements ilBuddySystemCollection.

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

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

offsetExists()

ilBuddySystemArrayCollection::offsetExists

(

$offset

)

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

References containsKey().

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

Here is the call graph for this function:

offsetGet()

ilBuddySystemArrayCollection::offsetGet

(

$offset

)

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

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

offsetSet()

ilBuddySystemArrayCollection::offsetSet	(		$offset,
			$value
	)

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

References add().

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

        $this->set($offset, $value);
    }

Here is the call graph for this function:

offsetUnset()

ilBuddySystemArrayCollection::offsetUnset

(

$offset

)

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

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

remove()

ilBuddySystemArrayCollection::remove

(

$key

)

Implements ilBuddySystemCollection.

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

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

removeElement()

ilBuddySystemArrayCollection::removeElement

(

$element

)

Implements ilBuddySystemCollection.

Definition at line 98 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	(		$key,
			$value
	)

Implements ilBuddySystemCollection.

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

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

slice()

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

Implements ilBuddySystemCollection.

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

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

toArray()

ilBuddySystemArrayCollection::toArray

(

)

Implements ilBuddySystemCollection.

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

References $elements.

                              : array
    {
        return $this->elements;
    }

Field Documentation

$elements

ilBuddySystemArrayCollection::$elements = []

private

Definition at line 12 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