Inheritance diagram for ilContainerReference:

Collaboration diagram for ilContainerReference:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	getTargetId ()
	get target id More...

	setTargetId ($a_target_id)
	set target id More...

	setTargetRefId ($a_id)
	set target ref_id More...

	getTargetRefId ()
	get Target ref_id More...

	getTitleType ()
	get title type More...

	setTitleType ($type)
	Set title type. More...

	read ()
	read More...

	getPresentationTitle ()
	Get presentation title. More...

	update ()
	update object More...

	delete ()
	delete More...

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone course reference. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor 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 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...

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

	getLastUpdateDate ()
	get last update date 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) 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	_lookupTargetId ($a_obj_id)
	lookup target id More...

static	_lookupTargetRefId ($a_obj_id)
	Lookup target ref_id. More...

static	_lookupTitle ($a_obj_id)
	Overwitten from base class. More...

static	_lookupTargetTitle ($a_obj_id)
	Lookup target title. More...

static	_lookupSourceId ($a_target_id)
	lookup source id More...

static	_lookupSourceIds ($a_target_id)
	Get ids of all container references that target the object with the given id. More...

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)
	only called in ilTree::saveSubTree More...

static	setDeletedDates ($a_ref_ids)
	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 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...

Data Fields
const	TITLE_TYPE_REUSE = 1

const	TITLE_TYPE_CUSTOM = 2

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

Protected Attributes
	$user

	$db = null

	$target_id = null

	$target_ref_id = null

	$title_type = self::TITLE_TYPE_REUSE

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Detailed Description

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilContainerReference::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

int	$a_id	reference id
bool	$a_call_by_reference

Returns: void

Definition at line 55 of file class.ilContainerReference.php.

References $DIC, $ilDB, and user().

     {
         global $DIC;
 
         $this->db = $DIC->database();
         $this->user = $DIC->user();
         $ilDB = $DIC->database();
 
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _lookupSourceId()

static ilContainerReference::_lookupSourceId ( $a_target_id )

static

lookup source id

Parameters

int $a_target_id obj_id of course or category

Returns: int obj_id of references

Definition at line 163 of file class.ilContainerReference.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilContainerReferenceAppEventListener\deleteReferences().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $query = "SELECT * FROM container_reference " .
             "WHERE target_obj_id = " . $ilDB->quote($a_target_id, 'integer') . " ";
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->obj_id;
         }
         return false;
     }

Here is the caller graph for this function:

◆ _lookupSourceIds()

static ilContainerReference::_lookupSourceIds ( $a_target_id )

static

Get ids of all container references that target the object with the given id.

Parameters

int $a_target_id obj_id of course or category

Returns: int[] obj_ids of references

Definition at line 186 of file class.ilContainerReference.php.

References $DIC, $ilDB, $query, $res, $ret, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjStudyProgramme\setProgressesCompletedFor().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $query = "SELECT * FROM container_reference " .
             "WHERE target_obj_id = " . $ilDB->quote($a_target_id, 'integer') . " ";
         $res = $ilDB->query($query);
         $ret = array();
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $ret[] = $row->obj_id;
         }
         return $ret;
     }

Here is the caller graph for this function:

◆ _lookupTargetId()

static ilContainerReference::_lookupTargetId ( $a_obj_id )

static

lookup target id

public

Parameters

int $a_ref_id Course reference obj_id

Returns

Definition at line 74 of file class.ilContainerReference.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjCourseReferenceAccess\_preloadData(), ilObjStudyProgramme\getCompletedCourses(), ilObjGroupReferenceListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilObjCategoryReferenceListGUI\initItem(), ilObjectReferenceCustomIconPresenter\lookupTargetId(), and ilNoteGUI\renderTargets().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $query = "SELECT * FROM container_reference " .
             "WHERE obj_id = " . $ilDB->quote($a_obj_id, 'integer') . " ";
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->target_obj_id;
         }
         return $a_obj_id;
     }

Here is the caller graph for this function:

◆ _lookupTargetRefId()

