ilObjRootFolder Class Reference
Class ilObjRootFolder. More...
Inheritance diagram for ilObjRootFolder:
Collaboration diagram for ilObjRootFolder:
Public Member Functions | |
| ilObjRootFolder ($a_id, $a_call_by_reference=true) | |
| Constructor @access public. More... | |
| delete () | |
| delete rootfolder and all related data 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 happend, each object may decide how it reacts. More... | |
| getTranslations () | |
| get all translations from this category More... | |
| deleteTranslation ($a_lang) | |
| removeTranslations () | |
| addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default) | |
| addAdditionalSubItemInformation (&$a_item_data) | |
| Add additional information to sub item, e.g. More... | |
| Public Member Functions inherited from ilObject | |
| ilObject ($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 ($a_force_db=false) | |
| 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... | |
| 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 @access public More... | |
| getLastUpdateDate () | |
| get last update date @access public More... | |
| getDiskUsage () | |
| 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) @access 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... | |
| 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... | |
| Public Member Functions inherited from ilContainer | |
| ilContainer ($a_id=0, $a_call_by_reference=true) | |
| Constructor @access public. More... | |
| createContainerDirectory () | |
| Create directory for the container. More... | |
| getContainerDirectory () | |
| Get the container directory. More... | |
| _getContainerDirectory ($a_id) | |
| Get the container directory. More... | |
| getBigIconPath () | |
| Get path for big icon. More... | |
| getSmallIconPath () | |
| Get path for small icon. More... | |
| getTinyIconPath () | |
| Get path for tiny icon. More... | |
| getCustomIconPath () | |
| Get path for custom icon. More... | |
| setHiddenFilesFound ($a_hiddenfilesfound) | |
| Set Found hidden files (set by getSubItems). More... | |
| getHiddenFilesFound () | |
| Get Found hidden files (set by getSubItems). More... | |
| getStyleSheetId () | |
| get ID of assigned style sheet object More... | |
| setStyleSheetId ($a_style_id) | |
| set ID of assigned style sheet object More... | |
| _lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL) | |
| Lookup a container setting. More... | |
| _writeContainerSetting ($a_id, $a_keyword, $a_value) | |
| _lookupIconPath ($a_id, $a_size="big") | |
| lookup icon path More... | |
| saveIcons ($a_custom_icon) | |
| save container icons More... | |
| removeCustomIcon () | |
| remove small icon More... | |
| cloneObject ($a_target_id, $a_copy_id=0) | |
| Clone container settings. More... | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| Clone object dependencies (container sorting) More... | |
| cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1) | |
| clone all objects according to this container More... | |
| getViewMode () | |
| Get container view mode. More... | |
| getOrderType () | |
| Get order type default implementation. More... | |
| setOrderType ($a_value) | |
| getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0) | |
| Get subitems of container. More... | |
| gotItems () | |
| Check whether we got any items. More... | |
| addAdditionalSubItemInformation (&$object) | |
| Add additional information to sub item, e.g. More... | |
| getGroupedObjTypes () | |
| Get grouped repository object types. More... | |
| enablePageEditing () | |
| Check whether page editing is allowed for container. More... | |
| create () | |
| Create. More... | |
| update () | |
| Update. More... | |
| read () | |
| read More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from ilObject | |
| static | _lookupObjIdByImportId ($a_import_id) |
| static | _lookupImportId ($a_obj_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 @global 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@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 | _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 | fixMissingTitles ($a_type, array &$a_obj_title_map) |
| Try to fix missing object titles. More... | |
| static | hasAutoRating ($a_type, $a_ref_id) |
| Check if auto rating is active for parent group/course. More... | |
| Static Public Member Functions inherited from ilContainer | |
| static | _getContainerSettings ($a_id) |
| static | _deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false) |
| static | _exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id) |
| static | getCompleteDescriptions (array $objects) |
| overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) 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... | |
| Data Fields inherited from ilContainer | |
| const | VIEW_SESSIONS = 0 |
| const | VIEW_OBJECTIVE = 1 |
| const | VIEW_TIMING = 2 |
| const | VIEW_ARCHIVE = 3 |
| const | VIEW_SIMPLE = 4 |
| const | VIEW_BY_TYPE = 5 |
| const | VIEW_INHERIT = 6 |
| const | VIEW_DEFAULT = self::VIEW_BY_TYPE |
| const | SORT_TITLE = 0 |
| const | SORT_MANUAL = 1 |
| const | SORT_ACTIVATION = 2 |
| const | SORT_INHERIT = 3 |
| const | SORT_CREATION = 4 |
| const | SORT_DIRECTION_ASC = 0 |
| const | SORT_DIRECTION_DESC = 1 |
| const | SORT_NEW_ITEMS_POSITION_TOP = 0 |
| const | SORT_NEW_ITEMS_POSITION_BOTTOM = 1 |
| const | SORT_NEW_ITEMS_ORDER_TITLE = 0 |
| const | SORT_NEW_ITEMS_ORDER_CREATION = 1 |
| const | SORT_NEW_ITEMS_ORDER_ACTIVATION = 2 |
| Static Public Attributes inherited from ilContainer | |
| static | $data_preloaded = false |
| Protected Attributes inherited from ilContainer | |
| $order_type = 0 | |
| $hiddenfilesfound = false | |
Detailed Description
Class ilObjRootFolder.
- Version
- $Id$Id: class.ilObjRootFolder.php,v 1.12 2003/11/20 17:04:19 shofmann Exp $
Definition at line 37 of file class.ilObjRootFolder.php.
Member Function Documentation
◆ addAdditionalSubItemInformation()
| ilObjRootFolder::addAdditionalSubItemInformation | ( | & | $object | ) |
Add additional information to sub item, e.g.
used in courses for timings information etc.
Reimplemented from ilContainer.
Definition at line 206 of file class.ilObjRootFolder.php.
207 {
208 include_once './Services/Object/classes/class.ilObjectActivation.php';
209 ilObjectActivation::addAdditionalSubItemInformation($a_item_data);
210 }
static addAdditionalSubItemInformation(array &$a_item)
Parse item data for list entries.
Definition: class.ilObjectActivation.php:340
References ilObjectActivation\addAdditionalSubItemInformation().
Here is the call graph for this function:
◆ addTranslation()
| ilObjRootFolder::addTranslation | ( | $a_title, | |
| $a_desc, | |||
| $a_lang, | |||
| $a_lang_default | |||
| ) |
Definition at line 185 of file class.ilObjRootFolder.php.
186 {
187 global $ilDB;
188
189 if (empty($a_title))
190 {
191 $a_title = "NO TITLE";
192 }
193
195 "(obj_id,title,description,lang_code,lang_default) ".
196 "VALUES ".
198 $ilDB->quote($a_title,'text').",".
203 return true;
204 }
References $ilDB, $query, $res, and ilObject\getId().
Here is the call graph for this function:
◆ delete()
| ilObjRootFolder::delete | ( | ) |
delete rootfolder and all related data
@access public
- Returns
- boolean true if all object data were removed; false if only a references were removed
Reimplemented from ilObject.
Definition at line 59 of file class.ilObjRootFolder.php.
60 {
61 // delete is disabled
62
63 $message = get_class($this)."::delete(): Can't delete root folder!";
65 return false;
66
67 // always call parent delete function first!!
68 if (!parent::delete())
69 {
70 return false;
71 }
72
73 // put here rootfolder specific stuff
74
75 return true;;
76 }
redirection script todo: (a better solution should control the processing via a xml file)
◆ deleteTranslation()
| ilObjRootFolder::deleteTranslation | ( | $a_lang | ) |
Definition at line 164 of file class.ilObjRootFolder.php.
References $ilDB, $query, $res, and ilObject\getId().
Here is the call graph for this function:
◆ getTranslations()
| ilObjRootFolder::getTranslations | ( | ) |
get all translations from this category
@access public
- Returns
- array
Definition at line 137 of file class.ilObjRootFolder.php.
138 {
139 global $ilDB;
140
141 $q = "SELECT * FROM object_translation WHERE obj_id = ".
144
145 $num = 0;
146
149 {
153 );
154 $num++;
155 }
156
157 // first entry is always the default language
159
161 }
References $data, $ilDB, $r, $row, DB_FETCHMODE_OBJECT, and ilObject\getId().
Here is the call graph for this function:
◆ ilObjRootFolder()
| ilObjRootFolder::ilObjRootFolder | ( | $a_id, | |
$a_call_by_reference = true |
|||
| ) |
Constructor @access public.
- Parameters
-
integer reference_id or object_id boolean treat the id as reference_id (true) or object_id (false)
Definition at line 45 of file class.ilObjRootFolder.php.
46 {
47 $this->type = "root";
48 $this->ilObject($a_id,$a_call_by_reference);
49 }
References ilObject\ilObject().
Here is the call graph for this function:
◆ notify()
| ilObjRootFolder::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 happend, each object may decide how it reacts.
@access public
- Parameters
-
string event integer reference id of object where the event occured array passes optional parameters if required
- Returns
- boolean
Reimplemented from ilObject.
Definition at line 88 of file class.ilObjRootFolder.php.
89 {
90 global $tree;
91
92 switch ($a_event)
93 {
94 case "link":
95
96 //var_dump("<pre>",$a_params,"</pre>");
97 //echo "RootFolder ".$this->getRefId()." triggered by link event. Objects linked into target object ref_id: ".$a_ref_id;
98 //exit;
99 break;
100
101 case "cut":
102
103 //echo "RootFolder ".$this->getRefId()." triggered by cut event. Objects are removed from target object ref_id: ".$a_ref_id;
104 //exit;
105 break;
106
107 case "copy":
108
109 //var_dump("<pre>",$a_params,"</pre>");
110 //echo "RootFolder ".$this->getRefId()." triggered by copy event. Objects are copied into target object ref_id: ".$a_ref_id;
111 //exit;
112 break;
113
114 case "paste":
115
116 //echo "RootFolder ".$this->getRefId()." triggered by paste (cut) event. Objects are pasted into target object ref_id: ".$a_ref_id;
117 //exit;
118 break;
119
120 case "new":
121
122 //echo "RootFolder ".$this->getRefId()." triggered by paste (new) event. Objects are applied to target object ref_id: ".$a_ref_id;
123 //exit;
124 break;
125 }
126
127
128 return true;
129 }
◆ removeTranslations()
| ilObjRootFolder::removeTranslations | ( | ) |
Definition at line 175 of file class.ilObjRootFolder.php.
References $ilDB, $query, $res, and ilObject\getId().
Here is the call graph for this function:
The documentation for this class was generated from the following file:
- Modules/RootFolder/classes/class.ilObjRootFolder.php
