A class that provides a collection of users for the awareness tool. More...

Inheritance diagram for ilAwarenessUserProvider:

Collaboration diagram for ilAwarenessUserProvider:

Public Member Functions
	__construct ()
	Constructor. More...

	setActivationMode ($a_val)
	Activate provider. More...

	getActivationMode ()
	Get Activate provider. More...

	setUserId ($a_val)
	Set user id. More...

	getUserId ()
	Get user id. More...

	setRefId ($a_val)
	Set ref id. More...

	getRefId ()
	Get ref id. More...

	setOnlineUserFilter ($a_val)
	Set online user filter. More...

	getOnlineUserFilter ()
	Get online user filter. More...

	getProviderId ()
	This should return a unique id for the provider The ID should start with the service/module id, separated by "_" and a second part that is unique within the module/service, e.g. More...

	getTitle ()
	Provider title (used in awareness overlay and in administration settings) More...

	getInfo ()
	Provider info (used in administration settings) More...

	getInitialUserSet ()
	Get initial set of users. More...

	collectUsers ()
	Collect all users. More...

	isHighlighted ()
	Is highlighted. More...

Data Fields
const	MODE_INACTIVE = 0

const	MODE_ONLINE_ONLY = 1

const	MODE_INCL_OFFLINE = 2

Protected Member Functions
	addUserToCollection ($a_user_id, ilAwarenessUserCollection $a_collection)
	Add user to collection. More...

Protected Attributes
	$user_id

	$ref_id

	$lng

	$db

	$online_user_filter = false

	$log

Detailed Description

A class that provides a collection of users for the awareness tool.

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.ilAwarenessUserProvider.php.

Constructor & Destructor Documentation

◆ __construct()

ilAwarenessUserProvider::__construct ( )

Constructor.

Definition at line 32 of file class.ilAwarenessUserProvider.php.

References $DIC, $ilDB, $lng, ilLoggerFactory\getLogger(), and settings().

     {
         global $DIC;
 
         $lng = $DIC->language();
         $ilDB = $DIC->database();
 
         $this->lng = $lng;
         $this->db = $ilDB;
         $this->settings = new ilSetting("awrn");
         $this->log = ilLoggerFactory::getLogger('awrn');
     }

Here is the call graph for this function:

Member Function Documentation

◆ addUserToCollection()

ilAwarenessUserProvider::addUserToCollection	(		$a_user_id,
		ilAwarenessUserCollection	$a_collection
	)

protected

Add user to collection.

Parameters

int	$a_user_id	user id
ilAwarenessUserCollection	$a_collection	collection

Definition at line 177 of file class.ilAwarenessUserProvider.php.

References ilAwarenessUserCollection\addUser(), getOnlineUserFilter(), and getUserId().

