ilObjFileBasedLMAccess Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjFileBasedLMAccess:

Collaboration diagram for ilObjFileBasedLMAccess:

Public Member Functions
	__construct ()
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
static	_determineStartUrl (int $a_id)
static	_checkGoto (string $target)
static	_lookupDiskUsage (int $a_id)
	Returns the number of bytes used on the harddisk by the learning module with the specified object id. More...
static	_preloadData (array $obj_ids, array $ref_ids)
static	isInfoEnabled (int $obj_id)
Static Public Member Functions inherited from ilObjectAccess
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...
static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Static Public Attributes
static array	$startfile = []

Protected Attributes
ilObjUser	$user
ilLanguage	$lng
ilRbacSystem	$rbacsystem
ilAccessHandler	$access

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

__construct()

ilObjFileBasedLMAccess::__construct

(

)

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\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	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = null
	)

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

References $access, $lng, ilRBACAccessHandler\addInfoItem(), ilAccessInfo\IL_NO_OBJECT_ACCESS, and ilLanguage\txt().

                                                                                                                 : bool
    {
        $lng = $this->lng;
        $ilAccess = $this->access;

        switch ($permission) {
            case "read":

                if (self::_determineStartUrl($obj_id) === "") {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                    return false;
                }
                break;
        }
        return true;
    }

Here is the call graph for this function:

_checkGoto()

static ilObjFileBasedLMAccess::_checkGoto ( string  $target )

static

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

References $DIC.

                                                     : bool
    {
        global $DIC;

        $ilAccess = $DIC->access();

        $t_arr = explode("_", $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 ( int  $a_id )

static

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

References $DIC, $ilDB, $q, and ilFileUtils\getWebspaceDir().

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

                                                        : string
    {
        global $DIC;

        static $startfile = [];
        if (isset($startfile[$a_id])) {
            return $startfile[$a_id];
        }

        $ilDB = $DIC->database();

        $q = "SELECT startfile, rid FROM file_based_lm WHERE id = " . $ilDB->quote($a_id, "integer");
        $set = $ilDB->query($q);
        $rec = $ilDB->fetchAssoc($set);
        $start_file = $rec["startfile"] ?? '';

        // Migrated learning module
        if (!empty($rec['rid'])) {
            // check if the file is available in the container
            $rid = $DIC->resourceStorage()->manageContainer()->find($rec['rid']);
            if (!$rid) {
                return $startfile[$a_id] = "";
            }
            $zip = $DIC->resourceStorage()->consume()->containerZIP($rid)->getZIP();
            foreach ($zip->getFiles() as $file) {
                if ($file === $start_file) {
                    return $startfile[$a_id] = $start_file;
                }
            }
            return $startfile[$a_id] = "";
        }

        // Old learning module
        $dir = realpath(__DIR__ . '/../../../../public/' . ilFileUtils::getWebspaceDir() . "/lm_data/lm_" . $a_id);

        if (($start_file !== "") && (is_file($dir . "/" . $start_file))) {
            return $startfile[$a_id] = str_replace(
                realpath(__DIR__ . '/../../../../public/'),
                "",
                $dir . "/" . $start_file
            );
        }

        if (is_file($dir . "/index.html")) {
            return $startfile[$a_id] = str_replace(
                realpath(__DIR__ . '/../../../../public/'),
                "",
                $dir . "/index.html"
            );
        }

        if (is_file($dir . "/index.htm")) {
            return $startfile[$a_id] = str_replace(realpath(__DIR__ . '/../../../../public/'), "", $dir . "/index.htm");
        }

        return $startfile[$a_id] = "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getCommands()

static ilObjFileBasedLMAccess::_getCommands ( )

static

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

Referenced by ilObjFileBasedLMListGUI\init().

                                         : array
    {
        return [
            [
                "permission" => "read", "cmd" => "view", "lang_var" => "show",
                "default" => true
            ],
            ["permission" => "write", "cmd" => "edit", "lang_var" => "edit_content"],
            ["permission" => "write", "cmd" => "properties", "lang_var" => "settings"]
        ];
    }

Here is the caller graph for this function:

_lookupDiskUsage()

static ilObjFileBasedLMAccess::_lookupDiskUsage ( int  $a_id )

static

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

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

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

                                                      : int
    {
        $lm_data_dir = ilFileUtils::getWebspaceDir('filesystem') . "/lm_data";
        $lm_dir = $lm_data_dir . DIRECTORY_SEPARATOR . "lm_" . $a_id;

        return file_exists($lm_dir) ? ilFileUtils::dirsize($lm_dir) : 0;
    }

Here is the call graph for this function:

_preloadData()

static ilObjFileBasedLMAccess::_preloadData ( array  $obj_ids, array  $ref_ids  )

static

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

References $DIC, $ilDB, $lm_set, and $q.

                                                                       : void
    {
        global $DIC;

        $ilDB = $DIC->database();

        $q = "SELECT id, startfile FROM file_based_lm WHERE " .
            $ilDB->in("id", $obj_ids, false, "integer");

        $lm_set = $ilDB->query($q);
        while ($rec = $ilDB->fetchAssoc($lm_set)) {
            self::$startfile[$rec["id"]] = $rec["startfile"] . "";
        }
    }

isInfoEnabled()

static ilObjFileBasedLMAccess::isInfoEnabled ( int  $obj_id )

static

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

References ilContainer\_lookupContainerSetting(), and ilObjectServiceSettingsGUI\INFO_TAB_VISIBILITY.

Referenced by ilObjFileBasedLMListGUI\getInfoScreenStatus().

                                                     : bool
    {
        return ilContainer::_lookupContainerSetting(
            $obj_id,
            ilObjectServiceSettingsGUI::INFO_TAB_VISIBILITY,
            true
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

ilAccessHandler ilObjFileBasedLMAccess::$access

protected

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

Referenced by _checkAccess().

$lng

ilLanguage ilObjFileBasedLMAccess::$lng

protected

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

Referenced by _checkAccess().

$rbacsystem

ilRbacSystem ilObjFileBasedLMAccess::$rbacsystem

protected

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

$startfile

array ilObjFileBasedLMAccess::$startfile = []

static

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

$user

ilObjUser ilObjFileBasedLMAccess::$user

protected

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

---

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

• components/ILIAS/HTMLLearningModule/classes/class.ilObjFileBasedLMAccess.php