Advanced metadata permission helper. More...

Inheritance diagram for ilAdvancedMDPermissionHelper:

Collaboration diagram for ilAdvancedMDPermissionHelper:

Data Fields
const int	CONTEXT_MD = 1

const int	CONTEXT_RECORD = 2

const int	CONTEXT_FIELD = 3

const int	ACTION_MD_CREATE_RECORD = 1

const int	ACTION_MD_IMPORT_RECORDS = 2

const int	ACTION_RECORD_EDIT = 5

const int	ACTION_RECORD_DELETE = 6

const int	ACTION_RECORD_EXPORT = 7

const int	ACTION_RECORD_TOGGLE_ACTIVATION = 8

const int	ACTION_RECORD_EDIT_PROPERTY = 9

const int	ACTION_RECORD_EDIT_FIELDS = 10

const int	ACTION_RECORD_CREATE_FIELD = 11

const int	ACTION_RECORD_FIELD_POSITIONS = 12

const int	ACTION_FIELD_EDIT = 13

const int	ACTION_FIELD_DELETE = 14

const int	ACTION_FIELD_EDIT_PROPERTY = 15

const int	SUBACTION_UNDEFINED = 0

const int	SUBACTION_RECORD_TITLE = 1

const int	SUBACTION_RECORD_DESCRIPTION = 2

const int	SUBACTION_RECORD_OBJECT_TYPES = 3

const int	SUBACTION_FIELD_TITLE = 4

const int	SUBACTION_FIELD_DESCRIPTION = 5

const int	SUBACTION_FIELD_SEARCHABLE = 6

const int	SUBACTION_FIELD_PROPERTIES = 7

