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=array())
	getIterator ()
	offsetExists ($offset)
	offsetGet ($offset)
	offsetSet ($offset, $value)
	offsetUnset ($offset)
	count ()
	add ($element)
	Adds an element at the end of the collection. Parameters mixed $element More...
	remove ($key)
	Parameters string | integer $key The index of the element to remove. Exceptions InvalidArgumentException More...
	removeElement ($element)
	Parameters mixed $element The element to remove. Exceptions InvalidArgumentException More...
	containsKey ($key)
	Parameters string | integer $key The index to check for. Returns boolean true if the collection contains the element, false otherwise. More...
	getKey ($element)
	clear ()
	Clears the list. More...
	contains ($element)
	Parameters mixed $element Returns boolean true if the collection contains the element, false otherwise. More...
	get ($key)
	Parameters string | integer $key The index of the element to get. Returns mixed More...
	set ($key, $value)
	Parameters string  | integer $key The index of the element to set. mixed $value More...
	isEmpty ()
	Returns boolean true if the collection is empty, false otherwise. More...
	getKeys ()
	Gets all indices of the collection. Returns array The indices of the collection, in the order of the corresponding elements in the collection. More...
	getValues ()
	Gets all values of the collection. Returns array The values of all elements in the collection, in the order they appear in the collection. More...
	filter (Closure $p)
	Returns all the elements of this collection that satisfy the predicate $callable. Parameters Closure $closure Returns ilBuddySystemCollection More...
	slice ($offset, $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. Returns ilBuddySystemCollection More...
	toArray ()

Private Attributes
	$elements = array()

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 11 of file class.ilBuddySystemArrayCollection.php.

Constructor & Destructor Documentation

__construct()

ilBuddySystemArrayCollection::__construct

(

array

$elements = array()

)

Parameters

array

$elements

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

References $elements.

    {
        $this->elements = $elements;
    }

Member Function Documentation

add()

ilBuddySystemArrayCollection::add

(

$element

)

Adds an element at the end of the collection.

Parameters

mixed

$element

Implements ilBuddySystemCollection.

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

Referenced by offsetSet().

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

Here is the caller graph for this function:

clear()

ilBuddySystemArrayCollection::clear

(

)

Clears the list.

Implements ilBuddySystemCollection.

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

References array.

    {
        $this->elements = array();
    }

contains()

ilBuddySystemArrayCollection::contains

(

$element

)

Parameters

mixed

$element

Returns

boolean true if the collection contains the element, false otherwise.

Implements ilBuddySystemCollection.

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

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

containsKey()

ilBuddySystemArrayCollection::containsKey

(

$key

)

Parameters

string | integer

$key

The index to check for.

Returns

boolean true if the collection contains the element, false otherwise.

Implements ilBuddySystemCollection.

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

References $key.

Referenced by offsetExists().

    {
        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 74 of file class.ilBuddySystemArrayCollection.php.

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

filter()

ilBuddySystemArrayCollection::filter

(

Closure

$p

)

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

Parameters

Closure

$closure

Returns

ilBuddySystemCollection

Implements ilBuddySystemCollection.

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

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

get()

ilBuddySystemArrayCollection::get

(

$key

)

Parameters

string | integer

$key

The index of the element to get.

Returns

mixed

Implements ilBuddySystemCollection.

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

References $key.

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

getIterator()

ilBuddySystemArrayCollection::getIterator

(

)

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

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

getKey()

ilBuddySystemArrayCollection::getKey

(

$element

)

Parameters

mixed

$element

The element

Returns

string|integer The index of the element.

Implements ilBuddySystemCollection.

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

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

getKeys()

ilBuddySystemArrayCollection::getKeys

(

)

Gets all indices of the collection.

Returns

array The indices of the collection, in the order of the corresponding elements in the collection.

Implements ilBuddySystemCollection.

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

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

getValues()

ilBuddySystemArrayCollection::getValues

(

)

Gets all values of the collection.

Returns

array The values of all elements in the collection, in the order they appear in the collection.

Implements ilBuddySystemCollection.

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

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

isEmpty()

ilBuddySystemArrayCollection::isEmpty

(

)

Returns

boolean true if the collection is empty, false otherwise.

Implements ilBuddySystemCollection.

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

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

offsetExists()

ilBuddySystemArrayCollection::offsetExists

(

$offset

)

Definition at line 37 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 45 of file class.ilBuddySystemArrayCollection.php.

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

offsetSet()

ilBuddySystemArrayCollection::offsetSet	(		$offset,
			$value
	)

Definition at line 53 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 66 of file class.ilBuddySystemArrayCollection.php.

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

remove()

ilBuddySystemArrayCollection::remove

(

$key

)

Parameters

string | integer

$key

The index of the element to remove.

Exceptions

InvalidArgumentException

Implements ilBuddySystemCollection.

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

References $key.

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

removeElement()

ilBuddySystemArrayCollection::removeElement

(

$element

)

Parameters

mixed

$element

The element to remove.

Exceptions

InvalidArgumentException

Implements ilBuddySystemCollection.

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

References $key.

    {
        $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
	)

Parameters

string  | integer	$key	The index of the element to set.
mixed	$value

Implements ilBuddySystemCollection.

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

References $key.

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

slice()

ilBuddySystemArrayCollection::slice	(		$offset,
			$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.

Returns

ilBuddySystemCollection

Implements ilBuddySystemCollection.

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

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

toArray()

ilBuddySystemArrayCollection::toArray

(

)

Returns

array

Implements ilBuddySystemCollection.

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

References $elements.

    {
        return $this->elements;
    }

Field Documentation

$elements

ilBuddySystemArrayCollection::$elements = array()

private

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