ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
Public Member Functions | Static Public Member Functions | Data Fields | Protected Member Functions | Private Attributes
ilObjRole Class Reference

Class ilObjRole. More...

+ Inheritance diagram for ilObjRole:
+ Collaboration diagram for ilObjRole:

Public Member Functions

 __construct ($a_id=0, $a_call_by_reference=false)
 Constructor @access public. More...
 
 validate ()
 Validate role data. More...
 
 getPresentationTitle ()
 return translated title for autogenerated roles More...
 
 toggleAssignUsersStatus ($a_assign_users)
 
 getAssignUsersStatus ()
 
 read ()
 loads "role" from database @access private More...
 
 assignData ($a_data)
 loads a record "role" from array @access public More...
 
 update ()
 updates a record "role" and write it into database @access public More...
 
 create ()
 create More...
 
 setAllowRegister ($a_allow_register)
 set allow_register of role More...
 
 getAllowRegister ()
 get allow_register More...
 
 setDiskQuota ($a_disk_quota)
 Sets the minimal disk quota imposed by this role. More...
 
 getDiskQuota ()
 Gets the minimal disk quota imposed by this role. More...
 
 setPersonalWorkspaceDiskQuota ($a_disk_quota)
 Sets the minimal personal workspace disk quota imposed by this role. More...
 
 getPersonalWorkspaceDiskQuota ()
 Gets the minimal personal workspace disk quota imposed by this role. More...
 
 setParent ($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 More...
 
 getCountMembers ()
 
 __getPermissionDefinitions ()
 
 changeExistingObjects ($a_start_node, $a_mode, $a_filter, $a_exclusion_filter=array(), $a_operation_mode=self::MODE_READ_OPERATIONS, $a_operation_stack=[])
 Change existing objects. More...
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor @access public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 read object data from db into object More...
 
 getId ()
 get object id @access public More...
 
 setId ($a_id)
 set object id @access public More...
 
 setRefId ($a_id)
 set reference id @access public More...
 
 getRefId ()
 get reference id @access public More...
 
 getType ()
 get object type @access public More...
 
 setType ($a_type)
 set object type @access public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title @access public More...
 
 getUntranslatedTitle ()
 get untranslated object title @access public More...
 
 setTitle ($a_title)
 set object title More...
 
 getDescription ()
 get object description More...
 
 setDescription ($a_desc)
 set object description More...
 
 getLongDescription ()
 get object long description (stored in object_description) More...
 
 getImportId ()
 get import id More...
 
 setImportId ($a_import_id)
 set import id More...
 
 setOfflineStatus ($a_status)
 Set offline status. More...
 
 getOfflineStatus ()
 Get offline status. More...
 
 supportsOfflineHandling ()
 Check whether object supports offline handling. More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 setOwner ($a_owner)
 set object owner More...
 
 getCreateDate ()
 get create date @access public More...
 
 getLastUpdateDate ()
 get last update date @access public More...
 
 getDiskUsage ()
 Gets the disk usage of the object in bytes. More...
 
 create ()
 create More...
 
 update ()
 update object in db More...
 
 MDUpdateListener ($a_element)
 Meta data update listener. More...
 
 createMetaData ()
 create meta data entry More...
 
 updateMetaData ()
 update meta data entry More...
 
 deleteMetaData ()
 delete meta data entry More...
 
 updateOwner ()
 update owner of object in db More...
 
 putInTree ($a_parent_ref)
 maybe this method should be in tree object!? More...
 
 setPermissions ($a_parent_ref)
 set permissions of object More...
 
 setParentRolePermissions ($a_parent_ref)
 Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
 
 createReference ()
 creates reference for object More...
 
 countReferences ()
 count references of object 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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...
 
 applyDidacticTemplate ($a_tpl_id)
 Apply template. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 getPossibleSubObjects ($a_filter=true)
 get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...
 

Static Public Member Functions

static createDefaultRole ($a_title, $a_description, $a_tpl_name, $a_ref_id)
 
static _getAssignUsersStatus ($a_role_id)
 
static _lookupRegisterAllowed ()
 get all roles that are activated in user registration More...
 
static _lookupAllowRegister ($a_role_id)
 check whether role is allowed in user registration or not More...
 
static _getTranslation ($a_role_title)
 
static _removeObjectId ($a_role_title)
 
static _updateAuthMode ($a_roles)
 
static _getAuthMode ($a_role_id)
 
static _getRolesByAuthMode ($a_auth_mode)
 Get roles by auth mode. More...
 
static _resetAuthMode ($a_auth_mode)
 Reset auth mode to default. More...
 
static isAutoGenerated ($a_role_id)
 
- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _lookupImportId ($a_obj_id)
 
static _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static lookupOfflineStatus ($a_obj_id)
 Lookup offline status using objectDataCache. More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id, $a_deleted_by)
 
static setDeletedDates ($a_ref_ids, $a_user_id)
 Set deleted date. More...
 
static _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
static _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
static _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
static _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type More...
 
static _exists ($a_id, $a_reference=false, $a_type=null)
 checks if an object exists in object_data@access public More...
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
 Prepare copy wizard object selection. More...
 
static collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
 Collect deletion dependencies. More...
 
static getDeletionDependencies ($a_obj_id)
 Get deletion dependencies. More...
 
static getLongDescriptions (array $a_obj_ids)
 Get long description data. More...
 
static getAllOwnedRepositoryObjects ($a_user_id)
 Get all ids of objects user owns. More...
 
static fixMissingTitles ($a_type, array &$a_obj_title_map)
 Try to fix missing object titles. More...
 
static _lookupCreationDate ($a_id)
 Lookup creation date. More...
 
static hasAutoRating ($a_type, $a_ref_id)
 Check if auto rating is active for parent group/course. More...
 

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
 
 $parent
 
 $allow_register
 
 $assign_users
 
 $disk_quota
 The disk quota in bytes. More...
 
 $wsp_disk_quota
 
- Data Fields inherited from ilObject
const TITLE_LENGTH = 255
 max length of object title More...
 
const DESC_LENGTH = 128
 
 $lng
 
 $id
 
 $ref_id
 
 $type
 
 $title
 
 $untranslatedTitle
 
 $desc
 
 $long_desc
 
 $owner
 
 $create_date
 
 $last_update
 
 $import_id
 
 $register = false
 
 $referenced
 
 $objectList
 
 $max_title
 
 $max_desc
 
 $add_dots
 

Protected Member Functions

 deleteLocalPolicies ($a_start, $a_policies, $a_filter)
 Delete local policies. More...
 
 adjustPermissions ($a_mode, $a_nodes, $a_policies, $a_filter, $a_exclusion_filter=array(), $a_operation_mode=self::MODE_READ_OPERATIONS, $a_operation_stack=[])
 Adjust permissions. More...
 
 changeExistingObjectsGrantPermissions ($a_role_id, $a_permissions, $a_ref_id, $a_operation_mode)
 
 isHandledObjectType ($a_filter, $a_exclusion_filter, $a_type)
 Check if type is filterer. More...
 
 updateOperationStack (&$a_stack, $a_node, $a_init=false)
 Update operation stack. More...
 
 updatePolicyStack (&$a_stack, $a_node)
 Update policy stack. More...
 
 createPermissionIntersection ($policy_stack, $a_current_ops, $a_id, $a_type)
 Create course group permission intersection. More...
 

