Public Member Functions

ilObjectAccess Class Reference

Class ilObjectAccess. More...

Inheritance 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).
 _checkCondition ($a_obj_id, $a_operator, $a_value)
 check condition
 _getCommands ()
 get commands
 _checkGoto ($a_target)
 check whether goto script will succeed

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.killing@gmx.de>
Version:
Id:
class.ilObjectAccess.php 12808 2006-12-08 18:04:21Z akill

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


Member Function Documentation

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

Reimplemented in ilObjGroupAccess, ilObjiLincClassroomAccess, ilObjiLincCourseAccess, ilObjCourseAccess, ilObjGlossaryAccess, ilObjFileBasedLMAccess, ilObjContentObjectAccess, ilObjMediaCastAccess, ilObjSAHSLearningModuleAccess, ilObjSurveyAccess, ilObjTestAccess, and ilObjPrivacySecurityAccess.

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

        {
                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;
        }

ilObjectAccess::_checkCondition ( a_obj_id,
a_operator,
a_value 
)

check condition

this method is called by ilConditionHandler

Reimplemented in ilObjTestAccess.

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

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

ilObjectAccess::_checkGoto ( a_target  ) 

check whether goto script will succeed

Reimplemented in ilObjGroupAccess, ilObjCategoryAccess, ilObjChatAccess, ilObjCourseAccess, ilObjExerciseAccess, ilObjExternalFeedAccess, ilObjFileAccess, ilObjForumAccess, ilObjGlossaryAccess, ilObjFileBasedLMAccess, ilObjContentObjectAccess, ilObjMediaCastAccess, ilObjSAHSLearningModuleAccess, ilObjSurveyAccess, ilObjTestAccess, and ilObjLinkResourceAccess.

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

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

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

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

Reimplemented in ilObjFolderAccess, ilObjGroupAccess, ilObjRootFolderAccess, ilObjiLincClassroomAccess, ilObjiLincCourseAccess, ilObjCategoryAccess, ilObjChatAccess, ilObjCourseAccess, ilObjExerciseAccess, ilObjExternalFeedAccess, ilObjFileAccess, ilObjForumAccess, ilObjGlossaryAccess, ilObjFileBasedLMAccess, ilObjDlBookAccess, ilObjLearningModuleAccess, ilObjMediaCastAccess, ilObjMediaPoolAccess, ilObjRemoteCourseAccess, ilObjSAHSLearningModuleAccess, ilObjSurveyAccess, ilObjSurveyQuestionPoolAccess, ilObjTestAccess, ilObjQuestionPoolAccess, and ilObjLinkResourceAccess.

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

Referenced by ilObjectListGUI::init().

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

Here is the caller graph for this function:


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