Referenced by collectUsers().

     {
         $ou = $this->getOnlineUserFilter();
         if ($this->getUserId() != $a_user_id && ($ou === false || in_array($a_user_id, $ou))) {
             $a_collection->addUser($a_user_id);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectUsers()

ilAwarenessUserProvider::collectUsers ( )

Collect all users.

Returns

Definition at line 160 of file class.ilAwarenessUserProvider.php.

References addUserToCollection(), getInitialUserSet(), and ilAwarenessUserCollection\getInstance().

     {
         $coll = ilAwarenessUserCollection::getInstance();
 
         foreach ($this->getInitialUserSet() as $u) {
             $this->addUserToCollection($u, $coll);
         }
 
         return $coll;
     }

Here is the call graph for this function:

◆ getActivationMode()

ilAwarenessUserProvider::getActivationMode ( )

Get Activate provider.

Returns: boolean activate provider

Definition at line 60 of file class.ilAwarenessUserProvider.php.

References getProviderId(), and settings().

     {
         return (int) $this->settings->get("up_act_" . $this->getProviderId());
     }

Here is the call graph for this function:

◆ getInfo()

ilAwarenessUserProvider::getInfo ( )

abstract

Provider info (used in administration settings)

Returns: string provider info text

Referenced by getOnlineUserFilter().

Here is the caller graph for this function:

◆ getInitialUserSet()

ilAwarenessUserProvider::getInitialUserSet ( )

abstract

Get initial set of users.

Returns: array array of user IDs

Referenced by collectUsers(), and getOnlineUserFilter().

Here is the caller graph for this function:

◆ getOnlineUserFilter()

ilAwarenessUserProvider::getOnlineUserFilter ( )

Get online user filter.

Returns: array array of user IDs | false if online status is not relevant

Definition at line 120 of file class.ilAwarenessUserProvider.php.

References $online_user_filter, getInfo(), getInitialUserSet(), getProviderId(), and getTitle().

Referenced by addUserToCollection(), and ilAwarenessUserProviderAllUsers\getInitialUserSet().

     {
         return $this->online_user_filter;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProviderId()

ilAwarenessUserProvider::getProviderId ( )

abstract

This should return a unique id for the provider The ID should start with the service/module id, separated by "_" and a second part that is unique within the module/service, e.g.

"user_all"

Returns: string provider id

Referenced by getActivationMode(), getOnlineUserFilter(), and setActivationMode().

Here is the caller graph for this function:

◆ getRefId()

ilAwarenessUserProvider::getRefId ( )

Get ref id.

Returns: int ref id

Definition at line 100 of file class.ilAwarenessUserProvider.php.

References $ref_id.

Referenced by ilAwarenessUserProviderCurrentCourse\getInitialUserSet().

     {
         return $this->ref_id;
     }

Here is the caller graph for this function:

◆ getTitle()

ilAwarenessUserProvider::getTitle ( )

abstract

Provider title (used in awareness overlay and in administration settings)

Returns: string provider title

Referenced by getOnlineUserFilter().

Here is the caller graph for this function:

◆ getUserId()

ilAwarenessUserProvider::getUserId ( )

Get user id.

Returns: int user id

Definition at line 80 of file class.ilAwarenessUserProvider.php.

References $user_id.

Referenced by addUserToCollection(), ilAwarenessUserProviderCourseContacts\getInitialUserSet(), and ilAwarenessUserProviderMemberships\getInitialUserSet().

     {
         return $this->user_id;
     }

Here is the caller graph for this function:

◆ isHighlighted()

ilAwarenessUserProvider::isHighlighted ( )

Is highlighted.

Returns: bool return true, if user group should be highlighted (using extra highlighted number)

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

     {
         return false;
     }

◆ setActivationMode()

ilAwarenessUserProvider::setActivationMode ( $a_val )

Activate provider.

Parameters

boolean $a_val activate provider

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

References getProviderId(), and settings().

     {
         $this->settings->set("up_act_" . $this->getProviderId(), (int) $a_val);
     }

Here is the call graph for this function:

◆ setOnlineUserFilter()

ilAwarenessUserProvider::setOnlineUserFilter ( $a_val )

Set online user filter.

Parameters

array $a_val array of user IDs | false if online status is not relevant

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

     {
         $this->online_user_filter = $a_val;
     }

◆ setRefId()

ilAwarenessUserProvider::setRefId ( $a_val )

Set ref id.

Parameters

int $a_val ref id

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

     {
         $this->ref_id = $a_val;
     }

◆ setUserId()

ilAwarenessUserProvider::setUserId ( $a_val )

Set user id.

Parameters

int $a_val user id

Definition at line 70 of file class.ilAwarenessUserProvider.php.

     {
         $this->user_id = $a_val;
     }

Field Documentation

◆ $db

ilAwarenessUserProvider::$db

protected

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

Referenced by ilAwarenessUserProviderAllUsers\getInitialUserSet(), ilAwarenessUserProviderMemberships\getInitialUserSet(), and ilAwarenessUserProviderCurrentCourse\getInitialUserSet().

◆ $lng

ilAwarenessUserProvider::$lng

protected

Definition at line 20 of file class.ilAwarenessUserProvider.php.

Referenced by __construct().

◆ $log

ilAwarenessUserProvider::$log

protected

Definition at line 27 of file class.ilAwarenessUserProvider.php.

◆ $online_user_filter

ilAwarenessUserProvider::$online_user_filter = false

protected

Definition at line 22 of file class.ilAwarenessUserProvider.php.

Referenced by getOnlineUserFilter().

◆ $ref_id

ilAwarenessUserProvider::$ref_id

protected

Definition at line 19 of file class.ilAwarenessUserProvider.php.

Referenced by ilAwarenessUserProviderMemberships\getInitialUserSet(), and getRefId().

◆ $user_id

ilAwarenessUserProvider::$user_id

protected

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

Referenced by getUserId().

◆ MODE_INACTIVE

const ilAwarenessUserProvider::MODE_INACTIVE = 0

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

Referenced by ilAwarenessUserCollector\collectUsers(), and ilObjAwarenessAdministrationGUI\initFormSettings().

◆ MODE_INCL_OFFLINE

const ilAwarenessUserProvider::MODE_INCL_OFFLINE = 2

Definition at line 16 of file class.ilAwarenessUserProvider.php.

Referenced by ilAwarenessUserCollector\collectUsers(), and ilObjAwarenessAdministrationGUI\initFormSettings().

◆ MODE_ONLINE_ONLY

const ilAwarenessUserProvider::MODE_ONLINE_ONLY = 1

Definition at line 15 of file class.ilAwarenessUserProvider.php.

Referenced by ilAwarenessUserCollector\collectUsers(), and ilObjAwarenessAdministrationGUI\initFormSettings().

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

Services/Awareness/classes/class.ilAwarenessUserProvider.php

Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addUserToCollection()

◆ collectUsers()

◆ getActivationMode()

◆ getInfo()

◆ getInitialUserSet()

◆ getOnlineUserFilter()

◆ getProviderId()

◆ getRefId()

◆ getTitle()

◆ getUserId()

◆ isHighlighted()

◆ setActivationMode()

◆ setOnlineUserFilter()

◆ setRefId()

◆ setUserId()

Field Documentation

◆ $db

◆ $lng

◆ $log

◆ $online_user_filter

◆ $ref_id

◆ $user_id

◆ MODE_INACTIVE

◆ MODE_INCL_OFFLINE

◆ MODE_ONLINE_ONLY