ilObjSAHSLearningModuleAccess Class Reference

Class ilObjContentObjectAccess. More...

Inheritance diagram for ilObjSAHSLearningModuleAccess:

Collaboration diagram for ilObjSAHSLearningModuleAccess:

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) 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	getConditionOperators ()
	Get possible conditions operaditors. More...
static	checkCondition ($a_trigger_obj_id, $a_operator, $a_value, $a_usr_id)
	check condition More...
static	_getCommands ($a_obj_id=null)
	get commands More...
static	_lookupOnline ($a_id)
	check wether learning module is online More...
static	_lookupEditable ($a_obj_id)
	Lookup editable. 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	_lookupUserCertificate ($obj_id, $usr_id=0)
	Checks whether a certificate exists for the active user or not. More...
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status. More...
static	_lookupUserIsOfflineMode ($a_obj_id)
	Checks offlineMode and returns false if. More...
static	_lookupOfflineModeAvailable ($a_id)
	check wether learning module is online 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...

Detailed Description

Class ilObjContentObjectAccess.

Author

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

Version

$Id$

Definition at line 17 of file class.ilObjSAHSLearningModuleAccess.php.

Member Function Documentation

_checkAccess()

ilObjSAHSLearningModuleAccess::_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 73 of file class.ilObjSAHSLearningModuleAccess.php.

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

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

        if ($a_user_id == "") {
            $a_user_id = $ilUser->getId();
        }

        switch ($a_cmd) {
            case "view":

                if (!ilObjSAHSLearningModuleAccess::_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;
        }

        switch ($a_permission) {
            case "visible":
                if (!ilObjSAHSLearningModuleAccess::_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 ilObjSAHSLearningModuleAccess::_checkGoto (   $a_target )

static

check whether goto script will succeed

Definition at line 181 of file class.ilObjSAHSLearningModuleAccess.php.

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

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

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

_getCommands()

static ilObjSAHSLearningModuleAccess::_getCommands (   $a_obj_id = null )

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 118 of file class.ilObjSAHSLearningModuleAccess.php.

References _lookupOfflineModeAvailable(), _lookupUserIsOfflineMode(), and array.

    {
        $commands = array(
            array("permission" => "read", "cmd" => "view", "lang_var" => "show","default" => true),
            array("permission" => "write", "cmd" => "editContent", "lang_var" => "edit_content"),
            array("permission" => "write", "cmd" => "edit", "lang_var" => "settings")
        );
        // #14866
        if ($a_obj_id && ilObjSAHSLearningModuleAccess::_lookupOfflineModeAvailable($a_obj_id)) {
            $offlineMode=ilObjSAHSLearningModuleAccess::_lookupUserIsOfflineMode($a_obj_id);
            if ($offlineMode == false) {
                $commands[]=array("permission" => "read", "cmd" => "offlineModeStart", "lang_var" => "offline_mode");
            } else {
                $commands[]=array("permission" => "read", "cmd" => "offlineModeStop", "lang_var" => "offline_mode");
                $commands[0]=array("permission" => "read", "cmd" => "offlineModeView", "lang_var" => "show","default" => true);
            }
        }
        
        return $commands;
    }

Here is the call graph for this function:

_isOffline()

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

Referenced by ilObjSAHSLearningModuleListGUI\getProperties().

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

Here is the caller graph for this function:

_lookupDiskUsage()

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

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

Referenced by ilObjSAHSLearningModule\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:

_lookupEditable()

static ilObjSAHSLearningModuleAccess::_lookupEditable (   $a_obj_id )

static

Lookup editable.

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

References $ilDB, and array.

Referenced by ilSAHSPresentationGUI\executeCommand(), ilObjSAHSLearningModuleListGUI\getCommandLink(), and ilObjSAHSLearningModuleListGUI\getProperties().

    {
        global $ilDB;
        
        $set = $ilDB->queryF(
            'SELECT * FROM sahs_lm WHERE id = %s',
            array('integer'),
            array($a_obj_id)
        );
        $rec = $ilDB->fetchAssoc($set);

        return $rec["editable"];
    }

Here is the caller graph for this function:

_lookupOfflineModeAvailable()

static ilObjSAHSLearningModuleAccess::_lookupOfflineModeAvailable (   $a_id )

static

check wether learning module is online

Definition at line 291 of file class.ilObjSAHSLearningModuleAccess.php.

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

Referenced by _getCommands().

    {
        global $ilDB;

        $set = $ilDB->queryF(
            'SELECT offline_mode FROM sahs_lm WHERE id = %s',
            array('integer'),
            array($a_id)
        );
        $rec = $ilDB->fetchAssoc($set);

        return ilUtil::yn2tf($rec["offline_mode"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupOnline()

static ilObjSAHSLearningModuleAccess::_lookupOnline (   $a_id )

static

check wether learning module is online

Definition at line 146 of file class.ilObjSAHSLearningModuleAccess.php.

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

Referenced by _checkAccess().

    {
        global $ilDB;

        $set = $ilDB->queryF(
            'SELECT c_online FROM sahs_lm WHERE id = %s',
            array('integer'),
            array($a_id)
        );
        $rec = $ilDB->fetchAssoc($set);
        
        return ilUtil::yn2tf($rec["c_online"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupUserCertificate()

static ilObjSAHSLearningModuleAccess::_lookupUserCertificate (   $obj_id,   $usr_id = 0  )

static

Checks whether a certificate exists for the active user or not.

Parameters

int	obj_id Object ID of the SCORM Learning Module
int	usr_id Object ID of the user. If not given, the active user will be taken

Returns

true/false

Definition at line 216 of file class.ilObjSAHSLearningModuleAccess.php.

References $ilUser, $type, ilObjUserTracking\_enabledLearningProgress(), ilObjSCORM2004LearningModule\_getCourseCompletionForUser(), ilObjSCORMLearningModule\_getCourseCompletionForUser(), ilLPStatus\_hasUserCompleted(), ilObjSAHSLearningModule\_lookupSubType(), ilCertificate\isActive(), and ilCertificate\isObjectActive().

Referenced by ilSCORMPresentationGUI\downloadCertificate(), ilObjSAHSLearningModuleListGUI\getProperties(), and ilSoapSCORMAdministration\hasSCORMCertificate().

    {
        global $ilUser;
        $uid = ($usr_id) ? $usr_id : $ilUser->getId();
        
        $completed = false;
        // check for certificates
        include_once "./Services/Certificate/classes/class.ilCertificate.php";
        if (ilCertificate::isActive() && ilCertificate::isObjectActive($obj_id)) {
            $lpdata = false;
            include_once "./Modules/ScormAicc/classes/class.ilObjSAHSLearningModule.php";
            $type = ilObjSAHSLearningModule::_lookupSubType($obj_id);
            include_once("Services/Tracking/classes/class.ilObjUserTracking.php");
            if (ilObjUserTracking::_enabledLearningProgress()) {
                include_once "./Services/Tracking/classes/class.ilLPStatus.php";
                $completed = ilLPStatus::_hasUserCompleted($obj_id, $uid);
                $lpdata = true;
            }
            switch ($type) {
                case "scorm":
                    if (!$lpdata) {
                        include_once "./Modules/ScormAicc/classes/class.ilObjSCORMLearningModule.php";
                        $completed = ilObjSCORMLearningModule::_getCourseCompletionForUser($obj_id, $uid);
                    }
                    break;
                case "scorm2004":
                    if (!$lpdata) {
                        include_once "./Modules/Scorm2004/classes/class.ilObjSCORM2004LearningModule.php";
                        $completed = ilObjSCORM2004LearningModule::_getCourseCompletionForUser($obj_id, $uid);
                    }
                    break;
                default:
                    break;
            }
        }
        return $completed;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupUserIsOfflineMode()

static ilObjSAHSLearningModuleAccess::_lookupUserIsOfflineMode (   $a_obj_id )

static

Checks offlineMode and returns false if.

Definition at line 270 of file class.ilObjSAHSLearningModuleAccess.php.

References $ilDB, $ilUser, and array.

Referenced by _getCommands(), ilSAHSPresentationGUI\executeCommand(), and ilObjectListGUI\initItem().

    {
        global $ilDB,$ilUser;

        $user_id = $ilUser->getId();

        $set = $ilDB->queryF(
            'SELECT offline_mode FROM sahs_user WHERE obj_id = %s AND user_id = %s',
            array('integer','integer'),
            array($a_obj_id, $user_id)
        );
        $rec = $ilDB->fetchAssoc($set);
        if ($rec["offline_mode"] == "offline") {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

checkCondition()

static ilObjSAHSLearningModuleAccess::checkCondition (   $a_trigger_obj_id,   $a_operator,   $a_value,   $a_usr_id  )

static

check condition

Parameters

type	$a_svy_id
type	$a_operator
type	$a_value
type	$a_usr_id

Returns

boolean

Implements ilConditionHandling.

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

References ilLPStatus\_hasUserCompleted(), ilLPStatus\_lookupStatus(), ilLPStatus\LP_STATUS_FAILED_NUM, ilConditionHandler\OPERATOR_FAILED, and ilConditionHandler\OPERATOR_FINISHED.

    {
        switch ($a_operator) {

            case ilConditionHandler::OPERATOR_FAILED:
                include_once './Services/Tracking/classes/class.ilLPStatus.php';
                return ilLPStatus::_lookupStatus($a_trigger_obj_id, $a_usr_id) == ilLPStatus::LP_STATUS_FAILED_NUM;
                break;
            
            case ilConditionHandler::OPERATOR_FINISHED:
            default:
                include_once './Services/Tracking/classes/class.ilLPStatus.php';
                return ilLPStatus::_hasUserCompleted($a_trigger_obj_id, $a_usr_id);

        }
        return true;
    }

Here is the call graph for this function:

getConditionOperators()

static ilObjSAHSLearningModuleAccess::getConditionOperators ( )

static

Get possible conditions operaditors.

Implements ilConditionHandling.

Definition at line 23 of file class.ilObjSAHSLearningModuleAccess.php.

References array, ilConditionHandler\OPERATOR_FAILED, and ilConditionHandler\OPERATOR_FINISHED.

    {
        include_once './Services/AccessControl/classes/class.ilConditionHandler.php';
        return array(
            ilConditionHandler::OPERATOR_FINISHED,
            ilConditionHandler::OPERATOR_FAILED
        );
    }

---

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

• Modules/ScormAicc/classes/class.ilObjSAHSLearningModuleAccess.php