Private Attributes

 $logger = null
 

Additional Inherited Members

- Protected Attributes inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

Detailed Description

Class ilObjRole.

Author
Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor @access public.

Parameters
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

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

54 {
55 global $DIC;
56
57 $this->logger = $DIC->logger()->ac();
58 $this->type = "role";
59 $this->disk_quota = 0;
60 $this->wsp_disk_quota = 0;
61 parent::__construct($a_id, $a_call_by_reference);
62 }
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc
Definition: PluginProviderHelper.php:30
$DIC
$DIC
Definition: xapitoken.php:46

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

+ Here is the call graph for this function:

Member Function Documentation

◆ __getPermissionDefinitions()

ilObjRole::__getPermissionDefinitions ( )

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

664 {
665 global $DIC;
666
667 $ilDB = $DIC['ilDB'];
668 $lng = $DIC['lng'];
669 $objDefinition = $DIC['objDefinition'];
670 $rbacreview = $DIC['rbacreview'];
671
672 $operation_info = $rbacreview->getOperationAssignment();
673 foreach ($operation_info as $info) {
674 if ($objDefinition->getDevMode($info['type'])) {
675 continue;
676 }
677 $rbac_objects[$info['typ_id']] = array("obj_id" => $info['typ_id'],
678 "type" => $info['type']);
679
680 // handle plugin permission texts
681 $txt = $objDefinition->isPlugin($info['type'])
682 ? ilObjectPlugin::lookupTxtById($info['type'], $info['type'] . "_" . $info['operation'])
683 : $lng->txt($info['type'] . "_" . $info['operation']);
684 if (substr($info['operation'], 0, 7) == "create_" &&
685 $objDefinition->isPlugin(substr($info['operation'], 7))) {
686 $txt = ilObjectPlugin::lookupTxtById(substr($info['operation'], 7), $info['type'] . "_" . $info['operation']);
687 }
688 $rbac_operations[$info['typ_id']][$info['ops_id']] = array(
689 "ops_id" => $info['ops_id'],
690 "title" => $info['operation'],
691 "name" => $txt);
692 }
693 return array($rbac_objects,$rbac_operations);
694 }
ilObjectPlugin\lookupTxtById
static lookupTxtById($plugin_id, $lang_var)
Definition: class.ilObjectPlugin.php:99
$txt
$txt
Definition: error.php:13
$ilDB
global $ilDB
Definition: storeScorm2004.php:19

References $DIC, $ilDB, ilObject\$lng, ilObject\$objDefinition, ilObject\$rbacreview, $txt, and ilObjectPlugin\lookupTxtById().

+ Here is the call graph for this function:

◆ _getAssignUsersStatus()

static ilObjRole::_getAssignUsersStatus (   $a_role_id)
static

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

155 {
156 global $DIC;
157
158 $ilDB = $DIC['ilDB'];
159
160 $query = "SELECT assign_users FROM role_data WHERE role_id = " . $ilDB->quote($a_role_id, 'integer') . " ";
161 $res = $ilDB->query($query);
162 while ($row = $ilDB->fetchObject($res)) {
163 return $row->assign_users ? true : false;
164 }
165 return false;
166 }
$query
$query
Definition: proxy_ylocal.php:13
$res
foreach($_POST as $key=> $value) $res
Definition: save_question_post_data.php:15

References $DIC, $ilDB, $query, and $res.

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

+ Here is the caller graph for this function:

◆ _getAuthMode()

static ilObjRole::_getAuthMode (   $a_role_id)
static

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

607 {
608 global $DIC;
609
610 $ilDB = $DIC['ilDB'];
611
612 $query = "SELECT auth_mode FROM role_data " .
613 "WHERE role_id= " . $ilDB->quote($a_role_id, 'integer') . " ";
614 $res = $ilDB->query($query);
615 $row = $ilDB->fetchAssoc($res);
616
617 return $row['auth_mode'];
618 }

References $DIC, $ilDB, $query, and $res.

◆ _getRolesByAuthMode()

static ilObjRole::_getRolesByAuthMode (   $a_auth_mode)
static

Get roles by auth mode.

@access public

Parameters
stringauth mode

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

628 {
629 global $DIC;
630
631 $ilDB = $DIC['ilDB'];
632
633 $query = "SELECT * FROM role_data " .
634 "WHERE auth_mode = " . $ilDB->quote($a_auth_mode, 'text');
635 $res = $ilDB->query($query);
636 $roles = array();
637 while ($row = $ilDB->fetchObject($res)) {
638 $roles[] = $row->role_id;
639 }
640 return $roles;
641 }

References $DIC, $ilDB, $query, and $res.

Referenced by ilRadiusSettings\read().

+ Here is the caller graph for this function:

◆ _getTranslation()

static ilObjRole::_getTranslation (   $a_role_title)
static

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

515 {
516 global $DIC;
517
518 $lng = $DIC['lng'];
519 $objDefinition = $DIC['objDefinition'];
520
521 $role_title = self::_removeObjectId($a_role_title);
522
523 if (preg_match("/^il_([a-z]{1,4})_./", $role_title, $type)) {
524 //BT ID 0032909: language variables for roles from plugins were not resolved properly
525 if ($objDefinition->isPlugin($type[1])) {
526 return ilObjectPlugin::lookupTxtById($type[1], $role_title);
527 }
528
529 return $lng->txt($role_title);
530 }
531
532 return $a_role_title;
533 }
ilObjRole\_removeObjectId
static _removeObjectId($a_role_title)
Definition: class.ilObjRole.php:535

References $DIC, ilObject\$lng, ilObject\$objDefinition, ilObject\$type, _removeObjectId(), and ilObjectPlugin\lookupTxtById().

Referenced by ilCourseEditParticipantsTableGUI\__construct(), ilRecommendedContentRoleTableGUI\__construct(), ilObjRoleGUI\addAdminLocatorItems(), ilObjRoleGUI\addLocatorItems(), ilObjRoleGUI\adoptPermObject(), ilObjRoleGUI\adoptPermSaveObject(), ilMailMemberSearchDataProvider\buildRoleTitle(), ilObjRoleFolderGUI\confirmDeleteObject(), ilObjRoleGUI\confirmDeleteRoleObject(), ilObjectRolePermissionTableGUI\createTitle(), ilObjBlog\getAllLocalRoles(), ilSkillProfile\getAssignedRoles(), ilObjectPermissionStatusGUI\getAssignedValidRoles(), ilObjectPermissionStatusGUI\getAvailableRolesTableData(), ilObjCourse\getLocalCourseRoles(), ilObjGroup\getLocalGroupRoles(), ilLearningSequenceRoles\getLocalLearningSequenceRoles(), ilObjCourseGUI\getLocalRoles(), ilObjGroupGUI\getLocalRoles(), ilObjLearningSequenceGUI\getLocalRoles(), ilSessionParticipantsTableGUI\getParentLocalRoles(), getPresentationTitle(), ilObjRoleTemplate\getPresentationTitle(), ilLTIProviderObjectSettingGUI\getRoleSelection(), ilObjBlog\getRolesWithContributeOrRedact(), ilDclTableViewEditFormGUI\initForm(), ilObjRoleTemplateGUI\initFormRoleTemplate(), ilSettingsPermissionGUI\initPermissionForm(), ilPermissionGUI\initRoleForm(), ilRoleSelectionTableGUI\parse(), ilRoleTableGUI\parse(), ilRbacLogTableGUI\parseChangesFaPa(), ilObjRoleGUI\readRoleProperties(), ilObjUserGUI\roleassignmentObject(), 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 (   $a_role_id)
static

