ilObjRole Class Reference

Class ilObjRole. More...

Inheritance diagram for ilObjRole:

Collaboration diagram for ilObjRole:

Public Member Functions
	__construct (int $a_id=0, bool $a_call_by_reference=false)
	Constructor @access public. More...
	validate ()
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	toggleAssignUsersStatus (bool $a_assign_users)
	getAssignUsersStatus ()
	read ()
	loads "role" from database @access private More...
	update ()
	create ()
	note: title, description and type should be set when this function is called More...
	setAllowRegister (bool $a_allow_register)
	getAllowRegister ()
	setParent (int $a_parent_ref)
	set reference id of parent object this is neccessary for non RBAC protected objects!!! More...
	getParent ()
	get reference id of parent object More...
	delete ()
	delete role and all related data @access public More...
	getCountMembers ()
	Get number of users assigned to role. More...
	__getPermissionDefinitions ()
	isAutoGenerated ()
	changeExistingObjects (int $a_start_node, int $a_mode, array $a_filter, array $a_exclusion_filter=[], int $a_operation_mode=self::MODE_READ_OPERATIONS, array $a_operation_stack=[])
	Change existing objects. More...
Public Member Functions inherited from ilObject
	getObjectProperties ()
	flushObjectProperties ()
	withReferences ()
	determines whether objects are referenced or not (got ref ids or not) More...
	processAutoRating ()
	read ()
	getId ()
	setId (int $id)
	setRefId (int $ref_id)
	getRefId ()
	getType ()
	setType (string $type)
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...
	getTitle ()
	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...
	setTitle (string $title)
	getDescription ()
	setDescription (string $description)
	getLongDescription ()
	get object long description (stored in object_description) More...
	getImportId ()
	setImportId (string $import_id)
	setOfflineStatus (bool $status)
	getOfflineStatus ()
	supportsOfflineHandling ()
	getOwner ()
	getOwnerName ()
	get full name of object owner More...
	setOwner (int $usr_id)
	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...
	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...
	create ()
	note: title, description and type should be set when this function is called More...
	update ()
	MDUpdateListener (string $element)
	Metadata update listener. More...
	createMetaData ()
	updateMetaData ()
	deleteMetaData ()
	updateOwner ()
	update owner of object in db More...
	putInTree (int $parent_ref_id)
	maybe this method should be in tree object!? More...
	setPermissions (int $parent_ref_id)
	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...
	applyDidacticTemplate (int $tpl_id)
	getXMLZip ()
	getHTMLDirectory ()
	appendCopyInfo (int $target_id, int $copy_id, int $new_obj_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...
	cloneMetaData (ilObject $target_obj)
	Copy meta data. More...
	selfOrParentWithRatingEnabled ()
	getPossibleSubObjects (bool $filter=true)
	get all possible sub objects of this type the object can decide which types of sub objects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	createDefaultRole (string $a_title, string $a_description, string $a_tpl_name, int $a_ref_id)
static	_getAssignUsersStatus (int $a_role_id)
static	_lookupRegisterAllowed ()
	get all roles that are activated in user registration More...
static	_lookupAllowRegister (int $a_role_id)
	check whether role is allowed in user registration or not More...
static	_getTranslation (string $a_role_title)
static	_removeObjectId (string $a_role_title)
static	_updateAuthMode (array $a_roles)
static	_getAuthMode (int $a_role_id)
static	_getRolesByAuthMode (string $a_auth_mode)
	Get roles by auth mode @access public. More...
static	_resetAuthMode (string $a_auth_mode)
	Reset auth mode to default. More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...
static	_lookupImportId (int $obj_id)
static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...
static	_getIdForImportId (string $import_id)
static	_getAllReferences (int $id)
	get all reference ids for object ID More...
static	_lookupTitle (int $obj_id)
static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...
static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...
static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)
static	_lookupDescription (int $obj_id)
static	_lookupLastUpdate (int $obj_id, bool $formatted=false)
static	_getLastUpdateOfObjects (array $obj_ids)
static	_lookupObjId (int $ref_id)
static	_setDeletedDate (int $ref_id, int $deleted_by)
static	setDeletedDates (array $ref_ids, int $user_id)
static	_resetDeletedDate (int $ref_id)
static	_lookupDeletedDate (int $ref_id)
static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...
static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...
static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...
static	_lookupType (int $id, bool $reference=false)
static	_isInTrash (int $ref_id)
static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...
static	_lookupObjectId (int $ref_id)
static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...
static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType (string $obj_type="", ?int $owner=null)
static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...
static	getIconForType (string $type)
static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $obj_ids)
static	getAllOwnedRepositoryObjects (int $user_id)
static	fixMissingTitles ($type, array &$obj_title_map)
	Try to fix missing object titles. More...
static	_lookupCreationDate (int $obj_id)
static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
const	MODE_PROTECTED_DELETE_LOCAL_POLICIES = 1
const	MODE_PROTECTED_KEEP_LOCAL_POLICIES = 2
const	MODE_UNPROTECTED_DELETE_LOCAL_POLICIES = 3
const	MODE_UNPROTECTED_KEEP_LOCAL_POLICIES = 4
const	MODE_ADD_OPERATIONS = 1
const	MODE_READ_OPERATIONS = 2
const	MODE_REMOVE_OPERATIONS = 3
int	$parent = null
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
const	DESC_LENGTH = 128
const	LONG_DESC_LENGTH = 4000
const	TABLE_OBJECT_DATA = "object_data"
array	$objectList
string	$untranslatedTitle

