|
ILIAS
Release_3_10_x_branch Revision 61812
|
Inheritance diagram for ilObjRole:
Collaboration diagram for ilObjRole:Public Member Functions | |
| ilObjRole ($a_id=0, $a_call_by_reference=false) | |
| Constructor public. | |
| toggleAssignUsersStatus ($a_assign_users) | |
| getAssignUsersStatus () | |
| _getAssignUsersStatus ($a_role_id) | |
| read () | |
| loads "role" from database private | |
| assignData ($a_data) | |
| loads a record "role" from array public | |
| update () | |
| updates a record "role" and write it into database public | |
| create () | |
| create | |
| setAllowRegister ($a_allow_register) | |
| set allow_register of role | |
| getAllowRegister () | |
| get allow_register | |
| _lookupRegisterAllowed () | |
| get all roles that are activated in user registration | |
| _lookupAllowRegister ($a_role_id) | |
| check whether role is allowed in user registration or not | |
| setParent ($a_parent_ref) | |
| set reference id of parent object this is neccessary for non RBAC protected objects!!! | |
| getParent () | |
| get reference id of parent object | |
| delete () | |
| delete role and all related data | |
| getCountMembers () | |
| _getTranslation ($a_role_title) | |
| _updateAuthMode ($a_roles) | |
| _getAuthMode ($a_role_id) | |
| __getPermissionDefinitions () | |
Public Member Functions inherited from ilObject | |
| ilObject ($a_id=0, $a_reference=true) | |
| Constructor public. | |
| withReferences () | |
| determines wehter objects are referenced or not (got ref ids or not) | |
| read ($a_force_db=false) | |
| read object data from db into object | |
| getId () | |
| get object id public | |
| setId ($a_id) | |
| set object id public | |
| setRefId ($a_id) | |
| set reference id public | |
| getRefId () | |
| get reference id public | |
| getType () | |
| get object type public | |
| setType ($a_type) | |
| set object type public | |
| getPresentationTitle () | |
| get presentation title Normally same as title Overwritten for sessions | |
| getTitle () | |
| get object title public | |
| getUntranslatedTitle () | |
| get untranslated object title public | |
| setTitle ($a_title) | |
| set object title | |
| getDescription () | |
| get object description | |
| setDescription ($a_desc) | |
| set object description | |
| getLongDescription () | |
| get object long description (stored in object_description) | |
| getImportId () | |
| get import id | |
| setImportId ($a_import_id) | |
| set import id | |
| _lookupObjIdByImportId ($a_import_id) | |
| getOwner () | |
| get object owner | |
| getOwnerName () | |
| _lookupOwnerName ($a_owner_id) | |
| lookup owner name for owner id | |
| setOwner ($a_owner) | |
| set object owner | |
| getCreateDate () | |
| get create date public | |
| getLastUpdateDate () | |
| get last update date public | |
| setObjDataRecord ($a_record) | |
| set object_data record (note: this method should only be called from the ilObjectFactory class) | |
| MDUpdateListener ($a_element) | |
| Meta data update listener. | |
| createMetaData () | |
| create meta data entry | |
| updateMetaData () | |
| update meta data entry | |
| deleteMetaData () | |
| delete meta data entry | |
| updateOwner () | |
| update owner of object in db | |
| _getIdForImportId ($a_import_id) | |
| get current object id for import id (static) | |
| _getAllReferences ($a_id) | |
| get all reference ids of object | |
| _lookupTitle ($a_id) | |
| lookup object title | |
| _lookupDescription ($a_id) | |
| lookup object description | |
| _lookupLastUpdate ($a_id, $a_as_string=false) | |
| lookup last update | |
| _getLastUpdateOfObjects ($a_objs) | |
| Get last update for a set of media objects. | |
| _lookupObjId ($a_id) | |
| _setDeletedDate ($a_ref_id) | |
| only called in ilTree::saveSubTree | |
| _resetDeletedDate ($a_ref_id) | |
| only called in ilObjectGUI::insertSavedNodes | |
| _writeTitle ($a_obj_id, $a_title) | |
| write title to db (static) | |
| _writeDescription ($a_obj_id, $a_desc) | |
| write description to db (static) | |
| _writeImportId ($a_obj_id, $a_import_id) | |
| write import id to db (static) | |
| _lookupType ($a_id, $a_reference=false) | |
| lookup object type | |
| _isInTrash ($a_ref_id) | |
| checks wether object is in trash | |
| _hasUntrashedReference ($a_obj_id) | |
| checks wether an object has at least one reference that is not in trash | |
| _lookupObjectId ($a_ref_id) | |
| lookup object id | |
| _getObjectsDataForType ($a_type, $a_omit_trash=false) | |
| get all objects of a certain type | |
| putInTree ($a_parent_ref) | |
| maybe this method should be in tree object!? | |
| setPermissions ($a_parent_ref) | |
| set permissions of object | |
| createReference () | |
| creates reference for object | |
| countReferences () | |
| count references of object | |
| 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) public | |
| createRoleFolder () | |
| creates a local role folder | |
| notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0) | |
| notifys an object about an event occured Based on the event passed, each object may decide how it reacts. | |
| setRegisterMode ($a_bool) | |
| isUserRegistered ($a_user_id=0) | |
| requireRegistration () | |
| getXMLZip () | |
| getHTMLDirectory () | |
| cloneObject ($a_target_id, $a_copy_id=0) | |
| Clone object permissions, put in tree ... | |
| appendCopyInfo ($a_target_id, $a_copy_id) | |
| Prepend Copy info if object with same name exists in that container. | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| Clone object dependencies. | |
| cloneMetaData ($target_obj) | |
| Copy meta data. | |
Static Public Member Functions | |
| _search (&$a_search_obj) | |
| STATIC METHOD search for role data. | |
| static | _getRolesByAuthMode ($a_auth_mode) |
| Get roles by auth mode. | |
| static | _resetAuthMode ($a_auth_mode) |
| Reset auth mode to default. | |
Static Public Member Functions inherited from ilObject | |
| static | _getIdsForTitle ($title, $type= '') |
| _exists ($a_id, $a_reference=false) | |
| checks if an object exists in object_data | |
| static | _getObjectsByType ($a_obj_type="") |
| Get objects by type. | |
| static | _prepareCloneSelection ($a_ref_ids, $new_type) |
| Prepare copy wizard object selection. | |
| static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
Data Fields | |
| $parent | |
| $allow_register | |
| $assign_users | |
Data Fields inherited from ilObject | |
| $ilias | |
| $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 | |
| $obj_data_record | |
| object_data record | |
Class ilObjRole.
Definition at line 34 of file class.ilObjRole.php.
| ilObjRole::__getPermissionDefinitions | ( | ) |
Definition at line 519 of file class.ilObjRole.php.
References ilObject\$lng, and DB_FETCHMODE_OBJECT.
| ilObjRole::_getAssignUsersStatus | ( | $a_role_id | ) |
Definition at line 69 of file class.ilObjRole.php.
References $res, and DB_FETCHMODE_OBJECT.
Referenced by ilRbacReview\getGlobalAssignableRoles(), ilObjUserFolderGUI\importUserRoleAssignmentObject(), ilSoapUserAdministration\importUsers(), ilObjUserFolderGUI\importUsersObject(), ilObjUserGUI\initCreate(), and ilSoapUserAdministration\isPermittedRole().
Here is the caller graph for this function:| ilObjRole::_getAuthMode | ( | $a_role_id | ) |
Definition at line 468 of file class.ilObjRole.php.
|
static |
Get roles by auth mode.
public
| string | auth mode |
Definition at line 487 of file class.ilObjRole.php.
References $res, and DB_FETCHMODE_OBJECT.
Referenced by ilRadiusSettings\read().
Here is the caller graph for this function:| ilObjRole::_getTranslation | ( | $a_role_title | ) |
Definition at line 433 of file class.ilObjRole.php.
References ilObject\$lng.
Referenced by ilCourseEditParticipantsTableGUI\__construct(), ilObjRoleGUI\editObject(), ilObjectStatusGUI\getAssignedValidRoles(), ilObjCourse\getLocalCourseRoles(), ilObjGroup\getLocalGroupRoles(), ilObjiLincCourse\getLocalRoles(), ilObjiLincCourse\getMemberRolesTitle(), ilObjGroup\getMemberRolesTitle(), ilObjectStatusGUI\getRoleAssignmentInfo(), ilObjGroupGUI\mailMembersObject(), ilObjiLincCourseGUI\mailMembersObject(), ilObjCourseGUI\mailMembersObject(), ilPermissionGUI\perm(), ilObjRoleTemplateGUI\permObject(), ilObjRoleGUI\permObject(), ilObjUserGUI\roleassignmentObject(), ilSoapRoleObjectXMLWriter\start(), and ilObjRoleFolderGUI\viewObject().
Here is the caller graph for this function:| ilObjRole::_lookupAllowRegister | ( | $a_role_id | ) |
check whether role is allowed in user registration or not
| int | $a_role_id | role id |
Definition at line 226 of file class.ilObjRole.php.
References DB_FETCHMODE_ASSOC.
Referenced by ilRegistrationGUI\__validateRole(), and ilRegistrationSettingsGUI\editRoles().
Here is the caller graph for this function:| ilObjRole::_lookupRegisterAllowed | ( | ) |
get all roles that are activated in user registration
public
Definition at line 199 of file class.ilObjRole.php.
References DB_FETCHMODE_ASSOC.
Referenced by ilRegistrationSettingsGUI\__prepareAccessLimitationRoleList(), ilRegistrationSettingsGUI\__prepareRoleList(), ilRegistrationGUI\__showRoleSelection(), ilObjAuthSettingsGUI\authSettingsObject(), ilRegistrationSettingsGUI\editRoleAccessLimitations(), and ilRegistrationSettingsGUI\saveRoleAccessLimitations().
Here is the caller graph for this function:
|
static |
Reset auth mode to default.
public
| string | auth mode |
Definition at line 509 of file class.ilObjRole.php.
Referenced by ilRadiusSettings\save().
Here is the caller graph for this function:
|
static |
STATIC METHOD search for role data.
This method is called from class.ilSearch This method used by class.ilSearchGUI.php to a link to the results
| object | object of search class public |
Definition at line 405 of file class.ilObjRole.php.
References $ilBench, $res, and DB_FETCHMODE_OBJECT.
Referenced by ilSearch\performSearch().
Here is the caller graph for this function:| ilObjRole::_updateAuthMode | ( | $a_roles | ) |
Definition at line 455 of file class.ilObjRole.php.
Referenced by ilRadiusSettings\save(), and ilObjAuthSettingsGUI\updateAuthRolesObject().
Here is the caller graph for this function:| ilObjRole::assignData | ( | $a_data | ) |
loads a record "role" from array public
| array | roledata |
Definition at line 114 of file class.ilObjRole.php.
References setAllowRegister(), ilObject\setDescription(), 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:| ilObjRole::create | ( | ) |
create
public
Reimplemented from ilObject.
Definition at line 151 of file class.ilObjRole.php.
References ilObject\$id, getAllowRegister(), and getAssignUsersStatus().
Here is the call graph for this function:| ilObjRole::delete | ( | ) |
delete role and all related data
public
Reimplemented from ilObject.
Definition at line 275 of file class.ilObjRole.php.
References ilLDAPRoleGroupMappingSettings\_deleteByRole(), ilObject\_exists(), DB_FETCHMODE_OBJECT, ilObject\getId(), and getParent().
Here is the call graph for this function:| ilObjRole::getAllowRegister | ( | ) |
get allow_register
public
Definition at line 188 of file class.ilObjRole.php.
References $allow_register.
Referenced by create().
Here is the caller graph for this function:| ilObjRole::getAssignUsersStatus | ( | ) |
Definition at line 64 of file class.ilObjRole.php.
References $assign_users.
Referenced by create(), and update().
Here is the caller graph for this function:| ilObjRole::getCountMembers | ( | ) |
Definition at line 390 of file class.ilObjRole.php.
| ilObjRole::getParent | ( | ) |
get reference id of parent object
public
Definition at line 263 of file class.ilObjRole.php.
References $parent.
Referenced by delete().
Here is the caller graph for this function:| ilObjRole::ilObjRole | ( | $a_id = 0, |
|
$a_call_by_reference = false |
|||
| ) |
Constructor public.
| integer | reference_id or object_id |
| boolean | treat the id as reference_id (true) or object_id (false) |
Definition at line 54 of file class.ilObjRole.php.
References ilObject\ilObject().
Here is the call graph for this function:| ilObjRole::read | ( | ) |
loads "role" from database private
Definition at line 87 of file class.ilObjRole.php.
References $data, assignData(), and DB_FETCHMODE_ASSOC.
Referenced by update().
Here is the call graph for this function:
Here is the caller graph for this function:| ilObjRole::setAllowRegister | ( | $a_allow_register | ) |
set allow_register of role
public
| integer |
Definition at line 172 of file class.ilObjRole.php.
Referenced by assignData().
Here is the caller graph for this function:| ilObjRole::setParent | ( | $a_parent_ref | ) |
set reference id of parent object this is neccessary for non RBAC protected objects!!!
public
| integer | ref_id of parent object |
Definition at line 252 of file class.ilObjRole.php.
| ilObjRole::toggleAssignUsersStatus | ( | $a_assign_users | ) |
Definition at line 60 of file class.ilObjRole.php.
Referenced by assignData().
Here is the caller graph for this function:| ilObjRole::update | ( | ) |
updates a record "role" and write it into database public
Reimplemented from ilObject.
Definition at line 126 of file class.ilObjRole.php.
References getAssignUsersStatus(), and read().
Here is the call graph for this function:| ilObjRole::$allow_register |
Definition at line 45 of file class.ilObjRole.php.
Referenced by getAllowRegister().
| ilObjRole::$assign_users |
Definition at line 46 of file class.ilObjRole.php.
Referenced by getAssignUsersStatus().
| ilObjRole::$parent |
Definition at line 43 of file class.ilObjRole.php.
Referenced by getParent().