ilClaimingPermissionHelper 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 ilClaimingPermissionHelper:

Collaboration diagram for ilClaimingPermissionHelper:

Public Member Functions
	reset ()
	Reset (internal caches) More...
	hasPermission (int $a_context_type, string $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check permission. More...
	hasPermissions (int $a_context_type, string $a_context_id, array $a_action_ids)
	Check permissions. More...
	getAllowedObjectTypes ()

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

Protected Member Functions
	__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, string $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, string $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, string $a_context_id, int $a_action_id, ?int $a_action_sub_id=null)
	Check permission against plugins. More...

Protected Attributes
int	$user_id = 0
int	$ref_id = 0
array	$map = []
array	$context_ids = []
array	$plugins = null

Static Protected Attributes
static array	$instances = []

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 Claiming permission helper base class

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 24 of file class.ilClaimingPermissionHelper.php.

Constructor & Destructor Documentation

__construct()

ilClaimingPermissionHelper::__construct ( int  $a_user_id, int  $a_ref_id  )

protected

Definition at line 34 of file class.ilClaimingPermissionHelper.php.

References buildPermissionMap(), reset(), setRefId(), and setUserId().

    {
        $this->setUserId($a_user_id);
        $this->setRefId($a_ref_id);
        $this->map = $this->buildPermissionMap();
        $this->reset();
    }

Here is the call graph for this function:

Member Function Documentation

buildPermissionMap()

ilClaimingPermissionHelper::buildPermissionMap ( )

abstractprotected

Build map of context and actions.

Referenced by __construct(), and getRefId().

Here is the caller graph for this function:

checkPermission()

ilClaimingPermissionHelper::checkPermission ( int  $a_context_type, string  $a_context_id, int  $a_action_id, ?int  $a_action_sub_id = null  )

protected

Check permission (helper: rbac, plugins)

Definition at line 187 of file class.ilClaimingPermissionHelper.php.

References checkPlugins(), and checkRBAC().