check whether role is allowed in user registration or not

Parameters
int$a_role_idrole id
Returns
boolean true if role is allowed in user registration

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

377 {
378 global $DIC;
379
380 $ilDB = $DIC['ilDB'];
381
382 $query = "SELECT * FROM role_data " .
383 " WHERE role_id =" . $ilDB->quote($a_role_id, 'integer');
384
385 $res = $ilDB->query($query);
386 if ($role_rec = $ilDB->fetchAssoc($res)) {
387 if ($role_rec["allow_register"]) {
388 return true;
389 }
390 }
391 return false;
392 }

References $DIC, $ilDB, $query, and $res.

Referenced by ilRegistrationSettingsGUI\editRoles(), 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

@access public

Returns
array array of int: role ids

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

350 {
351 global $DIC;
352
353 $ilDB = $DIC['ilDB'];
354
355 $query = "SELECT * FROM role_data " .
356 "JOIN object_data ON object_data.obj_id = role_data.role_id " .
357 "WHERE allow_register = 1";
358 $res = $ilDB->query($query);
359
360 $roles = array();
361 while ($role = $ilDB->fetchAssoc($res)) {
362 $roles[] = array("id" => $role["obj_id"],
363 "title" => $role["title"],
364 "auth_mode" => $role['auth_mode']);
365 }
366
367 return $roles;
368 }

References $DIC, $ilDB, $query, and $res.

Referenced by ilRegistrationSettingsGUI\__prepareAccessLimitationRoleList(), ilRegistrationSettingsGUI\__prepareRoleList(), ilUserProfile\addStandardFieldsToForm(), ilObjAuthSettingsGUI\authSettingsObject(), ilRegistrationSettingsGUI\editRoleAccessLimitations(), and ilRegistrationSettingsGUI\saveRoleAccessLimitations().

+ Here is the caller graph for this function:

◆ _removeObjectId()

static ilObjRole::_removeObjectId (   $a_role_title)
static

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

536 {
537 $role_title_parts = explode('_', $a_role_title);
538
539 $test2 = (int) $role_title_parts[3];
540 if ($test2 > 0) {
541 unset($role_title_parts[3]);
542 }
543
544 return implode('_', $role_title_parts);
545 }

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

+ Here is the caller graph for this function:

◆ _resetAuthMode()

static ilObjRole::_resetAuthMode (   $a_auth_mode)
static

Reset auth mode to default.

@access public

Parameters
stringauth mode

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

652 {
653 global $DIC;
654
655 $ilDB = $DIC['ilDB'];
656
657 $query = "UPDATE role_data SET auth_mode = 'default' WHERE auth_mode = " . $ilDB->quote($a_auth_mode, 'text');
658 $res = $ilDB->manipulate($query);
659 }

References $DIC, $ilDB, $query, and $res.

Referenced by ilRadiusSettings\save().

+ Here is the caller graph for this function:

◆ _updateAuthMode()

static ilObjRole::_updateAuthMode (   $a_roles)
static

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

593 {
594 global $DIC;
595
596 $ilDB = $DIC['ilDB'];
597
598 foreach ($a_roles as $role_id => $auth_mode) {
599 $query = "UPDATE role_data SET " .
600 "auth_mode= " . $ilDB->quote($auth_mode, 'text') . " " .
601 "WHERE role_id= " . $ilDB->quote($role_id, 'integer') . " ";
602 $res = $ilDB->manipulate($query);
603 }
604 }

References $DIC, $ilDB, $query, and $res.

Referenced by ilRadiusSettings\save(), and ilObjAuthSettingsGUI\updateAuthRolesObject().

+ Here is the caller graph for this function:

◆ adjustPermissions()

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

Adjust permissions.

Parameters
int$a_mode
array$a_nodesarray of nodes
array$a_policiesarray of object ref ids
array$a_exclusion_filterof object types.
Returns

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

