Class ilObjGlossaryAccess. More...

Inheritance diagram for ilObjGlossaryAccess:

Collaboration diagram for ilObjGlossaryAccess:

Public Member Functions

__construct ()

Constructor. More...

_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")

checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

Public Member Functions inherited from ilObjectAccess

_checkAccess ($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id="")

Checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)

check condition More...

canBeDelivered (ilWACPath $ilWACPath)

Parameters

ilWACPath $ilWACPath

Returns: bool

More...

Static Public Member Functions
static	_getCommands ()
	get commands More...

static	_lookupOnline ($a_id)
	check wether learning module is online More...

static	_lookupOnlineStatus ($a_ids)
	Check wether learning module is online (legacy version) More...

static	_checkGoto ($a_target)
	check whether goto script will succeed More...

Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...

static	_checkGoto ($a_target)
	check whether goto script will succeed More...

static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...

static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Protected Attributes
	$user

	$lng

	$rbacsystem

	$access

Detailed Description

Class ilObjGlossaryAccess.

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

Definition at line 10 of file class.ilObjGlossaryAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjGlossaryAccess::__construct ( )

Constructor.

Definition at line 36 of file class.ilObjGlossaryAccess.php.

References $DIC, and user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->lng = $DIC->language();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->access = $DIC->access();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjGlossaryAccess::_checkAccess	(	$a_cmd,
		$a_permission,
		$a_ref_id,
		$a_obj_id,
		$a_user_id = `""`
	)

checks wether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess)

Parameters

string	$a_cmd	command (not permission!)
string	$a_permission	permission
int	$a_ref_id	reference id
int	$a_obj_id	object id
int	$a_user_id	user id (if not provided, current user is taken)

Returns: mixed true, if everything is ok, message (string) when access is not granted

Definition at line 59 of file class.ilObjGlossaryAccess.php.

References $access, $ilUser, $lng, $rbacsystem, $user, _lookupOnline(), and IL_NO_OBJECT_ACCESS.

     {
         $ilUser = $this->user;
         $lng = $this->lng;
         $rbacsystem = $this->rbacsystem;
         $ilAccess = $this->access;
 
         if ($a_user_id == "") {
             $a_user_id = $ilUser->getId();
         }
 
         switch ($a_permission) {
             case "read":
                 if (!ilObjGlossaryAccess::_lookupOnline($a_obj_id)
                     && !$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id)) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                     return false;
                 }
                 break;
 
             case "visible":
                 if (!ilObjGlossaryAccess::_lookupOnline($a_obj_id) &&
                     (!$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id))) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                     return false;
                 }
                 break;
         }
 
 
         return true;
     }

Here is the call graph for this function:

◆ _checkGoto()

static ilObjGlossaryAccess::_checkGoto ( $a_target )

static

check whether goto script will succeed

Definition at line 164 of file class.ilObjGlossaryAccess.php.

References $DIC, ilObject\_getAllReferences(), and ilGlossaryTerm\_lookGlossaryID().

     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         
         $t_arr = explode("_", $a_target);
 
         if (($t_arr[0] != "glo" && $t_arr[0] != "git") || ((int) $t_arr[1]) <= 0) {
             return false;
         }
 
         if ($t_arr[0] == "glo") {
             if ($ilAccess->checkAccess("read", "", $t_arr[1]) ||
                 $ilAccess->checkAccess("visible", "", $t_arr[1])) {
                 return true;
             }
         }
 
         if ($t_arr[0] == "git") {
             if ($t_arr[2] > 0) {
                 $ref_ids = array($t_arr[2]);
             } else {
                 // determine learning object
                 $glo_id = ilGlossaryTerm::_lookGlossaryID($t_arr[1]);
                 $ref_ids = ilObject::_getAllReferences($glo_id);
             }
             // check read permissions
             foreach ($ref_ids as $ref_id) {
                 // Permission check
                 if ($ilAccess->checkAccess("read", "", $ref_id)) {
                     return true;
                 }
             }
         }
 
         return false;
     }

Here is the call graph for this function:

◆ _getCommands()

static ilObjGlossaryAccess::_getCommands ( )

static

get commands

this method returns an array of all possible commands/permission combinations

example: $commands = array ( array("permission" => "read", "cmd" => "view", "lang_var" => "show"), array("permission" => "write", "cmd" => "edit", "lang_var" => "edit"), );

Definition at line 104 of file class.ilObjGlossaryAccess.php.

Referenced by ilObjGlossaryListGUI\init().

     {
         $commands = array(
             array("permission" => "read", "cmd" => "view", "lang_var" => "show",
                 "default" => true),
             array("permission" => "write", "cmd" => "edit", "lang_var" => "edit_content"),
             array("permission" => "edit_content", "cmd" => "edit", "lang_var" => "edit_content"), // #11099
             array("permission" => "write", "cmd" => "properties", "lang_var" => "settings")
         );
         
         return $commands;
     }

Here is the caller graph for this function:

◆ _lookupOnline()

static ilObjGlossaryAccess::_lookupOnline ( $a_id )

static

check wether learning module is online

Definition at line 124 of file class.ilObjGlossaryAccess.php.

References $DIC, $ilDB, $lm_set, and ilUtil\yn2tf().

Referenced by _checkAccess(), and ilObjGlossaryListGUI\getProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "SELECT * FROM glossary WHERE id = " .
             $ilDB->quote($a_id, "integer");
         $lm_set = $ilDB->query($q);
         $lm_rec = $ilDB->fetchAssoc($lm_set);
 
         return ilUtil::yn2tf($lm_rec["is_online"]);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupOnlineStatus()

static ilObjGlossaryAccess::_lookupOnlineStatus ( $a_ids )

static

Check wether learning module is online (legacy version)

Deprecated:

Definition at line 143 of file class.ilObjGlossaryAccess.php.

References $DIC, $ilDB, $lm_set, and ilUtil\yn2tf().

Referenced by ilContainer\legacyOnlineFilter().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "SELECT id, is_online FROM glossary WHERE " .
             $ilDB->in("id", $a_ids, false, "integer");
         $lm_set = $ilDB->query($q);
         $status = [];
         while ($r = $ilDB->fetchAssoc($lm_set)) {
             $status[$r["id"]] = ilUtil::yn2tf($r["is_online"]);
         }
 
         return $status;
     }