ceLTIc\LTI\User\ProviderMemberships Class Reference

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

Inheritance diagram for ceLTIc\LTI\User\ProviderMemberships:

Collaboration diagram for ceLTIc\LTI\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...

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()

ceLTIc\LTI\User\ProviderMemberships::__construct

(

Container

$DIC

)

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

References ILIAS\Repository\lng(), and ILIAS\Repository\user().

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

Here is the call graph for this function:

Member Function Documentation

getInfo()

ceLTIc\LTI\User\ProviderMemberships::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Implements ceLTIc\LTI\User\Provider.

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getInitialUserSet()

ceLTIc\LTI\User\ProviderMemberships::getInitialUserSet

(

?array

$user_ids = null

)

Get initial set of users.

Parameters

?int[]

$user_ids

Returns

int[] array of user IDs

Implements ceLTIc\LTI\User\Provider.

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

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

                                                              : 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;
    }

Here is the call graph for this function:

getProviderId()

ceLTIc\LTI\User\ProviderMemberships::getProviderId

(

)

Get provider id.

Returns

string provider id

Implements ceLTIc\LTI\User\Provider.

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

                                   : string
    {
        return "mmbr_user_grpcrs";
    }

getTitle()

ceLTIc\LTI\User\ProviderMemberships::getTitle

(

)

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

Returns

string provider title

Implements ceLTIc\LTI\User\Provider.

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

isHighlighted()

ceLTIc\LTI\User\ProviderMemberships::isHighlighted

(

)

Is highlighted.

Returns

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

Implements ceLTIc\LTI\User\Provider.

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

                                   : bool
    {
        return false;
    }

Field Documentation

$db

ilDBInterface ceLTIc::LTI\User\ProviderMemberships::$db

protected

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

Referenced by ceLTIc\LTI\User\ProviderMemberships\getInitialUserSet().

$lng

ilLanguage ceLTIc::LTI\User\ProviderMemberships::$lng

protected

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

$user

ilObjUser ceLTIc::LTI\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