ilObjLearningSequenceAccess Class Reference

Inheritance diagram for ilObjLearningSequenceAccess:

Collaboration diagram for ilObjLearningSequenceAccess:

Public Member Functions
	usingRegistrationCode ()
	_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	isOffline (int $ref_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 bool	$using_code = false

Protected Member Functions
	getDICDependencies ()

Detailed Description

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

Member Function Documentation

_checkAccess()

ilObjLearningSequenceAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = null
	)

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

References $lng, $user_id, getDICDependencies(), ilAccessInfo\IL_NO_OBJECT_ACCESS, and isOffline().

                                                                                                                 : bool
    {
        list($rbacsystem, $il_access, $lng) = $this->getDICDependencies();

        switch ($permission) {
            case 'visible':
                $has_any_administrative_permission = false;
                if (!is_null($user_id)) {
                    $has_any_administrative_permission = (
                        $rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id) ||
                        $rbacsystem->checkAccessOfUser($user_id, 'edit_members', $ref_id) ||
                        $rbacsystem->checkAccessOfUser($user_id, 'edit_learning_progress', $ref_id)
                    );
                }

                $is_offine = $this->isOffline($ref_id);

                if ($is_offine && !$has_any_administrative_permission) {
                    $il_access->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                    return false;
                }
                return true;

            default:
                if (is_null($user_id)) {
                    return false;
                }
                return $rbacsystem->checkAccessOfUser($user_id, $permission, $ref_id);
        }
    }

Here is the call graph for this function:

_getCommands()

static ilObjLearningSequenceAccess::_getCommands ( )

static

Returns

array<array<string|bool>>

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

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

Referenced by ilObjLearningSequenceListGUI\init().

                                         : array
    {
        return 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'
            ]
        );
    }

Here is the caller graph for this function:

getDICDependencies()

ilObjLearningSequenceAccess::getDICDependencies ( )

protected

Returns

array<ilRbacSystem|ilAccess|ilLanguage>

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

References $DIC, and $lng.

Referenced by _checkAccess().

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

        return [
            $rbacsystem,
            $il_access,
            $lng
        ];
    }

Here is the caller graph for this function:

isOffline()

static ilObjLearningSequenceAccess::isOffline ( int  $ref_id )

static

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

References ilObjectFactory\getInstanceByRefId().

Referenced by _checkAccess(), and ilObjLearningSequenceSettingsGUI\update().

                                                 : bool
    {
        $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();
        }

        $new_status = ($online)
            ? $obj->getObjectProperties()->getPropertyIsOnline()->withOnline()
            : $obj->getObjectProperties()->getPropertyIsOnline()->withOffline();
        $obj->getObjectProperties()->storePropertyIsOnline($new_status);

        return !$online;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

usingRegistrationCode()

ilObjLearningSequenceAccess::usingRegistrationCode

(

)

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

                                           : bool
    {
        return self::$using_code;
    }

Field Documentation

$using_code

bool ilObjLearningSequenceAccess::$using_code = false

static

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

---

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

• components/ILIAS/LearningSequence/classes/class.ilObjLearningSequenceAccess.php