Inheritance diagram for ilObjWikiAccess:

Collaboration diagram for ilObjWikiAccess:

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...

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...

Static Public Member Functions
static	_getCommands ()
	get commands More...

static	_checkGoto ($a_target)
	check whether goto script will succeed More...

static	_lookupOnline ($a_id)
	Check wether wiki cast is online. More...

static	_lookupPublicFiles ($a_id)
	Check wether files should be public. 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. More...

static	_preloadData ($a_obj_ids, $a_ref_ids)
	Preload data. More...

Protected Attributes
	$user

	$lng

	$rbacsystem

	$access

Detailed Description

Class ilObjWikiAccess.

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjWikiAccess::__construct ( )

Constructor.

Definition at line 41 of file class.ilObjWikiAccess.php.

References $DIC, and user().

     {
         global $DIC;
 
         $this->user = $DIC->user();
         $this->lng = $DIC->language();
         $this->rbacsystem = $DIC->rbac()->system();
         $this->access = $DIC->access();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjWikiAccess::_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)

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 87 of file class.ilObjWikiAccess.php.

References $access, $ilUser, $lng, $rbacsystem, $user, _lookupOnline(), IL_NO_OBJECT_ACCESS, and IL_STATUS_MESSAGE.

     {
         $ilUser = $this->user;
         $lng = $this->lng;
         $rbacsystem = $this->rbacsystem;
         $ilAccess = $this->access;
 
         if ($a_user_id == "") {
             $a_user_id = $ilUser->getId();
         }
 
         switch ($a_cmd) {
             case "view":
 
                 if (!ilObjWikiAccess::_lookupOnline($a_obj_id)
                     && !$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id)) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                     return false;
                 }
                 break;
                 
             // for permission query feature
             case "infoScreen":
                 if (!ilObjWikiAccess::_lookupOnline($a_obj_id)) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                 } else {
                     $ilAccess->addInfoItem(IL_STATUS_MESSAGE, $lng->txt("online"));
                 }
                 break;
 
         }
         switch ($a_permission) {
             case "read":
             case "visible":
                 if (!ilObjWikiAccess::_lookupOnline($a_obj_id) &&
                     (!$rbacsystem->checkAccessOfUser($a_user_id, 'write', $a_ref_id))) {
                     $ilAccess->addInfoItem(IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                     return false;
                 }
                 break;
         }
 
         return true;
     }

Here is the call graph for this function:

◆ _checkGoto()

static ilObjWikiAccess::_checkGoto ( $a_target )

static

check whether goto script will succeed

Definition at line 135 of file class.ilObjWikiAccess.php.

References $DIC, $r, ilObject\_getAllReferences(), array, and ilWikiPage\lookupWikiId().

     {
         global $DIC;
 
         $ilAccess = $DIC->access();
         //      echo "-".$a_target."-"; exit;
         $t_arr = explode("_", $a_target);
 
         if ($t_arr[0] != "wiki" || (((int) $t_arr[1]) <= 0) && $t_arr[1] != "wpage") {
             return false;
         }
         
         if ($t_arr[1] == "wpage") {
             $wpg_id = (int) $t_arr[2];
             include_once("./Modules/Wiki/classes/class.ilWikiPage.php");
             $w_id = ilWikiPage::lookupWikiId($wpg_id);
             if ((int) $t_arr[3] > 0) {
                 $refs = array((int) $t_arr[3]);
             } else {
                 $refs = ilObject::_getAllReferences($w_id);
             }
             foreach ($refs as $r) {
                 if ($ilAccess->checkAccess("read", "", $r)) {
                     return true;
                 }
             }
         } elseif ($ilAccess->checkAccess("read", "", $t_arr[1])) {
             return true;
         }
         return false;
     }

Here is the call graph for this function:

◆ _getCommands()

static ilObjWikiAccess::_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"), );

Definition at line 64 of file class.ilObjWikiAccess.php.

References array.

Referenced by ilObjWikiListGUI\init().

     {
         $commands = array(
             array("permission" => "read", "cmd" => "view", "lang_var" => "show",
                 "default" => true),
             array("permission" => "write", "cmd" => "editSettings", "lang_var" => "settings")
         );
         
         return $commands;
     }

Here is the caller graph for this function:

◆ _lookupOnline()

static ilObjWikiAccess::_lookupOnline ( $a_id )

static

Check wether wiki cast is online.

Parameters

int $a_id wiki id

Definition at line 172 of file class.ilObjWikiAccess.php.

References $DIC, and $ilDB.

Referenced by _checkAccess(), and ilObjWikiListGUI\getProperties().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "SELECT * FROM il_wiki_data WHERE id = " .
             $ilDB->quote($a_id, "integer");
         $wk_set = $ilDB->query($q);
         $wk_rec = $ilDB->fetchAssoc($wk_set);
 
         return $wk_rec["is_online"];
     }

Here is the caller graph for this function:

◆ _lookupPublicFiles()

static ilObjWikiAccess::_lookupPublicFiles ( $a_id )

static

Check wether files should be public.

Parameters

int $a_id wiki id

Definition at line 191 of file class.ilObjWikiAccess.php.

References $DIC, and $ilDB.

     {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         $q = "SELECT * FROM il_wiki_data WHERE id = " .
             $ilDB->quote($a_id, "integer");
         $wk_set = $ilDB->query($q);
         $wk_rec = $ilDB->fetchAssoc($wk_set);
 
         return $wk_rec["public_files"];
     }

Field Documentation

◆ $access

ilObjWikiAccess::$access

protected

Definition at line 35 of file class.ilObjWikiAccess.php.

Referenced by _checkAccess().

◆ $lng

ilObjWikiAccess::$lng

protected

Definition at line 25 of file class.ilObjWikiAccess.php.

Referenced by _checkAccess().

◆ $rbacsystem

ilObjWikiAccess::$rbacsystem

protected

Definition at line 30 of file class.ilObjWikiAccess.php.

Referenced by _checkAccess().

◆ $user

ilObjWikiAccess::$user

protected

Definition at line 20 of file class.ilObjWikiAccess.php.

Referenced by _checkAccess().

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

Modules/Wiki/classes/class.ilObjWikiAccess.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkAccess()

◆ _checkGoto()

◆ _getCommands()

◆ _lookupOnline()

◆ _lookupPublicFiles()

Field Documentation

◆ $access

◆ $lng

◆ $rbacsystem

◆ $user