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

	setBehaviour ($a_val)
	Set behaviour (see ilItemGroupBehaviour) More...

	getBehaviour ()
	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 ()
	Read data from db. 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 ()

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public 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...

	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 ()

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

	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)

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

Public Member Functions inherited from ilObject
	__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 ()
	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...

	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 @access public More...

	getLastUpdateDate ()
	get last update date @access 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) @access 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...

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	lookupBehaviour ($a_id)
	Lookup behaviour. More...

Static Public Member Functions inherited from ilObject2
static	_lookupObjIdByImportId ($a_import_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	_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	_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@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)

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

Protected Member Functions
	doRead ()
	Read. More...

	doCreate ()
	Creation. More...

	doUpdate ()
	Update. More...

	doDelete ()
	Deletion. More...

	doCloneObject ($new_obj, $a_target_id, $a_copy_id=null, $a_omit_tree=false)
	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 ()

Static Protected Member Functions
static	lookup ($a_id, $a_key)
	Lookup hide title. More...

Protected Attributes
	$obj_def

	$access_type

	$access_begin

	$access_end

	$access_visibility

	$item_data_ar = null

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Additional Inherited Members
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

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_id	id
bool	$a_reference	ref id?

Returns

Reimplemented from ilObject2.

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

    {
        global $DIC;
 
        $this->log = $DIC["ilLog"];
        $tree = $DIC->repositoryTree();
        $objDefinition = $DIC["objDefinition"];
        $ilDB = $DIC->database();
        
        $this->tree = $tree;
        $this->obj_def = $objDefinition;
        $this->db = $ilDB;
 
        $this->item_data_ar = new ilItemGroupAR();
 
        parent::__construct($a_id, $a_reference);
    }

References $DIC, $ilDB, ilObject\$objDefinition, ilObject\$tree, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ cloneDependencies()

ilObjItemGroup::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone dependencies.

Parameters

return

Reimplemented from ilObject2.

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

    {
        $ilLog = $this->log;
        
        $ilLog->write(__METHOD__ . ': Cloning item group dependencies -' . $a_source_id . '-');
        
        parent::cloneDependencies($a_target_id, $a_copy_id);
 
        include_once('./Modules/ItemGroup/classes/class.ilItemGroupItems.php');
        $ig_items = new ilItemGroupItems($a_target_id);
        $ig_items->cloneItems($this->getRefId(), $a_copy_id);
 
        return true;
    }

References $ilLog, ilObject\$log, and ilObject2\getRefId().

Here is the call graph for this function:

◆ doCloneObject()

ilObjItemGroup::doCloneObject	(	$new_obj,
		$a_target_id,
		$a_copy_id = `null`,
		$a_omit_tree = `false`
	)

protected

Clone obj item group.

Parameters

ilObjItemGroup	$new_obj
int	$a_target_id
string	$a_copy_id
bool	$a_omit_tree

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

    {
        $new_obj->setHideTitle($this->getHideTitle());
        $new_obj->setBehaviour($this->getBehaviour());
        $new_obj->update();
    }

References getBehaviour(), and getHideTitle().

Here is the call graph for this function:

◆ doCreate()

ilObjItemGroup::doCreate ( )

protected

Creation.

Reimplemented from ilObject2.

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

    {
        if ($this->getId()) {
            $this->item_data_ar->setId($this->getId());
            $this->item_data_ar->create();
        }
    }

References ilObject\getId().

Here is the call graph for this function:

◆ doDelete()

ilObjItemGroup::doDelete ( )

protected

Deletion.

Reimplemented from ilObject2.

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

    {
        if ($this->getId()) {
            $this->item_data_ar->delete();
        }
    }

References ilObject\getId().

Here is the call graph for this function:

◆ doRead()

ilObjItemGroup::doRead ( )

protected

Read.

Reimplemented from ilObject2.

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ doUpdate()

ilObjItemGroup::doUpdate ( )

protected

Update.

Reimplemented from ilObject2.

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

    {
        if ($this->getId()) {
            $this->item_data_ar->update();
        }
    }

