ilObjStudyProgrammeReferenceAccess Class Reference

Inheritance diagram for ilObjStudyProgrammeReferenceAccess:

Collaboration diagram for ilObjStudyProgrammeReferenceAccess:

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 ilContainerReferenceAccess
	_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...
	canBeDelivered (ilWACPath $ilWACPath)
	Parameters ilWACPath $ilWACPath Returns bool More...

Static Public Member Functions
static	_getCommands ($a_ref_id=null)
Static Public Member Functions inherited from ilContainerReferenceAccess
static	_isAccessible ($a_ref_id)
	Check if target is accessible and not deleted. 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 if object type does not support centralized offline handling. More...
static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Detailed Description

Definition at line 3 of file class.ilObjStudyProgrammeReferenceAccess.php.

Member Function Documentation

_checkAccess()

ilObjStudyProgrammeReferenceAccess::_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.

ilAccessHandler $ilAccess

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 22 of file class.ilObjStudyProgrammeReferenceAccess.php.

References $DIC, Vendor\Package\$e, $target_id, ilContainerReference\_lookupTargetRefId(), ilStudyProgrammeDIC\dic(), and ilObjStudyProgramme\getInstanceByRefId().

    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        switch ($a_permission) {
            case 'visible':
            case 'read':

                $target_ref_id = ilContainerReference::_lookupTargetRefId($a_obj_id);
                if (!$ilAccess->checkAccessOfUser($a_user_id, $a_permission, $a_cmd, $target_ref_id)) {
                    return false;
                }
                break;
            case "delete":

                if (!$ilAccess->checkAccessOfUser($a_user_id, $a_permission, $a_cmd, $a_ref_id)) {
                    return false;
                }
                $tree = $DIC['tree'];
                $assignment_ids = [];
                $target_ref_id = ilContainerReference::_lookupTargetRefId($a_obj_id);
                $prg = ilObjStudyProgramme::getInstanceByRefId($target_ref_id);
                $target_id = $prg->getId();
                $progress_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB'];
                $parent = $tree->getParentNodeData($a_ref_id);
                if ($parent["type"] === "prg" && !$parent["deleted"]) {
                    $parent = ilObjStudyProgramme::getInstanceByRefId($parent["ref_id"]);
                    foreach ($parent->getProgresses() as $parent_progress
                    ) {
                        try {
                            $progress =
                                $progress_db->getInstanceForAssignment(
                                    $target_id,
                                    $parent_progress->getAssignmentId()
                                );
                        } catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                            continue;
                        }
                        if ($progress->isRelevant()) {
                            return false;
                        }
                    }
                }

                break;
        }

        return true;
    }

Here is the call graph for this function:

_getCommands()

static ilObjStudyProgrammeReferenceAccess::_getCommands (   $a_ref_id = null )

static

Definition at line 72 of file class.ilObjStudyProgrammeReferenceAccess.php.

References $DIC, and ilObjStudyProgrammeAccess\_getCommands().

    {
        global $DIC;

        $ilAccess = $DIC->access();

        if ($ilAccess->checkAccess('write', '', $a_ref_id)) {
            // Only local (reference specific commands)
            $commands = [
                ["permission" => "read", "cmd" => "view", "lang_var" => "show", "default" => true]
                ,["permission" => "write", "cmd" => "view", "lang_var" => "edit_content"]
                ,["permission" => "write", "cmd" => "edit", "lang_var" => "settings"]
                ,["permission" => "write", "cmd" => "editReference", "lang_var" => "edit"]
            ];
        } else {
            $commands = ilObjStudyProgrammeAccess::_getCommands();
        }
        return $commands;
    }

Here is the call graph for this function:

---

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

• Modules/StudyProgrammeReference/classes/class.ilObjStudyProgrammeReferenceAccess.php