static ilContainerReference::_lookupTargetRefId ( $a_obj_id )

static

Lookup target ref_id.

Parameters

int $a_obj_id obj_id

Returns

Definition at line 95 of file class.ilContainerReference.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjGroupReferenceAccess\_checkAccess(), ilObjCourseReferenceAccess\_checkAccess(), ilObjGroupReferenceGUI\_goto(), ilObjCourseReferenceGUI\_goto(), and ilObjCategoryReferenceGUI\_goto().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $query = "SELECT ref_id FROM object_reference obr " .
             "JOIN container_reference cr ON obr.obj_id = cr.target_obj_id " .
             "WHERE cr.obj_id = " . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->ref_id;
         }
         return false;
     }

Here is the caller graph for this function:

◆ _lookupTargetTitle()

static ilContainerReference::_lookupTargetTitle ( $a_obj_id )

static

Lookup target title.

Returns: string title

Definition at line 140 of file class.ilContainerReference.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by _lookupTitle(), ilCourseObjectivesTableGUI\fillRow(), and ilObjStudyProgramme\getCompletedCourses().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
         
         $query = "SELECT title FROM object_data od " .
             "JOIN container_reference cr ON target_obj_id = od.obj_id " .
             "WHERE cr.obj_id = " . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return $row->title;
         }
         return '';
     }

Here is the caller graph for this function:

◆ _lookupTitle()

static ilContainerReference::_lookupTitle ( $a_obj_id )

static

Overwitten from base class.

Parameters

int $a_obj_id

Returns

Definition at line 116 of file class.ilContainerReference.php.

References $DIC, $ilDB, $query, $res, $row, _lookupTargetTitle(), ilDBConstants\FETCHMODE_OBJECT, and TITLE_TYPE_CUSTOM.

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fetchData(), ilStudyProgrammeMembersTableGUI\fetchData(), ilTree\fetchNodeData(), ilNoteGUI\getNoteListHTML(), ilObjGroupReferenceListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilObjCategoryReferenceListGUI\initItem(), and ilPCResourcesGUI\insertResourcesIntoPageContent().

     {
         global $DIC;
 
         $ilDB = $DIC->database();
          
         $query = 'SELECT title,title_type FROM container_reference cr ' .
                  'JOIN object_data od ON cr.obj_id = od.obj_id ' .
                  'WHERE cr.obj_id = ' . $ilDB->quote($a_obj_id, 'integer');
         $res = $ilDB->query($query);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             if ($row->title_type == ilContainerReference::TITLE_TYPE_CUSTOM) {
                 return $row->title;
             }
         }
         return ilContainerReference::_lookupTargetTitle($a_obj_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneObject()

ilContainerReference::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone course reference.

public

Parameters

int	target ref_id
int	copy id

Definition at line 366 of file class.ilContainerReference.php.

References $db, $ilDB, $ilUser, $query, and $user.

     {
         $ilDB = $this->db;
         $ilUser = $this->user;
         
         $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
         
         $query = "INSERT INTO container_reference (obj_id, target_obj_id, title_type) " .
             "VALUES( " .
             $ilDB->quote($new_obj->getId(), 'integer') . ", " .
             $ilDB->quote($this->getTargetId(), 'integer') . ", " .
             $ilDB->quote($this->getTitleType(), 'integer') . ' ' .
             ")";
         $ilDB->manipulate($query);
         return $new_obj;
     }

◆ delete()

ilContainerReference::delete ( )

delete

public

Parameters

Definition at line 343 of file class.ilContainerReference.php.

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

     {
         $ilDB = $this->db;
 
         if (!parent::delete()) {
             return false;
         }
 
         $query = "DELETE FROM container_reference " .
             "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
         $ilDB->manipulate($query);
         
         return true;
     }

Here is the call graph for this function:

◆ getPresentationTitle()

ilContainerReference::getPresentationTitle ( )

Get presentation title.

Returns: string presentation title

Definition at line 301 of file class.ilContainerReference.php.

References ilObject\getTitle(), and getTitleType().

     {
         if ($this->getTitleType() == self::TITLE_TYPE_CUSTOM) {
             return $this->getTitle();
         } else {
             return $this->lng->txt('reference_of') . ' ' . $this->getTitle();
         }
     }

Here is the call graph for this function:

◆ getTargetId()

ilContainerReference::getTargetId ( )

get target id

public

Returns

Definition at line 208 of file class.ilContainerReference.php.

References $target_id.

Referenced by read(), and update().

     {
         return $this->target_id;
     }

Here is the caller graph for this function:

◆ getTargetRefId()

ilContainerReference::getTargetRefId ( )

get Target ref_id

public

Parameters

Definition at line 245 of file class.ilContainerReference.php.

References $target_ref_id.

     {
         return $this->target_ref_id;
     }

◆ getTitleType()

ilContainerReference::getTitleType ( )

get title type

Returns: type

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

References $title_type.

Referenced by getPresentationTitle(), read(), and update().

     {
         return $this->title_type;
     }

Here is the caller graph for this function:

◆ read()

ilContainerReference::read ( )

read

public

Returns

Definition at line 274 of file class.ilContainerReference.php.

References $db, $ilDB, $query, $res, $row, ilObject\_getAllReferences(), ilObject\_lookupTitle(), ilDBConstants\FETCHMODE_OBJECT, ilObject\getId(), getTargetId(), getTitleType(), setTargetId(), setTargetRefId(), setTitleType(), and TITLE_TYPE_REUSE.

     {
         $ilDB = $this->db;
         
         parent::read();
         
         $query = "SELECT * FROM container_reference " .
             "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
         $res = $ilDB->query($query);
         
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->setTargetId($row->target_obj_id);
             $this->setTitleType($row->title_type);
         }
         $ref_ids = ilObject::_getAllReferences($this->getTargetId());
         $this->setTargetRefId(current($ref_ids));
         
         if ($this->getTitleType() == ilContainerReference::TITLE_TYPE_REUSE) {
             #$this->title = $this->lng->txt('reference_of').' '.ilObject::_lookupTitle($this->getTargetId());
             $this->title = ilObject::_lookupTitle($this->getTargetId());
         }
     }