Protected Member Functions
	deleteLocalPolicies (int $a_start, array $a_policies, array $a_filter)
	adjustPermissions (int $a_mode, array $a_nodes, array $a_policies, array $a_filter, array $a_exclusion_filter=[], int $a_operation_mode=self::MODE_READ_OPERATIONS, array $a_operation_stack=[])
	changeExistingObjectsGrantPermissions (int $a_role_id, array $a_permissions, int $a_ref_id, int $a_operation_mode)
	isHandledObjectType (array $a_filter, array $a_exclusion_filter, string $a_type)
	updateOperationStack (array &$a_stack, int $a_node, bool $a_init=false)
	Update operation stack. More...
	updatePolicyStack (array &$a_stack, int $a_node)
	createPermissionIntersection (array $policy_stack, array $a_current_ops, int $a_id, string $a_type)
	Create permission intersection. More...
Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)
	beforeMDUpdateListener (string $a_element)
	doCreateMetaData ()
	beforeCreateMetaData ()
	doUpdateMetaData ()
	beforeUpdateMetaData ()
	doDeleteMetaData ()
	beforeDeleteMetaData ()
	handleAutoRating ()
	hasAutoRating ()

Protected Attributes
bool	$allow_register = false
bool	$assign_users = false
Protected Attributes inherited from ilObject
ilLogger	$obj_log
ILIAS	$ilias
ilObjectDefinition	$obj_definition
ilDBInterface	$db
ilLogger	$log
ilErrorHandling	$error
ilTree	$tree
ilAppEventHandler	$app_event_handler
ilRbacAdmin	$rbac_admin
ilRbacReview	$rbac_review
ilObjUser	$user
ilLanguage	$lng
LOMServices	$lom_services
bool	$call_by_reference
int	$max_title = self::TITLE_LENGTH
int	$max_desc = self::DESC_LENGTH
bool	$add_dots = true
int	$ref_id = null
string	$type = ""
string	$title = ""
string	$desc = ""
string	$long_desc = ""
int	$owner = 0
string	$create_date = ""
string	$last_update = ""
string	$import_id = ""
bool	$register = false

Private Attributes
ilLogger	$logger

Detailed Description

Class ilObjRole.

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

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

Constructor & Destructor Documentation

__construct()

ilObjRole::__construct	(	int	$a_id = 0,
		bool	$a_call_by_reference = false
	)

Constructor @access public.

Parameters

int	reference_id or object_id
bool	treat the id as reference_id (true) or object_id (false)

Definition at line 50 of file class.ilObjRole.php.

    {
        global $DIC;
 
        $this->logger = $DIC->logger()->ac();
        $this->type = "role";
        parent::__construct($a_id, $a_call_by_reference);
    }

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\logger().

Here is the call graph for this function:

Member Function Documentation

__getPermissionDefinitions()

ilObjRole::__getPermissionDefinitions

(

)

Definition at line 501 of file class.ilObjRole.php.

                                                : array
    {
        $operation_info = $this->rbac_review->getOperationAssignment();
        $rbac_objects = $rbac_operations = [];
        foreach ($operation_info as $info) {
            if ($this->obj_definition->getDevMode($info['type'])) {
                continue;
            }
            $rbac_objects[$info['typ_id']] = ["obj_id" => $info['typ_id'],
                                                   "type" => $info['type']
            ];
 
            // handle plugin permission texts
            $txt = $this->obj_definition->isPlugin($info['type'])
                ? ilObjectPlugin::lookupTxtById($info['type'], $info['type'] . "_" . $info['operation'])
                : $this->lng->txt($info['type'] . "_" . $info['operation']);
            if (substr($info['operation'], 0, 7) == "create_" &&
                $this->obj_definition->isPlugin(substr($info['operation'], 7))) {
                $txt = ilObjectPlugin::lookupTxtById(
                    substr($info['operation'], 7),
                    $info['type'] . "_" . $info['operation']
                );
            }
            $rbac_operations[$info['typ_id']][$info['ops_id']] = [
                "ops_id" => $info['ops_id'],
                "title" => $info['operation'],
                "name" => $txt
            ];
        }
        return [$rbac_objects, $rbac_operations];
    }

References $info, $txt, ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().

Here is the call graph for this function:

_getAssignUsersStatus()

static ilObjRole::_getAssignUsersStatus ( int  $a_role_id )

static

Definition at line 141 of file class.ilObjRole.php.

                                                                : bool
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "SELECT assign_users FROM role_data WHERE role_id = " . $ilDB->quote($a_role_id, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            return (bool) $row->assign_users;
        }
        return false;
    }

References $DIC, $ilDB, and $res.

Referenced by ilRbacReview\getGlobalAssignableRoles(), ilSoapUserAdministration\importUsers(), ilObjUserGUI\initCreate(), ilObjUserFolderGUI\initUserRoleAssignmentForm(), ilSoapUserAdministration\isPermittedRole(), and ilObjUserFolderGUI\redirectOnRoleWithMissingWrite().

Here is the caller graph for this function:

_getAuthMode()

static ilObjRole::_getAuthMode ( int  $a_role_id )

static

Definition at line 452 of file class.ilObjRole.php.

                                                       : string
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT auth_mode FROM role_data " .
            "WHERE role_id= " . $ilDB->quote($a_role_id, 'integer') . " ";
        $res = $ilDB->query($query);
        $row = $ilDB->fetchAssoc($res);
 
        return $row['auth_mode'];
    }

References $DIC, $ilDB, and $res.

_getRolesByAuthMode()

static ilObjRole::_getRolesByAuthMode ( string  $a_auth_mode )

static

Get roles by auth mode @access public.

Parameters

string

auth mode

Returns

int[]