776 {
777 global $DIC;
778
779 $rbacadmin = $DIC['rbacadmin'];
780 $rbacreview = $DIC['rbacreview'];
781 $tree = $DIC['tree'];
782 $logger = $DIC->logger()->ac();
783
784 $operation_stack = array();
785 $policy_stack = array();
786 $node_stack = array();
787
788 $start_node = current($a_nodes);
789 array_push($node_stack, $start_node);
790 $this->updatePolicyStack($policy_stack, $start_node['child']);
791
792 if ($a_operation_mode == self::MODE_READ_OPERATIONS) {
793 $this->updateOperationStack($operation_stack, $start_node['child'], true);
794 }
795 else {
796 $operation_stack = $a_operation_stack;
797 }
798
799 $this->logger->debug('adjust permissions operation stack');
800 $this->logger->dump($operation_stack, ilLogLevel::DEBUG);
801
802 include_once "Services/AccessControl/classes/class.ilRbacLog.php";
803 $rbac_log_active = ilRbacLog::isActive();
804
805 $local_policy = false;
806 foreach ($a_nodes as $node) {
807 $cmp_node = end($node_stack);
808 while ($relation = $tree->getRelationOfNodes($node, $cmp_node)) {
809 switch ($relation) {
810 case ilTree::RELATION_NONE:
811 case ilTree::RELATION_SIBLING:
812 $logger->debug('Handling sibling/none relation.');
813 array_pop($operation_stack);
814 array_pop($policy_stack);
815 array_pop($node_stack);
816 $cmp_node = end($node_stack);
817 $local_policy = false;
818 break;
819
820 case ilTree::RELATION_CHILD:
821 case ilTree::RELATION_EQUALS:
822 case ilTree::RELATION_PARENT:
823 default:
824 $logger->debug('Handling child/equals/parent ' . $relation);
825 break 2;
826 }
827 }
828
829 if ($local_policy) {
830 continue;
831 }
832
833 // Start node => set permissions and continue
834 if ($node['child'] == $start_node['child']) {
835 if ($this->isHandledObjectType($a_filter, $a_exclusion_filter, $node['type'])) {
836 if ($rbac_log_active) {
837 $rbac_log_roles = $rbacreview->getParentRoleIds($node['child'], false);
838 $rbac_log_old = ilRbacLog::gatherFaPa($node['child'], array_keys($rbac_log_roles));
839 }
840
841 // Set permissions
842 $perms = end($operation_stack);
843 $this->changeExistingObjectsGrantPermissions(
844 $this->getId(),
845 (array) $perms[$node['type']],
846 $node['child'],
847 $a_operation_mode
848 );
849
850 if ($rbac_log_active) {
851 $rbac_log_new = ilRbacLog::gatherFaPa($node['child'], array_keys($rbac_log_roles));
852 $rbac_log = ilRbacLog::diffFaPa($rbac_log_old, $rbac_log_new);
853 ilRbacLog::add(ilRbacLog::EDIT_TEMPLATE_EXISTING, $node['child'], $rbac_log);
854 }
855 }
856 continue;
857 }
858
859 // Node has local policies => update permission stack and continue
860 if (in_array($node['child'], $a_policies) and ($node['child'] != SYSTEM_FOLDER_ID)) {
861 $local_policy = true;
862 $this->updatePolicyStack($policy_stack, $node['child']);
863 $this->updateOperationStack($operation_stack, $node['child']);
864 array_push($node_stack, $node);
865 continue;
866 }
867
868 // Continue if this object type is not in filter
869 if (!$this->isHandledObjectType($a_filter, $a_exclusion_filter, $node['type'])) {
870 continue;
871 }
872
873 if ($rbac_log_active) {
874 $rbac_log_roles = $rbacreview->getParentRoleIds($node['child'], false);
875 $rbac_log_old = ilRbacLog::gatherFaPa($node['child'], array_keys($rbac_log_roles));
876 }
877
878 // Node is course or group => create permission intersection
879 if (
880 ($a_mode == self::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES || $a_mode == self::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES) &&
881 ($node['type'] == 'crs' || $node['type'] == 'grp')
882 ) {
883 // Copy role permission intersection
884 $perms = end($operation_stack);
885 $this->createPermissionIntersection($policy_stack, $perms[$node['type']], $node['child'], $node['type']);
886 if ($this->updateOperationStack($operation_stack, $node['child'])) {
887 $this->updatePolicyStack($policy_stack, $node['child']);
888 array_push($node_stack, $node);
889 }
890 }
891
892 // Set permission
893 $perms = end($operation_stack);
894 $this->changeExistingObjectsGrantPermissions(
895 $this->getId(),
896 (array) $perms[$node['type']],
897 $node['child'],
898 $a_operation_mode
899 );
900 if ($rbac_log_active) {
901 $rbac_log_new = ilRbacLog::gatherFaPa($node['child'], array_keys($rbac_log_roles));
902 $rbac_log = ilRbacLog::diffFaPa($rbac_log_old, $rbac_log_new);
903 ilRbacLog::add(ilRbacLog::EDIT_TEMPLATE_EXISTING, $node['child'], $rbac_log);
904 }
905 }
906 }
ilObjRole\createPermissionIntersection
createPermissionIntersection($policy_stack, $a_current_ops, $a_id, $a_type)
Create course group permission intersection.
Definition: class.ilObjRole.php:1064
ilObjRole\changeExistingObjectsGrantPermissions
changeExistingObjectsGrantPermissions($a_role_id, $a_permissions, $a_ref_id, $a_operation_mode)
Definition: class.ilObjRole.php:914
ilObjRole\updatePolicyStack
updatePolicyStack(&$a_stack, $a_node)
Update policy stack.
Definition: class.ilObjRole.php:1032
ilObjRole\isHandledObjectType
isHandledObjectType($a_filter, $a_exclusion_filter, $a_type)
Check if type is filterer.
Definition: class.ilObjRole.php:970
ilObjRole\updateOperationStack
updateOperationStack(&$a_stack, $a_node, $a_init=false)
Update operation stack.
Definition: class.ilObjRole.php:988
ilObject\getId
getId()
get object id @access public
Definition: class.ilObject.php:320
ilRbacLog\diffFaPa
static diffFaPa(array $a_old, array $a_new)
Definition: class.ilRbacLog.php:69
ilRbacLog\add
static add($a_action, $a_ref_id, array $a_diff, $a_source_ref_id=false)
Definition: class.ilRbacLog.php:137
ilRbacLog\EDIT_TEMPLATE_EXISTING
const EDIT_TEMPLATE_EXISTING
Definition: class.ilRbacLog.php:22
ilRbacLog\gatherFaPa
static gatherFaPa($a_ref_id, array $a_role_ids, $a_add_action=false)
Definition: class.ilRbacLog.php:35
ilRbacLog\isActive
static isActive()
Definition: class.ilRbacLog.php:25
ilTree\RELATION_EQUALS
const RELATION_EQUALS
Definition: class.ilTree.php:36
ilTree\RELATION_PARENT
const RELATION_PARENT
Definition: class.ilTree.php:34
ilTree\RELATION_NONE
const RELATION_NONE
Definition: class.ilTree.php:37
ilTree\RELATION_SIBLING
const RELATION_SIBLING
Definition: class.ilTree.php:35
ilTree\RELATION_CHILD
const RELATION_CHILD
Definition: class.ilTree.php:33

References $DIC, $logger, ilObject\$rbacadmin, ilObject\$rbacreview, ilObject\$tree, ilRbacLog\add(), changeExistingObjectsGrantPermissions(), createPermissionIntersection(), ilLogLevel\DEBUG, ilRbacLog\diffFaPa(), ilRbacLog\EDIT_TEMPLATE_EXISTING, ilRbacLog\gatherFaPa(), ilObject\getId(), ilRbacLog\isActive(), isHandledObjectType(), ilTree\RELATION_CHILD, ilTree\RELATION_EQUALS, ilTree\RELATION_NONE, ilTree\RELATION_PARENT, ilTree\RELATION_SIBLING, updateOperationStack(), and updatePolicyStack().

Referenced by changeExistingObjects().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ assignData()

ilObjRole::assignData (   $a_data)

loads a record "role" from array @access public

Parameters
arrayroledata

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

199 {
200 $this->setTitle(ilUtil::stripSlashes($a_data["title"]));
201 $this->setDescription(ilUtil::stripslashes($a_data["desc"]));
202 $this->setAllowRegister($a_data["allow_register"]);
203 $this->toggleAssignUsersStatus($a_data['assign_users']);
204 $this->setDiskQuota($a_data['disk_quota']);
205 $this->setPersonalWorkspaceDiskQuota($a_data['wsp_disk_quota']);
206 }
ilObjRole\setAllowRegister
setAllowRegister($a_allow_register)
set allow_register of role
Definition: class.ilObjRole.php:268
ilObjRole\toggleAssignUsersStatus
toggleAssignUsersStatus($a_assign_users)
Definition: class.ilObjRole.php:145
ilObjRole\setDiskQuota
setDiskQuota($a_disk_quota)
Sets the minimal disk quota imposed by this role.
Definition: class.ilObjRole.php:296
ilObjRole\setPersonalWorkspaceDiskQuota
setPersonalWorkspaceDiskQuota($a_disk_quota)
Sets the minimal personal workspace disk quota imposed by this role.
Definition: class.ilObjRole.php:324
ilObject\setTitle
setTitle($a_title)
set object title
Definition: class.ilObject.php:418
ilObject\setDescription
setDescription($a_desc)
set object description
Definition: class.ilObject.php:443
ilUtil\stripSlashes
static stripSlashes($a_str, $a_strip_html=true, $a_allow="")
strip slashes if magic qoutes is enabled
Definition: class.ilUtil.php:2408

References setAllowRegister(), ilObject\setDescription(), setDiskQuota(), setPersonalWorkspaceDiskQuota(), ilObject\setTitle(), ilUtil\stripSlashes(), and toggleAssignUsersStatus().

Referenced by read().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ changeExistingObjects()

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

Change existing objects.

