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

Inheritance diagram for ilObjBookingPoolAccess:

Collaboration diagram for ilObjBookingPoolAccess:

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

	canBeDelivered (ilWACPath $ilWACPath)

	_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	_lookupOnlineStatus (array $a_ids)
	Check whether booking pool is online (legacy version) 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
ilLanguage	$lng

ilAccessHandler	$access

ilObjUser	$user

ilRbacSystem	$rbacsystem

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: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

◆ __construct()

ilObjBookingPoolAccess::__construct ( )

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ _checkAccess()

ilObjBookingPoolAccess::_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 68 of file class.ilObjBookingPoolAccess.php.

                                                                                                                 : bool
    {
        $ilUser = $this->user;
        $rbacsystem = $this->rbacsystem;
 
        if ($user_id === null) {
            $user_id = $ilUser->getId();
        }
 
        // add no access info item and return false if access is not granted
        // $ilAccess->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $text, $data = "");
        //
        // for all RBAC checks use checkAccessOfUser instead the normal checkAccess-method:
        // $rbacsystem->checkAccessOfUser($user_id, $permission, $ref_id)
 
        //TODO refactor this: first check if the object is online and then the permissions.
        #22653
        if (($permission === "visible" || $permission === "read") && !$rbacsystem->checkAccessOfUser($user_id, 'write', $ref_id)) {
            if (self::_isOffline($obj_id)) {
                $this->access->addInfoItem(ilAccessInfo::IL_NO_OBJECT_ACCESS, $this->lng->txt("offline"));
                return false;
            }
        }
 
        return true;
    }

References $rbacsystem, $ref_id, $user, $user_id, ILIAS\Repository\access(), ilRbacSystem\checkAccessOfUser(), ilAccessInfo\IL_NO_OBJECT_ACCESS, and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ _checkGoto()

static ilObjBookingPoolAccess::_checkGoto ( string $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 49 of file class.ilObjBookingPoolAccess.php.

                                                     : bool
    {
        global $DIC;
 
        $ilAccess = $DIC->access();
 
        $t_arr = explode("_", $target);
 
        if ($t_arr[0] !== "book" || ((int) $t_arr[1]) <= 0) {
            return false;
        }
 
        if ($ilAccess->checkAccess("read", "", $t_arr[1]) ||
            $ilAccess->checkAccess("visible", "", $t_arr[1])) {
            return true;
        }
        return false;
    }

References $DIC.

◆ _getCommands()

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

                                         : array
    {
        $commands = array();
        $commands[] = array("permission" => "read", "cmd" => "render", "lang_var" => "show", "default" => true);
        $commands[] = array("permission" => "write", "cmd" => "render", "lang_var" => "book_booking_objects");
        $commands[] = array("permission" => "write", "cmd" => "edit", "lang_var" => "settings");
 
        return $commands;
    }

Referenced by ilObjBookingPoolListGUI\init().

Here is the caller graph for this function:

◆ _lookupOnlineStatus()

static ilObjBookingPoolAccess::_lookupOnlineStatus ( array $a_ids )

static

Check whether booking pool is online (legacy version)

Deprecated:

Definition at line 99 of file class.ilObjBookingPoolAccess.php.

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

References $DIC, $ilDB, $lm_set, and $q.

Referenced by ILIAS\Container\Content\Filter\FilterManager\legacyOnlineFilter().

Here is the caller graph for this function:

◆ canBeDelivered()

ilObjBookingPoolAccess::canBeDelivered ( ilWACPath $ilWACPath )

Reimplemented from ilObjectAccess.

Definition at line 115 of file class.ilObjBookingPoolAccess.php.

                                                        : bool
    {
        // we return always false, since the files in the file/ and post/ directoies
        // are server by php (they could/should be moved to the data dir outside of the web doc root)
        return false;
    }

Field Documentation

◆ $access

ilAccessHandler ilObjBookingPoolAccess::$access

protected

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

◆ $lng

ilLanguage ilObjBookingPoolAccess::$lng

protected

Definition at line 24 of file class.ilObjBookingPoolAccess.php.

◆ $rbacsystem

ilRbacSystem ilObjBookingPoolAccess::$rbacsystem

protected

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

Referenced by _checkAccess().

◆ $user

ilObjUser ilObjBookingPoolAccess::$user

protected

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

Referenced by _checkAccess().

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

components/ILIAS/BookingManager/classes/class.ilObjBookingPoolAccess.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _checkAccess()

◆ _checkGoto()

◆ _getCommands()

◆ _lookupOnlineStatus()

◆ canBeDelivered()

Field Documentation

◆ $access

◆ $lng

◆ $rbacsystem

◆ $user