ILIAS\Awareness\User\ProviderMemberships Class Reference

All members of the same courses/groups as the user. More...

Inheritance diagram for ILIAS\Awareness\User\ProviderMemberships:

Collaboration diagram for ILIAS\Awareness\User\ProviderMemberships:

Public Member Functions
	__construct (Container $DIC)
	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 (?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
ilObjUser	$user
ilLanguage	$lng
ilDBInterface	$db

Detailed Description

All members of the same courses/groups as the user.

Author

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\Awareness\User\ProviderMemberships::__construct

(

Container

$DIC

)

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

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

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

Here is the call graph for this function:

Member Function Documentation

getInfo()

ILIAS\Awareness\User\ProviderMemberships::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Implements ILIAS\Awareness\User\Provider.

Definition at line 63 of file class.ProviderMemberships.php.

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

getInitialUserSet()

ILIAS\Awareness\User\ProviderMemberships::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 74 of file class.ProviderMemberships.php.

                                                              : array
    {
        $ilDB = $this->db;
 
        $groups_and_courses_of_user = \ilParticipants::_getMembershipByType(
            $this->user->getId(),
            ["grp", "crs"]
        );
 
        $set = $ilDB->query(
            "SELECT DISTINCT usr_id FROM obj_members " .
            " WHERE " . $ilDB->in("obj_id", $groups_and_courses_of_user, false, "integer") . ' ' .
            'AND (admin > ' . $ilDB->quote(0, 'integer') . ' ' .
            'OR tutor > ' . $ilDB->quote(0, 'integer') . ' ' .
            'OR member > ' . $ilDB->quote(0, 'integer') . ")"
        );
        $ub = array();
        while ($rec = $ilDB->fetchAssoc($set)) {
            $ub[] = (int) $rec["usr_id"];
        }
 
        return $ub;
    }

References ILIAS\Awareness\User\ProviderMemberships\$db, $ilDB, ilParticipants\_getMembershipByType(), ILIAS\Repository\int(), and ILIAS\Repository\user().

Here is the call graph for this function:

getProviderId()

ILIAS\Awareness\User\ProviderMemberships::getProviderId

(

)

Get provider id.

Returns

string provider id

Implements ILIAS\Awareness\User\Provider.

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

                                   : string
    {
        return "mmbr_user_grpcrs";
    }

getTitle()

ILIAS\Awareness\User\ProviderMemberships::getTitle

(

)

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

Returns

string provider title

Implements ILIAS\Awareness\User\Provider.

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

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

References ILIAS\Repository\lng().

Here is the call graph for this function:

isHighlighted()

ILIAS\Awareness\User\ProviderMemberships::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 98 of file class.ProviderMemberships.php.

                                   : bool
    {
        return false;
    }

Field Documentation

$db

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

protected

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

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

$lng

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

protected

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

$user

ilObjUser ILIAS\Awareness\User\ProviderMemberships::$user

protected

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

---

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

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