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

Class ilObjItemGroup. More...

+ Inheritance diagram for ilObjItemGroup:
+ Collaboration diagram for ilObjItemGroup:

Public Member Functions

 __construct ($a_id=0, $a_reference=true)
 Constructor. More...
 
 setId ($a_val)
 Set ID. More...
 
 initType ()
 Init type. More...
 
 setHideTitle ($a_val)
 Set hide title. More...
 
 getHideTitle ()
 Get hide title. More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone dependencies. More...
 
- Public Member Functions inherited from ilObject2
 __construct ($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 data from db. 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...
 
 setObjDataRecord ($a_record)
 set object_data record (note: this method should only be called from the ilObjectFactory class) More...
 
 create ($a_clone_mode=false)
 
 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...
 
 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...
 
 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 ()
 
 appendCopyInfo ($a_target_id, $a_copy_id)
 Prepend Copy info if object with same name exists in that container. More...
 
 cloneMetaData ($target_obj)
 Copy meta data. More...
 
 cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false)
 Clone object permissions, put in tree ... More...
 
 cloneDependencies ($a_target_id, $a_copy_id)
 Clone object dependencies. 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...
 

Static Public Member Functions

static fixContainerItemGroupRefsAfterCloning ($a_source_container, $a_copy_id)
 Fix container item group references after a container has been cloned. More...
 
static lookupHideTitle ($a_id)
 Lookup hide title. More...
 
- Static Public Member Functions inherited from ilObject2
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 _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)
 
static _getObjectsByType ($a_obj_type="", $a_owner="")
 Get objects by type. More...
 
static _prepareCloneSelection ($a_ref_ids, $new_type)
 
static _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
 Get icon for repository item. 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...
 

Protected Member Functions

 doRead ()
 Read. More...
 
 doCreate ()
 Creation. More...
 
 doUpdate ()
 Update. More...
 
 doDelete ()
 Deletion. More...
 
 doCloneObject ($new_obj, $a_target_id, $a_copy_id)
 Clone obj item group. More...
 
- Protected Member Functions inherited from ilObject2
 initType ()
 
 doRead ()
 
 doCreate ()
 
 beforeCreate ()
 
 doUpdate ()
 
 beforeUpdate ()
 
 doMDUpdateListener ($a_element)
 
 beforeMDUpdateListener ($a_element)
 
 doCreateMetaData ()
 
 beforeCreateMetaData ()
 
 doUpdateMetaData ()
 
 beforeUpdateMetaData ()
 
 doDelete ()
 
 beforeDelete ()
 
 doCloneObject ($new_obj, $a_target_id, $a_copy_id=null)
 
 beforeCloneObject ()
 

Protected Attributes

 $access_type
 
 $access_begin
 
 $access_end
 
 $access_visibility
 
 $item_data_ar = null
 

Additional Inherited Members

- 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 ilObjItemGroup.

Author
Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e
Version
$Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilObjItemGroup::__construct (   $a_id = 0,
  $a_reference = true 
)

Constructor.

Parameters
int$a_idid
bool$a_referenceref id?
Returns

Reimplemented from ilObject2.

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

35 {
36 global $tree, $objDefinition, $ilDB;
37
38 $this->tree = $tree;
39 $this->obj_def = $objDefinition;
40 $this->db = $ilDB;
41
42 $this->item_data_ar = new ilItemGroupAR();
43
44 parent::__construct($a_id, $a_reference);
45 }
Item group active record class.
global $ilDB

References $ilDB.

Member Function Documentation

◆ cloneDependencies()

ilObjItemGroup::cloneDependencies (   $a_target_id,
  $a_copy_id 
)

Clone dependencies.

Parameters

return

Reimplemented from ilObject2.

Definition at line 146 of file class.ilObjItemGroup.php.

147 {
148 global $ilLog;
149
150 $ilLog->write(__METHOD__.': Cloning item group dependencies -'.$a_source_id.'-');
151
152 parent::cloneDependencies($a_target_id,$a_copy_id);
153
154 include_once('./Modules/ItemGroup/classes/class.ilItemGroupItems.php');
155 $ig_items = new ilItemGroupItems($a_target_id);
156 $ig_items->cloneItems($this->getRefId(), $a_copy_id);
157
158 return true;
159 }
getRefId()
get reference id @access public

References $ilLog, and ilObject2\getRefId().

+ Here is the call graph for this function:

◆ doCloneObject()

ilObjItemGroup::doCloneObject (   $new_obj,
  $a_target_id,
  $a_copy_id 
)
protected

Clone obj item group.

Parameters

return

Reimplemented from ilObject2.

Definition at line 134 of file class.ilObjItemGroup.php.

135 {
136 $new_obj->setHideTitle($this->getHideTitle());
137 $new_obj->update();
138 }
getHideTitle()
Get hide title.

References getHideTitle().

+ Here is the call graph for this function:

◆ doCreate()

ilObjItemGroup::doCreate ( )
protected

Creation.

Reimplemented from ilObject2.

Definition at line 97 of file class.ilObjItemGroup.php.

98 {
99 if($this->getId())
100 {
101 $this->item_data_ar->setId($this->getId());
102 $this->item_data_ar->create();
103 }
104 }
getId()
get object id @access public

References ilObject2\getId().

+ Here is the call graph for this function:

◆ doDelete()

ilObjItemGroup::doDelete ( )
protected

Deletion.

