ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5f
ilObjCategory Class Reference

Class ilObjCategory. More...

+ Inheritance diagram for ilObjCategory:
+ Collaboration diagram for ilObjCategory:

Public Member Functions

 ilObjCategory ($a_id=0, $a_call_by_reference=true)
 Constructor @access public. More...
 
 delete ()
 delete category and all related data
More...
 
 getTranslations ()
 get all translations from this category More...
 
 removeTranslations ()
 
 deleteTranslation ($a_lang)
 
 addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
 
 updateTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
 
 cloneObject ($a_target_id, $a_copy_id=0)
 Clone course (no member data) More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies (container sorting) More...
 
 addAdditionalSubItemInformation (&$a_item_data)
 Add additional information to sub item, e.g. 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...
 
- 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...
 

Additional Inherited Members

- 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...
 
- 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...
 
- 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
 
- 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...
 
- Static Public Attributes inherited from ilContainer
static $data_preloaded = false
 
- Protected Attributes inherited from ilContainer
 $order_type = 0
 
 $hiddenfilesfound = false
 

Detailed Description

Class ilObjCategory.

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

Definition at line 19 of file class.ilObjCategory.php.

Member Function Documentation

◆ addAdditionalSubItemInformation()

ilObjCategory::addAdditionalSubItemInformation ( $a_item_data)

Add additional information to sub item, e.g.

used in courses for timings information etc.

Reimplemented from ilContainer.

Definition at line 278 of file class.ilObjCategory.php.

279 {
280 include_once './Services/Object/classes/class.ilObjectActivation.php';
282 }
static addAdditionalSubItemInformation(array &$a_item)
Parse item data for list entries.

References ilObjectActivation\addAdditionalSubItemInformation().

+ Here is the call graph for this function:

◆ addTranslation()

ilObjCategory::addTranslation (   $a_title,
  $a_desc,
  $a_lang,
  $a_lang_default 
)

Definition at line 128 of file class.ilObjCategory.php.

129 {
130 global $ilDB;
131
132 if (empty($a_title))
133 {
134 $a_title = "NO TITLE";
135 }
136
137 $query = "INSERT INTO object_translation ".
138 "(obj_id,title,description,lang_code,lang_default) ".
139 "VALUES ".
140 "(".$ilDB->quote($this->getId(),'integer').",".
141 $ilDB->quote($a_title,'text').",".$ilDB->quote($a_desc,'text').",".
142 $ilDB->quote($a_lang,'text').",".$ilDB->quote($a_lang_default,'integer').")";
143 $res = $ilDB->manipulate($query);
144
145 return true;
146 }
getId()
get object id @access public
global $ilDB

References $ilDB, $query, $res, and ilObject\getId().

+ Here is the call graph for this function:

◆ cloneDependencies()

ilObjCategory::cloneDependencies (   $a_target_id,
  $a_copy_id 
)

Clone object dependencies (container sorting)

@access public

Parameters
inttarget ref id of new course
intcopy id return bool

Reimplemented from ilContainer.

Definition at line 217 of file class.ilObjCategory.php.

