ceLTIc\LTI\User\ProviderCurrentCourse Class Reference

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

Inheritance diagram for ceLTIc\LTI\User\ProviderCurrentCourse:

Collaboration diagram for ceLTIc\LTI\User\ProviderCurrentCourse:

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
ilLanguage	$lng
ILIAS Awareness StandardGUIRequest	$request
ILIAS DI RBACServices	$rbac
ilDBInterface	$db
ilTree	$tree
ilAccessHandler	$access

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 28 of file class.ProviderCurrentCourse.php.

Constructor & Destructor Documentation

__construct()

ceLTIc\LTI\User\ProviderCurrentCourse::__construct

(

Container

$DIC

)

Definition at line 37 of file class.ProviderCurrentCourse.php.

References ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\rbac().

    {
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->access = $DIC->access();
        $this->rbac = $DIC->rbac();
        $this->lng = $DIC->language();
        $this->request = $DIC->awareness()
            ->internal()
            ->gui()
            ->standardRequest();
    }

Here is the call graph for this function:

Member Function Documentation

getInfo()

ceLTIc\LTI\User\ProviderCurrentCourse::getInfo

(

)

Provider info (used in administration settings)

Returns

string provider info text

Implements ceLTIc\LTI\User\Provider.

Definition at line 73 of file class.ProviderCurrentCourse.php.

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

getInitialUserSet()

ceLTIc\LTI\User\ProviderCurrentCourse::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 84 of file class.ProviderCurrentCourse.php.

References ceLTIc\LTI\User\ProviderCurrentCourse\$access, ceLTIc\LTI\User\ProviderCurrentCourse\$db, $ilDB, $path, $ref_id, ceLTIc\LTI\User\ProviderCurrentCourse\$tree, ilLoggerFactory\getLogger(), ilObjCourse\lookupShowMembersEnabled(), and ILIAS\Repository\rbac().

                                                              : array
    {
        $ilDB = $this->db;
        $tree = $this->tree;
        $ilAccess = $this->access;
        $rbacreview = $this->rbac->review();

        $ub = array();

        $awrn_logger = \ilLoggerFactory::getLogger('awrn');

        $ref_id = $this->request->getRefId();
        if ($ref_id > 0) {
            $path = $tree->getPathFull($ref_id);
            foreach ($path as $p) {
                if ($p["type"] == "crs" &&
                    ($ilAccess->checkAccess("write", "", $p["child"]) ||
                        (\ilObjCourse::lookupShowMembersEnabled($p["obj_id"]) && $ilAccess->checkAccess("read", "", $p["child"])))) {
                    $lrol = $rbacreview->getRolesOfRoleFolder($p["child"], false);
                    $set = $ilDB->query('SELECT DISTINCT(usr_id) FROM rbac_ua ' .
                        'WHERE ' . $ilDB->in('rol_id', $lrol, false, 'integer'));

                    //$set = $ilDB->query($q = "SELECT DISTINCT usr_id FROM obj_members ".
                    //  " WHERE obj_id = ".$ilDB->quote($p["obj_id"], "integer"));
                    $ub = array();
                    while ($rec = $ilDB->fetchAssoc($set)) {
                        $ub[] = $rec["usr_id"];

                        $awrn_logger->debug("ilAwarenessUserProviderCurrentCourse: obj_id: " . $p["obj_id"] . ", " .
                            "Collected User: " . $rec["usr_id"]);
                    }
                }
            }
        }
        return $ub;
    }

Here is the call graph for this function:

getProviderId()

ceLTIc\LTI\User\ProviderCurrentCourse::getProviderId

(

)

Get provider id.

Returns

string provider id

Implements ceLTIc\LTI\User\Provider.

Definition at line 54 of file class.ProviderCurrentCourse.php.

                                   : string
    {
        return "crs_current";
    }

getTitle()

ceLTIc\LTI\User\ProviderCurrentCourse::getTitle

(

)

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

Returns

string provider title

Implements ceLTIc\LTI\User\Provider.

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

References ILIAS\Repository\lng().

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

Here is the call graph for this function:

isHighlighted()

ceLTIc\LTI\User\ProviderCurrentCourse::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 121 of file class.ProviderCurrentCourse.php.

                                   : bool
    {
        return false;
    }

Field Documentation

$access

ilAccessHandler ceLTIc::LTI\User\ProviderCurrentCourse::$access

protected

Definition at line 35 of file class.ProviderCurrentCourse.php.

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

$db

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

protected

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

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

$lng

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

protected

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

$rbac

ILIAS DI RBACServices ceLTIc::LTI\User\ProviderCurrentCourse::$rbac

protected

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

$request

ILIAS Awareness StandardGUIRequest ceLTIc::LTI\User\ProviderCurrentCourse::$request

protected

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

$tree

ilTree ceLTIc::LTI\User\ProviderCurrentCourse::$tree

protected

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

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

---

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

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