Reimplemented from ilObject2.

Definition at line 120 of file class.ilObjItemGroup.php.

121 {
122 if($this->getId())
123 {
124 $this->item_data_ar->delete();
125 }
126 }

References ilObject2\getId().

+ Here is the call graph for this function:

◆ doRead()

ilObjItemGroup::doRead ( )
protected

Read.

Reimplemented from ilObject2.

Definition at line 89 of file class.ilObjItemGroup.php.

90 {
91 $this->item_data_ar = new ilItemGroupAR($this->getId());
92 }

References ilObject2\getId().

+ Here is the call graph for this function:

◆ doUpdate()

ilObjItemGroup::doUpdate ( )
protected

Update.

Reimplemented from ilObject2.

Definition at line 109 of file class.ilObjItemGroup.php.

110 {
111 if($this->getId())
112 {
113 $this->item_data_ar->update();
114 }
115 }

References ilObject2\getId().

+ Here is the call graph for this function:

◆ fixContainerItemGroupRefsAfterCloning()

static ilObjItemGroup::fixContainerItemGroupRefsAfterCloning (   $a_source_container,
  $a_copy_id 
)
static

Fix container item group references after a container has been cloned.

Parameters

return

Definition at line 167 of file class.ilObjItemGroup.php.

168 {
169 global $ilLog;
170
171 $ilLog->write(__METHOD__.': Fix item group references in '.$a_source_container->getType());
172
173 include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
174 $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
175 $mappings = $cwo->getMappings();
176
177 $new_container_ref_id = $mappings[$a_source_container->getRefId()];
178 $ilLog->write(__METHOD__.': 2-'.$new_container_ref_id.'-');
179 $new_container_obj_id = ilObject::_lookupObjId($new_container_ref_id);
180
181 include_once("./Services/COPage/classes/class.ilPageObject.php");
182 include_once("./Services/Container/classes/class.ilContainerPage.php");
183 $ilLog->write(__METHOD__.': 3'.$new_container_obj_id.'-');
184 if (ilPageObject::_exists("cont", $new_container_obj_id))
185 {
186 $ilLog->write(__METHOD__.': 4');
187 $new_page = new ilContainerPage($new_container_obj_id);
188 $new_page->buildDom();
189 include_once("./Services/COPage/classes/class.ilPCResources.php");
191 $new_page->update();
192 }
193 $ilLog->write(__METHOD__.': 5');
194 }
Container page object.
static _getInstance($a_copy_id)
Get instance of copy wizard options.
static _lookupObjId($a_id)
static modifyItemGroupRefIdsByMapping($a_page, $mappings)
Modify ref ids by mapping.
static _exists($a_parent_type, $a_id, $a_lang="", $a_no_cache=false)
Checks whether page exists.

References $ilLog, ilPageObject\_exists(), ilCopyWizardOptions\_getInstance(), ilObject\_lookupObjId(), and ilPCResources\modifyItemGroupRefIdsByMapping().

Referenced by ilContainer\cloneDependencies().

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getHideTitle()

ilObjItemGroup::getHideTitle ( )

Get hide title.

Returns
bool hide title

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

82 {
83 return $this->item_data_ar->getHideTitle();
84 }

Referenced by doCloneObject().

+ Here is the caller graph for this function:

◆ initType()

ilObjItemGroup::initType ( )

Init type.

Reimplemented from ilObject2.

Definition at line 61 of file class.ilObjItemGroup.php.

62 {
63 $this->type = "itgr";
64 }

◆ lookupHideTitle()

static ilObjItemGroup::lookupHideTitle (   $a_id)
static

Lookup hide title.

Parameters
int$a_idID
Returns
bool

Definition at line 202 of file class.ilObjItemGroup.php.

203 {
204 global $ilDB;
205
206 $set = $ilDB->query("SELECT hide_title FROM itgr_data ".
207 " WHERE id = ".$ilDB->quote($a_id, "integer")
208 );
209 $rec = $ilDB->fetchAssoc($set);
210 return $rec["hide_title"];
211 }

References $ilDB.

Referenced by ilContainerContentGUI\renderItemGroup().

+ Here is the caller graph for this function:

◆ setHideTitle()

ilObjItemGroup::setHideTitle (   $a_val)

Set hide title.

Parameters
bool$a_valhide title

Definition at line 71 of file class.ilObjItemGroup.php.

72 {
73 $this->item_data_ar->setHideTitle($a_val);
74 }

◆ setId()

ilObjItemGroup::setId (   $a_val)

Set ID.

Parameters
int$a_valID

Reimplemented from ilObject2.

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

53 {
54 parent::setId($a_val);
55 $this->item_data_ar->setId($a_val);
56 }

Field Documentation

◆ $access_begin

ilObjItemGroup::$access_begin
protected

Definition at line 22 of file class.ilObjItemGroup.php.

◆ $access_end

ilObjItemGroup::$access_end
protected

Definition at line 23 of file class.ilObjItemGroup.php.

◆ $access_type

ilObjItemGroup::$access_type
protected

Definition at line 21 of file class.ilObjItemGroup.php.

◆ $access_visibility

ilObjItemGroup::$access_visibility
protected

Definition at line 24 of file class.ilObjItemGroup.php.

◆ $item_data_ar

ilObjItemGroup::$item_data_ar = null
protected

Definition at line 25 of file class.ilObjItemGroup.php.


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