Definition at line 472 of file class.ilObjRole.php.

                                                                   : array
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM role_data " .
            "WHERE auth_mode = " . $ilDB->quote($a_auth_mode, 'text');
        $res = $ilDB->query($query);
        $roles = [];
        while ($row = $ilDB->fetchObject($res)) {
            $roles[] = $row->role_id;
        }
        return $roles;
    }

References $DIC, $ilDB, and $res.

_getTranslation()

static ilObjRole::_getTranslation ( string  $a_role_title )

static

Definition at line 364 of file class.ilObjRole.php.

                                                                : string
    {
        global $DIC;
 
        $lng = $DIC->language();
        $objDefinition = $DIC['objDefinition'];
 
        $role_title = self::_removeObjectId($a_role_title);
 
        if (preg_match("/^il_([a-z]{1,4})_./", $role_title, $type)) {
            //BT ID 0032909: language variables for roles from plugins were not resolved properly
            if ($objDefinition->isPlugin($type[1])) {
                return ilObjectPlugin::lookupTxtById($type[1], $role_title);
            }
            return $lng->txt($role_title);
        }
        return $a_role_title;
    }

References $DIC, $lng, and ilObjectPlugin\lookupTxtById().

Referenced by ilDclTableViewEditGUI\__construct(), ilRecommendedContentRoleTableGUI\__construct(), ilCourseEditParticipantsTableGUI\__construct(), ilObjRoleGUI\addAdminLocatorItems(), ilObjRoleTemplateGUI\addAdminLocatorItems(), ilObjRoleGUI\addLocatorItems(), ilObjRoleGUI\adoptPermObject(), ilObjRoleGUI\adoptPermSaveObject(), ilMailMemberSearchDataProvider\buildRoleTitle(), ilObjRoleFolderGUI\confirmDeleteObject(), ilObjRoleGUI\confirmDeleteRoleObject(), ilObjectRolePermissionTableGUI\createTitle(), ilRoleAssignmentTableGUI\fillRow(), ilObjBlog\getAllLocalRoles(), ilObjectPermissionStatusGUI\getAssignedValidRoles(), ilObjectPermissionStatusGUI\getAvailableRolesTableData(), ilObjCourse\getLocalCourseRoles(), ilObjGroup\getLocalGroupRoles(), ilLearningSequenceRoles\getLocalLearningSequenceRoles(), ilObjGroupGUI\getLocalRoles(), ilObjLearningSequenceGUI\getLocalRoles(), ilObjCourseGUI\getLocalRoles(), ilSessionParticipantsTableGUI\getParentLocalRoles(), getPresentationTitle(), ilObjRoleTemplate\getPresentationTitle(), ilLTIProviderObjectSettingGUI\getRoleSelection(), ilObjBlog\getRolesWithContributeOrRedact(), ilObjRoleTemplateGUI\getRoleTemplateForm(), ilSettingsPermissionGUI\initPermissionForm(), ilPermissionGUI\initRoleForm(), ilRoleTableGUI\parse(), ilRoleAssignmentTableGUI\parse(), ILIAS\AccessControl\Log\Table\parseChangesFaPa(), ilPermissionGUI\showConfirmBlockRole(), and ilSoapRoleObjectXMLWriter\start().

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupAllowRegister()

static ilObjRole::_lookupAllowRegister ( int  $a_role_id )

static

check whether role is allowed in user registration or not

Definition at line 240 of file class.ilObjRole.php.

                                                               : bool
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "SELECT * FROM role_data " .
            " WHERE role_id =" . $ilDB->quote($a_role_id, 'integer');
 
        $res = $ilDB->query($query);
        if ($role_rec = $ilDB->fetchAssoc($res)) {
            if ($role_rec["allow_register"]) {
                return true;
            }
        }
        return false;
    }

References $DIC, $ilDB, and $res.

Referenced by ilRegistrationSettingsGUI\initRolesForm(), and ilAccountRegistrationGUI\saveForm().

Here is the caller graph for this function:

_lookupRegisterAllowed()

static ilObjRole::_lookupRegisterAllowed ( )

static

get all roles that are activated in user registration

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

                                                   : array
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        $query = "SELECT * FROM role_data " .
            "JOIN object_data ON object_data.obj_id = role_data.role_id " .
            "WHERE allow_register = 1";
        $res = $ilDB->query($query);
 
        $roles = [];
        while ($role = $ilDB->fetchAssoc($res)) {
            $roles[] = ["id" => (int) $role["obj_id"],
                             "title" => (string) $role["title"],
                             "auth_mode" => (string) $role['auth_mode']
            ];
        }
        return $roles;
    }

References $DIC, $ilDB, $res, and ILIAS\Repository\int().

Referenced by ilObjAuthSettingsGUI\buildRegistrationRoleMappingForm(), ilAccountRegistrationGUI\buildRolesInput(), ilRegistrationSettingsGUI\initRoleAccessForm(), ilRegistrationSettingsGUI\prepareAccessLimitationRoleList(), ilRegistrationSettingsGUI\prepareRoleList(), and ilRegistrationSettingsGUI\saveRoleAccessLimitations().

Here is the call graph for this function:

Here is the caller graph for this function:

_removeObjectId()

static ilObjRole::_removeObjectId ( string  $a_role_title )

static

Todo:

rename of remove method

Definition at line 386 of file class.ilObjRole.php.

                                                                : string
    {
        $role_title_parts = explode('_', $a_role_title);
 
        $test2 = (int) ($role_title_parts[3] ?? 0);
        if ($test2 > 0) {
            unset($role_title_parts[3]);
        }
 
        return implode('_', $role_title_parts);
    }

References ILIAS\Repository\int().

Referenced by ilObjectRolePermissionTableGUI\createTitle(), and ilObjectPermissionStatusGUI\getAvailableRolesTableData().

