Represents a set of collected users. More...

Inheritance diagram for ilAwarenessUserCollection:

Collaboration diagram for ilAwarenessUserCollection:

Public Member Functions
	addUser ($a_id)
	Add user. More...

	removeUser ($a_id)
	Remove user. More...

	getUsers ()
	Get users. More...

	count ()

Static Public Member Functions
static	getInstance ()
	Get instance. More...

Protected Attributes
	$users = array()

Detailed Description

Represents a set of collected users.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 12 of file class.ilAwarenessUserCollection.php.

Member Function Documentation

◆ addUser()

ilAwarenessUserCollection::addUser ( $a_id )

Add user.

Parameters

integer $a_id user id

Definition at line 31 of file class.ilAwarenessUserCollection.php.

Referenced by ilAwarenessUserProvider\addUserToCollection().

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

Here is the caller graph for this function:

◆ count()

ilAwarenessUserCollection::count ( )

Definition at line 61 of file class.ilAwarenessUserCollection.php.

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

◆ getInstance()

static ilAwarenessUserCollection::getInstance ( )

static

Get instance.

Returns: ilAwarenessUserCollection user collection

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

Referenced by ilAwarenessUserCollector\collectUsers(), and ilAwarenessUserProvider\collectUsers().

     {
         return new ilAwarenessUserCollection();
     }

Here is the caller graph for this function:

◆ getUsers()

ilAwarenessUserCollection::getUsers ( )

Get users.

Returns: array array of user ids (integer)

Definition at line 53 of file class.ilAwarenessUserCollection.php.

References $users.

     {
         return $this->users;
     }

◆ removeUser()

ilAwarenessUserCollection::removeUser ( $a_id )

Remove user.

Parameters

integer $a_id user id

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

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

Field Documentation

◆ $users

ilAwarenessUserCollection::$users = array()

protected

Definition at line 14 of file class.ilAwarenessUserCollection.php.

Referenced by getUsers().

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

Services/Awareness/classes/class.ilAwarenessUserCollection.php

Public Member Functions

Static Public Member Functions

Protected Attributes