ilObjectAccess Class Reference

Class ilObjectAccess. More...

Inheritance diagram for ilObjectAccess:

Collaboration diagram for ilObjectAccess:

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...
	_checkCondition ($a_obj_id, $a_operator, $a_value, $a_usr_id)
	check condition More...
	_getCommands ()
	get commands More...
	_checkGoto ($a_target)
	check whether goto script will succeed More...
	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Static Public Member Functions
static	_isOffline ($a_obj_id)
	Type-specific implementation of general status, has to be overwritten. More...

Detailed Description

Class ilObjectAccess.

This class contains methods that check object specific conditions for access to objects. Every object type should provide an inherited class called ilObj<TypeName>Access

Author

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

Version

$Id$

Definition at line 16 of file class.ilObjectAccess.php.

Member Function Documentation

_checkAccess()

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)

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

Definition at line 33 of file class.ilObjectAccess.php.

References $ilUser.

        {
                global $ilUser, $ilAccess;

                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:
                // $rbacsystem->checkAccessOfUser($a_user_id, $a_permission, $a_ref_id)

                return true;
        }

_checkCondition()

ilObjectAccess::_checkCondition	(		$a_obj_id,
			$a_operator,
			$a_value,
			$a_usr_id
	)

check condition

this method is called by ilConditionHandler

Definition at line 56 of file class.ilObjectAccess.php.

        {
                switch($a_operator)
                {
                        default:
                                return true;
                }
        }

_checkGoto()

ilObjectAccess::_checkGoto

(

$a_target

)

check whether goto script will succeed

Definition at line 90 of file class.ilObjectAccess.php.

Referenced by ilObjChatroomAccess\_getCommands(), and ilObjForumAccess\_getCommands().

        {
                global $ilAccess;
                
                $t_arr = explode("_", $a_target);

                if ($ilAccess->checkAccess("read", "", $t_arr[1]))
                {
                        return true;
                }
                return false;
        }

Here is the caller graph for this function:

_getCommands()

ilObjectAccess::_getCommands

(

)

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"), );

Definition at line 77 of file class.ilObjectAccess.php.

Referenced by ilObjectListGUI\init(), ilObjSAHSLearningModuleListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), and ilObjCategoryReferenceListGUI\initItem().

        {
                $commands = array
                (
                        array()
                );
                
                return $commands;
        }

Here is the caller graph for this function:

_isOffline()

static ilObjectAccess::_isOffline (   $a_obj_id )

static

Type-specific implementation of general status, has to be overwritten.

Used in ListGUI and Learning Progress

Parameters

int

$a_obj_id

Returns

bool

Definition at line 111 of file class.ilObjectAccess.php.

        {
                return null;
        }

_preloadData()

ilObjectAccess::_preloadData	(		$a_obj_ids,
			$a_ref_ids
	)

Preload data.

Parameters

array

$a_obj_ids

array of object ids

Definition at line 121 of file class.ilObjectAccess.php.

        {
                
        }

---

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

• Services/Object/classes/class.ilObjectAccess.php