ilObjStudyProgrammeAccess Class Reference

Class ilObjStudyProgrammeAccess. More...

Inheritance diagram for ilObjStudyProgrammeAccess:

Collaboration diagram for ilObjStudyProgrammeAccess:

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 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	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	getConditionOperators ()
	Get operators. More...
static	checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_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	getConditionOperators ()
	Returns an array with valid operators for the specific object type. More...
static	checkCondition ($a_trigger_obj_id, $a_operator, $a_value, $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 19 of file class.ilObjStudyProgrammeAccess.php.

Member Function Documentation

_checkAccess()

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

    {
        if ($a_user_id == "") {
            global $DIC;
            $a_user_id = $DIC->user()->getId();
        }
 
        if ($a_permission == "delete") {
            require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
            $prg = ilObjStudyProgramme::getInstanceByRefId($a_ref_id);
            if ($prg->hasRelevantProgresses()) {
                return false;
            }
        }
 
        return parent::_checkAccess($a_cmd, $a_permission, $a_ref_id, $a_obj_id, $a_user_id);
    }

References $DIC, and ilObjStudyProgramme\getInstanceByRefId().

Here is the call graph for this function:

_checkGoto()

static ilObjStudyProgrammeAccess::_checkGoto (   $a_target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

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

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 67 of file class.ilObjStudyProgrammeAccess.php.

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

Referenced by ilObjStudyProgrammeReferenceAccess\_getCommands(), and ilObjStudyProgrammeListGUI\init().

Here is the caller graph for this function:

checkCondition()

static ilObjStudyProgrammeAccess::checkCondition (   $a_obj_id,   $a_operator,   $a_value,   $a_usr_id  )

static

Parameters

type	$a_obj_id
type	$a_operator
type	$a_value
type	$a_usr_id

Returns

boolean

Implements ilConditionHandling.

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

    {
        if ($a_operator === ilConditionHandler::OPERATOR_ACCREDITED_OR_PASSED) {
            $valid_progress = array(
                ilStudyProgrammeProgress::STATUS_COMPLETED,
                ilStudyProgrammeProgress::STATUS_ACCREDITED
            );
 
            $prg_user_progress = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB']->getInstancesForUser($a_obj_id, $a_usr_id);
            foreach ($prg_user_progress as $progress) {
                if (in_array($progress->getStatus(), $valid_progress)) {
                    return true;
                }
            }
        }
        return false;
    }

References ilStudyProgrammeDIC\dic(), ilConditionHandler\OPERATOR_ACCREDITED_OR_PASSED, ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

Here is the call graph for this function:

getConditionOperators()

static ilObjStudyProgrammeAccess::getConditionOperators ( )

static

Get operators.

Implements ilConditionHandling.

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

    {
        return array(
            ilConditionHandler::OPERATOR_ACCREDITED_OR_PASSED
        );
    }

References ilConditionHandler\OPERATOR_ACCREDITED_OR_PASSED.

---

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

• Modules/StudyProgramme/classes/class.ilObjStudyProgrammeAccess.php