218 {
219 parent::cloneDependencies($a_target_id,$a_copy_id);
220
221
222 // clone taxonomies
223
224 include_once("./Services/Taxonomy/classes/class.ilObjTaxonomy.php");
225 $all_tax = ilObjTaxonomy::getUsageOfObject($this->getId());
226 if(sizeof($all_tax))
227 {
228 include_once("./Services/Taxonomy/classes/class.ilTaxNodeAssignment.php");
229
230 $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
231 $mappings = $cwo->getMappings();
232
233 foreach($all_tax as $old_tax_id)
234 {
235 if($old_tax_id)
236 {
237 // clone it
238 $old_tax = new ilObjTaxonomy($old_tax_id);
239 $new_tax = $old_tax->cloneObject(0,0,true);
240 $tax_map = $old_tax->getNodeMapping();
241
242 // assign new taxonomy to new category
243 ilObjTaxonomy::saveUsage($new_tax->getId(), ilObject::_lookupObjId($a_target_id));
244
245 // clone assignments (for all sub-items)
246 foreach($mappings as $old_ref_id => $new_ref_id)
247 {
248 if($old_ref_id != $new_ref_id)
249 {
250 $old_obj_id = ilObject::_lookupObjId($old_ref_id);
251 $new_obj_id = ilObject::_lookupObjId($new_ref_id);
252 $obj_type = ilObject::_lookupType($old_obj_id);
253
254 $tax_ass = new ilTaxNodeAssignment($obj_type, $old_obj_id, "obj", $old_tax_id);
255 $assignmts = $tax_ass->getAssignmentsOfItem($old_obj_id);
256 if(sizeof($assignmts))
257 {
258 $new_tax_ass = new ilTaxNodeAssignment($obj_type, $new_obj_id, "obj", $new_tax->getId());
259 foreach($assignmts as $a)
260 {
261 if($tax_map[$a["node_id"]])
262 {
263 $new_tax_ass->addAssignment($tax_map[$a["node_id"]], $new_obj_id);
264 }
265 }
266 }
267 }
268 }
269 }
270 }
271 }
272 }
static _getInstance($a_copy_id)
Get instance of copy wizard options.
static getUsageOfObject($a_obj_id, $a_include_titles=false)
Get usage of object.
static saveUsage($a_tax_id, $a_obj_id)
Save Usage.
static _lookupObjId($a_id)
static _lookupType($a_id, $a_reference=false)
lookup object type
Taxonomy node <-> item assignment.

References ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), ilObject\_lookupType(), ilObject\getId(), ilObjTaxonomy\getUsageOfObject(), and ilObjTaxonomy\saveUsage().

+ Here is the call graph for this function:

◆ cloneObject()

ilObjCategory::cloneObject (   $a_target_id,
  $a_copy_id = 0 
)

Clone course (no member data)

@access public

Parameters
inttarget ref_id
intcopy id

Reimplemented from ilContainer.

Definition at line 178 of file class.ilObjCategory.php.

179 {
180 global $ilDB,$ilUser;
181
182 $new_obj = parent::cloneObject($a_target_id,$a_copy_id);
183
184 /* done in class.ilContainer
185 include_once('./Services/Container/classes/class.ilContainerSortingSettings.php');
186 ilContainerSortingSettings::_cloneSettings($this->getId(),$new_obj->getId());
187 */
188
189 include_once("./Services/Object/classes/class.ilObjectTranslation.php");
191 $ot->copy($new_obj->getId());
192
193 /*
194 $first = true;
195 $translations = $this->getTranslations();
196 if(is_array($translations['Fobject']))
197 {
198 foreach($translations['Fobject'] as $num => $translation)
199 {
200 $new_obj->addTranslation($translation['title'],$translation['desc'],$translation['lang'],$first);
201
202 if($first)
203 {
204 $first = false;
205 }
206 }
207 }*/
208
209 // clone icons
210 $new_obj->saveIcons($this->getBigIconPath(),
211 $this->getSmallIconPath(),
212 $this->getTinyIconPath());
213
214 return $new_obj;
215 }
getBigIconPath()
Get path for big icon.
getSmallIconPath()
Get path for small icon.
getTinyIconPath()
Get path for tiny icon.
static getInstance($a_obj_id)
Get instance.
global $ilUser
Definition: imgupload.php:15

References $ilDB, $ilUser, ilContainer\getBigIconPath(), ilObject\getId(), ilObjectTranslation\getInstance(), ilContainer\getSmallIconPath(), and ilContainer\getTinyIconPath().

+ Here is the call graph for this function:

◆ delete()

ilObjCategory::delete ( )

delete category 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 39 of file class.ilObjCategory.php.

40 {
41 global $ilDB,$ilAppEventHandler;
42
43 // always call parent delete function first!!
44 if (!parent::delete())
45 {
46 return false;
47 }
48
49 // put here category specific stuff
50 include_once('./Services/User/classes/class.ilObjUserFolder.php');
52
53 $query = "DELETE FROM object_translation WHERE obj_id = ".$ilDB->quote($this->getId(),'integer');
54 $res = $ilDB->manipulate($query);
55
56 // taxonomies
57 include_once "Services/Taxonomy/classes/class.ilObjTaxonomy.php";
58 foreach(ilObjTaxonomy::getUsageOfObject($this->getId()) as $tax_id)
59 {
60 if($tax_id)
61 {
62 $tax = new ilObjTaxonomy($tax_id);
63 $tax->delete();
64 }
65 }
66
67 $ilAppEventHandler->raise('Modules/Category',
68 'delete',
69 array('object' => $this,
70 'obj_id' => $this->getId()));
71
72 return true;
73 }
const USER_FOLDER_ID
Class ilObjUserFolder.
static _updateUserFolderAssignment($a_old_id, $a_new_id)
Update user folder assignment Typically called after deleting a category with local user accounts.