Parameters
int$a_start_node
int$a_mode
arrayfilter Filter of object types (array('all') => change all objects
Returns

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

710 {
711 global $DIC;
712
713 $tree = $DIC->repositoryTree();
714 $rbacreview = $DIC->rbac()->review();
715
716 // Get node info of subtree
717 $nodes = $tree->getRbacSubtreeInfo($a_start_node);
718
719 // get local policies
720 $all_local_policies = $rbacreview->getObjectsWithStopedInheritance($this->getId());
721
722 // filter relevant roles
723 $local_policies = array();
724 foreach ($all_local_policies as $lp) {
725 if (isset($nodes[$lp])) {
726 $local_policies[] = $lp;
727 }
728 }
729
730 // Delete deprecated policies
731 switch ($a_mode) {
732 case self::MODE_UNPROTECTED_DELETE_LOCAL_POLICIES:
733 case self::MODE_PROTECTED_DELETE_LOCAL_POLICIES:
734 $local_policies = $this->deleteLocalPolicies($a_start_node, $local_policies, $a_filter);
735 break;
736 }
737 $this->adjustPermissions($a_mode, $nodes, $local_policies, $a_filter, $a_exclusion_filter, $a_operation_mode, $a_operation_stack);
738 }
ilObjRole\MODE_PROTECTED_DELETE_LOCAL_POLICIES
const MODE_PROTECTED_DELETE_LOCAL_POLICIES
Definition: class.ilObjRole.php:18
ilObjRole\MODE_UNPROTECTED_DELETE_LOCAL_POLICIES
const MODE_UNPROTECTED_DELETE_LOCAL_POLICIES
Definition: class.ilObjRole.php:20
ilObjRole\deleteLocalPolicies
deleteLocalPolicies($a_start, $a_policies, $a_filter)
Delete local policies.
Definition: class.ilObjRole.php:745
ilObjRole\adjustPermissions
adjustPermissions($a_mode, $a_nodes, $a_policies, $a_filter, $a_exclusion_filter=array(), $a_operation_mode=self::MODE_READ_OPERATIONS, $a_operation_stack=[])
Adjust permissions.
Definition: class.ilObjRole.php:775

References $DIC, ilObject\$rbacreview, ilObject\$tree, adjustPermissions(), deleteLocalPolicies(), ilObject\getId(), MODE_PROTECTED_DELETE_LOCAL_POLICIES, and MODE_UNPROTECTED_DELETE_LOCAL_POLICIES.

+ Here is the call graph for this function:

◆ changeExistingObjectsGrantPermissions()

ilObjRole::changeExistingObjectsGrantPermissions (   $a_role_id,
  $a_permissions,
  $a_ref_id,
  $a_operation_mode 
)
protected
Parameters
$a_role_id
$a_permissions
$a_ref_id
$a_operation_mode

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

915 {
916 global $DIC;
917
918 $admin = $DIC->rbac()->admin();
919 $review = $DIC->rbac()->review();
920 if ($a_operation_mode == self::MODE_READ_OPERATIONS) {
921 $admin->grantPermission(
922 $a_role_id,
923 $a_permissions,
924 $a_ref_id
925 );
926 }
927 elseif ($a_operation_mode == self::MODE_ADD_OPERATIONS) {
928 $current_operations = $review->getRoleOperationsOnObject(
929 $a_role_id,
930 $a_ref_id
931 );
932 $this->logger->debug('Current operations');
933 $this->logger->dump($current_operations);
934
935 $new_ops = array_unique(array_merge($a_permissions, $current_operations));
936 $this->logger->debug('New operations');
937 $this->logger->dump($new_ops);
938
939 $admin->grantPermission(
940 $a_role_id,
941 $new_ops,
942 $a_ref_id
943 );
944 }
945 elseif ($a_operation_mode == self::MODE_REMOVE_OPERATIONS) {
946 $current_operations = $review->getRoleOperationsOnObject(
947 $a_role_id,
948 $a_ref_id
949 );
950 $this->logger->debug('Current operations');
951 $this->logger->dump($current_operations);
952
953 $new_ops = array_diff($current_operations, $a_permissions);
954
955 $admin->grantPermission(
956 $a_role_id,
957 $new_ops,
958 $a_ref_id
959 );
960 }
961 }

References $DIC.

Referenced by adjustPermissions().

+ Here is the caller graph for this function:

◆ create()

ilObjRole::create ( )

create

@access public

Returns
integer object id

Reimplemented from ilObject.

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

241 {
242 global $DIC;
243
244 $ilDB = $DIC['ilDB'];
245
246 $this->id = parent::create();
247
248 $query = "INSERT INTO role_data " .
249 "(role_id,allow_register,assign_users,disk_quota,wsp_disk_quota) " .
250 "VALUES " .
251 "(" . $ilDB->quote($this->id, 'integer') . "," .
252 $ilDB->quote($this->getAllowRegister(), 'integer') . "," .
253 $ilDB->quote($this->getAssignUsersStatus(), 'integer') . "," .
254 $ilDB->quote($this->getDiskQuota(), 'integer') . "," .
255 $ilDB->quote($this->getPersonalWorkspaceDiskQuota(), 'integer') . ")"
256 ;
257 $res = $ilDB->query($query);
258
259 return $this->id;
260 }
ilObjRole\getPersonalWorkspaceDiskQuota
getPersonalWorkspaceDiskQuota()
Gets the minimal personal workspace disk quota imposed by this role.
Definition: class.ilObjRole.php:338
ilObjRole\getAllowRegister
getAllowRegister()
get allow_register
Definition: class.ilObjRole.php:283
ilObjRole\getDiskQuota
getDiskQuota()
Gets the minimal disk quota imposed by this role.
Definition: class.ilObjRole.php:310

References $DIC, ilObject\$id, $ilDB, $query, $res, getAllowRegister(), getAssignUsersStatus(), getDiskQuota(), and getPersonalWorkspaceDiskQuota().

+ Here is the call graph for this function:

◆ createDefaultRole()

static ilObjRole::createDefaultRole (   $a_title,
  $a_description,
  $a_tpl_name,
  $a_ref_id 
)
static
Parameters
type$a_title
type$a_description
type$a_tpl_name
type$a_ref_id
Returns
ilObjRole

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

73 {
74 global $DIC;
75
76 $ilDB = $DIC['ilDB'];
77
78 // SET PERMISSION TEMPLATE OF NEW LOCAL CONTRIBUTOR ROLE
79 $res = $ilDB->query("SELECT obj_id FROM object_data " .
80 " WHERE type=" . $ilDB->quote("rolt", "text") .
81 " AND title=" . $ilDB->quote($a_tpl_name, "text"));
82 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
83 $tpl_id = $row->obj_id;
84 }
85
86 if (!$tpl_id) {
87 return null;
88 }
89
90 include_once './Services/AccessControl/classes/class.ilObjRole.php';
91 $role = new ilObjRole();
92 $role->setTitle($a_title);
93 $role->setDescription($a_description);
94 $role->create();
95
96 $GLOBALS['DIC']['rbacadmin']->assignRoleToFolder($role->getId(), $a_ref_id, 'y');
97
98 $GLOBALS['DIC']['rbacadmin']->copyRoleTemplatePermissions(
99 $tpl_id,
100 ROLE_FOLDER_ID,
101 $a_ref_id,
102 $role->getId()
103 );
104
105 $ops = $GLOBALS['DIC']['rbacreview']->getOperationsOfRole(
106 $role->getId(),
107 ilObject::_lookupType($a_ref_id, true),
108 $a_ref_id
109 );
110 $GLOBALS['DIC']['rbacadmin']->grantPermission(
111 $role->getId(),
112 $ops,
113 $a_ref_id
114 );
115 return $role;
116 }
$GLOBALS
if(!defined('PATH_SEPARATOR')) $GLOBALS['_PEAR_default_error_mode']
Definition: PEAR.php:64
ilObjRole
Class ilObjRole.
Definition: class.ilObjRole.php:17
ilObject\_lookupType
static _lookupType($a_id, $a_reference=false)
lookup object type
Definition: class.ilObject.php:1278

