ilObjCmiXapiAccess Class Reference

Inheritance diagram for ilObjCmiXapiAccess:

Collaboration diagram for ilObjCmiXapiAccess:

Static Public Member Functions
static	_getCommands ()
	get commands 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...
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...

Additional Inherited Members
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)

Detailed Description

Definition at line 15 of file class.ilObjCmiXapiAccess.php.

Member Function Documentation

_getCommands()

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

    {
        global $DIC; /* @var \ILIAS\DI\Container $DIC */
        
        $commands = array(
            array(
                "permission" => "read",
                "cmd" => "infoScreen",
                "lang_var" => "infoScreen",
                "default" => true
            ),
            array(
                'permission' => 'write',
                'cmd' => 'ilCmiXapiSettingsGUI::show',
                'lang_var' => ilObjCmiXapiGUI::TAB_ID_SETTINGS
            )
        );
        
        return $commands;
    }

References $DIC, and ilObjCmiXapiGUI\TAB_ID_SETTINGS.

Referenced by ilObjCmiXapiListGUI\init().

Here is the caller graph for this function:

checkCondition()

static ilObjCmiXapiAccess::checkCondition (   $a_trigger_obj_id,   $a_operator,   $a_value,   $a_usr_id  )

static

check condition for a specific user and object

Parameters

type	$a_trigger_obj_id
type	$a_operator
type	$a_value
type	$a_usr_id

Implements ilConditionHandling.

Definition at line 46 of file class.ilObjCmiXapiAccess.php.

    {
        switch ($a_operator) {
            case ilConditionHandler::OPERATOR_FAILED:
                return ilLPStatus::_lookupStatus($a_trigger_obj_id, $a_usr_id) == ilLPStatus::LP_STATUS_FAILED_NUM;
            
            case ilConditionHandler::OPERATOR_FINISHED:
                return ilLPStatus::_hasUserCompleted($a_trigger_obj_id, $a_usr_id);
        }
        
        return false;
    }

References ilLPStatus\_hasUserCompleted(), ilLPStatus\_lookupStatus(), ilLPStatus\LP_STATUS_FAILED_NUM, ilConditionHandler\OPERATOR_FAILED, and ilConditionHandler\OPERATOR_FINISHED.

Here is the call graph for this function:

getConditionOperators()

static ilObjCmiXapiAccess::getConditionOperators ( )

static

Returns an array with valid operators for the specific object type.

Implements ilConditionHandling.

Definition at line 38 of file class.ilObjCmiXapiAccess.php.

    {
        return [
            ilConditionHandler::OPERATOR_FINISHED,
            ilConditionHandler::OPERATOR_FAILED
        ];
    }

References ilConditionHandler\OPERATOR_FAILED, and ilConditionHandler\OPERATOR_FINISHED.

---

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

• Modules/CmiXapi/classes/class.ilObjCmiXapiAccess.php