References $ilDB, $query, $res, ilObjUserFolder\_updateUserFolderAssignment(), ilObject\getId(), ilObjTaxonomy\getUsageOfObject(), and USER_FOLDER_ID.

+ Here is the call graph for this function:

◆ deleteTranslation()

ilObjCategory::deleteTranslation (   $a_lang)

Definition at line 117 of file class.ilObjCategory.php.

118 {
119 global $ilDB;
120
121 $query = "DELETE FROM object_translation WHERE obj_id= ".
122 $ilDB->quote($this->getId(),'integer')." AND lang_code = ".
123 $ilDB->quote($a_lang, 'text');
124 $res = $ilDB->manipulate($query);
125 }

References $ilDB, $query, $res, and ilObject\getId().

+ Here is the call graph for this function:

◆ getTranslations()

ilObjCategory::getTranslations ( )

get all translations from this category

@access public

Returns
array

Definition at line 81 of file class.ilObjCategory.php.

82 {
83 global $ilDB;
84
85 $q = "SELECT * FROM object_translation WHERE obj_id = ".
86 $ilDB->quote($this->getId(),'integer')." ORDER BY lang_default DESC";
87 $r = $this->ilias->db->query($q);
88
89 $num = 0;
90
91 while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT))
92 {
93 $data["Fobject"][$num]= array("title" => $row->title,
94 "desc" => $row->description,
95 "lang" => $row->lang_code
96 );
97 $num++;
98 }
99
100 // first entry is always the default language
101 $data["default_language"] = 0;
102
103 return $data ? $data : array();
104 }
const DB_FETCHMODE_OBJECT
Definition: class.ilDB.php:11
$data
$r
Definition: example_031.php:79
redirection script todo: (a better solution should control the processing via a xml file)

References $data, $ilDB, $r, $row, DB_FETCHMODE_OBJECT, and ilObject\getId().

+ Here is the call graph for this function:

◆ ilObjCategory()

ilObjCategory::ilObjCategory (   $a_id = 0,
  $a_call_by_reference = true 
)

Constructor @access public.

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

Definition at line 27 of file class.ilObjCategory.php.

28 {
29 $this->type = "cat";
30 $this->ilContainer($a_id,$a_call_by_reference);
31 }
ilContainer($a_id=0, $a_call_by_reference=true)
Constructor @access public.

References ilContainer\ilContainer().

+ Here is the call graph for this function:

◆ removeTranslations()

ilObjCategory::removeTranslations ( )

Definition at line 107 of file class.ilObjCategory.php.

108 {
109 global $ilDB;
110
111 $query = "DELETE FROM object_translation WHERE obj_id= ".
112 $ilDB->quote($this->getId(),'integer');
113 $res = $ilDB->manipulate($query);
114 }

References $ilDB, $query, $res, and ilObject\getId().

+ Here is the call graph for this function:

◆ updateTranslation()

ilObjCategory::updateTranslation (   $a_title,
  $a_desc,
  $a_lang,
  $a_lang_default 
)

Definition at line 149 of file class.ilObjCategory.php.

150 {
151 global $ilDB, $ilLog;
152
153 if (empty($a_title))
154 {
155 $a_title = "NO TITLE";
156 }
157
158 $query = "UPDATE object_translation ".
159 "SET title = ". $ilDB->quote($a_title,'text').",".
160 "description = ".$ilDB->quote($a_desc,'text').",".
161 "lang_code = ".$ilDB->quote($a_lang,'text') . ",".
162 "lang_default = ".$ilDB->quote($a_lang_default,'integer')." ".
163 "WHERE ".
164 " obj_id = ".$ilDB->quote($this->getId(),'integer');
165 $res = $ilDB->manipulate($query);
166
167 return true;
168 }

References $ilDB, $ilLog, $query, $res, and ilObject\getId().

+ Here is the call graph for this function:

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