ilObjBibliographicAccess Class Reference

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

Inheritance diagram for ilObjBibliographicAccess:

Collaboration diagram for ilObjBibliographicAccess:

Public Member Functions
	_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)

Static Public Member Functions
static	_getCommands ()
	get commands More...
static	_checkGoto (string $target)
static	_lookupOnline (int $a_id)
	Check wether bibliographic is online or not. 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...

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 Class ilObjBibliographicAccess

Author

Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Gabriel Comte gc@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Member Function Documentation

_checkAccess()

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

Definition at line 75 of file class.ilObjBibliographicAccess.php.

References $DIC, $lng, $user_id, ilAccessInfo\IL_NO_OBJECT_ACCESS, ilAccessInfo\IL_STATUS_MESSAGE, and ilObjBibliographicGUI\P_ENTRY_ID.

                                                                                                                 : bool
    {
        global $DIC;
        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $rbacsystem = $DIC['rbacsystem'];
        $ilAccess = $DIC['ilAccess'];
        if (is_null($user_id)) {
            $user_id = $ilUser->getId();
        }

        if ($DIC->http()->wrapper()->query()->has(ilObjBibliographicGUI::P_ENTRY_ID)) {
            $entry_id = $DIC->http()->wrapper()->query()->retrieve(
                ilObjBibliographicGUI::P_ENTRY_ID,
                $DIC->refinery()->kindlyTo()->int()
            );
            if (!$this->checkEntryIdMatch($obj_id, $entry_id)) {
                return false;
            }
        }

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

        return true;
    }

_checkGoto()

static ilObjBibliographicAccess::_checkGoto ( string  $target )

static

Definition at line 58 of file class.ilObjBibliographicAccess.php.

References $DIC.

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

_getCommands()

static ilObjBibliographicAccess::_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<int, array<string, string>>|array<int, array<string, string|bool>>

Definition at line 42 of file class.ilObjBibliographicAccess.php.

Referenced by ilObjBibliographicListGUI\init().

                                         : array
    {
        return [
            [
                "permission" => "read",
                "cmd" => "render",
                "lang_var" => "show",
                "default" => true,
            ],
            ["permission" => "write", "cmd" => "view", "lang_var" => "edit_content"],
            ["permission" => "write", "cmd" => "settings", "lang_var" => "settings"],
        ];
    }

Here is the caller graph for this function:

_lookupOnline()

static ilObjBibliographicAccess::_lookupOnline ( int  $a_id )

static

Check wether bibliographic is online or not.

Definition at line 149 of file class.ilObjBibliographicAccess.php.

Referenced by ilObjBibliographicListGUI\getProperties().

                                                   : bool
    {
        $bibl_obj = new ilObjBibliographic($a_id);
        return $bibl_obj->getObjectProperties()->getPropertyIsOnline()->getIsOnline();
    }

Here is the caller graph for this function:

---

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

• components/ILIAS/Bibliographic/classes/class.ilObjBibliographicAccess.php