References $DIC, $GLOBALS, $ilDB, $res, ilObject\_lookupType(), and ilDBConstants\FETCHMODE_OBJECT.

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 (   $policy_stack,
  $a_current_ops,
  $a_id,
  $a_type 
)
protected

Create course group permission intersection.

Parameters
arrayoperation stack
int$a_id
string$a_type
Returns

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

1065 {
1066 global $DIC;
1067
1068 $ilDB = $DIC['ilDB'];
1069 $rbacreview = $DIC['rbacreview'];
1070 $rbacadmin = $DIC['rbacadmin'];
1071
1072 static $course_non_member_id = null;
1073 static $group_non_member_id = null;
1074 static $group_open_id = null;
1075 static $group_closed_id = null;
1076
1077 // Get template id
1078 switch ($a_type) {
1079 case 'grp':
1080
1081 include_once './Modules/Group/classes/class.ilObjGroup.php';
1082 $type = ilObjGroup::lookupGroupTye(ilObject::_lookupObjId($a_id));
1083 #var_dump("GROUP TYPE",$type);
1084 switch ($type) {
1085 case GRP_TYPE_CLOSED:
1086 if (!$group_closed_id) {
1087 $query = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_closed'";
1088 $res = $ilDB->query($query);
1089 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
1090 $group_closed_id = $row->obj_id;
1091 }
1092 }
1093 $template_id = $group_closed_id;
1094 #var_dump("GROUP CLOSED id:" . $template_id);
1095 break;
1096
1097 case GRP_TYPE_OPEN:
1098 default:
1099 if (!$group_open_id) {
1100 $query = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_grp_status_open'";
1101 $res = $ilDB->query($query);
1102 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
1103 $group_open_id = $row->obj_id;
1104 }
1105 }
1106 $template_id = $group_open_id;
1107 #var_dump("GROUP OPEN id:" . $template_id);
1108 break;
1109 }
1110 break;
1111
1112 case 'crs':
1113 if (!$course_non_member_id) {
1114 $query = "SELECT obj_id FROM object_data WHERE type='rolt' AND title='il_crs_non_member'";
1115 $res = $ilDB->query($query);
1116 while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
1117 $course_non_member_id = $row->obj_id;
1118 }
1119 }
1120 $template_id = $course_non_member_id;
1121 break;
1122 }
1123
1124 $current_ops = $a_current_ops[$a_type];
1125
1126 // Create intersection template permissions
1127 if ($template_id) {
1128 //$rolf = $rbacreview->getRoleFolderIdOfObject($a_id);
1129
1130 $rbacadmin->copyRolePermissionIntersection(
1131 $template_id,
1132 ROLE_FOLDER_ID,
1133 $this->getId(),
1134 end($policy_stack),
1135 $a_id,
1136 $this->getId()
1137 );
1138 } else {
1139 #echo "No template id for ".$a_id.' of type'.$a_type.'<br>';
1140 }
1141 #echo "ROLE ASSIGN: ".$rolf.' AID'.$a_id;
1142 if ($a_id and !$GLOBALS['DIC']['rbacreview']->isRoleAssignedToObject($this->getId(), $a_id)) {
1143 $rbacadmin->assignRoleToFolder($this->getId(), $a_id, "n");
1144 }
1145 return true;
1146 }
GRP_TYPE_OPEN
const GRP_TYPE_OPEN
Definition: class.ilObjGroup.php:20
GRP_TYPE_CLOSED
const GRP_TYPE_CLOSED
Definition: class.ilObjGroup.php:19
ilObjGroup\lookupGroupTye
static lookupGroupTye($a_id)
Lookup group type.
Definition: class.ilObjGroup.php:150
ilObject\_lookupObjId
static _lookupObjId($a_id)
Definition: class.ilObject.php:1107
$a_type
$a_type
Definition: workflow.php:92

References $a_type, $DIC, $GLOBALS, $ilDB, $query, ilObject\$rbacadmin, ilObject\$rbacreview, $res, ilObject\$type, ilObject\_lookupObjId(), ilDBConstants\FETCHMODE_OBJECT, ilObject\getId(), GRP_TYPE_CLOSED, GRP_TYPE_OPEN, and ilObjGroup\lookupGroupTye().

Referenced by adjustPermissions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ delete()

ilObjRole::delete ( )

delete role and all related data

@access public

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

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

425 {
426 global $DIC;
427
428 $rbacadmin = $DIC['rbacadmin'];
429 $rbacreview = $DIC['rbacreview'];
430 $ilDB = $DIC['ilDB'];
431
432 // Temporary bugfix
433 if ($rbacreview->hasMultipleAssignments($this->getId())) {
434 ilLoggerFactory::getLogger('ac')->warning('Found role with multiple assignments: role_id: ' . $this->getId());
435 ilLoggerFactory::getLogger('ac')->warning('Aborted deletion of role.');
436 return false;
437 }
438
439 if ($rbacreview->isAssignable($this->getId(), $this->getParent())) {
440 ilLoggerFactory::getLogger('ac')->debug('Handling assignable role...');
441 // do not delete a global role, if the role is the last
442 // role a user is assigned to.
443 //
444 // Performance improvement: In the code section below, we
445 // only need to consider _global_ roles. We don't need
446 // to check for _local_ roles, because a user who has
447 // a local role _always_ has a global role too.
448 $last_role_user_ids = array();
449 if ($this->getParent() == ROLE_FOLDER_ID) {
450 ilLoggerFactory::getLogger('ac')->debug('Handling global role...');
451 // The role is a global role: check if
452 // we find users who aren't assigned to any
453 // other global role than this one.
454 $user_ids = $rbacreview->assignedUsers($this->getId());
455
456 foreach ($user_ids as $user_id) {
457 // get all roles each user has
458 $role_ids = $rbacreview->assignedRoles($user_id);
459
460 // is last role?
461 if (count($role_ids) == 1) {
462 $last_role_user_ids[] = $user_id;
463 }
464 }
465 }
466
467 // users with last role found?
468 if (count($last_role_user_ids) > 0) {
469 $user_names = array();
470 foreach ($last_role_user_ids as $user_id) {
471 // GET OBJECT TITLE
472 $user_names[] = ilObjUser::_lookupLogin($user_id);
473 }
474
475 // TODO: This check must be done in rolefolder object because if multiple
476 // roles were selected the other roles are still deleted and the system does not
477 // give any feedback about this.
478 $users = implode(', ', $user_names);
479 ilLoggerFactory::getLogger('ac')->info('Cannot delete last global role of users.');
480 $this->ilias->raiseError($this->lng->txt("msg_user_last_role1") . " " .
481 $users . "<br/>" . $this->lng->txt("msg_user_last_role2"), $this->ilias->error_obj->WARNING);
482 } else {
483 ilLoggerFactory::getLogger('ac')->debug('Starting deletion of assignable role: role_id: ' . $this->getId());
484 $rbacadmin->deleteRole($this->getId(), $this->getParent());
485
486 // Delete ldap role group mappings
487 include_once('./Services/LDAP/classes/class.ilLDAPRoleGroupMappingSettings.php');
488 ilLDAPRoleGroupMappingSettings::_deleteByRole($this->getId());
489
490 // delete object_data entry
491 parent::delete();
492
493 // delete role_data entry
494 $query = "DELETE FROM role_data WHERE role_id = " . $ilDB->quote($this->getId(), 'integer');
495 $res = $ilDB->manipulate($query);
496 }
497 } else {
498 ilLoggerFactory::getLogger('ac')->debug('Starting deletion of linked role: role_id ' . $this->getId());
499 // linked local role: INHERITANCE WAS STOPPED, SO DELETE ONLY THIS LOCAL ROLE
500 $rbacadmin->deleteLocalRole($this->getId(), $this->getParent());
501 }
502 return true;
503 }
ilLoggerFactory\getLogger
static getLogger($a_component_id)
Get component logger.
Definition: class.ilLoggerFactory.php:74
ilObjRole\getParent
getParent()
get reference id of parent object
Definition: class.ilObjRole.php:412
ilObjUser\_lookupLogin
static _lookupLogin($a_user_id)
lookup login
Definition: class.ilObjUser.php:815
ilias
redirection script todo: (a better solution should control the processing via a xml file)

