ilAwarenessUserProviderAllUsers Class Reference

Test provider, adds all users. More...

Inheritance diagram for ilAwarenessUserProviderAllUsers:

Collaboration diagram for ilAwarenessUserProviderAllUsers:

Public Member Functions
	__construct ()
	Constructor. More...
	getProviderId ()
	Get provider id. 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...
Public Member Functions inherited from ilAwarenessUserProvider
	__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...

Additional Inherited Members
Data Fields inherited from ilAwarenessUserProvider
const	MODE_INACTIVE = 0
const	MODE_ONLINE_ONLY = 1
const	MODE_INCL_OFFLINE = 2
Protected Member Functions inherited from ilAwarenessUserProvider
	addUserToCollection ($a_user_id, ilAwarenessUserCollection $a_collection)
	Add user to collection. More...
Protected Attributes inherited from ilAwarenessUserProvider
	$user_id
	$ref_id
	$lng
	$db
	$online_user_filter = false
	$log

Detailed Description

Test provider, adds all users.

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilAwarenessUserProviderAllUsers::__construct

(

)

Constructor.

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

References $DIC.

    {
        global $DIC;

        parent::__construct();

        $this->db = $DIC->database();
    }

Member Function Documentation

getInfo()

ilAwarenessUserProviderAllUsers::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Definition at line 55 of file class.ilAwarenessUserProviderAllUsers.php.

    {
        $this->lng->loadLanguageModule("user");
        return $this->lng->txt("user_awrn_all_users_info");
    }

getInitialUserSet()

ilAwarenessUserProviderAllUsers::getInitialUserSet

(

)

Get initial set of users.

Returns

array array of user IDs

Definition at line 66 of file class.ilAwarenessUserProviderAllUsers.php.

References ilAwarenessUserProvider\$db, $ilDB, and ilAwarenessUserProvider\getOnlineUserFilter().

    {
        $ilDB = $this->db;

        $ub = array();
        // all online users
        if ($this->getOnlineUserFilter() !== false) {
            foreach ($this->getOnlineUserFilter() as $u) {
                $ub[] = $u;
            }
        } else {        // all users
            $set = $ilDB->query("SELECT usr_id FROM usr_data ");
            while ($rec = $ilDB->fetchAssoc($set)) {
                $ub[] = $rec["usr_id"];
            }
        }
        return $ub;
    }

Here is the call graph for this function:

getProviderId()

ilAwarenessUserProviderAllUsers::getProviderId

(

)

Get provider id.

Returns

string provider id

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

    {
        return "user_all";
    }

getTitle()

ilAwarenessUserProviderAllUsers::getTitle

(

)

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

Returns

string provider title

Definition at line 44 of file class.ilAwarenessUserProviderAllUsers.php.

    {
        $this->lng->loadLanguageModule("user");
        return $this->lng->txt("user_awrn_all_users");
    }

---

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

• Services/Awareness/classes/class.ilAwarenessUserProviderAllUsers.php