This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilObjWikiAccess:

Collaboration diagram for ilObjWikiAccess:

Public Member Functions
	__construct ()

	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

Public Member Functions inherited from ilObjectAccess
	_checkAccess (string $cmd, string $permission, int $ref_id, int $obj_id, ?int $user_id=null)
	Checks whether a user may invoke a command or not (this method is called by ilAccessHandler::checkAccess) More...

	canBeDelivered (ilWACPath $ilWACPath)

	canBeDelivered (ilWACPath $ilWACPath)

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

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

static	_lookupOnline (int $a_id)

static	_lookupOnlineStatus (array $a_ids)
	see legacyOnlineFilter in ilContainer More...

static	_lookupPublicFiles (int $a_id)
	Check wether files should be public. More...

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

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

static	_isOffline (int $obj_id)
	Type-specific implementation of general status, has to be overwritten if object type does not support centralized offline handling. More...

static	_preloadData (array $obj_ids, array $ref_ids)
	Preload data. More...

Protected Attributes
ilObjUser	$user

ilLanguage	$lng

ilRbacSystem	$rbacsystem

ilAccessHandler	$access

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilObjWikiAccess::__construct ( )

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

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

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\lng(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjWikiAccess::_checkAccess	(	string	$cmd,
		string	$permission,
		int	$ref_id,
		int	$obj_id,
		?int	$user_id = `null`
	)

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

Reimplemented from ilObjectAccess.

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

                                                                                                                 : bool
    {
        $ilUser = $this->user;
        $lng = $this->lng;
        $rbacsystem = $this->rbacsystem;
        $ilAccess = $this->access;
 
        if (is_null($user_id)) {
            $user_id = $ilUser->getId();
        }
 
        switch ($cmd) {
            case "view":
 
                if (!self::_lookupOnline($obj_id)
                    && !$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id)) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                    return false;
                }
                break;
 
            // for permission query feature
            case "infoScreen":
                if (!self::_lookupOnline($obj_id)) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                } else {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_STATUS_MESSAGE, $lng->txt("online"));
                }
                break;
 
        }
        switch ($permission) {
            case "read":
            case "visible":
                if (!self::_lookupOnline($obj_id) &&
                    (!$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id))) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $lng->txt("offline"));
                    return false;
                }
 
                $info = ilExcRepoObjAssignment::getInstance()->getAccessInfo($ref_id, $user_id);
                if (!$info->isGranted()) {
                    $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, implode(" / ", $info->getNotGrantedReasons()));
                    return false;
                }
                break;
        }
 
        return true;
    }

References $access, $ilUser, $lng, $rbacsystem, $ref_id, $user, ilRbacSystem\checkAccessOfUser(), ilExcRepoObjAssignment\getInstance(), ilAccessInfo\IL_NO_OBJECT_ACCESS, ilAccessInfo\IL_STATUS_MESSAGE, and ilLanguage\txt().

Here is the call graph for this function:

◆ _checkGoto()

static ilObjWikiAccess::_checkGoto ( string $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

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

                                                     : bool
    {
        global $DIC;
 
        $ilAccess = $DIC->access();
        //      echo "-".$target."-"; exit;
        $t_arr = explode("_", $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];
            $w_id = ilWikiPage::lookupWikiId($wpg_id);
            if ((int) ($t_arr[3] ?? 0) > 0) {
                $refs = array((int) $t_arr[3]);
            } else {
                $refs = ilObject::_getAllReferences($w_id);
            }
            foreach ($refs as $r) {
                if ($ilAccess->checkAccess("read", "", (int) $r) ||
                    $ilAccess->checkAccess("visible", "", (int) $r)) {
                    return true;
                }
            }
        } elseif ($ilAccess->checkAccess("read", "", (int) $t_arr[1]) ||
            $ilAccess->checkAccess("visible", "", (int) $t_arr[1])) {
            return true;
        }
        return false;
    }

References $DIC, ilObject\_getAllReferences(), ILIAS\Repository\int(), and ilWikiPage\lookupWikiId().

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

Returns: array{permission?:string, cmd?:string, lang_var?:string, default?:bool}[]

Reimplemented from ilObjectAccess.

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

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

Referenced by ilObjWikiListGUI\init().

Here is the caller graph for this function:

◆ _lookupOnline()

static ilObjWikiAccess::_lookupOnline ( int $a_id )

static

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

                                                   : bool
    {
        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 (bool) $wk_rec["is_online"];
    }

References $DIC, and $ilDB.

Referenced by ilObjWikiListGUI\getProperties().

Here is the caller graph for this function:

◆ _lookupOnlineStatus()

static ilObjWikiAccess::_lookupOnlineStatus ( array $a_ids )

static

see legacyOnlineFilter in ilContainer

Deprecated:

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

                                                            : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $q = "SELECT id, is_online FROM il_wiki_data WHERE " .
            $ilDB->in("id", $a_ids, false, "integer");
        $lm_set = $ilDB->query($q);
        $status = [];
        while ($r = $ilDB->fetchAssoc($lm_set)) {
            $status[$r["id"]] = (bool) $r["is_online"];
        }
        return $status;
    }

References $DIC, $ilDB, and $lm_set.

Referenced by ilContainer\legacyOnlineFilter().

Here is the caller graph for this function:

◆ _lookupPublicFiles()

static ilObjWikiAccess::_lookupPublicFiles ( int $a_id )

static

Check wether files should be public.

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

                                                        : bool
    {
        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 (bool) $wk_rec["public_files"];
    }

References $DIC, and $ilDB.

Field Documentation

◆ $access

ilAccessHandler ilObjWikiAccess::$access

protected

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

Referenced by _checkAccess().

◆ $lng

ilLanguage ilObjWikiAccess::$lng

protected

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

Referenced by _checkAccess().

◆ $rbacsystem

ilRbacSystem ilObjWikiAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

◆ $user

ilObjUser ilObjWikiAccess::$user

protected

Definition at line 24 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()

◆ _lookupOnlineStatus()

◆ _lookupPublicFiles()

Field Documentation

◆ $access

◆ $lng

◆ $rbacsystem

◆ $user