ilObjStudyProgrammeAccess Class Reference

Class ilObjStudyProgrammeAccess. More...

Inheritance diagram for ilObjStudyProgrammeAccess:

Collaboration diagram for ilObjStudyProgrammeAccess:

Public Member Functions
	_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...
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)
	canBeDelivered (ilWACPath $ilWACPath)

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
	check whether goto script will succeed More...
static	getConditionOperators ()
	Get operators. More...
static	checkCondition (int $a_trigger_obj_id, string $a_operator, string $a_value, int $a_usr_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	getConditionOperators ()
	Returns an array with valid operators for the specific object type. More...
static	checkCondition (int $a_trigger_obj_id, string $a_operator, string $a_value, int $a_usr_id)
	check condition for a specific user and object More...

Detailed Description

Class ilObjStudyProgrammeAccess.

TODO: deletion is only allowed if there are no more users assigned to the programme.

Author

: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

Definition at line 28 of file class.ilObjStudyProgrammeAccess.php.

Member Function Documentation

_checkAccess()

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

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

Reimplemented from ilObjectAccess.

Definition at line 30 of file class.ilObjStudyProgrammeAccess.php.

                                                                                                                 : bool
    {
        if ($user_id === 0 || $user_id === null) {
            global $DIC;
            $user_id = $DIC->user()->getId();
        }
 
        if ($permission === "delete") {
            $prg = ilObjStudyProgramme::getInstanceByRefId($ref_id);
            if ($prg->hasRelevantProgresses()) {
                return false;
            }
        }
 
        return parent::_checkAccess($cmd, $permission, $ref_id, $obj_id, $user_id);
    }

References $DIC, $ref_id, $user_id, and ilObjStudyProgramme\getInstanceByRefId().

Here is the call graph for this function:

_checkGoto()

static ilObjStudyProgrammeAccess::_checkGoto ( string  $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

                                                     : bool
    {
        global $DIC;
        $ilAccess = $DIC->access();
        $t_arr = explode('_', $target);
        if ($t_arr[0] !== 'prg' || ((int) $t_arr[1]) <= 0) {
            return false;
        }
 
        return $ilAccess->checkAccess('read', '', (int) $t_arr[1]);
    }

References $DIC.

_getCommands()

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

                                         : array
    {
        $commands = [];
        $commands[] = ['permission' => 'read', 'cmd' => 'view', 'lang_var' => 'show', 'default' => true];
        $commands[] = ['permission' => 'write', 'cmd' => 'view', 'lang_var' => 'edit_content'];
        $commands[] = [ 'permission' => 'write', 'cmd' => 'edit', 'lang_var' => 'settings'];
 
        return $commands;
    }

Referenced by ilObjStudyProgrammeListGUI\init().

Here is the caller graph for this function:

checkCondition()

static ilObjStudyProgrammeAccess::checkCondition ( int  $a_trigger_obj_id, string  $a_operator, string  $a_value, int  $a_usr_id  )

static

Parameters

int	$a_trigger_obj_id
string	$a_operator
string	$a_value
int	$a_usr_id

Returns

boolean

Implements ilConditionHandling.

Definition at line 101 of file class.ilObjStudyProgrammeAccess.php.

     : bool {
        if ($a_operator === ilConditionHandler::OPERATOR_ACCREDITED_OR_PASSED) {
            $repo = ilStudyProgrammeDIC::dic()['repo.assignment'];
            $assignments = $repo->getAllForNodeIsContained($a_trigger_obj_id, [$a_usr_id]);
 
            foreach ($assignments as $ass) {
                if ($ass->getProgressForNode($a_trigger_obj_id)->isSuccessful()) {
                    return true;
                }
            }
        }
        return false;
    }

References ilStudyProgrammeDIC\dic().

Here is the call graph for this function:

getConditionOperators()

static ilObjStudyProgrammeAccess::getConditionOperators ( )

static

Get operators.

Implements ilConditionHandling.

Definition at line 87 of file class.ilObjStudyProgrammeAccess.php.

                                                  : array
    {
        return array(
            ilConditionHandler::OPERATOR_ACCREDITED_OR_PASSED
        );
    }

References ilConditionHandler\OPERATOR_ACCREDITED_OR_PASSED.

---

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

• components/ILIAS/StudyProgramme/classes/class.ilObjStudyProgrammeAccess.php