Protected Member Functions
	readContextIds (int $a_context_type)
	Get all context ids for context type (from DB, is cached) More...

	buildPermissionMap ()
	Build map of context and actions. More...

	getActivePlugins ()
	Get active plugins (for current slot) More...

	checkPermission (int $a_context_type, int $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check permission (helper: rbac, plugins) More...

Protected Member Functions inherited from ilClaimingPermissionHelper
	__construct (int $a_user_id, int $a_ref_id)

	setUserId (int $a_value)

	getUserId ()

	setRefId (int $a_value)

	getRefId ()

	readContextIds (int $a_context_type)
	Get all context ids for context type (from DB, is cached) More...

	buildPermissionMap ()
	Build map of context and actions. More...

	isValidContextAndAction (int $a_context_type, int $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check if given combination of context and action is valid. More...

	getValidContextIds (int $a_context_type)
	Get context ids for context type (uses cache) More...

	checkPermission (int $a_context_type, int $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check permission (helper: rbac, plugins) More...

	checkRBAC ()
	Check permission against RBAC. More...

	getActivePlugins ()
	Get active plugins (for current slot) More...

	checkPlugins (int $a_context_type, int $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check permission against plugins. More...

Additional Inherited Members
Public Member Functions inherited from ilClaimingPermissionHelper
	reset ()
	Reset (internal caches) More...

	hasPermission (int $a_context_type, int $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check permission. More...

	hasPermissions (int $a_context_type, int $a_context_id, array $a_action_ids)
	Check permissions. More...

Static Public Member Functions inherited from ilClaimingPermissionHelper
static	getInstance (int $a_user_id, int $a_ref_id)

Protected Attributes inherited from ilClaimingPermissionHelper
int	$user_id = 0

int	$ref_id = 0

array	$map = []

array	$context_ids = []

array	$plugins = null

Static Protected Attributes inherited from ilClaimingPermissionHelper
static array	$instances = []

Detailed Description

Advanced metadata permission helper.

Author: Jörg Lützenkirchen luetz.nosp@m.enki.nosp@m.rchen.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Member Function Documentation

◆ buildPermissionMap()

ilAdvancedMDPermissionHelper::buildPermissionMap ( )

protected

Build map of context and actions.

Reimplemented from ilClaimingPermissionHelper.

Definition at line 92 of file class.ilAdvancedMDPermissionHelper.php.

                                           : array
    {
        return array(
            self::CONTEXT_MD => array(
                "actions" => array(
                    self::ACTION_MD_CREATE_RECORD
                    ,
                    self::ACTION_MD_IMPORT_RECORDS
                )
            ),
            self::CONTEXT_RECORD => array(
                "actions" => array(
                    self::ACTION_RECORD_EDIT
                    ,
                    self::ACTION_RECORD_DELETE
                    ,
                    self::ACTION_RECORD_EXPORT
                    ,
                    self::ACTION_RECORD_TOGGLE_ACTIVATION
                    ,
                    self::ACTION_RECORD_EDIT_FIELDS
                    ,
                    self::ACTION_RECORD_FIELD_POSITIONS
                    ,
                    self::ACTION_RECORD_CREATE_FIELD
                ),
                "subactions" => array(
                    self::ACTION_RECORD_EDIT_PROPERTY =>
                        array(
                            self::SUBACTION_RECORD_TITLE
                            ,
                            self::SUBACTION_RECORD_DESCRIPTION
                            ,
                            self::SUBACTION_RECORD_OBJECT_TYPES
                        )
                )
            ),
            self::CONTEXT_FIELD => array(
                "actions" => array(
                    self::ACTION_FIELD_EDIT,
                    self::ACTION_FIELD_DELETE
                ),
                "subactions" => array(
                    self::ACTION_FIELD_EDIT_PROPERTY =>
                        array(
                            self::SUBACTION_FIELD_TITLE
                            ,
                            self::SUBACTION_FIELD_DESCRIPTION
                            ,
                            self::SUBACTION_FIELD_SEARCHABLE
                            ,
                            self::SUBACTION_FIELD_PROPERTIES
                        )
                )
            )
        );
    }

◆ checkPermission()

ilAdvancedMDPermissionHelper::checkPermission	(	int	$a_context_type,
		int	$a_context_id,
		int	$a_action_id,
		?int	$a_action_sub_id = `null`
	)

protected

Check permission (helper: rbac, plugins)

Reimplemented from ilClaimingPermissionHelper.

Definition at line 160 of file class.ilAdvancedMDPermissionHelper.php.

     : bool {
        global $DIC;
 
        $ilAccess = $DIC['ilAccess'];
 
        if (!$this->checkPlugins($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id)) {
            return false;
        }
 
        // export is considered read-action
        if ($a_context_type == ilAdvancedMDPermissionHelper::CONTEXT_RECORD &&
            $a_action_id == ilAdvancedMDPermissionHelper::ACTION_RECORD_EXPORT) {
            return $ilAccess->checkAccessOfUser($this->getUserId(), "read", "", $this->getRefId());
        }
 
        return $this->checkRBAC();
    }

◆ getActivePlugins()

ilAdvancedMDPermissionHelper::getActivePlugins ( )

protected

Get active plugins (for current slot)

Reimplemented from ilClaimingPermissionHelper.

Definition at line 152 of file class.ilAdvancedMDPermissionHelper.php.

                                         : Generator
    {
        global $DIC;
 
        $component_factory = $DIC['component.factory'];
        yield from $component_factory->getActivePluginsInSlot("amdc");
    }

References $DIC, and ILIAS\ResourceStorage\Flavour\Machine\DefaultMachines\from().

Here is the call graph for this function:

◆ readContextIds()

ilAdvancedMDPermissionHelper::readContextIds ( int $a_context_type )

protected

Get all context ids for context type (from DB, is cached)

Reimplemented from ilClaimingPermissionHelper.

Definition at line 59 of file class.ilAdvancedMDPermissionHelper.php.

                                                          : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        switch ($a_context_type) {
            case self::CONTEXT_MD:
                return array($this->ref_id);
 
            case self::CONTEXT_RECORD:
                $set = $ilDB->query("SELECT record_id id" .
                    " FROM adv_md_record");
                break;
 
            case self::CONTEXT_FIELD:
                $set = $ilDB->query("SELECT field_id id" .
                    " FROM adv_mdf_definition");
                break;
 
            default:
                return array();
        }
 
        $res = array();
        while ($row = $ilDB->fetchAssoc($set)) {
            $res[] = (int) $row["id"];
        }
        return $res;
    }