Here is the call graph for this function:

Here is the caller graph for this function:

_resetAuthMode()

static ilObjRole::_resetAuthMode ( string  $a_auth_mode )

static

Reset auth mode to default.

Definition at line 491 of file class.ilObjRole.php.

                                                              : void
    {
        global $DIC;
 
        $ilDB = $DIC['ilDB'];
 
        $query = "UPDATE role_data SET auth_mode = 'default' WHERE auth_mode = " . $ilDB->quote($a_auth_mode, 'text');
        $res = $ilDB->manipulate($query);
    }

References $DIC, $ilDB, and $res.

_updateAuthMode()

static ilObjRole::_updateAuthMode ( array  $a_roles )

static

Definition at line 439 of file class.ilObjRole.php.

                                                          : void
    {
        global $DIC;
 
        $ilDB = $DIC->database();
        foreach ($a_roles as $role_id => $auth_mode) {
            $query = "UPDATE role_data SET " .
                "auth_mode= " . $ilDB->quote($auth_mode, 'text') . " " .
                "WHERE role_id= " . $ilDB->quote($role_id, 'integer') . " ";
            $res = $ilDB->manipulate($query);
        }
    }

References $DIC, $ilDB, and $res.

Referenced by ilObjAuthSettingsGUI\updateRegistrationRoleMappingObject().

Here is the caller graph for this function:

adjustPermissions()

ilObjRole::adjustPermissions ( int  $a_mode, array  $a_nodes, array  $a_policies, array  $a_filter, array  $a_exclusion_filter = [], int  $a_operation_mode = self::MODE_READ_OPERATIONS, array  $a_operation_stack = []  )

protected

Definition at line 607 of file class.ilObjRole.php.

     : void {
        $operation_stack = [];
        $policy_stack = [];
        $node_stack = [];
 
        $start_node = current($a_nodes);
        $node_stack[] = $start_node;
        $this->updatePolicyStack($policy_stack, $start_node['child']);
 
        if ($a_operation_mode == self::MODE_READ_OPERATIONS) {
            $this->updateOperationStack($operation_stack, $start_node['child'], true);
        } else {
            $operation_stack = $a_operation_stack;
        }
 
        $this->logger->debug('adjust permissions operation stack');
        $this->logger->dump($operation_stack, ilLogLevel::DEBUG);
 
        $rbac_log_active = ilRbacLog::isActive();
 
        $local_policy = false;
        foreach ($a_nodes as $node) {
            $cmp_node = end($node_stack);
            while ($relation = $this->tree->getRelationOfNodes($node, $cmp_node)) {
                switch ($relation) {
                    case ilTree::RELATION_NONE:
                    case ilTree::RELATION_SIBLING:
                        $this->logger->debug('Handling sibling/none relation.');
                        array_pop($operation_stack);
                        array_pop($policy_stack);
                        array_pop($node_stack);
                        $cmp_node = end($node_stack);
                        $local_policy = false;
                        break;
 
                    case ilTree::RELATION_CHILD:
                    case ilTree::RELATION_EQUALS:
                    case ilTree::RELATION_PARENT:
                    default:
                        $this->logger->debug('Handling child/equals/parent ' . $relation);
                        break 2;
                }
            }
 
            if ($local_policy) {
                continue;
            }
 
            // Start node => set permissions and continue
            if ($node['child'] == $start_node['child']) {
                if ($this->isHandledObjectType($a_filter, $a_exclusion_filter, $node['type'])) {
                    if ($rbac_log_active) {
                        $rbac_log_roles = $this->rbac_review->getParentRoleIds($node['child'], false);
                        $rbac_log_old = ilRbacLog::gatherFaPa((int) $node['child'], array_keys($rbac_log_roles));
                    }
 
                    // Set permissions
                    $perms = end($operation_stack);
                    $this->changeExistingObjectsGrantPermissions(
                        $this->getId(),
                        (array) ($perms[$node['type']] ?? []),
                        $node['child'],
                        $a_operation_mode
                    );
 
                    if ($rbac_log_active) {
                        $rbac_log_new = ilRbacLog::gatherFaPa((int) $node['child'], array_keys($rbac_log_roles));
                        $rbac_log = ilRbacLog::diffFaPa($rbac_log_old, $rbac_log_new);
                        ilRbacLog::add(ilRbacLog::EDIT_TEMPLATE_EXISTING, $node['child'], $rbac_log);
                    }
                }
                continue;
            }
 
            // Node has local policies => update permission stack and continue
            if (in_array($node['child'], $a_policies) && $node['child'] != SYSTEM_FOLDER_ID) {
                $local_policy = true;
                $this->updatePolicyStack($policy_stack, $node['child']);
                $this->updateOperationStack($operation_stack, $node['child']);
                $node_stack[] = $node;
                continue;
            }
 
            // Continue if this object type is not in filter
            if (!$this->isHandledObjectType($a_filter, $a_exclusion_filter, $node['type'])) {
                continue;
            }
 
            if ($rbac_log_active) {
                $rbac_log_roles = $this->rbac_review->getParentRoleIds($node['child'], false);
                $rbac_log_old = ilRbacLog::gatherFaPa((int) $node['child'], array_keys($rbac_log_roles));
            }
 
            // Node is course or group => create permission intersection
            if (
                ($a_mode == self::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES || $a_mode == self::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES) &&
                ($node['type'] == 'crs' || $node['type'] == 'grp')
            ) {
                // Copy role permission intersection
                $perms = end($operation_stack);
                $this->createPermissionIntersection(
                    $policy_stack,
                    $perms[$node['type']] ?? [],
                    $node['child'],
                    $node['type']
                );
                if ($this->updateOperationStack($operation_stack, $node['child'])) {
                    $this->updatePolicyStack($policy_stack, $node['child']);
                    $node_stack[] = $node;
                }
            }
 
            // Set permission
            $perms = end($operation_stack);
            $this->changeExistingObjectsGrantPermissions(
                $this->getId(),
                (array) ($perms[$node['type']] ?? []),
                $node['child'],
                $a_operation_mode
            );
            if ($rbac_log_active) {
                $rbac_log_new = ilRbacLog::gatherFaPa((int) $node['child'], array_keys($rbac_log_roles));
                $rbac_log = ilRbacLog::diffFaPa($rbac_log_old, $rbac_log_new);
                ilRbacLog::add(ilRbacLog::EDIT_TEMPLATE_EXISTING, $node['child'], $rbac_log);
            }
        }
    }