References $DIC, $ilDB, $query, ilObject\$rbacadmin, ilObject\$rbacreview, $res, ilLDAPRoleGroupMappingSettings\_deleteByRole(), ilObjUser\_lookupLogin(), ilObject\getId(), ilLoggerFactory\getLogger(), and getParent().

+ Here is the call graph for this function:

◆ deleteLocalPolicies()

ilObjRole::deleteLocalPolicies (   $a_start,
  $a_policies,
  $a_filter 
)
protected

Delete local policies.

Parameters
array$a_policiesarray of object ref ids that define local policies
Returns

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

746 {
747 global $DIC;
748
749 $rbacreview = $DIC['rbacreview'];
750 $rbacadmin = $DIC['rbacadmin'];
751
752 $local_policies = array();
753 foreach ($a_policies as $policy) {
754 if ($policy == $a_start or $policy == SYSTEM_FOLDER_ID) {
755 $local_policies[] = $policy;
756 continue;
757 }
758 if (!in_array('all', $a_filter) and !in_array(ilObject::_lookupType(ilObject::_lookupObjId($policy)), $a_filter)) {
759 $local_policies[] = $policy;
760 continue;
761 }
762 $rbacadmin->deleteLocalRole($this->getId(), $policy);
763 }
764 return $local_policies;
765 }

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, ilObject\_lookupObjId(), ilObject\_lookupType(), and ilObject\getId().

Referenced by changeExistingObjects().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getAllowRegister()

ilObjRole::getAllowRegister ( )

get allow_register

@access public

Returns
integer

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

284 {
285 return $this->allow_register ? $this->allow_register : false;
286 }

Referenced by create(), and ilObjRoleGUI\readRoleProperties().

+ Here is the caller graph for this function:

◆ getAssignUsersStatus()

ilObjRole::getAssignUsersStatus ( )

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

150 {
151 return $this->assign_users ? $this->assign_users : 0;
152 }

Referenced by create(), ilObjRoleGUI\readRoleProperties(), and update().

+ Here is the caller graph for this function:

◆ getCountMembers()

ilObjRole::getCountMembers ( )

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

506 {
507 global $DIC;
508
509 $rbacreview = $DIC['rbacreview'];
510
511 return count($rbacreview->assignedUsers($this->getId()));
512 }

References $DIC, and ilObject\$rbacreview.

◆ getDiskQuota()

ilObjRole::getDiskQuota ( )

Gets the minimal disk quota imposed by this role.

Returns the minimal disk quota in bytes. The default value is 0.

@access public

Returns
integer

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

311 {
312 return $this->disk_quota;
313 }
ilObjRole\$disk_quota
$disk_quota
The disk quota in bytes.
Definition: class.ilObjRole.php:45

References $disk_quota.

Referenced by create(), ilObjRoleGUI\readRoleProperties(), and update().

+ Here is the caller graph for this function:

◆ getParent()

ilObjRole::getParent ( )

get reference id of parent object

@access public

Returns
integer ref_id of parent object

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

413 {
414 return $this->parent;
415 }

References $parent.

Referenced by delete().

+ Here is the caller graph for this function:

◆ getPersonalWorkspaceDiskQuota()

ilObjRole::getPersonalWorkspaceDiskQuota ( )

Gets the minimal personal workspace disk quota imposed by this role.

Returns the minimal disk quota in bytes. The default value is 0.

@access public

Returns
integer

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

339 {
340 return $this->wsp_disk_quota;
341 }

References $wsp_disk_quota.

Referenced by create(), ilObjRoleGUI\readRoleProperties(), and update().

+ Here is the caller graph for this function:

◆ getPresentationTitle()

ilObjRole::getPresentationTitle ( )

return translated title for autogenerated roles

Returns

Reimplemented from ilObject.

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

141 {
142 return ilObjRole::_getTranslation($this->getTitle());
143 }
ilObjRole\_getTranslation
static _getTranslation($a_role_title)
Definition: class.ilObjRole.php:514
ilObject\getTitle
getTitle()
get object title @access public
Definition: class.ilObject.php:396

References _getTranslation(), and ilObject\getTitle().

+ Here is the call graph for this function:

◆ isAutoGenerated()

static ilObjRole::isAutoGenerated (   $a_role_id)
static

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

698 {
699 return substr(ilObject::_lookupTitle($a_role_id), 0, 3) == 'il_';
700 }
ilObject\_lookupTitle
static _lookupTitle($a_id)
lookup object title
Definition: class.ilObject.php:988

References ilObject\_lookupTitle().

Referenced by ilObjRoleGUI\initFormRoleProperties().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ isHandledObjectType()

ilObjRole::isHandledObjectType (   $a_filter,
  $a_exclusion_filter,
  $a_type 
)
protected

Check if type is filterer.

Parameters
array$a_filter
string$a_type
Returns

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

971 {
972 if (in_array($a_type, $a_exclusion_filter)) {
973 return false;
974 }
975
976 if (in_array('all', $a_filter)) {
977 return true;
978 }
979 return in_array($a_type, $a_filter);
980 }

References $a_type.

Referenced by adjustPermissions().

+ Here is the caller graph for this function:

◆ read()

ilObjRole::read ( )

loads "role" from database @access private

Reimplemented from ilObject.

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

173 {
174 global $DIC;
175
176 $ilDB = $DIC['ilDB'];
177
178 $query = "SELECT * FROM role_data WHERE role_id= " . $ilDB->quote($this->id, 'integer') . " ";
179
180 $res = $ilDB->query($query);
181 if ($res->numRows() > 0) {
182 $data = $ilDB->fetchAssoc($res);
183
184 // fill member vars in one shot
185 $this->assignData($data);
186 } else {
187 $this->ilias->raiseError("<b>Error: There is no dataset with id " . $this->id . "!</b><br />class: " . get_class($this) . "<br />Script: " . __FILE__ . "<br />Line: " . __LINE__, $this->ilias->FATAL);
188 }
189
190 parent::read();
191 }
ilObjRole\assignData
assignData($a_data)
loads a record "role" from array @access public
Definition: class.ilObjRole.php:198
$data
$data
Definition: storeScorm.php:23

References $data, $DIC, $ilDB, $query, $res, and assignData().

