ILIAS  release_6 Revision v6.24-5-g0c8bfefb3b8
ilObjRoleTemplate Class Reference

Class ilObjRoleTemplate. More...

+ Inheritance diagram for ilObjRoleTemplate:
+ Collaboration diagram for ilObjRoleTemplate:

Public Member Functions

 __construct ($a_id=0, $a_call_by_reference=false)
 Constructor public. More...
 
 getPresentationTitle ()
 return translated title for autogenerated templates More...
 
 delete ()
 delete role template and all related data More...
 
 isInternalTemplate ()
 
 getFilterOfInternalTemplate ()
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor 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 public More...
 
 setId ($a_id)
 set object id public More...
 
 setRefId ($a_id)
 set reference id public More...
 
 getRefId ()
 get reference id public More...
 
 getType ()
 get object type public More...
 
 setType ($a_type)
 set object type public More...
 
 getPresentationTitle ()
 get presentation title Normally same as title Overwritten for sessions More...
 
 getTitle ()
 get object title public More...
 
 getUntranslatedTitle ()
 get untranslated object title 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 public More...
 
 getLastUpdateDate ()
 get last update date 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) 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...
 

Additional Inherited Members

- 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 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 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 Attributes inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

Detailed Description

Class ilObjRoleTemplate.

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor public.

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

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

References ILIAS\GlobalScreen\Provider\__construct().

43  {
44  $this->type = "rolt";
45  parent::__construct($a_id, $a_call_by_reference);
46  }
__construct(Container $dic, ilPlugin $plugin)
+ Here is the call graph for this function:

Member Function Documentation

◆ delete()

ilObjRoleTemplate::delete ( )

delete role template and all related data

public

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

Definition at line 63 of file class.ilObjRoleTemplate.php.

References $_GET, $DIC, ilObject\$rbacadmin, and ilObject\getId().

64  {
65  // put here role template specific stuff
66  global $DIC;
67 
68  $rbacadmin = $DIC['rbacadmin'];
69 
70  // delete rbac permissions
71  $rbacadmin->deleteTemplate($this->getId(), $_GET["ref_id"]);
72 
73  // always call parent delete function at the end!!
74  return (parent::delete()) ? true : false;
75  }
$_GET["client_id"]
getId()
get object id public
$DIC
Definition: xapitoken.php:46
+ Here is the call graph for this function:

◆ getFilterOfInternalTemplate()

ilObjRoleTemplate::getFilterOfInternalTemplate ( )

Definition at line 86 of file class.ilObjRoleTemplate.php.

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

87  {
88  global $DIC;
89 
90  $objDefinition = $DIC['objDefinition'];
91 
92  $filter = array();
93 
94  switch ($this->getTitle()) {
95  case "il_grp_admin":
96  case "il_grp_member":
97  case "il_grp_status_closed":
98  case "il_grp_status_open":
99  $obj_data = $objDefinition->getSubObjects('grp', false);
100  unset($obj_data["rolf"]);
101  $filter = array_keys($obj_data);
102  $filter[] = 'grp';
103  break;
104 
105  case "il_crs_admin":
106  case "il_crs_tutor":
107  case "il_crs_member":
108  case "il_crs_non_member":
109  $obj_data = $objDefinition->getSubObjects('crs', false);
110  unset($obj_data["rolf"]);
111  $filter = array_keys($obj_data);
112  $filter[] = 'crs';
113  break;
114  case "il_frm_moderator":
115  $filter[] = 'frm';
116  break;
117  case "il_chat_moderator":
118  $filter[] = 'chtr';
119  break;
120  }
121 
122  return $filter;
123  }
getTitle()
get object title public
$DIC
Definition: xapitoken.php:46
+ Here is the call graph for this function:

◆ getPresentationTitle()

ilObjRoleTemplate::getPresentationTitle ( )

return translated title for autogenerated templates

Definition at line 52 of file class.ilObjRoleTemplate.php.

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

52  : string
53  {
54  return ilObjRole::_getTranslation($this->getTitle());
55  }
getTitle()
get object title public
static _getTranslation($a_role_title)
+ Here is the call graph for this function:

◆ isInternalTemplate()

ilObjRoleTemplate::isInternalTemplate ( )

Definition at line 77 of file class.ilObjRoleTemplate.php.

References ilObject\getTitle().

78  {
79  if (substr($this->getTitle(), 0, 3) == "il_") {
80  return true;
81  }
82 
83  return false;
84  }
getTitle()
get object title public
+ Here is the call graph for this function:

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