changeExistingObjects()

ilObjRole::changeExistingObjects	(	int	$a_start_node,
		int	$a_mode,
		array	$a_filter,
		array	$a_exclusion_filter = [],
		int	$a_operation_mode = self::MODE_READ_OPERATIONS,
		array	$a_operation_stack = []
	)

Change existing objects.

Parameters

array

filter Filter of object types (array('all') => change all objects

Definition at line 542 of file class.ilObjRole.php.

     : void {
        // Get node info of subtree
        $nodes = $this->tree->getRbacSubtreeInfo($a_start_node);
 
        // get local policies
        $all_local_policies = $this->rbac_review->getObjectsWithStopedInheritance($this->getId());
 
        // filter relevant roles
        $local_policies = [];
        foreach ($all_local_policies as $lp) {
            if (isset($nodes[$lp])) {
                $local_policies[] = $lp;
            }
        }
 
        // Delete deprecated policies
        switch ($a_mode) {
            case self::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES:
            case self::MODE_PROTECTED_DELETE_LOCAL_POLICIES:
                $local_policies = $this->deleteLocalPolicies($a_start_node, $local_policies, $a_filter);
                break;
        }
        $this->adjustPermissions(
            $a_mode,
            $nodes,
            $local_policies,
            $a_filter,
            $a_exclusion_filter,
            $a_operation_mode,
            $a_operation_stack
        );
    }

changeExistingObjectsGrantPermissions()

ilObjRole::changeExistingObjectsGrantPermissions ( int  $a_role_id, array  $a_permissions, int  $a_ref_id, int  $a_operation_mode  )

protected

Definition at line 743 of file class.ilObjRole.php.

     : void {
        global $DIC;
 
        $admin = $DIC->rbac()->admin();
        $review = $DIC->rbac()->review();
        if ($a_operation_mode == self::MODE_READ_OPERATIONS) {
            $admin->grantPermission(
                $a_role_id,
                $a_permissions,
                $a_ref_id
            );
        } elseif ($a_operation_mode == self::MODE_ADD_OPERATIONS) {
            $current_operations = $review->getRoleOperationsOnObject(
                $a_role_id,
                $a_ref_id
            );
            $this->logger->debug('Current operations');
            $this->logger->dump($current_operations);
 
            $new_ops = array_unique(array_merge($a_permissions, $current_operations));
            $this->logger->debug('New operations');
            $this->logger->dump($new_ops);
 
            $admin->grantPermission(
                $a_role_id,
                $new_ops,
                $a_ref_id
            );
        } elseif ($a_operation_mode == self::MODE_REMOVE_OPERATIONS) {
            $current_operations = $review->getRoleOperationsOnObject(
                $a_role_id,
                $a_ref_id
            );
            $this->logger->debug('Current operations');
            $this->logger->dump($current_operations);
 
            $new_ops = array_diff($current_operations, $a_permissions);
 
            $admin->grantPermission(
                $a_role_id,
                $new_ops,
                $a_ref_id
            );
        }
    }

create()

ilObjRole::create

(

)

note: title, description and type should be set when this function is called

Reimplemented from ilObject.

Definition at line 188 of file class.ilObjRole.php.

                            : int
    {
        global $DIC;
 
        $this->id = parent::create();
        $query = "INSERT INTO role_data " .
            "(role_id,allow_register,assign_users) " .
            "VALUES " .
            "(" . $this->db->quote($this->id, 'integer') . "," .
            $this->db->quote($this->getAllowRegister(), 'integer') . "," .
            $this->db->quote($this->getAssignUsersStatus(), 'integer') . ")";
        $res = $this->db->query($query);
 
        return $this->id;
    }

References $DIC, $id, and $res.

createDefaultRole()

static ilObjRole::createDefaultRole ( string  $a_title, string  $a_description, string  $a_tpl_name, int  $a_ref_id  )

static

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

     : ?ilObjRole {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        // SET PERMISSION TEMPLATE OF NEW LOCAL CONTRIBUTOR ROLE
        $res = $ilDB->query("SELECT obj_id FROM object_data " .
            " WHERE type=" . $ilDB->quote("rolt", "text") .
            " AND title=" . $ilDB->quote($a_tpl_name, "text"));
        $tpl_id = 0;
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $tpl_id = (int) $row->obj_id;
        }
        if (!$tpl_id) {
            return null;
        }
 
        $role = new ilObjRole();
        $role->setTitle($a_title);
        $role->setDescription($a_description);
        $role->create();
 
        $GLOBALS['DIC']['rbacadmin']->assignRoleToFolder($role->getId(), $a_ref_id, 'y');
        $GLOBALS['DIC']['rbacadmin']->copyRoleTemplatePermissions(
            $tpl_id,
            ROLE_FOLDER_ID,
            $a_ref_id,
            $role->getId()
        );
 
        $ops = $GLOBALS['DIC']['rbacreview']->getOperationsOfRole(
            $role->getId(),
            ilObject::_lookupType($a_ref_id, true),
            $a_ref_id
        );
        $GLOBALS['DIC']['rbacadmin']->grantPermission(
            $role->getId(),
            $ops,
            $a_ref_id
        );
        return $role;
    }