References ilObject\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 196 of file class.ilObjItemGroup.php.

    {
        global $DIC;
 
        $ilLog = $DIC["ilLog"];
        
        $ilLog->write(__METHOD__ . ': Fix item group references in ' . $a_source_container->getType());
        
        include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
        $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
        $mappings = $cwo->getMappings();
                
        $new_container_ref_id = $mappings[$a_source_container->getRefId()];
        $ilLog->write(__METHOD__ . ': 2-' . $new_container_ref_id . '-');
        $new_container_obj_id = ilObject::_lookupObjId($new_container_ref_id);
        
        include_once("./Services/COPage/classes/class.ilPageObject.php");
        include_once("./Services/Container/classes/class.ilContainerPage.php");
        $ilLog->write(__METHOD__ . ': 3' . $new_container_obj_id . '-');
        if (ilPageObject::_exists("cont", $new_container_obj_id)) {
            $ilLog->write(__METHOD__ . ': 4');
            $new_page = new ilContainerPage($new_container_obj_id);
            $new_page->buildDom();
            include_once("./Services/COPage/classes/class.ilPCResources.php");
            ilPCResources::modifyItemGroupRefIdsByMapping($new_page, $mappings);
            $new_page->update();
        }
        $ilLog->write(__METHOD__ . ': 5');
    }

References $DIC, $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:

◆ getBehaviour()

ilObjItemGroup::getBehaviour ( )

Get hide title.

Returns: int behaviour

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

    {
        return $this->item_data_ar->getBehaviour();
    }

Referenced by doCloneObject().

Here is the caller graph for this function:

◆ getHideTitle()

ilObjItemGroup::getHideTitle ( )

Get hide title.

Returns: bool hide title

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

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

Referenced by doCloneObject().

Here is the caller graph for this function:

◆ initType()

ilObjItemGroup::initType ( )

Init type.

Reimplemented from ilObject2.

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

    {
        $this->type = "itgr";
    }

◆ lookup()

static ilObjItemGroup::lookup	(	$a_id,
		$a_key
	)

staticprotected

Lookup hide title.

Parameters

int $a_id ID

Returns: bool

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $set = $ilDB->query(
            "SELECT " . $a_key . " FROM itgr_data " .
            " WHERE id = " . $ilDB->quote($a_id, "integer")
        );
        $rec = $ilDB->fetchAssoc($set);
        return $rec[$a_key];
    }

References $DIC, and $ilDB.

Referenced by lookupBehaviour(), and lookupHideTitle().

Here is the caller graph for this function:

◆ lookupBehaviour()

static ilObjItemGroup::lookupBehaviour ( $a_id )

static

Lookup behaviour.

Parameters

int $a_id ID

Returns: int

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

    {
        return self::lookup($a_id, "behaviour");
    }

References lookup().

Referenced by ilContainerContentGUI\renderItemGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ lookupHideTitle()

static ilObjItemGroup::lookupHideTitle ( $a_id )

static

Lookup hide title.

Parameters

int $a_id ID

Returns: bool

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

    {
        return self::lookup($a_id, "hide_title");
    }

References lookup().

Referenced by ilContainerContentGUI\renderItemGroup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setBehaviour()

ilObjItemGroup::setBehaviour ( $a_val )

Set behaviour (see ilItemGroupBehaviour)

Parameters

int $a_val behaviour

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

    {
        $this->item_data_ar->setBehaviour($a_val);
    }

◆ setHideTitle()

ilObjItemGroup::setHideTitle ( $a_val )

Set hide title.

Parameters

bool $a_val hide title

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

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

◆ setId()

ilObjItemGroup::setId ( $a_val )

Set ID.

Parameters

int $a_val ID

Reimplemented from ilObject.

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

    {
        parent::setId($a_val);
        $this->item_data_ar->setId($a_val);
    }

Field Documentation

◆ $access_begin

ilObjItemGroup::$access_begin

protected

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

◆ $access_end

ilObjItemGroup::$access_end

protected

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

◆ $access_type

ilObjItemGroup::$access_type

protected

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

◆ $access_visibility

ilObjItemGroup::$access_visibility

protected

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

◆ $item_data_ar

ilObjItemGroup::$item_data_ar = null

protected

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

◆ $obj_def

ilObjItemGroup::$obj_def

protected

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

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

Modules/ItemGroup/classes/class.ilObjItemGroup.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Static Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ cloneDependencies()

◆ doCloneObject()

◆ doCreate()

◆ doDelete()

◆ doRead()

◆ doUpdate()

◆ fixContainerItemGroupRefsAfterCloning()

◆ getBehaviour()

◆ getHideTitle()

◆ initType()

◆ lookup()

◆ lookupBehaviour()

◆ lookupHideTitle()

◆ setBehaviour()

◆ setHideTitle()

◆ setId()

Field Documentation

◆ $access_begin

◆ $access_end

◆ $access_type

◆ $access_visibility

◆ $item_data_ar

◆ $obj_def