ilObjectPluginAccess Class Reference

Access class for repsoitory plugins. More...

Inheritance diagram for ilObjectPluginAccess:

Collaboration diagram for ilObjectPluginAccess:

Public Member Functions
	__construct ()
	Constructor. More...
	_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=0)
	check condition 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	_checkGoto ($a_target)
	check whether goto script will succeed More...
static	_getCommands ()
	get commands 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...

Protected Attributes
	$user
	$access

Detailed Description

Access class for repsoitory plugins.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

Definition at line 32 of file class.ilObjectPluginAccess.php.

Constructor & Destructor Documentation

__construct()

ilObjectPluginAccess::__construct

(

)

Constructor.

Definition at line 48 of file class.ilObjectPluginAccess.php.

    {
        global $DIC;
 
        $this->user = $DIC->user();
        $this->access = $DIC->access();
    }

References $DIC, and user().

Here is the call graph for this function:

Member Function Documentation

_checkAccess()

ilObjectPluginAccess::_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 71 of file class.ilObjectPluginAccess.php.

    {
        $ilUser = $this->user;
        $ilAccess = $this->access;
 
        if ($a_user_id == "") {
            $a_user_id = $ilUser->getId();
        }
 
        // add no access info item and return false if access is not granted
        // $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $a_text, $a_data = "");
        //
        // for all RBAC checks use checkAccessOfUser instead the normal checkAccess-method:
        // $ilAccess->checkAccessOfUser($a_user_id, $a_permission, $a_cmd, $a_ref_id)
 
        return true;
    }

References $access, $ilUser, and $user.

_checkCondition()

ilObjectPluginAccess::_checkCondition	(		$a_obj_id,
			$a_operator,
			$a_value,
			$a_usr_id = 0
	)

check condition

this method is called by ilConditionHandler

Reimplemented from ilObjectAccess.

Definition at line 94 of file class.ilObjectPluginAccess.php.

    {
        return true;
    }

_checkGoto()

static ilObjectPluginAccess::_checkGoto (   $a_target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 102 of file class.ilObjectPluginAccess.php.

    {
        global $DIC;
 
        $ilAccess = $DIC->access();
        
        $t_arr = explode("_", $a_target);
 
        if ($ilAccess->checkAccess("read", "", $t_arr[1])) {
            return true;
        }
        return false;
    }

References $DIC.

_getCommands()

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

    {
        return array();
    }

Field Documentation

$access

ilObjectPluginAccess::$access

protected

Definition at line 42 of file class.ilObjectPluginAccess.php.

Referenced by _checkAccess().

$user

ilObjectPluginAccess::$user

protected

Definition at line 37 of file class.ilObjectPluginAccess.php.

Referenced by _checkAccess().

---

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

• Services/Repository/classes/class.ilObjectPluginAccess.php