ilObjFileBasedLMAccess Class Reference

Class ilFileBasedLMAccess. More...

Inheritance diagram for ilObjFileBasedLMAccess:

Collaboration diagram for ilObjFileBasedLMAccess:

Public Member Functions
	_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)
	_getCommands ()
	get commands
	_lookupOnline ($a_id)
	check wether learning module is online
	_determineStartUrl ($a_id)
	check wether learning module is online
	_checkGoto ($a_target)
	check whether goto script will succeed
	_lookupDiskUsage ($a_id)
	Returns the number of bytes used on the harddisk by the learning module with the specified object id.
	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data.
Public Member Functions inherited from ilObjectAccess
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id=0)
	check condition

Static Public Member Functions
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status.

Static Public Attributes
static	$online
static	$startfile

Detailed Description

Class ilFileBasedLMAccess.

Author

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

Version

Id:

class.ilObjFileBasedLMAccess.php 37317 2012-10-03 12:57:24Z akill

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

Member Function Documentation

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

Reimplemented from ilObjectAccess.

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

References $ilUser, $lng, _determineStartUrl(), _lookupOnline(), and IL_NO_OBJECT_ACCESS.

        {
                global $ilUser, $lng, $rbacsystem, $ilAccess;

                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:

ilObjFileBasedLMAccess::_checkGoto

(

$a_target

)

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

        {
                global $ilAccess;
                
                $t_arr = explode("_", $a_target);

                if ($t_arr[0] != "htlm" || ((int) $t_arr[1]) <= 0)
                {
                        return false;
                }

                if ($ilAccess->checkAccess("visible", "", $t_arr[1]))
                {
                        return true;
                }
                return false;
        }

ilObjFileBasedLMAccess::_determineStartUrl

(

$a_id

)

check wether learning module is online

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

References ilUtil\getWebspaceDir().

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

        {
                global $ilDB;

                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;
                }
                else if (@is_file($dir."/index.html"))
                {
                        return "./".$dir."/index.html";
                }
                else if (@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:

ilObjFileBasedLMAccess::_getCommands

(

)

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"), );

Reimplemented from ilObjectAccess.

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

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:

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

Reimplemented from ilObjectAccess.

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

References _lookupOnline().

Referenced by ilObjFileBasedLMListGUI\getProperties().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObjFileBasedLMAccess::_lookupDiskUsage

(

$a_id

)

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 183 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:

ilObjFileBasedLMAccess::_lookupOnline

(

$a_id

)

check wether learning module is online

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

References ilUtil\yn2tf().

Referenced by _checkAccess(), and _isOffline().

        {
                global $ilDB;

                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:

ilObjFileBasedLMAccess::_preloadData	(		$a_obj_ids,
			$a_ref_ids
	)

Preload data.

Parameters

array

$a_obj_ids

array of object ids

Reimplemented from ilObjectAccess.

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

References $ilUser, and ilUtil\yn2tf().

        {
                global $ilDB, $ilUser;
                
                $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

ilObjFileBasedLMAccess::$online

static

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

ilObjFileBasedLMAccess::$startfile

static

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

---

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

• Modules/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php