ilObjLearningSequenceAccess Class Reference

Class ilObjLearningSequenceAccess class. More...

Inheritance diagram for ilObjLearningSequenceAccess:

Collaboration diagram for ilObjLearningSequenceAccess:

Public Member Functions
	usingRegistrationCode ()
	_checkAccess ($cmd, $permission, $ref_id, $obj_id, $usr_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...
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	isOffline ($ref_id)
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...

Static Public Attributes
static	$using_code = false

Protected Member Functions
	getDICDependencies ()

Detailed Description

Class ilObjLearningSequenceAccess class.

Definition at line 11 of file class.ilObjLearningSequenceAccess.php.

Member Function Documentation

_checkAccess()

ilObjLearningSequenceAccess::_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)

Please do not check any preconditions handled by ilConditionHandler here. Also don't do any RBAC checks.

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 93 of file class.ilObjLearningSequenceAccess.php.

    {
        list($rbacsystem, $il_access, $lng) = $this->getDICDependencies();
 
        switch ($permission) {
            case 'visible':
                $has_any_administrative_permission = (
                    $rbacsystem->checkAccessOfUser($usr_id, 'write', $ref_id) ||
                    $rbacsystem->checkAccessOfUser($usr_id, 'edit_members', $ref_id) ||
                    $rbacsystem->checkAccessOfUser($usr_id, 'edit_learning_progress', $ref_id)
                );
 
                $is_offine = $this->isOffline($ref_id);
 
                if ($is_offine && !$has_any_administrative_permission) {
                    $il_access->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                    return false;
                }
                return true;
 
            default:
                return $rbacsystem->checkAccessOfUser($usr_id, $permission, $ref_id);
        }
    }

References $lng, getDICDependencies(), IL_NO_OBJECT_ACCESS, and isOffline().

Here is the call graph for this function:

_getCommands()

static ilObjLearningSequenceAccess::_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"), );

Reimplemented from ilObjectAccess.

Definition at line 15 of file class.ilObjLearningSequenceAccess.php.

                                          : array
    {
        $commands = array(
            [
                'cmd' => ilObjLearningSequenceGUI::CMD_VIEW,
                'permission' => 'read',
                'lang_var' => 'show',
                'default' => true
            ],
            [
                'cmd' => ilObjLearningSequenceGUI::CMD_LEARNER_VIEW,
                'permission' => 'read',
                'lang_var' => 'show',
            ],
            [
                'cmd' => ilObjLearningSequenceGUI::CMD_CONTENT,
                'permission' => 'write',
                'lang_var' => 'edit_content'
            ],
            [
                'cmd' => ilObjLearningSequenceGUI::CMD_SETTINGS,
                'permission' => 'write',
                'lang_var' => 'settings'
            ],
            [
                'cmd' => ilObjLearningSequenceGUI::CMD_UNPARTICIPATE,
                'permission' => 'unparticipate',
                'lang_var' => 'unparticipate'
            ]
        );
        return $commands;
    }

References ilObjLearningSequenceGUI\CMD_CONTENT, ilObjLearningSequenceGUI\CMD_LEARNER_VIEW, ilObjLearningSequenceGUI\CMD_SETTINGS, ilObjLearningSequenceGUI\CMD_UNPARTICIPATE, and ilObjLearningSequenceGUI\CMD_VIEW.

Referenced by ilObjLearningSequenceListGUI\init().

Here is the caller graph for this function:

getDICDependencies()

ilObjLearningSequenceAccess::getDICDependencies ( )

protected

Definition at line 118 of file class.ilObjLearningSequenceAccess.php.

                                            : array
    {
        global $DIC;
        $rbacsystem = $DIC['rbacsystem'];
        $il_access = $DIC['ilAccess'];
        $lng = $DIC['lng'];
 
        return [
            $rbacsystem,
            $il_access,
            $lng
        ];
    }

References $DIC, and $lng.

Referenced by _checkAccess().

Here is the caller graph for this function:

isOffline()

static ilObjLearningSequenceAccess::isOffline (   $ref_id )

static

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

    {
        $obj = ilObjectFactory::getInstanceByRefId($ref_id);
        $act = $obj->getLSActivation();
        $online = $act->getIsOnline();
 
        if (!$online
            && ($act->getActivationStart() !== null ||
                $act->getActivationEnd() !== null)
        ) {
            $ts_now = time();
            $activation_start = $act->getActivationStart();
            if ($activation_start !== null) {
                $after_activation_start = $ts_now >= $activation_start->getTimestamp();
            } else {
                $after_activation_start = true;
            }
            $activation_end = $act->getActivationEnd();
            if ($activation_end !== null) {
                $before_activation_end = $ts_now <= $activation_end->getTimestamp();
            } else {
                $before_activation_end = true;
            }
 
            $online = ($after_activation_start && $before_activation_end);
        }
 
        if ($act->getEffectiveOnlineStatus() === false && $online === true) {
            $obj->setEffectiveOnlineStatus(true);
            $obj->announceLSOOnline();
        }
        if ($act->getEffectiveOnlineStatus() === true && $online === false) {
            $obj->setEffectiveOnlineStatus(false);
            $obj->announceLSOOffline();
        }
 
 
        return !$online;
    }

References ilObjectFactory\getInstanceByRefId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

usingRegistrationCode()

ilObjLearningSequenceAccess::usingRegistrationCode

(

)

Definition at line 48 of file class.ilObjLearningSequenceAccess.php.

    {
        return self::$using_code;
    }

References $using_code.

Field Documentation

$using_code

ilObjLearningSequenceAccess::$using_code = false

static

Definition at line 13 of file class.ilObjLearningSequenceAccess.php.

Referenced by usingRegistrationCode().

---

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

• Modules/LearningSequence/classes/class.ilObjLearningSequenceAccess.php