ILIAS  release_5-0 Revision 5.0.0-1144-gc4397b1f87
ilObjRoleTemplate Class Reference

Class ilObjRoleTemplate. More...

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

Public Member Functions

 ilObjRoleTemplate ($a_id=0, $a_call_by_reference=false)
 Constructor public. More...
 
 delete ()
 delete role template and all related data More...
 
 isInternalTemplate ()
 
 getFilterOfInternalTemplate ()
 
- Public Member Functions inherited from ilObject
 ilObject ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ($a_force_db=false)
 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...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
 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...
 
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class) 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...
 
 _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
 _lookupOwner ($a_id)
 lookup object owner More...
 
 _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
 _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
 _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
 _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
 _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
 _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
 _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
 _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
 _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
 _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type 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...
 
 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 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...
 
 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. More...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 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...
 
 _lookupCreationDate ($a_id)
 Lookup creation date. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ilObject
static _lookupObjIdByImportId ($a_import_id)
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupObjId ($a_id)
 
static setDeletedDates ($a_ref_ids)
 Set deleted date type $ilDB. More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id 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 _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item. 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 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
 
 $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 More...
 

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.

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 55 of file class.ilObjRoleTemplate.php.

References $_GET, and ilObject\getId().

56  {
57  // put here role template specific stuff
58  global $rbacadmin;
59 
60  // delete rbac permissions
61  $rbacadmin->deleteTemplate($this->getId(),$_GET["ref_id"]);
62 
63  // always call parent delete function at the end!!
64  return (parent::delete()) ? true : false;
65  }
$_GET["client_id"]
getId()
get object id public
+ Here is the call graph for this function:

◆ getFilterOfInternalTemplate()

ilObjRoleTemplate::getFilterOfInternalTemplate ( )

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

References ilObject\getTitle().

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

◆ ilObjRoleTemplate()

ilObjRoleTemplate::ilObjRoleTemplate (   $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 ilObject\ilObject().

43  {
44  $this->type = "rolt";
45  $this->ilObject($a_id,$a_call_by_reference);
46  }
ilObject($a_id=0, $a_reference=true)
Constructor public.
+ Here is the call graph for this function:

◆ isInternalTemplate()

ilObjRoleTemplate::isInternalTemplate ( )

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

References ilObject\getTitle().

68  {
69  if (substr($this->getTitle(),0,3) == "il_")
70  {
71  return true;
72  }
73 
74  return false;
75  }
getTitle()
get object title public
+ Here is the call graph for this function:

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