Referenced by update().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ setAllowRegister()

ilObjRole::setAllowRegister (   $a_allow_register)

set allow_register of role

@access public

Parameters
integer

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

269 {
270 if (empty($a_allow_register)) {
271 $a_allow_register == 0;
272 }
273
274 $this->allow_register = (int) $a_allow_register;
275 }

Referenced by assignData(), and ilObjRoleGUI\loadRoleProperties().

+ Here is the caller graph for this function:

◆ setDiskQuota()

ilObjRole::setDiskQuota (   $a_disk_quota)

Sets the minimal disk quota imposed by this role.

The minimal disk quota is specified in bytes.

@access public

Parameters
integer

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

297 {
298 $this->disk_quota = $a_disk_quota;
299 }

Referenced by assignData(), and ilObjRoleGUI\loadRoleProperties().

+ Here is the caller graph for this function:

◆ setParent()

ilObjRole::setParent (   $a_parent_ref)

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

@access public

Parameters
integerref_id of parent object

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

402 {
403 $this->parent = $a_parent_ref;
404 }

◆ setPersonalWorkspaceDiskQuota()

ilObjRole::setPersonalWorkspaceDiskQuota (   $a_disk_quota)

Sets the minimal personal workspace disk quota imposed by this role.

The minimal disk quota is specified in bytes.

@access public

Parameters
integer

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

325 {
326 $this->wsp_disk_quota = $a_disk_quota;
327 }

Referenced by assignData(), and ilObjRoleGUI\loadRoleProperties().

+ Here is the caller graph for this function:

◆ toggleAssignUsersStatus()

ilObjRole::toggleAssignUsersStatus (   $a_assign_users)

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

146 {
147 $this->assign_users = (int) $a_assign_users;
148 }

Referenced by assignData(), and ilObjRoleGUI\loadRoleProperties().

+ Here is the caller graph for this function:

◆ update()

ilObjRole::update ( )

updates a record "role" and write it into database @access public

Reimplemented from ilObject.

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

213 {
214 global $DIC;
215
216 $ilDB = $DIC['ilDB'];
217
218 $query = "UPDATE role_data SET " .
219 "allow_register= " . $ilDB->quote($this->allow_register, 'integer') . ", " .
220 "assign_users = " . $ilDB->quote($this->getAssignUsersStatus(), 'integer') . ", " .
221 "disk_quota = " . $ilDB->quote($this->getDiskQuota(), 'integer') . ", " .
222 "wsp_disk_quota = " . $ilDB->quote($this->getPersonalWorkspaceDiskQuota(), 'integer') . " " .
223 "WHERE role_id= " . $ilDB->quote($this->id, 'integer') . " ";
224 $res = $ilDB->manipulate($query);
225
226 parent::update();
227
228 $this->read();
229
230 return true;
231 }
ilObjRole\read
read()
loads "role" from database @access private
Definition: class.ilObjRole.php:172

References $DIC, $ilDB, $query, $res, getAssignUsersStatus(), getDiskQuota(), getPersonalWorkspaceDiskQuota(), and read().

+ Here is the call graph for this function:

◆ updateOperationStack()

ilObjRole::updateOperationStack ( &  $a_stack,
  $a_node,
  $a_init = false 
)
protected

Update operation stack.

Parameters
array$a_stack
int$a_node
Returns

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

989 {
990 global $DIC;
991
992 $rbacreview = $DIC['rbacreview'];
993
994 $has_policies = null;
995 $policy_origin = null;
996
997 if ($a_node == ROOT_FOLDER_ID) {
998 $has_policies = true;
999 $policy_origin = ROLE_FOLDER_ID;
1000 } else {
1001 $has_policies = $rbacreview->getLocalPolicies($a_node);
1002 $policy_origin = $a_node;
1003
1004 if ($a_init) {
1005 $parent_roles = $rbacreview->getParentRoleIds($a_node, false);
1006 if ($parent_roles[$this->getId()]) {
1007 $a_stack[] = $rbacreview->getAllOperationsOfRole(
1008 $this->getId(),
1009 $parent_roles[$this->getId()]['parent']
1010 );
1011 }
1012 return true;
1013 }
1014 }
1015
1016 if (!$has_policies) {
1017 return false;
1018 }
1019
1020 $a_stack[] = $rbacreview->getAllOperationsOfRole(
1021 $this->getId(),
1022 $policy_origin
1023 );
1024 return true;
1025 }

References $DIC, ilObject\$rbacreview, and ilObject\getId().

Referenced by adjustPermissions().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ updatePolicyStack()

ilObjRole::updatePolicyStack ( &  $a_stack,
  $a_node 
)
protected

Update policy stack.

Parameters
object$a_node
Returns

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

1033 {
1034 global $DIC;
1035
1036 $rbacreview = $DIC['rbacreview'];
1037
1038 $has_policies = null;
1039 $policy_origin = null;
1040
1041 if ($a_node == ROOT_FOLDER_ID) {
1042 $has_policies = true;
1043 $policy_origin = ROLE_FOLDER_ID;
1044 } else {
1045 $has_policies = $rbacreview->getLocalPolicies($a_node);
1046 $policy_origin = $a_node;
1047 }
1048
1049 if (!$has_policies) {
1050 return false;
1051 }
1052
1053 $a_stack[] = $policy_origin;
1054 return true;
1055 }

References $DIC, and ilObject\$rbacreview.

Referenced by adjustPermissions().

+ Here is the caller graph for this function:

◆ validate()

ilObjRole::validate ( )

Validate role data.

Returns
bool

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

124 {
125 global $DIC;
126
127 $ilErr = $DIC['ilErr'];
128
129 if (substr($this->getTitle(), 0, 3) == 'il_') {
130 $ilErr->setMessage('msg_role_reserved_prefix');
131 return false;
132 }
133 return true;
134 }
$ilErr
$ilErr
Definition: raiseError.php:18

References $DIC, $ilErr, and ilObject\getTitle().

+ Here is the call graph for this function:

Field Documentation

◆ $allow_register

ilObjRole::$allow_register

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

◆ $assign_users

ilObjRole::$assign_users

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

◆ $disk_quota

ilObjRole::$disk_quota

The disk quota in bytes.

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

Referenced by getDiskQuota().

◆ $logger

ilObjRole::$logger = null
private

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

Referenced by adjustPermissions().

◆ $parent

ilObjRole::$parent

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

Referenced by getParent().

◆ $wsp_disk_quota

ilObjRole::$wsp_disk_quota

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

Referenced by getPersonalWorkspaceDiskQuota().

◆ MODE_ADD_OPERATIONS

const ilObjRole::MODE_ADD_OPERATIONS = 1

Definition at line 23 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 18 of file class.ilObjRole.php.

Referenced by changeExistingObjects(), 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 19 of file class.ilObjRole.php.

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

◆ MODE_READ_OPERATIONS

const ilObjRole::MODE_READ_OPERATIONS = 2

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

Referenced by ilObjRoleFolderGUI\adjustRoleObject(), and ilObjRoleFolderGUI\doChangeExistingObjects().

◆ MODE_REMOVE_OPERATIONS

const ilObjRole::MODE_REMOVE_OPERATIONS = 3

Definition at line 25 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 20 of file class.ilObjRole.php.

Referenced by changeExistingObjects(), 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 21 of file class.ilObjRole.php.

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

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