ILIAS\Awareness\User\Collection Class Reference

Represents a set of collected users. More...

Inheritance diagram for ILIAS\Awareness\User\Collection:

Collaboration diagram for ILIAS\Awareness\User\Collection:

Public Member Functions
	addUser (int $a_id)
	removeUser (int $a_id)
	getUsers ()
	count ()

Protected Attributes
array	$users = array()

Detailed Description

Represents a set of collected users.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

Definition at line 25 of file class.Collection.php.

Member Function Documentation

addUser()

ILIAS\Awareness\User\Collection::addUser

(

int

$a_id

)

Parameters

int

$a_id

user id

Definition at line 33 of file class.Collection.php.

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

Referenced by ILIAS\Awareness\User\Collector\collectUsers(), and ILIAS\Awareness\User\Collector\collectUsersFromProvider().

Here is the caller graph for this function:

count()

ILIAS\Awareness\User\Collection::count

(

)

Definition at line 56 of file class.Collection.php.

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

References ILIAS\Awareness\User\Collection\count().

Referenced by ILIAS\Awareness\User\Collection\count().

Here is the call graph for this function:

Here is the caller graph for this function:

getUsers()

ILIAS\Awareness\User\Collection::getUsers

(

)

Returns

int[] array of user ids

Definition at line 51 of file class.Collection.php.

                              : array
    {
        return $this->users;
    }

References ILIAS\Awareness\User\Collection\$users.

removeUser()

ILIAS\Awareness\User\Collection::removeUser

(

int

$a_id

)

Parameters

int

$a_id

user id

Definition at line 41 of file class.Collection.php.

                                         : void
    {
        if (isset($this->users[$a_id])) {
            unset($this->users[$a_id]);
        }
    }

Field Documentation

$users

array ILIAS\Awareness\User\Collection::$users = array()

protected

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

Referenced by ILIAS\Awareness\User\Collection\getUsers().

---

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

• components/ILIAS/Awareness/User/class.Collection.php