ILIAS\Awareness\User\ProviderAllUsers Class Reference

Test provider, adds all users. More...

Inheritance diagram for ILIAS\Awareness\User\ProviderAllUsers:

Collaboration diagram for ILIAS\Awareness\User\ProviderAllUsers:

Public Member Functions
	__construct (Container $DIC)
	getProviderId ()
	getTitle ()
	Provider title (used in awareness overlay and in administration settings) More...
	getInfo ()
	Provider info (used in administration settings) More...
	getInitialUserSet (?array $user_ids=null)
	Get initial set of users. More...
	isHighlighted ()
	Is highlighted. More...
	getProviderId ()
	getTitle ()
	Provider title (used in awareness overlay and in administration settings) More...
	getInfo ()
	Provider info (used in administration settings) More...
	getInitialUserSet (?array $user_ids=null)
	Get initial set of users. More...
	isHighlighted ()
	Is highlighted. More...

Protected Attributes
ilLanguage	$lng
ilDBInterface	$db

Detailed Description

Test provider, adds all users.

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\Awareness\User\ProviderAllUsers::__construct

(

Container

$DIC

)

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

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

References $DIC, ILIAS\DI\Container\language(), and ILIAS\Repository\lng().

Here is the call graph for this function:

Member Function Documentation

getInfo()

ILIAS\Awareness\User\ProviderAllUsers::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Implements ILIAS\Awareness\User\Provider.

Definition at line 57 of file class.ProviderAllUsers.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

getInitialUserSet()

ILIAS\Awareness\User\ProviderAllUsers::getInitialUserSet

(

?array

$user_ids = null

)

Get initial set of users.

Parameters

?int[]

$user_ids

Returns

int[] array of user IDs

Implements ILIAS\Awareness\User\Provider.

Definition at line 68 of file class.ProviderAllUsers.php.

                                                              : array
    {
        $ilDB = $this->db;
 
        $ub = array();
        // all online users
        if (!is_null($user_ids)) {
            return $user_ids;
        } else {        // all users
            $set = $ilDB->query("SELECT usr_id FROM usr_data ");
            while ($rec = $ilDB->fetchAssoc($set)) {
                $ub[] = (int) $rec["usr_id"];
            }
        }
        return $ub;
    }

References ILIAS\Awareness\User\ProviderAllUsers\$db, $ilDB, and ILIAS\Repository\int().

Here is the call graph for this function:

getProviderId()

ILIAS\Awareness\User\ProviderAllUsers::getProviderId

(

)

Implements ILIAS\Awareness\User\Provider.

Definition at line 38 of file class.ProviderAllUsers.php.

                                   : string
    {
        return "user_all";
    }

getTitle()

ILIAS\Awareness\User\ProviderAllUsers::getTitle

(

)

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

Returns

string provider title

Implements ILIAS\Awareness\User\Provider.

Definition at line 47 of file class.ProviderAllUsers.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

isHighlighted()

ILIAS\Awareness\User\ProviderAllUsers::isHighlighted

(

)

Is highlighted.

Returns

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

Implements ILIAS\Awareness\User\Provider.

Definition at line 85 of file class.ProviderAllUsers.php.

                                   : bool
    {
        return false;
    }

Field Documentation

$db

ilDBInterface ILIAS\Awareness\User\ProviderAllUsers::$db

protected

Definition at line 30 of file class.ProviderAllUsers.php.

Referenced by ILIAS\Awareness\User\ProviderAllUsers\getInitialUserSet().

$lng

ilLanguage ILIAS\Awareness\User\ProviderAllUsers::$lng

protected

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

---

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

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