Class ilFileBasedLMAccess. More...

Inheritance diagram for ilObjFileBasedLMAccess:

Collaboration diagram for ilObjFileBasedLMAccess:

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...

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

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

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

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

static	_lookupDiskUsage ($a_id)
	Returns the number of bytes used on the harddisk by the learning module with the specified object id. More...

static	_isOffline ($a_obj_id)
	Type-specific implementation of general status. More...

static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. 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. More...

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

Static Public Attributes
static	$online

static	$startfile

Protected Attributes
	$user

	$lng

	$rbacsystem

	$access

Detailed Description

Class ilFileBasedLMAccess.

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

Version: $Id$

Definition at line 16 of file class.ilObjFileBasedLMAccess.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjFileBasedLMAccess::__construct ( )

Constructor.

Definition at line 42 of file class.ilObjFileBasedLMAccess.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()

ilObjFileBasedLMAccess::_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: boolean true, if everything is ok

Definition at line 67 of file class.ilObjFileBasedLMAccess.php.

References $access, $ilUser, $lng, $rbacsystem, $user, _determineStartUrl(), _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 "visible":
                 if (!ilObjFileBasedLMAccess::_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 "read":
 
                 if ((!ilObjFileBasedLMAccess::_lookupOnline($a_obj_id)
                     && !$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id)) ||
                     ilObjFileBasedLMAccess::_determineStartUrl($a_obj_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 ilObjFileBasedLMAccess::_checkGoto ( $a_target )

static

check whether goto script will succeed

Definition at line 187 of file class.ilObjFileBasedLMAccess.php.

References $DIC.

     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         
         $t_arr = explode("_", $a_target);
 
         if ($t_arr[0] != "htlm" || ((int) $t_arr[1]) <= 0) {
             return false;
         }
 
         if ($ilAccess->checkAccess("visible", "", $t_arr[1]) ||
             $ilAccess->checkAccess("read", "", $t_arr[1])) {
             return true;
         }
         return false;
     }

◆ _determineStartUrl()

static ilObjFileBasedLMAccess::_determineStartUrl ( $a_id )

static

check wether learning module is online

Definition at line 154 of file class.ilObjFileBasedLMAccess.php.

References $DIC, $ilDB, and ilUtil\getWebspaceDir().

Referenced by _checkAccess(), ilObjFileBasedLMGUI\executeCommand(), ilObjFileBasedLMListGUI\getProperties(), ilObjFileBasedLMGUI\getSettingsFormValues(), ilObjFileBasedLMGUI\getTabs(), ilObjFileBasedLMGUI\initSettingsForm(), and ilObjFileBasedLMGUI\showLearningModule().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if (isset(self::$startfile[$a_id])) {
             $start_file = self::$startfile[$a_id];
         } else {
             $q = "SELECT startfile FROM file_based_lm WHERE id = " . $ilDB->quote($a_id, "integer");
             $set = $ilDB->query($q);
             $rec = $ilDB->fetchAssoc($set);
             $start_file = $rec["startfile"];
             self::$startfile[$a_id] = $start_file . "";
         }
         
         $dir = ilUtil::getWebspaceDir() . "/lm_data/lm_" . $a_id;
         
         if (($start_file != "") &&
             (@is_file($dir . "/" . $start_file))) {
             return "./" . $dir . "/" . $start_file;
         } elseif (@is_file($dir . "/index.html")) {
             return "./" . $dir . "/index.html";
         } elseif (@is_file($dir . "/index.htm")) {
             return "./" . $dir . "/index.htm";
         }
 
         return "";
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getCommands()

static ilObjFileBasedLMAccess::_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 114 of file class.ilObjFileBasedLMAccess.php.

References array.

Referenced by ilObjFileBasedLMListGUI\init().

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

Here is the caller graph for this function:

◆ _isOffline()

static ilObjFileBasedLMAccess::_isOffline ( $a_obj_id )

static

Type-specific implementation of general status.

Used in ListGUI and Learning Progress

Parameters

int $a_obj_id

Returns: bool

Definition at line 227 of file class.ilObjFileBasedLMAccess.php.

Referenced by ilObjFileBasedLMListGUI\getProperties().

     {
         return !self::_lookupOnline($a_obj_id);
     }

Here is the caller graph for this function:

◆ _lookupDiskUsage()

static ilObjFileBasedLMAccess::_lookupDiskUsage ( $a_id )

static

Returns the number of bytes used on the harddisk by the learning module with the specified object id.

Parameters

int	object id of a file object.

Definition at line 211 of file class.ilObjFileBasedLMAccess.php.

References ilUtil\dirsize(), and ilUtil\getWebspaceDir().

Referenced by ilObjFileBasedLM\getDiskUsage().

     {
         $lm_data_dir = ilUtil::getWebspaceDir('filesystem') . "/lm_data";
         $lm_dir = $lm_data_dir . DIRECTORY_SEPARATOR . "lm_" . $a_id;
         
         return file_exists($lm_dir) ? ilUtil::dirsize($lm_dir) : 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupOnline()

static ilObjFileBasedLMAccess::_lookupOnline ( $a_id )

static

check wether learning module is online

Definition at line 133 of file class.ilObjFileBasedLMAccess.php.

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

Referenced by _checkAccess().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if (isset(self::$online[$a_id])) {
             return self::$online[$a_id];
         }
         $q = "SELECT is_online FROM file_based_lm WHERE id = " . $ilDB->quote($a_id, "integer");
         $set = $ilDB->query($q);
         $rec = $ilDB->fetchAssoc($set);
 
         self::$online[$a_id] = ilUtil::yn2tf($rec["is_online"]);
         
         return self::$online[$a_id];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _preloadData()

static ilObjFileBasedLMAccess::_preloadData	(	$a_obj_ids,
		$a_ref_ids
	)

static

Preload data.

Parameters

array $a_obj_ids array of object ids

Definition at line 237 of file class.ilObjFileBasedLMAccess.php.

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

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         $ilUser = $DIC->user();
         
         $q = "SELECT id, is_online, startfile FROM file_based_lm WHERE " .
             $ilDB->in("id", $a_obj_ids, false, "integer");
 
         $lm_set = $ilDB->query($q);
         while ($rec = $ilDB->fetchAssoc($lm_set)) {
             self::$online[$rec["id"]] = ilUtil::yn2tf($rec["is_online"]);
             self::$startfile[$rec["id"]] = $rec["startfile"] . "";
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $access

ilObjFileBasedLMAccess::$access

protected

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

Referenced by _checkAccess().

◆ $lng

ilObjFileBasedLMAccess::$lng

protected

Definition at line 26 of file class.ilObjFileBasedLMAccess.php.

Referenced by _checkAccess().

◆ $online

ilObjFileBasedLMAccess::$online

static

Definition at line 52 of file class.ilObjFileBasedLMAccess.php.

◆ $rbacsystem

ilObjFileBasedLMAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

◆ $startfile

ilObjFileBasedLMAccess::$startfile

static

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

◆ $user

ilObjFileBasedLMAccess::$user

protected

Definition at line 21 of file class.ilObjFileBasedLMAccess.php.

Referenced by _checkAccess().

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

Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkAccess()

◆ _checkGoto()

◆ _determineStartUrl()

◆ _getCommands()

◆ _isOffline()

◆ _lookupDiskUsage()

◆ _lookupOnline()

◆ _preloadData()

Field Documentation

◆ $access

◆ $lng

◆ $online

◆ $rbacsystem

◆ $startfile

◆ $user