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

Inheritance diagram for ilUDFPermissionHelper:

Collaboration diagram for ilUDFPermissionHelper:

Data Fields
const	CONTEXT_UDF = 1

const	CONTEXT_FIELD = 2

const	ACTION_UDF_CREATE_FIELD = 1

const	ACTION_FIELD_EDIT = 1

const	ACTION_FIELD_DELETE = 2

const	ACTION_FIELD_EDIT_PROPERTY = 3

const	ACTION_FIELD_EDIT_ACCESS = 4

const	SUBACTION_FIELD_TITLE = 1

const	SUBACTION_FIELD_PROPERTIES = 2

const	SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL = 1

const	SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION = 2

const	SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL = 3

const	SUBACTION_FIELD_ACCESS_VISIBLE_COURSES = 4

const	SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS = 5

const	SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL = 6

const	SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL = 7

const	SUBACTION_FIELD_ACCESS_REQUIRED = 8

const	SUBACTION_FIELD_ACCESS_EXPORT = 9

const	SUBACTION_FIELD_ACCESS_SEARCHABLE = 10

const	SUBACTION_FIELD_ACCESS_CERTIFICATE = 11

Protected Member Functions
	readContextIds (int $a_context_type)

	buildPermissionMap ()

	getActivePlugins ()

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

Additional Inherited Members
Public Member Functions inherited from ilClaimingPermissionHelper
	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 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

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 UDF permission helper

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 23 of file class.ilUDFPermissionHelper.php.

Member Function Documentation

◆ buildPermissionMap()

ilUDFPermissionHelper::buildPermissionMap ( )

protected

Definition at line 82 of file class.ilUDFPermissionHelper.php.

                                            : array // Missing array type.
     {
         return array(
             self::CONTEXT_UDF => array(
                 "actions" => array(
                     self::ACTION_UDF_CREATE_FIELD
                 )
             ),
             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_PROPERTIES
                         )
                     ,self::ACTION_FIELD_EDIT_ACCESS =>
                         array(
                             self::SUBACTION_FIELD_ACCESS_VISIBLE_PERSONAL
                             ,self::SUBACTION_FIELD_ACCESS_VISIBLE_REGISTRATION
                             ,self::SUBACTION_FIELD_ACCESS_VISIBLE_LOCAL
                             ,self::SUBACTION_FIELD_ACCESS_VISIBLE_COURSES
                             ,self::SUBACTION_FIELD_ACCESS_VISIBLE_GROUPS
                             ,self::SUBACTION_FIELD_ACCESS_CHANGEABLE_PERSONAL
                             ,self::SUBACTION_FIELD_ACCESS_CHANGEABLE_LOCAL
                             ,self::SUBACTION_FIELD_ACCESS_REQUIRED
                             ,self::SUBACTION_FIELD_ACCESS_EXPORT
                             ,self::SUBACTION_FIELD_ACCESS_SEARCHABLE
                             ,self::SUBACTION_FIELD_ACCESS_CERTIFICATE
                         )
                 )
             )
         );
     }

◆ getActivePlugins()

ilUDFPermissionHelper::getActivePlugins ( )

protected

Definition at line 123 of file class.ilUDFPermissionHelper.php.

References $DIC.

                                          : Generator // Missing array type.
     {
         global $DIC;
         $component_factory = $DIC["component.factory"];
         yield from $component_factory->getActivePluginsInSlot("udfc");
     }

◆ readContextIds()

ilUDFPermissionHelper::readContextIds ( int $a_context_type )

protected

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

References $DIC, $ilDB, $res, and ilClaimingPermissionHelper\getRefId().

                                                           : array // Missing array type.
     {
         global $DIC;
 
         $ilDB = $DIC['ilDB'];
 
         switch ($a_context_type) {
             case self::CONTEXT_UDF:
                 return array($this->getRefId());
 
             case self::CONTEXT_FIELD:
                 $set = $ilDB->query("SELECT field_id id" .
                     " FROM udf_definition");
                 break;
 
             default:
                 return array();
         }
 
         $res = array();
         while ($row = $ilDB->fetchAssoc($set)) {
             $res[] = $row["id"];
         }
         return $res;
     }