References ILIAS\Repository\int().

Referenced by ilObjChatroom\createDefaultRole(), ilObjBlog\initDefaultRoles(), ilObjCourse\initDefaultRoles(), ilObjForum\initDefaultRoles(), ilObjGroup\initDefaultRoles(), ilLearningSequenceRoles\initDefaultRoles(), ilObjSession\initDefaultRoles(), and ilIndividualAssessmentAccessHandler\initDefaultRolesForObject().

Here is the call graph for this function:

Here is the caller graph for this function:

createPermissionIntersection()

ilObjRole::createPermissionIntersection ( array  $policy_stack, array  $a_current_ops, int  $a_id, string  $a_type  )

protected

Create permission intersection.

Definition at line 869 of file class.ilObjRole.php.

     : void {
        static $course_non_member_id = null;
        static $group_non_member_id = null;
        static $group_open_id = null;
        static $group_closed_id = null;
 
        $template_id = 0;
        // Get template id
        switch ($a_type) {
            case 'grp':
                $type = ilObjGroup::lookupGroupTye(ilObject::_lookupObjId($a_id));
                switch ($type) {
                    case ilGroupConstants::GRP_TYPE_CLOSED:
                        if (!$group_closed_id) {
                            $query = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_closed'";
                            $res = $this->db->query($query);
                            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                                $group_closed_id = (int) $row->obj_id;
                            }
                        }
                        $template_id = $group_closed_id;
                        #var_dump("GROUP CLOSED id:" . $template_id);
                        break;
 
                    case ilGroupConstants::GRP_TYPE_OPEN:
                    default:
                        if (!$group_open_id) {
                            $query = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_open'";
                            $res = $this->db->query($query);
                            while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                                $group_open_id = (int) $row->obj_id;
                            }
                        }
                        $template_id = $group_open_id;
                        break;
                }
                break;
 
            case 'crs':
                if (!$course_non_member_id) {
                    $query = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_crs_non_member'";
                    $res = $this->db->query($query);
                    while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                        $course_non_member_id = (int) $row->obj_id;
                    }
                }
                $template_id = $course_non_member_id;
                break;
        }
 
        // Create intersection template permissions
        if ($template_id && $policy_stack !== []) {
            $this->rbac_admin->copyRolePermissionIntersection(
                $template_id,
                ROLE_FOLDER_ID,
                $this->getId(),
                end($policy_stack),
                $a_id,
                $this->getId()
            );
        } else {
        }
        if ($a_id && !$GLOBALS['DIC']['rbacreview']->isRoleAssignedToObject($this->getId(), $a_id)) {
            $this->rbac_admin->assignRoleToFolder($this->getId(), $a_id, "n");
        }
    }

References $res, ilObject\_lookupObjId(), ilDBConstants\FETCHMODE_OBJECT, ilGroupConstants\GRP_TYPE_CLOSED, ilGroupConstants\GRP_TYPE_OPEN, ILIAS\Repository\int(), and ilObjGroup\lookupGroupTye().

Here is the call graph for this function:

delete()

ilObjRole::delete

(

)

delete role and all related data @access public

Returns

bool true if all object data were removed; false if only a references were removed

Reimplemented from ilObject.

Definition at line 280 of file class.ilObjRole.php.

                            : bool
    {
        global $DIC;
 
        // Temporary bugfix
        if ($this->rbac_review->hasMultipleAssignments($this->getId())) {
            $this->logger->warning('Found role with multiple assignments: role_id: ' . $this->getId());
            $this->logger->warning('Aborted deletion of role.');
            return false;
        }
 
        if ($this->rbac_review->isAssignable($this->getId(), $this->getParent())) {
            $this->logger->debug('Handling assignable role...');
            // do not delete a global role, if the role is the last
            // role a user is assigned to.
            //
            // Performance improvement: In the code section below, we
            // only need to consider _global_ roles. We don't need
            // to check for _local_ roles, because a user who has
            // a local role _always_ has a global role too.
            $last_role_user_ids = [];
            if ($this->getParent() == ROLE_FOLDER_ID) {
                ilLoggerFactory::getLogger('ac')->debug('Handling global role...');
                // The role is a global role: check if
                // we find users who aren't assigned to any
                // other global role than this one.
                $user_ids = $this->rbac_review->assignedUsers($this->getId());
 
                foreach ($user_ids as $user_id) {
                    // get all roles each user has
                    $role_ids = $this->rbac_review->assignedRoles($user_id);
 
                    // is last role?
                    if (count($role_ids) == 1) {
                        $last_role_user_ids[] = $user_id;
                    }
                }
            }
 
            // users with last role found?
            if ($last_role_user_ids !== []) {
                $user_names = [];
                foreach ($last_role_user_ids as $user_id) {
                    // GET OBJECT TITLE
                    $user_names[] = ilObjUser::_lookupLogin($user_id);
                }
 
                // TODO: This check must be done in rolefolder object because if multiple
                // roles were selected the other roles are still deleted and the system does not
                // give any feedback about this.
                $users = implode(', ', $user_names);
                $this->logger->info('Cannot delete last global role of users.');
                $this->ilias->raiseError($this->lng->txt("msg_user_last_role1") . " " .
                    $users . "<br/>" . $this->lng->txt("msg_user_last_role2"), $this->ilias->error_obj->WARNING);
            } else {
                $this->logger->debug('Starting deletion of assignable role: role_id: ' . $this->getId());
                $this->rbac_admin->deleteRole($this->getId(), $this->getParent());
 
                // Delete ldap role group mappings
                ilLDAPRoleGroupMappingSettings::_deleteByRole($this->getId());
 
                // delete object_data entry
                parent::delete();
 
                // delete role_data entry
                $query = "DELETE FROM role_data WHERE role_id = " . $this->db->quote($this->getId(), 'integer');
                $res = $this->db->manipulate($query);
            }
        } else {
            $this->logger->debug('Starting deletion of linked role: role_id ' . $this->getId());
            // linked local role: INHERITANCE WAS STOPPED, SO DELETE ONLY THIS LOCAL ROLE
            $this->rbac_admin->deleteLocalRole($this->getId(), $this->getParent());
        }
        return true;
    }