Referenced by hasPermission().

     : bool {
        return ($this->checkRBAC() &&
            $this->checkPlugins($a_context_type, (string) $a_context_id, $a_action_id, $a_action_sub_id));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkPlugins()

ilClaimingPermissionHelper::checkPlugins ( int  $a_context_type, string  $a_context_id, int  $a_action_id, ?int  $a_action_sub_id = null  )

protected

Check permission against plugins.

Definition at line 217 of file class.ilClaimingPermissionHelper.php.

References XapiProxy\$plugin, $valid, getActivePlugins(), and ilAdvancedMDPermissionHelper\SUBACTION_UNDEFINED.

Referenced by checkPermission(), and ilAdvancedMDPermissionHelper\checkPermission().

     : bool {
        $valid = true;

        if (!is_array($this->plugins)) {
            $this->plugins = iterator_to_array($this->getActivePlugins());
        }

        foreach ($this->plugins as $plugin) {
            $a_action_sub_id = is_null($a_action_sub_id)
                ? ilAdvancedMDPermissionHelper::SUBACTION_UNDEFINED
                : $a_action_sub_id;
            if (!$plugin->checkPermission($this->getUserId(), $a_context_type, $a_context_id, $a_action_id, $a_action_sub_id)) {
                $valid = false;
                break;
            }
        }

        return $valid;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkRBAC()

ilClaimingPermissionHelper::checkRBAC ( )

protected

Check permission against RBAC.

Definition at line 200 of file class.ilClaimingPermissionHelper.php.

References $DIC, getActivePlugins(), getRefId(), and getUserId().

Referenced by checkPermission(), and ilAdvancedMDPermissionHelper\checkPermission().

                                  : bool
    {
        global $DIC;
        $ilAccess = $DIC->access();

        // we are currently only supporting write operations
        return $ilAccess->checkAccessOfUser($this->getUserId(), "write", "", $this->getRefId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getActivePlugins()

ilClaimingPermissionHelper::getActivePlugins ( )

abstractprotected

Get active plugins (for current slot)

Referenced by checkPlugins(), and checkRBAC().

Here is the caller graph for this function:

getAllowedObjectTypes()

ilClaimingPermissionHelper::getAllowedObjectTypes

(

)

Returns

array of object type strings

Definition at line 245 of file class.ilClaimingPermissionHelper.php.

Referenced by ilAdvancedMDPermissionHelper\readContextIds().

                                           : array
    {
        $accepted_types = ['cat','crs','sess','grp','iass','exc','file'];

        $obj_def = new ilObjectDefinition();
        $adv_md_types = $obj_def->getAdvancedMetaDataTypes();

        $valid_accepted_types = [];
        foreach ($adv_md_types as $value) {
            if (in_array($value['obj_type'], $accepted_types) || in_array($value['sub_type'], $accepted_types)) {
                array_push($valid_accepted_types, $value['obj_type']);
            }
        }

        return $valid_accepted_types;
    }

Here is the caller graph for this function:

getInstance()

static ilClaimingPermissionHelper::getInstance ( int  $a_user_id, int  $a_ref_id  )

static

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

Referenced by ilCustomUserFieldsGUI\__construct(), and ilAdvancedMDSettingsGUI\__construct().

                                                                     : self
    {
        if (!isset(self::$instances[$a_user_id][$a_ref_id])) {
            self::$instances[$a_user_id][$a_ref_id] = new static($a_user_id, $a_ref_id);
        }
        return self::$instances[$a_user_id][$a_ref_id];
    }

Here is the caller graph for this function:

getRefId()

ilClaimingPermissionHelper::getRefId ( )

protected

Definition at line 76 of file class.ilClaimingPermissionHelper.php.

References $ref_id, buildPermissionMap(), and readContextIds().

Referenced by ilAdvancedMDPermissionHelper\checkPermission(), checkRBAC(), and ilUDFPermissionHelper\readContextIds().

                                 : int
    {
        return $this->ref_id;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserId()

ilClaimingPermissionHelper::getUserId ( )

protected

Definition at line 66 of file class.ilClaimingPermissionHelper.php.

References $user_id.

Referenced by ilAdvancedMDPermissionHelper\checkPermission(), and checkRBAC().

                                  : int
    {
        return $this->user_id;
    }

Here is the caller graph for this function:

getValidContextIds()

ilClaimingPermissionHelper::getValidContextIds ( int  $a_context_type )

protected

Get context ids for context type (uses cache)

See also

self::readContextIds()

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

References readContextIds().

Referenced by isValidContextAndAction().

                                                              : array
    {
        if (!array_key_exists($a_context_type, $this->context_ids)) {
            $this->context_ids[$a_context_type] = $this->readContextIds($a_context_type);
        }
        return (array) $this->context_ids[$a_context_type];
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasPermission()

ilClaimingPermissionHelper::hasPermission	(	int	$a_context_type,
		string	$a_context_id,
		int	$a_action_id,
		?int	$a_action_sub_id = null
	)

Check permission.

Definition at line 150 of file class.ilClaimingPermissionHelper.php.

References checkPermission(), and isValidContextAndAction().

Referenced by hasPermissions(), and ilAdvancedMDFieldDefinition\importDefinitionFormPostValues().

     : bool {
        if ($this->isValidContextAndAction($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id)) {
            return $this->checkPermission($a_context_type, $a_context_id, $a_action_id, $a_action_sub_id);
        }
        // :TODO: exception?
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasPermissions()

ilClaimingPermissionHelper::hasPermissions	(	int	$a_context_type,
		string	$a_context_id,
		array	$a_action_ids
	)

Check permissions.

Definition at line 166 of file class.ilClaimingPermissionHelper.php.

References $res, and hasPermission().

Referenced by ilAdvancedMDFieldDefinition\addToFieldDefinitionForm().

                                                                                                  : array
    {
        $res = [];

        foreach ($a_action_ids as $action_id) {
            if (is_array($action_id)) {
                $action_sub_id = $action_id[1];
                $action_id = $action_id[0];

                $res[$action_id][$action_sub_id] = $this->hasPermission($a_context_type, $a_context_id, $action_id, $action_sub_id);
            } else {
                $res[$action_id] = $this->hasPermission($a_context_type, $a_context_id, $action_id);
            }
        }

        return $res;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isValidContextAndAction()

ilClaimingPermissionHelper::isValidContextAndAction ( int  $a_context_type, string  $a_context_id, int  $a_action_id, ?int  $a_action_sub_id = null  )

protected

Check if given combination of context and action is valid.

Definition at line 100 of file class.ilClaimingPermissionHelper.php.

References $valid, and getValidContextIds().

Referenced by hasPermission().

     : bool {
        $valid = false;

        if (array_key_exists($a_context_type, $this->map)) {
            if (!$a_action_sub_id) {
                if (in_array($a_action_id, $this->map[$a_context_type]["actions"])) {
                    $valid = true;
                }
            } else {
                if (array_key_exists($a_action_id, $this->map[$a_context_type]["subactions"]) &&
                    in_array($a_action_sub_id, $this->map[$a_context_type]["subactions"][$a_action_id])) {
                    $valid = true;
                }
            }
        }

        if ($valid &&
            $a_context_id &&
            !in_array($a_context_id, $this->getValidContextIds($a_context_type))) {
            $valid = false;
        }

        if (DEVMODE && !$valid) {
            trigger_error("INVALID permission context - " . $a_context_type . ":" . $a_context_id . ":" . $a_action_id . ":" . $a_action_sub_id, E_USER_WARNING);
        }

        return $valid;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

readContextIds()

ilClaimingPermissionHelper::readContextIds ( int  $a_context_type )

abstractprotected

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

Referenced by getRefId(), and getValidContextIds().

Here is the caller graph for this function:

reset()

ilClaimingPermissionHelper::reset

(

)

Reset (internal caches)

Definition at line 53 of file class.ilClaimingPermissionHelper.php.

Referenced by __construct().

                           : void
    {
        $this->context_ids = [];
    }

Here is the caller graph for this function:

setRefId()

ilClaimingPermissionHelper::setRefId ( int  $a_value )

protected

Definition at line 71 of file class.ilClaimingPermissionHelper.php.

Referenced by __construct().

                                             : void
    {
        $this->ref_id = $a_value;
    }

Here is the caller graph for this function:

setUserId()

ilClaimingPermissionHelper::setUserId ( int  $a_value )

protected

Definition at line 61 of file class.ilClaimingPermissionHelper.php.

Referenced by __construct().

                                              : void
    {
        $this->user_id = $a_value;
    }

Here is the caller graph for this function:

Field Documentation

$context_ids

array ilClaimingPermissionHelper::$context_ids = []

protected

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

$instances

array ilClaimingPermissionHelper::$instances = []

staticprotected

Definition at line 32 of file class.ilClaimingPermissionHelper.php.

$map

array ilClaimingPermissionHelper::$map = []

protected

Definition at line 28 of file class.ilClaimingPermissionHelper.php.

$plugins

array ilClaimingPermissionHelper::$plugins = null

protected

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

$ref_id

int ilClaimingPermissionHelper::$ref_id = 0

protected

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

Referenced by getRefId().

$user_id

int ilClaimingPermissionHelper::$user_id = 0

protected

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

Referenced by getUserId().

---

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

• components/ILIAS/AccessControl/classes/class.ilClaimingPermissionHelper.php