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

Inheritance diagram for ilObjLinkResourceAccess:

Collaboration diagram for ilObjLinkResourceAccess:

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)

	canBeDelivered (ilWACPath $ilWACPath)

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

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

static	_getFirstLink (int $a_webr_id)
	Get first link item Check before with _isSingular() if there is more or less than one. More...

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

static	_checkDirectLink ($a_obj_id)
	Check whether there is only one active link in the web resource. 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...

Static Public Attributes
static array	$item = []

static array	$single_link = []

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 ilObjLinkResourceAccess

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

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

Member Function Documentation

◆ _checkAccess()

ilObjLinkResourceAccess::_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 73 of file class.ilObjLinkResourceAccess.php.

     : bool {
        global $DIC;
        $rbacsystem = $DIC->rbac()->system();
        $web_link_repo = new ilWebLinkDatabaseRepository($obj_id);
 
        // Set offline if no valid link exists
        if ($permission == 'read') {
            if (!$web_link_repo->getAllItemsAsContainer(true)
                                     ->getFirstItem() &&
                !$rbacsystem->checkAccessOfUser(
                    $user_id,
                    'write',
                    $ref_id
                )) {
                return false;
            }
        }
        return parent::_checkAccess(
            $cmd,
            $permission,
            $ref_id,
            $obj_id,
            $user_id
        );
    }

◆ _checkDirectLink()

static ilObjLinkResourceAccess::_checkDirectLink ( $a_obj_id )

static

Check whether there is only one active link in the web resource.

In this case this link is shown in a new browser window

Definition at line 139 of file class.ilObjLinkResourceAccess.php.

                                                      : bool
    {
        if (isset(self::$single_link[$a_obj_id])) {
            return self::$single_link[$a_obj_id];
        }
 
        $web_link_repo = new ilWebLinkDatabaseRepository($a_obj_id);
 
        return self::$single_link[$a_obj_id] = $web_link_repo->doesOnlyOneItemExist(true);
    }

Referenced by ilObjLinkResourceListGUI\getCommandFrame(), ilObjLinkResourceListGUI\getCommandLink(), ilObjLinkResourceListGUI\getDescription(), and ilObjLinkResourceListGUI\getTitle().

Here is the caller graph for this function:

◆ _checkGoto()

static ilObjLinkResourceAccess::_checkGoto ( string $target )

static

check whether goto script will succeed

Reimplemented from ilObjectAccess.

Definition at line 56 of file class.ilObjLinkResourceAccess.php.

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

References $DIC, $ref_id, $type, and ILIAS\Repository\int().

Here is the call graph for this function:

◆ _getCommands()

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

                                         : array
    {
        return array(
            array("permission" => "read",
                  "cmd" => "",
                  "lang_var" => "show",
                  "default" => true
            ),
            array("permission" => "read",
                  "cmd" => "exportHTML",
                  "lang_var" => "export_html"
            ),
            array("permission" => "write",
                  "cmd" => "editLinks",
                  "lang_var" => "edit_content"
            ),
            array("permission" => "write",
                  "cmd" => "settings",
                  "lang_var" => "settings"
            )
        );
    }

Referenced by ilObjLinkResourceListGUI\init().

Here is the caller graph for this function:

◆ _getFirstLink()

static ilObjLinkResourceAccess::_getFirstLink ( int $a_webr_id )

static

Get first link item Check before with _isSingular() if there is more or less than one.

Definition at line 109 of file class.ilObjLinkResourceAccess.php.

                                                        : ilWebLinkItem
    {
        if (isset(self::$item[$a_webr_id])) {
            return self::$item[$a_webr_id];
        }
 
        $web_link_repo = new ilWebLinkDatabaseRepository($a_webr_id);
 
        $current_item = $web_link_repo->getAllItemsAsContainer(true)
                                      ->getFirstItem();
 
        self::$item[$current_item->getWebrId()] = $current_item;
 
        return $current_item;
    }

Referenced by ilObjLinkResourceGUI\callDirectLink(), ilObjLinkResourceListGUI\getCommandFrame(), ilObjLinkResourceListGUI\getDescription(), and ilObjLinkResourceListGUI\getTitle().

Here is the caller graph for this function:

◆ _preloadData()

static ilObjLinkResourceAccess::_preloadData	(	array	$obj_ids,
		array	$ref_ids
	)

static

Preload data.

Reimplemented from ilObjectAccess.

Definition at line 125 of file class.ilObjLinkResourceAccess.php.

                                                                       : void
    {
        foreach ($obj_ids as $id) {
            $web_link_repo = new ilWebLinkDatabaseRepository($id);
            $first_item = $web_link_repo->getAllItemsAsContainer(true)
                                        ->getFirstItem();
            self::$item[$id] = $first_item;
        }
    }

References $id.

Field Documentation

◆ $item

array ilObjLinkResourceAccess::$item = []

static

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

◆ $single_link

array ilObjLinkResourceAccess::$single_link = []

static

Definition at line 31 of file class.ilObjLinkResourceAccess.php.

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

Modules/WebResource/classes/class.ilObjLinkResourceAccess.php

Public Member Functions

Static Public Member Functions

Static Public Attributes

Detailed Description

Member Function Documentation

◆ _checkAccess()

◆ _checkDirectLink()

◆ _checkGoto()

◆ _getCommands()

◆ _getFirstLink()

◆ _preloadData()

Field Documentation

◆ $item

◆ $single_link