References $DIC, $res, $user_id, ilLDAPRoleGroupMappingSettings\_deleteByRole(), ilObjUser\_lookupLogin(), ILIAS\Survey\Mode\getId(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ROLE_FOLDER_ID.

Here is the call graph for this function:

deleteLocalPolicies()

ilObjRole::deleteLocalPolicies ( int  $a_start, array  $a_policies, array  $a_filter  )

protected

Definition at line 582 of file class.ilObjRole.php.

                                                                                            : array
    {
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];
 
        $local_policies = [];
        foreach ($a_policies as $policy) {
            if ($policy == $a_start || $policy == SYSTEM_FOLDER_ID) {
                $local_policies[] = $policy;
                continue;
            }
            if (!in_array('all', $a_filter) && !in_array(
                ilObject::_lookupType(ilObject::_lookupObjId($policy)),
                $a_filter
            )) {
                $local_policies[] = $policy;
                continue;
            }
            $rbacadmin->deleteLocalRole($this->getId(), $policy);
        }
        return $local_policies;
    }

References $DIC, ilObject\_lookupObjId(), ilObject\_lookupType(), ILIAS\Survey\Mode\getId(), and SYSTEM_FOLDER_ID.

Here is the call graph for this function:

getAllowRegister()

ilObjRole::getAllowRegister

(

)

Definition at line 209 of file class.ilObjRole.php.

                                      : bool
    {
        return $this->allow_register;
    }

getAssignUsersStatus()

ilObjRole::getAssignUsersStatus

(

)

Definition at line 136 of file class.ilObjRole.php.

                                          : bool
    {
        return $this->assign_users;
    }

getCountMembers()

ilObjRole::getCountMembers

(

)

Get number of users assigned to role.

Definition at line 359 of file class.ilObjRole.php.

                                     : int
    {
        return count($this->rbac_review->assignedUsers($this->getId()));
    }

getParent()

ilObjRole::getParent

(

)

get reference id of parent object

Definition at line 270 of file class.ilObjRole.php.

                               : ?int
    {
        return $this->parent;
    }

getPresentationTitle()

ilObjRole::getPresentationTitle

(

)

get presentation title Normally same as title Overwritten for sessions

Reimplemented from ilObject.

Definition at line 120 of file class.ilObjRole.php.

                                          : string
    {
        $r = ilObjRole::_getTranslation($this->getTitle());
 
        if ($r === $this->getUntranslatedTitle()) {
            return $r;
        }
 
        return $r . ' (' . $this->getUntranslatedTitle() . ')';
    }

References _getTranslation(), and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

isAutoGenerated()

ilObjRole::isAutoGenerated

(

)

Definition at line 533 of file class.ilObjRole.php.

                                     : bool
    {
        return substr($this->title, 0, 3) == 'il_';
    }

isHandledObjectType()

ilObjRole::isHandledObjectType ( array  $a_filter, array  $a_exclusion_filter, string  $a_type  )

protected

Definition at line 794 of file class.ilObjRole.php.

                                                                                                      : bool
    {
        if (in_array($a_type, $a_exclusion_filter)) {
            return false;
        }
 
        if (in_array('all', $a_filter)) {
            return true;
        }
        return in_array($a_type, $a_filter);
    }

read()

ilObjRole::read

(

)

loads "role" from database @access private

Reimplemented from ilObject.

Definition at line 158 of file class.ilObjRole.php.

                          : void
    {
        $query = "SELECT * FROM role_data WHERE role_id= " . $this->db->quote($this->id, 'integer') . " ";
        $res = $this->db->query($query);
        if ($res->numRows() > 0) {
            $row = $this->db->fetchAssoc($res);
            $this->setAllowRegister((bool) $row['allow_register']);
            $this->toggleAssignUsersStatus((bool) ($row['assign_users'] ?? false));
        } else {
            $this->logger->logStack(ilLogLevel::ERROR);
            throw new ilObjectException('There is no dataset with id: ' . $this->id);
        }
        parent::read();
    }

References $res, ilLogLevel\ERROR, and ILIAS\Repository\logger().

Here is the call graph for this function:

setAllowRegister()

ilObjRole::setAllowRegister

(

bool

$a_allow_register

)

Definition at line 204 of file class.ilObjRole.php.

                                                            : void
    {
        $this->allow_register = $a_allow_register;
    }

setParent()

ilObjRole::setParent

(

int

$a_parent_ref

)

set reference id of parent object this is neccessary for non RBAC protected objects!!!

Definition at line 262 of file class.ilObjRole.php.

                                                : void
    {
        $this->parent = $a_parent_ref;
    }

toggleAssignUsersStatus()

ilObjRole::toggleAssignUsersStatus

(

bool

$a_assign_users

)

