ILIAS
trunk Revision v11.0_alpha-1769-g99a433fe2dc
|
Public Member Functions | |
__construct (int $a_id=0, bool $a_call_by_reference=false) | |
Constructor public. More... | |
validate () | |
getPresentationTitle () | |
toggleAssignUsersStatus (bool $a_assign_users) | |
getAssignUsersStatus () | |
read () | |
loads "role" from database private More... | |
update () | |
create () | |
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 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... | |
![]() | |
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) | |
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 public. More... | |
static | _resetAuthMode (string $a_auth_mode) |
Reset auth mode to default. More... | |
![]() | |
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 |
![]() | |
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... | |
![]() | |
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 |
![]() | |
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 |
Class ilObjRole.
Definition at line 26 of file class.ilObjRole.php.
ilObjRole::__construct | ( | int | $a_id = 0 , |
bool | $a_call_by_reference = false |
||
) |
Constructor public.
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.
References $DIC, ILIAS\GlobalScreen\Provider\__construct(), and ILIAS\Repository\logger().
ilObjRole::__getPermissionDefinitions | ( | ) |
Definition at line 501 of file class.ilObjRole.php.
References $txt, ILIAS\Repository\lng(), and ilObjectPlugin\lookupTxtById().
|
static |
Definition at line 141 of file class.ilObjRole.php.
References $DIC, $ilDB, and $res.
Referenced by ilRbacReview\getGlobalAssignableRoles(), ilSoapUserAdministration\importUsers(), ilObjUserGUI\initCreate(), ilObjUserFolderGUI\initUserRoleAssignmentForm(), ilSoapUserAdministration\isPermittedRole(), and ilObjUserFolderGUI\redirectOnRoleWithMissingWrite().
|
static |
|
static |
Get roles by auth mode public.
string | auth mode |
Definition at line 472 of file class.ilObjRole.php.
References $DIC, $ilDB, and $res.
|
static |
Definition at line 364 of file class.ilObjRole.php.
References $DIC, ilObject\$lng, ilObject\$type, ilObjectPlugin\lookupTxtById(), and ilLanguage\txt().
Referenced by ilRecommendedContentRoleTableGUI\__construct(), ilCourseEditParticipantsTableGUI\__construct(), ilObjRoleTemplateGUI\addAdminLocatorItems(), ilObjRoleGUI\addAdminLocatorItems(), ilObjRoleGUI\addLocatorItems(), ilObjRoleGUI\adoptPermObject(), ilObjRoleGUI\adoptPermSaveObject(), ilMailMemberSearchDataProvider\buildRoleTitle(), ilObjRoleFolderGUI\confirmDeleteObject(), ilObjRoleGUI\confirmDeleteRoleObject(), ILIAS\Skill\Profile\SkillProfileManager\countUsers(), ilObjectRolePermissionTableGUI\createTitle(), ilRoleAssignmentTableGUI\fillRow(), ilObjBlog\getAllLocalRoles(), ilObjectPermissionStatusGUI\getAssignedValidRoles(), ilObjectPermissionStatusGUI\getAvailableRolesTableData(), ilObjCourse\getLocalCourseRoles(), ilObjGroup\getLocalGroupRoles(), ilLearningSequenceRoles\getLocalLearningSequenceRoles(), ilObjLearningSequenceGUI\getLocalRoles(), ilObjGroupGUI\getLocalRoles(), ilObjCourseGUI\getLocalRoles(), ilSessionParticipantsTableGUI\getParentLocalRoles(), ilObjRoleTemplate\getPresentationTitle(), getPresentationTitle(), ilLTIProviderObjectSettingGUI\getRoleSelection(), ilObjBlog\getRolesWithContributeOrRedact(), ilObjRoleTemplateGUI\getRoleTemplateForm(), ilUserRoleStartingPointTableGUI\getTitleForCriterium(), ilDclTableViewEditFormGUI\initForm(), ilSettingsPermissionGUI\initPermissionForm(), ilPermissionGUI\initRoleForm(), ilRoleAssignmentTableGUI\parse(), ilRoleTableGUI\parse(), ILIAS\AccessControl\Log\Table\parseChangesFaPa(), ilPermissionGUI\showConfirmBlockRole(), and ilSoapRoleObjectXMLWriter\start().
|
static |
check whether role is allowed in user registration or not
Definition at line 240 of file class.ilObjRole.php.
References $DIC, $ilDB, and $res.
Referenced by ilRegistrationSettingsGUI\initRolesForm(), and ilAccountRegistrationGUI\saveForm().
|
static |
get all roles that are activated in user registration
Definition at line 217 of file class.ilObjRole.php.
References $DIC, $ilDB, $res, and ILIAS\Repository\int().
Referenced by ilObjAuthSettingsGUI\buildRegistrationRoleMappingForm(), ilUserProfile\getRolesInput(), ilRegistrationSettingsGUI\initRoleAccessForm(), ilRegistrationSettingsGUI\prepareAccessLimitationRoleList(), ilRegistrationSettingsGUI\prepareRoleList(), and ilRegistrationSettingsGUI\saveRoleAccessLimitations().
|
static |
Definition at line 386 of file class.ilObjRole.php.
References $DIC, ilObject\$lng, ilECSSetting\ecsConfigured(), ilECSUtils\getPossibleRemoteTypes(), ILIAS\Repository\int(), ilObjectPlugin\lookupTxtById(), ilArrayUtil\sortArray(), and ilLanguage\txt().
Referenced by ilObjectRolePermissionTableGUI\createTitle(), and ilObjectPermissionStatusGUI\getAvailableRolesTableData().
|
static |
|
static |
Definition at line 439 of file class.ilObjRole.php.
References $DIC, $ilDB, and $res.
Referenced by ilObjAuthSettingsGUI\updateRegistrationRoleMappingObject().
|
protected |
Definition at line 607 of file class.ilObjRole.php.
References $relation, ilRbacLog\add(), changeExistingObjectsGrantPermissions(), createPermissionIntersection(), ilLogLevel\DEBUG, ilRbacLog\diffFaPa(), ilRbacLog\EDIT_TEMPLATE_EXISTING, ilRbacLog\gatherFaPa(), ilObject\getId(), ilRbacLog\isActive(), isHandledObjectType(), ILIAS\Repository\logger(), ilTree\RELATION_CHILD, ilTree\RELATION_EQUALS, ilTree\RELATION_NONE, ilTree\RELATION_PARENT, ilTree\RELATION_SIBLING, SYSTEM_FOLDER_ID, updateOperationStack(), and updatePolicyStack().
Referenced by 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.
array | filter Filter of object types (array('all') => change all objects |
Definition at line 542 of file class.ilObjRole.php.
References adjustPermissions(), deleteLocalPolicies(), and ilObject\getId().
|
protected |
Definition at line 743 of file class.ilObjRole.php.
References $DIC, and ILIAS\Repository\logger().
Referenced by adjustPermissions().
ilObjRole::create | ( | ) |
Definition at line 188 of file class.ilObjRole.php.
References $DIC, $id, $res, getAllowRegister(), and getAssignUsersStatus().
|
static |
Definition at line 59 of file class.ilObjRole.php.
References $DIC, $GLOBALS, $ilDB, $res, ilObject\_lookupType(), ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), null, and ROLE_FOLDER_ID.
Referenced by ilObjChatroom\createDefaultRole(), ilLearningSequenceRoles\initDefaultRoles(), ilObjSession\initDefaultRoles(), ilObjBlog\initDefaultRoles(), ilObjForum\initDefaultRoles(), ilObjGroup\initDefaultRoles(), ilObjCourse\initDefaultRoles(), and ilIndividualAssessmentAccessHandler\initDefaultRolesForObject().
|
protected |
Create permission intersection.
Definition at line 869 of file class.ilObjRole.php.
References $GLOBALS, $res, ilObject\$type, ilObject\_lookupObjId(), ilDBConstants\FETCHMODE_OBJECT, ilObject\getId(), ilGroupConstants\GRP_TYPE_CLOSED, ilGroupConstants\GRP_TYPE_OPEN, ILIAS\Repository\int(), ilObjGroup\lookupGroupTye(), null, and ROLE_FOLDER_ID.
Referenced by adjustPermissions().
ilObjRole::delete | ( | ) |
delete role and all related data public
Definition at line 280 of file class.ilObjRole.php.
References $DIC, $res, $user_id, ilLDAPRoleGroupMappingSettings\_deleteByRole(), ilObjUser\_lookupLogin(), ilObject\getId(), ilLoggerFactory\getLogger(), getParent(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ROLE_FOLDER_ID.
|
protected |
Definition at line 582 of file class.ilObjRole.php.
References $DIC, ilObject\_lookupObjId(), ilObject\_lookupType(), ilObject\getId(), and SYSTEM_FOLDER_ID.
Referenced by changeExistingObjects().
ilObjRole::getAllowRegister | ( | ) |
Definition at line 209 of file class.ilObjRole.php.
References $allow_register.
Referenced by create().
ilObjRole::getAssignUsersStatus | ( | ) |
Definition at line 136 of file class.ilObjRole.php.
References $assign_users.
Referenced by create(), and update().
ilObjRole::getCountMembers | ( | ) |
Get number of users assigned to role.
Definition at line 359 of file class.ilObjRole.php.
ilObjRole::getParent | ( | ) |
get reference id of parent object
Definition at line 270 of file class.ilObjRole.php.
References $parent.
Referenced by delete().
ilObjRole::getPresentationTitle | ( | ) |
Definition at line 120 of file class.ilObjRole.php.
References $r, _getTranslation(), ilObject\getTitle(), and ilObject\getUntranslatedTitle().
ilObjRole::isAutoGenerated | ( | ) |
Definition at line 533 of file class.ilObjRole.php.
|
protected |
Definition at line 794 of file class.ilObjRole.php.
Referenced by adjustPermissions().
ilObjRole::read | ( | ) |
loads "role" from database private
Definition at line 158 of file class.ilObjRole.php.
References $res, ilLogLevel\ERROR, ILIAS\Repository\logger(), setAllowRegister(), and toggleAssignUsersStatus().
Referenced by update().
ilObjRole::setAllowRegister | ( | bool | $a_allow_register | ) |
Definition at line 204 of file class.ilObjRole.php.
Referenced by read().
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.
ilObjRole::toggleAssignUsersStatus | ( | bool | $a_assign_users | ) |
Definition at line 131 of file class.ilObjRole.php.
Referenced by read().
ilObjRole::update | ( | ) |
Definition at line 173 of file class.ilObjRole.php.
References $res, getAssignUsersStatus(), and read().
|
protected |
Update operation stack.
Definition at line 809 of file class.ilObjRole.php.
References ilObject\getId(), null, ROLE_FOLDER_ID, and ROOT_FOLDER_ID.
Referenced by adjustPermissions().
|
protected |
Definition at line 846 of file class.ilObjRole.php.
References null, ROLE_FOLDER_ID, and ROOT_FOLDER_ID.
Referenced by adjustPermissions().
ilObjRole::validate | ( | ) |
Definition at line 107 of file class.ilObjRole.php.
References $DIC, $ilErr, and ilObject\getTitle().
|
protected |
Definition at line 41 of file class.ilObjRole.php.
Referenced by getAllowRegister().
|
protected |
Definition at line 42 of file class.ilObjRole.php.
Referenced by getAssignUsersStatus().
|
private |
Definition at line 37 of file class.ilObjRole.php.
int ilObjRole::$parent = null |
Definition at line 39 of file class.ilObjRole.php.
Referenced by getParent().
const ilObjRole::MODE_ADD_OPERATIONS = 1 |
Definition at line 33 of file class.ilObjRole.php.
Referenced by ilObjRoleFolderGUI\adjustRoleObject().
const ilObjRole::MODE_PROTECTED_DELETE_LOCAL_POLICIES = 1 |
const ilObjRole::MODE_PROTECTED_KEEP_LOCAL_POLICIES = 2 |
Definition at line 29 of file class.ilObjRole.php.
Referenced by ilPermissionGUI\addRole(), ilObjRoleFolderGUI\doChangeExistingObjects(), ilObjRoleGUI\permSaveObject(), and ilObjRoleGUI\showChangeExistingObjectsConfirmation().
const ilObjRole::MODE_READ_OPERATIONS = 2 |
Definition at line 34 of file class.ilObjRole.php.
Referenced by ilObjRoleFolderGUI\adjustRoleObject(), and ilObjRoleFolderGUI\doChangeExistingObjects().
const ilObjRole::MODE_REMOVE_OPERATIONS = 3 |
Definition at line 35 of file class.ilObjRole.php.
Referenced by ilObjRoleFolderGUI\adjustRoleObject().
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().
const ilObjRole::MODE_UNPROTECTED_KEEP_LOCAL_POLICIES = 4 |
Definition at line 31 of file class.ilObjRole.php.
Referenced by ilPermissionGUI\addRole(), ilObjLTIAdministrationGUI\createLtiUserRole(), ilObjRoleFolderGUI\doChangeExistingObjects(), ilObjRoleGUI\permSaveObject(), ilObjRoleGUI\showChangeExistingObjectsConfirmation(), and ilPermissionGUI\unblockRoles().