Here is the call graph for this function:

◆ setTargetId()

ilContainerReference::setTargetId ( $a_target_id )

set target id

public

Parameters

int $a_target_id target id

Returns

Definition at line 221 of file class.ilContainerReference.php.

Referenced by read().

     {
         $this->target_id = $a_target_id;
     }

Here is the caller graph for this function:

◆ setTargetRefId()

ilContainerReference::setTargetRefId ( $a_id )

set target ref_id

public

Parameters

Definition at line 233 of file class.ilContainerReference.php.

Referenced by read().

     {
         $this->target_ref_id = $a_id;
     }

Here is the caller graph for this function:

◆ setTitleType()

ilContainerReference::setTitleType ( $type )

Set title type.

Parameters

type $type

Definition at line 263 of file class.ilContainerReference.php.

References ilObject\$type.

Referenced by read().

     {
         $this->title_type = $type;
     }

Here is the caller graph for this function:

◆ update()

ilContainerReference::update ( )

update object

public

Parameters

Definition at line 317 of file class.ilContainerReference.php.

References $db, $ilDB, $query, ilObject\getId(), getTargetId(), getTitleType(), and League\Flysystem\Adapter\Polyfill\update().

     {
         $ilDB = $this->db;
         
         parent::update();
         
         $query = "DELETE FROM container_reference " .
             "WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " ";
         $ilDB->manipulate($query);
         
         $query = "INSERT INTO container_reference (obj_id, target_obj_id, title_type) " .
             "VALUES( " .
             $ilDB->quote($this->getId(), 'integer') . ", " .
             $ilDB->quote($this->getTargetId(), 'integer') . ", " .
             $ilDB->quote($this->getTitleType(), 'integer') . ' ' .
             ")";
         $ilDB->manipulate($query);
     }