Definition at line 131 of file class.ilObjRole.php.

                                                                 : void
    {
        $this->assign_users = $a_assign_users;
    }

update()

ilObjRole::update

(

)

Reimplemented from ilObject.

Definition at line 173 of file class.ilObjRole.php.

                            : bool
    {
        $query = "UPDATE role_data SET " .
            "allow_register= " . $this->db->quote($this->allow_register, 'integer') . ", " .
            "assign_users = " . $this->db->quote($this->getAssignUsersStatus(), 'integer') . " " .
            "WHERE role_id= " . $this->db->quote($this->id, 'integer') . " ";
        $res = $this->db->manipulate($query);
 
        parent::update();
 
        $this->read();
 
        return true;
    }

References $res.

updateOperationStack()

ilObjRole::updateOperationStack ( array &  $a_stack, int  $a_node, bool  $a_init = false  )

protected

Update operation stack.

Definition at line 809 of file class.ilObjRole.php.

     : bool {
        $has_policies = null;
 
        if ($a_node == ROOT_FOLDER_ID) {
            $has_policies = true;
            $policy_origin = ROLE_FOLDER_ID;
        } else {
            $has_policies = $this->rbac_review->getLocalPolicies($a_node);
            $policy_origin = $a_node;
 
            if ($a_init) {
                $parent_roles = $this->rbac_review->getParentRoleIds($a_node, false);
                if ($parent_roles[$this->getId()]) {
                    $a_stack[] = $this->rbac_review->getAllOperationsOfRole(
                        $this->getId(),
                        $parent_roles[$this->getId()]['parent']
                    );
                }
                return true;
            }
        }
 
        if (!$has_policies) {
            return false;
        }
 
        $a_stack[] = $this->rbac_review->getAllOperationsOfRole(
            $this->getId(),
            $policy_origin
        );
        return true;
    }

References ROLE_FOLDER_ID.

updatePolicyStack()

ilObjRole::updatePolicyStack ( array &  $a_stack, int  $a_node  )

protected

Definition at line 846 of file class.ilObjRole.php.

                                                                      : bool
    {
        $has_policies = null;
 
        if ($a_node == ROOT_FOLDER_ID) {
            $has_policies = true;
            $policy_origin = ROLE_FOLDER_ID;
        } else {
            $has_policies = $this->rbac_review->getLocalPolicies($a_node);
            $policy_origin = $a_node;
        }
 
        if (!$has_policies) {
            return false;
        }
 
        $a_stack[] = $policy_origin;
        return true;
    }

References ROLE_FOLDER_ID, and ROOT_FOLDER_ID.

validate()

ilObjRole::validate

(

)

Definition at line 107 of file class.ilObjRole.php.

                              : bool
    {
        global $DIC;
 
        $ilErr = $DIC['ilErr'];
 
        if (substr($this->getTitle(), 0, 3) == 'il_') {
            $ilErr->setMessage('msg_role_reserved_prefix');
            return false;
        }
        return true;
    }

References $DIC, $ilErr, and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

Field Documentation

$allow_register

bool ilObjRole::$allow_register = false

protected

Definition at line 41 of file class.ilObjRole.php.

$assign_users

bool ilObjRole::$assign_users = false

protected

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

$logger

ilLogger ilObjRole::$logger

private

Definition at line 37 of file class.ilObjRole.php.

$parent

int ilObjRole::$parent = null

Definition at line 39 of file class.ilObjRole.php.

MODE_ADD_OPERATIONS

const ilObjRole::MODE_ADD_OPERATIONS = 1

Definition at line 33 of file class.ilObjRole.php.

Referenced by ilObjRoleFolderGUI\adjustRoleObject().

MODE_PROTECTED_DELETE_LOCAL_POLICIES

const ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES = 1

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

Referenced by ilDidacticTemplateLocalPolicyAction\createLocalPolicy(), ilDidacticTemplateLocalPolicyAction\revert(), ilDidacticTemplateLocalPolicyAction\revertLocalPolicy(), and ilObjRoleGUI\showChangeExistingObjectsConfirmation().

MODE_PROTECTED_KEEP_LOCAL_POLICIES

const ilObjRole::MODE_PROTECTED_KEEP_LOCAL_POLICIES = 2

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

Referenced by ilPermissionGUI\addRole(), ilObjRoleGUI\permSaveObject(), and ilObjRoleGUI\showChangeExistingObjectsConfirmation().

MODE_READ_OPERATIONS

const ilObjRole::MODE_READ_OPERATIONS = 2

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

Referenced by ilObjRoleFolderGUI\adjustRoleObject().

MODE_REMOVE_OPERATIONS

const ilObjRole::MODE_REMOVE_OPERATIONS = 3

Definition at line 35 of file class.ilObjRole.php.

Referenced by ilObjRoleFolderGUI\adjustRoleObject().

MODE_UNPROTECTED_DELETE_LOCAL_POLICIES

const ilObjRole::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES = 3

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

Referenced by ilDidacticTemplateLocalPolicyAction\createLocalPolicy(), ilDidacticTemplateBlockRoleAction\deleteLocalPolicy(), ilDidacticTemplateLocalPolicyAction\revert(), ilDidacticTemplateLocalPolicyAction\revertLocalPolicy(), and ilObjRoleGUI\showChangeExistingObjectsConfirmation().

MODE_UNPROTECTED_KEEP_LOCAL_POLICIES

const ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES = 4

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

Referenced by ilPermissionGUI\addRole(), ilObjLTIAdministrationGUI\createLtiUserRole(), ilObjRoleGUI\permSaveObject(), ilObjRoleGUI\showChangeExistingObjectsConfirmation(), and ilPermissionGUI\unblockRoles().

---

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

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