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 whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...
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 (int $a_ref_id=null)
Static Public Member Functions inherited from ilContainerReferenceAccess
static	_isAccessible (int $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 (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...

Detailed Description

Definition at line 21 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 whether 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 40 of file class.ilObjStudyProgrammeReferenceAccess.php.

References $DIC, $target_id, ilContainerReference\_lookupTargetRefId(), and ilObjStudyProgramme\getInstanceByRefId().

                                                                                              : bool
    {
        global $DIC;
        $ilAccess = $DIC['ilAccess'];
        switch ($a_permission) {
            case 'visible':
            case 'read':
                $target_ref_id = ilContainerReference::_lookupTargetRefId($a_obj_id);
                if (!$target_ref_id || !$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'];
                $target_ref_id = ilContainerReference::_lookupTargetRefId($a_obj_id);
                $prg = ilObjStudyProgramme::getInstanceByRefId($target_ref_id);
                $target_id = $prg->getId();
                $parent = $tree->getParentNodeData($a_ref_id);
                if ($parent["type"] === "prg" && !$parent["deleted"]) {
                    $parent = ilObjStudyProgramme::getInstanceByRefId($parent["ref_id"]);
                    if (! $parent->canBeRemoved()) {
                        return false;
                    }
                }

                break;
        }

        return true;
    }

Here is the call graph for this function:

_getCommands()

static ilObjStudyProgrammeReferenceAccess::_getCommands ( int  $a_ref_id = null )

static

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

References $DIC, ilObject\_lookupObjId(), and ilContainerReference\_lookupTargetRefId().

                                                             : array
    {
        global $DIC;
        $ilAccess = $DIC->access();
        $prgr_obj_id = ilObject::_lookupObjId($a_ref_id);
        $target_ref_id = ilContainerReference::_lookupTargetRefId($prgr_obj_id);

        $commands = [];

        if ($ilAccess->checkAccess('write', '', $a_ref_id)) {
            $commands[] = ["permission" => "write", "cmd" => "editReference", "lang_var" => "edit"];
        }
        if ($ilAccess->checkAccess('read', '', $target_ref_id)) {
            $commands[] = array('permission' => 'visible', 'cmd' => 'view', 'lang_var' => 'show', 'default' => true);
        }

        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