Class ilObject2 This is an intermediate progress of ilObject class. More...

Inheritance diagram for ilObject2:

Collaboration diagram for ilObject2:

Public Member Functions
	__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...

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

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

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

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

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

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

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

	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	_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)
	only called in ilTree::saveSubTree 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, $a_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 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	_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 @global type $ilDB. 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	_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	_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
	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 ()

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

Detailed Description

Class ilObject2 This is an intermediate progress of ilObject class.

Please do not ust it yet.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 14 of file class.ilObject2.php.

Constructor & Destructor Documentation

◆ __construct()

ilObject2::__construct	(	$a_id = `0`,
		$a_reference = `true`
	)

Constructor @access public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

Reimplemented in ilObjFile, ilObjStudyProgrammeAdmin, ilStudyProgrammeLeafMock, ilRemoteObjectBase, ilObjItemGroup, ilObjPoll, ilObjTermsOfService, ilVerificationObject, and ilObjCloud.

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

        {
                $this->initType();
                parent::__construct($a_id, $a_reference);
        }

References initType().

Here is the call graph for this function:

Member Function Documentation

◆ _exists()

static ilObject2::_exists	(	$a_id,
		$a_reference = `false`,
		$a_type = `null`
	)

staticfinal

checks if an object exists in object_data@access public

Parameters

integer	object id or reference id
boolean	true if id is a reference, else false (default)
string	restrict on a certain type.

Returns: boolean true if object exists

Reimplemented from ilObject.

Definition at line 239 of file class.ilObject2.php.

239{ return parent::_exists($a_id, $a_reference, $a_type); }

$a_type

Definition: workflow.php:93

References $a_type.

Referenced by ilCloudPlugin\__construct(), ilDclBaseRecordModel\deleteFile(), ilDclFileuploadRecordRepresentation\getHTML(), ilDclFileuploadRecordFieldModel\parseExportValue(), ilDclFileuploadRecordRepresentation\parseFormInput(), ilDclMobRecordRepresentation\parseFormInput(), ilDclFileuploadRecordFieldModel\parseSortingValue(), and ilDclFileuploadFieldRepresentation\passThroughFilter().

Here is the caller graph for this function:

◆ _getAllReferences()

static ilObject2::_getAllReferences ( $a_id )

staticfinal

get all reference ids of object

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 189 of file class.ilObject2.php.

189{ return parent::_getAllReferences($a_id); }

Referenced by ilObjPollAccess\canBeDelivered(), ilObjDataCollectionAccess\checkAccessForDataCollectionId(), ilObjDataCollectionAccess\checkActionForObjId(), and ilObjDataCollectionAccess\isTableInDataCollection().

Here is the caller graph for this function:

◆ _getIcon()

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

staticfinal

Get icon for repository item.

Parameters

int	object id
string	size (big, small, tiny)
string	object type
boolean	true: offline, false: online

Reimplemented from ilObject.

Definition at line 276 of file class.ilObject2.php.

276{ return parent::_getIcon($a_obj_id, $a_size, $a_type, $a_offline); }

References $a_type.

Referenced by ilObjQuestionPoolGUI\setTitleAndDescription().

Here is the caller graph for this function:

◆ _getIdForImportId()

static ilObject2::_getIdForImportId ( $a_import_id )

staticfinal

get current object id for import id (static)

Parameters

int $a_import_id import id

Returns: int id

Reimplemented from ilObject.

Definition at line 188 of file class.ilObject2.php.

188{ return parent::_getIdForImportId($a_import_id); }

◆ _getIdsForTitle()

static ilObject2::_getIdsForTitle	(	$title,
		$type = `''`,
		$partialmatch = `false`
	)

staticfinal

Reimplemented from ilObject.

Definition at line 192 of file class.ilObject2.php.

192{ return parent::_getIdsForTitle($title, $type, $partialmatch); }

ilObject\$type

$type

Definition: class.ilObject.php:45

ilObject\$title

$title

Definition: class.ilObject.php:46

References ilObject\$title, and ilObject\$type.

◆ _getLastUpdateOfObjects()

static ilObject2::_getLastUpdateOfObjects ( $a_objs )

staticfinal

Get last update for a set of media objects.

Parameters

array

Reimplemented from ilObject.

Definition at line 195 of file class.ilObject2.php.

195{ return parent::_getLastUpdateOfObjects($a_objs); }

◆ _getObjectsByType()

static ilObject2::_getObjectsByType	(	$a_obj_type = `""`,
		$a_owner = `""`
	)

staticfinal

Get objects by type.

Reimplemented from ilObject.

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

245{ return parent::_getObjectsByType($a_obj_type, $a_owner); }

◆ _getObjectsDataForType()

static ilObject2::_getObjectsDataForType	(	$a_type,
		$a_omit_trash = `false`
	)

staticfinal

get all objects of a certain type

Parameters

string	$a_type	desired object type
boolean	$a_omit_trash	omit objects, that are in trash only (default: false)

Returns: array array of object data arrays ("id", "title", "type", "description")

Reimplemented from ilObject.

Definition at line 207 of file class.ilObject2.php.

207{ return parent::_getObjectsDataForType($a_type, $a_omit_trash); }

References $a_type.

◆ _hasUntrashedReference()

static ilObject2::_hasUntrashedReference ( $a_obj_id )

staticfinal

checks wether an object has at least one reference that is not in trash

Reimplemented from ilObject.

Definition at line 205 of file class.ilObject2.php.

205{ return parent::_hasUntrashedReference($a_obj_id); }

◆ _isInTrash()

static ilObject2::_isInTrash ( $a_ref_id )

staticfinal

checks wether object is in trash

Reimplemented from ilObject.

Definition at line 204 of file class.ilObject2.php.

204{ return parent::_isInTrash($a_ref_id); }

◆ _lookupDeletedDate()

static ilObject2::_lookupDeletedDate ( $a_ref_id )

staticfinal

only called in ilObjectGUI::insertSavedNodes

Reimplemented from ilObject.

Definition at line 199 of file class.ilObject2.php.

199{ return parent::_lookupDeletedDate($a_ref_id); }

◆ _lookupDescription()

static ilObject2::_lookupDescription ( $a_id )

staticfinal

lookup object description

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 193 of file class.ilObject2.php.

193{ return parent::_lookupDescription($a_id); }

◆ _lookupLastUpdate()

static ilObject2::_lookupLastUpdate	(	$a_id,
		$a_as_string = `false`
	)

staticfinal

lookup last update

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 194 of file class.ilObject2.php.

194{ return parent::_lookupLastUpdate($a_id, $a_as_string); }

◆ _lookupObjectId()

static ilObject2::_lookupObjectId ( $a_ref_id )

staticfinal

lookup object id

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 206 of file class.ilObject2.php.

206{ return parent::_lookupObjectId($a_ref_id); }

Referenced by ilPollBlockGUI\commentJSCall(), ilPollBlockGUI\getNumberOfComments(), ilDclIliasReferenceRecordFieldModel\getStatus(), ilDclIliasReferenceRecordFieldModel\getValueForRepresentation(), ilDclTable\hasPermissionToDeleteRecord(), ilDclTable\hasPermissionToDeleteRecords(), ilDclTable\hasPermissionToEditRecord(), and ilDclTable\hasPermissionToViewRecord().

Here is the caller graph for this function:

◆ _lookupObjId()

static ilObject2::_lookupObjId ( $a_id )

staticfinal

Reimplemented from ilObject.

Definition at line 196 of file class.ilObject2.php.

196{ return parent::_lookupObjId($a_id); }

Referenced by ilDclBaseRecordModel\deleteMob().

Here is the caller graph for this function:

◆ _lookupObjIdByImportId()

static ilObject2::_lookupObjIdByImportId ( $a_import_id )

staticfinal

Reimplemented from ilObject.

Definition at line 60 of file class.ilObject2.php.

60{ return parent::_lookupObjIdByImportId($a_import_id); }

◆ _lookupOwner()

static ilObject2::_lookupOwner ( $a_id )

staticfinal

lookup object owner

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 191 of file class.ilObject2.php.

191{ return parent::_lookupOwner($a_id); }

◆ _lookupOwnerName()

static ilObject2::_lookupOwnerName ( $a_owner_id )

staticfinal

lookup owner name for owner id

Reimplemented from ilObject.

Definition at line 63 of file class.ilObject2.php.

63{ return parent::_lookupOwnerName($a_owner_id); }

◆ _lookupTitle()

static ilObject2::_lookupTitle ( $a_id )

staticfinal

lookup object title

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 190 of file class.ilObject2.php.

190{ return parent::_lookupTitle($a_id); }

Referenced by ilPortfolioRepositoryGUI\confirmPortfolioDeletion(), ilPortfolioHTMLExport\exportHTMLPages(), ilPortfolioPageTableGUI\fillRow(), ilDclIliasReferenceRecordFieldModel\getValueForRepresentation(), ilObjPortfolioBaseGUI\preview(), and ilPortfolioPageGUI\renderBlog().

Here is the caller graph for this function:

◆ _lookupType()

static ilObject2::_lookupType	(	$a_id,
		$a_reference = `false`
	)

staticfinal

lookup object type

Parameters

int $a_id object id

Reimplemented from ilObject.

Definition at line 203 of file class.ilObject2.php.

203{ return parent::_lookupType($a_id,$a_reference); }

Referenced by ilDclFileuploadRecordRepresentation\getHTML(), ilOrgUnitAppEventListener\handleEvent(), ilOrgUnitImporter\importXmlRepresentation(), ilDclFileuploadRecordFieldModel\parseExportValue(), ilDclFileuploadRecordRepresentation\parseFormInput(), ilDclMobRecordRepresentation\parseFormInput(), ilDclFileuploadRecordFieldModel\parseSortingValue(), and ilDclFileuploadFieldRepresentation\passThroughFilter().

Here is the caller graph for this function:

◆ _prepareCloneSelection()

static ilObject2::_prepareCloneSelection	(	$a_ref_ids,
		$new_type,
		$show_path = `true`
	)

staticfinal

Prepare copy wizard object selection.

This method should renamed. Currently used in ilObjsurvey and ilObjTest

Deprecated:: since version 5.2

@global type $ilDB @global type $lng @global type $objDefinition

Parameters

array	$a_ref_ids
string	$new_type
bool	$show_path

Returns: array

Reimplemented from ilObject.

Definition at line 247 of file class.ilObject2.php.

247{ return parent::_prepareCloneSelection($a_ref_ids,$new_type, $a_show_path); }

◆ _resetDeletedDate()

static ilObject2::_resetDeletedDate ( $a_ref_id )

staticfinal

only called in ilObjectGUI::insertSavedNodes

Reimplemented from ilObject.

Definition at line 198 of file class.ilObject2.php.

198{ return parent::_resetDeletedDate($a_ref_id); }

◆ _setDeletedDate()

static ilObject2::_setDeletedDate ( $a_ref_id )

staticfinal

only called in ilTree::saveSubTree

Reimplemented from ilObject.

Definition at line 197 of file class.ilObject2.php.

197{ return parent::_setDeletedDate($a_ref_id); }

◆ _writeDescription()

static ilObject2::_writeDescription	(	$a_obj_id,
		$a_desc
	)

staticfinal

write description to db (static)

Parameters

int	$a_obj_id	object id
string	$a_desc	description @access public

Reimplemented from ilObject.

Definition at line 201 of file class.ilObject2.php.

201{ return parent::_writeDescription($a_obj_id, $a_desc); }

◆ _writeImportId()

static ilObject2::_writeImportId	(	$a_obj_id,
		$a_import_id
	)

staticfinal

write import id to db (static)

Parameters

int	$a_obj_id	object id
string	$a_import_id	import id @access public

Reimplemented from ilObject.

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

202{ return parent::_writeImportId($a_obj_id, $a_import_id); }

◆ _writeTitle()

static ilObject2::_writeTitle	(	$a_obj_id,
		$a_title
	)

staticfinal

write title to db (static)

Parameters

int	$a_obj_id	object id
string	$a_title	title @access public

Reimplemented from ilObject.

Definition at line 200 of file class.ilObject2.php.

200{ return parent::_writeTitle($a_obj_id, $a_title); }

◆ appendCopyInfo()

ilObject2::appendCopyInfo	(	$a_target_id,
		$a_copy_id
	)

final

Prepend Copy info if object with same name exists in that container.

@access public

Parameters

int copy_id

Reimplemented from ilObject.

Definition at line 248 of file class.ilObject2.php.

248{ return parent::appendCopyInfo($a_target_id,$a_copy_id); }

◆ beforeCloneObject()

ilObject2::beforeCloneObject ( )

protected

Definition at line 269 of file class.ilObject2.php.

        {
                return true;
        }

Referenced by cloneObject().

Here is the caller graph for this function:

◆ beforeCreate()

ilObject2::beforeCreate ( )

protected

Reimplemented in ilRemoteObjectBase.

Definition at line 86 of file class.ilObject2.php.

        {
                return true;
        }

Referenced by create().

Here is the caller graph for this function:

◆ beforeCreateMetaData()

ilObject2::beforeCreateMetaData ( )

protected

Reimplemented in ilObjFile.

Definition at line 158 of file class.ilObject2.php.

        {
                return true;
        }

Referenced by createMetaData().

Here is the caller graph for this function:

◆ beforeDelete()

ilObject2::beforeDelete ( )

protected

Reimplemented in ilObjFile.

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

        {
                return true;
        }

Referenced by delete().

Here is the caller graph for this function:

◆ beforeMDUpdateListener()

ilObject2::beforeMDUpdateListener ( $a_element )

protected

Reimplemented in ilObjFile.

Definition at line 135 of file class.ilObject2.php.

        {
                return true;
        }

Referenced by MDUpdateListener().

Here is the caller graph for this function:

◆ beforeUpdate()

ilObject2::beforeUpdate ( )

protected

Reimplemented in ilObjFile.

Definition at line 112 of file class.ilObject2.php.

        {
                return true;
        }

Referenced by update().

Here is the caller graph for this function:

◆ beforeUpdateMetaData()

ilObject2::beforeUpdateMetaData ( )

protected

Reimplemented in ilObjFile.

Definition at line 181 of file class.ilObject2.php.

        {
                return true;
        }

Referenced by updateMetaData().

Here is the caller graph for this function:

◆ cloneDependencies()

ilObject2::cloneDependencies	(	$a_target_id,
		$a_copy_id
	)

Clone object dependencies.

This method allows to refresh any ref id references to other objects that are affected in the same copy process. Ask ilCopyWizardOptions for the mappings.

@access public

Parameters

int	ref_id of target object
int	copy_id

Reimplemented from ilObject.

Reimplemented in ilObjItemGroup, and ilObjWorkspaceFolder.

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

274{ return parent::cloneDependencies($a_target_id,$a_copy_id); }

◆ cloneMetaData()

ilObject2::cloneMetaData ( $target_obj )

final

Copy meta data.

@access public

Parameters

object target object

Reimplemented from ilObject.

Definition at line 249 of file class.ilObject2.php.

249{ return parent::cloneMetaData($target_obj); }

Referenced by ilObjFile\doCloneObject().

Here is the caller graph for this function:

◆ cloneObject()

ilObject2::cloneObject	(	$a_target_id,
		$a_copy_id = `null`,
		$a_omit_tree = `false`
	)

final

Clone object permissions, put in tree ...

@access public

Parameters

int	target id
int	copy id for class.ilCopyWizardOptions()

Returns: object new object

Reimplemented from ilObject.

Definition at line 251 of file class.ilObject2.php.

        {
                if($this->beforeCloneObject())
                {
                        $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
                        if($new_obj)
                        {
                                $this->doCloneObject($new_obj, $a_target_id, $a_copy_id);
                                return $new_obj;
                        }
                }
        }

References beforeCloneObject(), and doCloneObject().

Here is the call graph for this function:

◆ countReferences()

ilObject2::countReferences ( )

final

count references of object

@access public

Returns: integer number of references for this object

Reimplemented from ilObject.

Definition at line 211 of file class.ilObject2.php.

211{ return parent::countReferences(); }

◆ create()

ilObject2::create ( $a_clone_mode = false )

final

Definition at line 68 of file class.ilObject2.php.

        {
                if($this->beforeCreate())
                {
                        $id = parent::create();
                        if($id)
                        {
                                $this->doCreate($a_clone_mode);
                                return $id;
                        }
                }
        }

References ilObject\$id, beforeCreate(), and doCreate().

Here is the call graph for this function:

◆ createMetaData()

ilObject2::createMetaData ( )

final

create meta data entry

Reimplemented from ilObject.

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

        {
                if($this->beforeCreateMetaData())
                {
                        if(parent::createMetaData())
                        {
                                $this->doCreateMetaData();
                                return true;
                        }
                }
                return false;
        }

References beforeCreateMetaData(), and doCreateMetaData().

Referenced by ilObjFile\createProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createReference()

ilObject2::createReference ( )

final

creates reference for object

@access public

Returns: integer reference_id of object

Reimplemented from ilObject.

Definition at line 210 of file class.ilObject2.php.

210{ return parent::createReference(); }

Referenced by ilRemoteObjectBase\createFromECSEContent().

Here is the caller graph for this function:

◆ delete()

ilObject2::delete ( )

final

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

@access public

Returns: boolean true if object was removed completely; false if only a references was removed

Reimplemented from ilObject.

Definition at line 213 of file class.ilObject2.php.

        {
                if($this->beforeDelete())
                {
                        if(parent::delete())
                        {
                                $this->doDelete();
                                $this->id = null;
                                return true;
                        }                       
                }               
                return false;
        }

References beforeDelete(), and doDelete().

Here is the call graph for this function:

◆ deleteMetaData()

ilObject2::deleteMetaData ( )

final

delete meta data entry

Reimplemented from ilObject.

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

186{ return parent::deleteMetaData(); }

Referenced by ilObjFile\doDelete().

Here is the caller graph for this function:

◆ doCloneObject()

ilObject2::doCloneObject	(	$new_obj,
		$a_target_id,
		$a_copy_id = `null`
	)

protected

Reimplemented in ilObjFile, ilObjTaxonomy, ilObjWorkspaceFolder, ilObjPoll, and ilObjPortfolioTemplate.

Definition at line 264 of file class.ilObject2.php.

        {
                
        }

Referenced by cloneObject().

Here is the caller graph for this function:

◆ doCreate()

ilObject2::doCreate ( )

protected

Reimplemented in ilObjBibliographic, ilObjBlog, ilObjCloud, ilObjItemGroup, ilObjPoll, ilObjPortfolioBase, ilObjPortfolioTemplate, ilObjTaxonomy, ilVerificationObject, and ilRemoteObjectBase.

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

        {
                
        }

Referenced by create().

Here is the caller graph for this function:

◆ doCreateMetaData()

ilObject2::doCreateMetaData ( )

protected

Reimplemented in ilObjFile.

Definition at line 153 of file class.ilObject2.php.

        {
                
        }

Referenced by createMetaData().

Here is the caller graph for this function:

◆ doDelete()

ilObject2::doDelete ( )

protected

Reimplemented in ilObjBlog, ilObjCloud, ilObjDataCollection, ilObjFile, ilObjItemGroup, ilObjPoll, ilObjPortfolioBase, ilObjTaxonomy, ilVerificationObject, and ilRemoteObjectBase.

Definition at line 227 of file class.ilObject2.php.

        {
 
        }

Referenced by delete(), and ilObjBibliographic\doUpdate().

Here is the caller graph for this function:

◆ doMDUpdateListener()

ilObject2::doMDUpdateListener ( $a_element )

protected

Reimplemented in ilObjFile.

Definition at line 130 of file class.ilObject2.php.

        {
                
        }

Referenced by MDUpdateListener().

Here is the caller graph for this function:

◆ doRead()

ilObject2::doRead ( )

protected

Reimplemented in ilObjBibliographic, ilObjBlog, ilObjCloud, ilObjDataCollection, ilObjFile, ilObjItemGroup, ilObjPoll, ilObjPortfolioBase, ilObjPortfolioTemplate, ilObjTaxonomy, ilVerificationObject, and ilRemoteObjectBase.

Definition at line 40 of file class.ilObject2.php.

        {
                
        }

Referenced by read().

Here is the caller graph for this function:

◆ doUpdate()

ilObject2::doUpdate ( )

protected

Reimplemented in ilObjBibliographic, ilObjBlog, ilObjCloud, ilObjDataCollection, ilObjFile, ilObjItemGroup, ilObjPoll, ilObjPortfolio, ilObjPortfolioBase, ilObjPortfolioTemplate, ilObjTaxonomy, ilVerificationObject, and ilRemoteObjectBase.

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

        {
                
        }

Referenced by update().

Here is the caller graph for this function:

◆ doUpdateMetaData()

ilObject2::doUpdateMetaData ( )

protected

Reimplemented in ilObjFile.

Definition at line 176 of file class.ilObject2.php.

        {
                
        }

Referenced by updateMetaData().

Here is the caller graph for this function:

◆ getCreateDate()

ilObject2::getCreateDate ( )

final

get create date @access public

Returns: string creation date

Reimplemented from ilObject.

Definition at line 65 of file class.ilObject2.php.

65{ return parent::getCreateDate(); }

◆ getDescription()

ilObject2::getDescription ( )

final

get object description

@access public

Returns: string object description

Reimplemented from ilObject.

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

55{ return parent::getDescription(); }

Referenced by ilObjFile\addNewsNotification(), ilObjTaxonomy\doCloneObject(), and ilRemoteObjectBase\sendNewContentNotification().

Here is the caller graph for this function:

◆ getId()

ilObject2::getId ( )

get object id @access public

Returns: integer object id

Reimplemented from ilObject.

Definition at line 45 of file class.ilObject2.php.

45{ return parent::getId(); }

Here is the caller graph for this function:

◆ getImportId()

ilObject2::getImportId ( )

final

get import id

@access public

Returns: string import id

Reimplemented from ilObject.

Definition at line 58 of file class.ilObject2.php.

58{ return parent::getImportId(); }

◆ getLastUpdateDate()

ilObject2::getLastUpdateDate ( )

final

get last update date @access public

Returns: string date of last update

Reimplemented from ilObject.

Definition at line 66 of file class.ilObject2.php.

66{ return parent::getLastUpdateDate(); }

◆ getLongDescription()

ilObject2::getLongDescription ( )

final

get object long description (stored in object_description)

@access public

Returns: string object description

Reimplemented from ilObject.

Definition at line 57 of file class.ilObject2.php.

57{ return parent::getLongDescription(); }

◆ getOwner()

ilObject2::getOwner ( )

final

get object owner

@access public

Returns: integer owner id

Reimplemented from ilObject.

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

61{ return parent::getOwner(); }

◆ getOwnerName()

ilObject2::getOwnerName ( )

final

Reimplemented from ilObject.

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

62{ return parent::getOwnerName(); }

◆ getPresentationTitle()

ilObject2::getPresentationTitle ( )

final

get presentation title Normally same as title Overwritten for sessions

@access public

Parameters

return

Reimplemented from ilObject.

Definition at line 51 of file class.ilObject2.php.

51{ return parent::getPresentationTitle(); }

◆ getRefId()

ilObject2::getRefId ( )

final

get reference id @access public

Returns: integer reference id

Reimplemented from ilObject.

Definition at line 48 of file class.ilObject2.php.

48{ return parent::getRefId(); }

Referenced by ilObjItemGroup\cloneDependencies(), ilObjDataCollection\doCloneObject(), ilObjWorkspaceFolder\downloadFolder(), ilObjBlog\initDefaultRoles(), and ilRemoteObjectBase\sendNewContentNotification().

Here is the caller graph for this function:

◆ getTitle()

ilObject2::getTitle ( )

final

get object title @access public

Returns: string object title

Reimplemented from ilObject.

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

52{ return parent::getTitle(); }

Referenced by ilObjTaxonomy\doCloneObject(), ilObjDataCollection\doCreate(), ilObjWorkspaceFolder\downloadFolder(), ilObjFile\getFileExtension(), ilVerificationObject\getOfflineFilename(), ilObjFile\getUploadFile(), ilObjFile\isHidden(), ilObjFile\isInline(), ilRemoteObjectBase\sendNewContentNotification(), and ilObjFile\updateWithVersion().

Here is the caller graph for this function:

◆ getType()

ilObject2::getType ( )

final

get object type @access public

Returns: string object type

Reimplemented from ilObject.

Definition at line 49 of file class.ilObject2.php.

49{ return parent::getType(); }

Referenced by ilObjFile\addNewsNotification(), ilObjFile\beforeMDUpdateListener(), ilObjFile\doCreateMetaData(), ilObjFile\doMDUpdateListener(), ilObjPoll\doRead(), ilObjPortfolioBase\doRead(), ilObjPoll\doUpdate(), ilObjPortfolioBase\doUpdate(), ilObjFile\doUpdateMetaData(), ilObjBibliographic\getFileDirectory(), ilOrgUnitExtension\getPlugin(), ilObjectPlugin\getPlugin(), ilObjFile\getVersions(), ilObjBlog\handleQuotaUpdate(), ilObjPortfolio\handleQuotaUpdate(), ilVerificationObject\handleQuotaUpdate(), ilObjFile\handleQuotaUpdate(), ilRemoteObjectBase\importMetadataFromJson(), and ilRemoteObjectBase\sendNewContentNotification().

Here is the caller graph for this function:

◆ getUntranslatedTitle()

ilObject2::getUntranslatedTitle ( )

final

get untranslated object title @access public

Returns: string object title

Reimplemented from ilObject.

Definition at line 53 of file class.ilObject2.php.

53{ return parent::getUntranslatedTitle(); }

◆ initDefaultRoles()

ilObject2::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

Returns: array empty array

Reimplemented from ilObject.

Reimplemented in ilObjBlog.

Definition at line 237 of file class.ilObject2.php.

237{ return array(); }

◆ initType()

ilObject2::initType ( )

abstractprotected

Reimplemented in ilObjBibliographic, ilObjBlog, ilObjCloud, ilObjCourseVerification, ilObjDataCollection, ilObjExerciseVerification, ilObjFile, ilObjItemGroup, ilObjPoll, ilObjPortfolio, ilObjPortfolioTemplate, ilObjRemoteCategory, ilObjRemoteCourse, ilObjRemoteFile, ilObjRemoteGlossary, ilObjRemoteGroup, ilObjRemoteLearningModule, ilObjRemoteTest, ilObjRemoteWiki, ilObjSCORMVerification, ilObjStudyProgrammeAdmin, ilStudyProgrammeLeafMock, ilObjTestVerification, ilObjWikiSettings, ilObjWorkspaceFolder, ilObjWorkspaceRootFolder, ilObjContactAdministration, ilObjHelpSettings, ilObjTaxonomy, and ilObjTermsOfService.

Referenced by __construct(), and ilObjectPlugin\__construct().

Here is the caller graph for this function:

◆ isUserRegistered()

ilObject2::isUserRegistered ( $a_user_id = 0 )

final

Reimplemented from ilObject.

Definition at line 241 of file class.ilObject2.php.

241{ return parent::isUserRegistered($a_user_id); }

◆ MDUpdateListener()

ilObject2::MDUpdateListener ( $a_element )

final

Meta data update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Parameters

string $a_element

Reimplemented from ilObject.

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

        {
                if($this->beforeMDUpdateListener($a_element))
                {
                        if(parent::MDUpdateListener($a_element))
                        {
                                $this->doMDUpdateListener($a_element);
                                return true;
                        }
                }
                return false;
        }

References beforeMDUpdateListener(), and doMDUpdateListener().

Here is the call graph for this function:

◆ putInTree()

ilObject2::putInTree ( $a_parent_ref )

final

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Reimplemented from ilObject.

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

208{ return parent::putInTree($a_parent_ref); }

Referenced by ilRemoteObjectBase\createFromECSEContent().

Here is the caller graph for this function:

◆ read()

ilObject2::read ( )

final

Read data from db.

Reimplemented from ilObject.

Definition at line 35 of file class.ilObject2.php.

        {
                parent::read();
                $this->doRead();
        }

References doRead().

Here is the call graph for this function:

◆ requireRegistration()

ilObject2::requireRegistration ( )

final

Reimplemented from ilObject.

Definition at line 242 of file class.ilObject2.php.

242{ return parent::requireRegistration(); }

◆ setDescription()

ilObject2::setDescription ( $a_desc )

final

set object description

@access public

Parameters

string $a_desc object description

Reimplemented from ilObject.

Definition at line 56 of file class.ilObject2.php.

56{ return parent::setDescription($a_desc); }

Referenced by ilObjBibliographic\cloneStructure(), and ilRemoteObjectBase\updateFromECSContent().

Here is the caller graph for this function:

◆ setId()

ilObject2::setId ( $a_id )

set object id @access public

Parameters

integer $a_id object id

Reimplemented from ilObject.

Reimplemented in ilObjItemGroup.

Definition at line 46 of file class.ilObject2.php.

46{ return parent::setId($a_id); }

Referenced by ilObjBibliographic\__construct().

Here is the caller graph for this function:

◆ setImportId()

ilObject2::setImportId ( $a_import_id )

final

set import id

@access public

Parameters

string $a_import_id import id

Reimplemented from ilObject.

Definition at line 59 of file class.ilObject2.php.

59{ return parent::setImportId($a_import_id); }

◆ setOwner()

ilObject2::setOwner ( $a_owner )

final

set object owner

@access public

Parameters

integer $a_owner owner id

Reimplemented from ilObject.

Definition at line 64 of file class.ilObject2.php.

64{ return parent::setOwner($a_owner); }

Referenced by ilRemoteObjectBase\beforeCreate().

Here is the caller graph for this function:

◆ setPermissions()

ilObject2::setPermissions ( $a_parent_ref )

final

set permissions of object

Parameters

integer reference_id of parent object @access public

Reimplemented from ilObject.

Definition at line 209 of file class.ilObject2.php.

209{ return parent::setPermissions($a_parent_ref); }

Referenced by ilRemoteObjectBase\createFromECSEContent().

Here is the caller graph for this function:

◆ setRefId()

ilObject2::setRefId ( $a_id )

final

set reference id @access public

Parameters

integer $a_id reference id

Reimplemented from ilObject.

Definition at line 47 of file class.ilObject2.php.

47{ return parent::setRefId($a_id); }

◆ setRegisterMode()

ilObject2::setRegisterMode ( $a_bool )

final

Reimplemented from ilObject.

Definition at line 240 of file class.ilObject2.php.

240{ return parent::setRegisterMode($a_bool); }

◆ setTitle()

ilObject2::setTitle ( $a_title )

final

set object title

@access public

Parameters

string $a_title object title

Reimplemented from ilObject.

Definition at line 54 of file class.ilObject2.php.

54{ return parent::setTitle($a_title); }

Referenced by ilObjBibliographic\cloneStructure(), ilObjFile\getUploadFile(), ilRemoteObjectBase\updateFromECSContent(), and ilObjFile\updateWithVersion().

Here is the caller graph for this function:

◆ setType()

ilObject2::setType ( $a_type )

final

set object type @access public

Parameters

integer $a_type object type

Reimplemented from ilObject.

Definition at line 50 of file class.ilObject2.php.

50{ return parent::setType($a_type); }

References $a_type.

Referenced by ilObjBibliographic\cloneStructure().

Here is the caller graph for this function:

◆ update()

ilObject2::update ( )

final

update object in db

@access public

Returns: boolean true on success

Reimplemented from ilObject.

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

        {
                if($this->beforeUpdate())
                {
                        if (!parent::update())
                        {
                                return false;
                        }
                        $this->doUpdate();
                        
                        return true;
                }
                
                return false;
        }

References beforeUpdate(), and doUpdate().

Referenced by ilObjPortfolioBase\cloneBasics(), ilObjFile\getUploadFile(), ilRemoteObjectBase\updateFromECSContent(), and ilObjFile\updateWithVersion().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMetaData()

ilObject2::updateMetaData ( )

final

update meta data entry

Reimplemented from ilObject.

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

        {
                if($this->beforeUpdateMetaData())
                {
                        if(parent::updateMetaData())
                        {
                                $this->doUpdateMetaData();
                                return true;
                        }
                }
                return false;
        }

References beforeUpdateMetaData(), and doUpdateMetaData().

Referenced by ilObjFile\beforeUpdate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateOwner()

ilObject2::updateOwner ( )

final

update owner of object in db

@access public

Returns: boolean true on success

Reimplemented from ilObject.

Definition at line 187 of file class.ilObject2.php.

187{ return parent::updateOwner(); }

◆ withReferences()

ilObject2::withReferences ( )

final

determines wehter objects are referenced or not (got ref ids or not)

Reimplemented from ilObject.

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

30{ return parent::withReferences(); }

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

Services/Object/classes/class.ilObject2.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _exists()

◆ _getAllReferences()

◆ _getIcon()

◆ _getIdForImportId()

◆ _getIdsForTitle()

◆ _getLastUpdateOfObjects()

◆ _getObjectsByType()

◆ _getObjectsDataForType()

◆ _hasUntrashedReference()

◆ _isInTrash()

◆ _lookupDeletedDate()

◆ _lookupDescription()

◆ _lookupLastUpdate()

◆ _lookupObjectId()

◆ _lookupObjId()

◆ _lookupObjIdByImportId()

◆ _lookupOwner()

◆ _lookupOwnerName()

◆ _lookupTitle()

◆ _lookupType()

◆ _prepareCloneSelection()

◆ _resetDeletedDate()

◆ _setDeletedDate()

◆ _writeDescription()

◆ _writeImportId()

◆ _writeTitle()

◆ appendCopyInfo()

◆ beforeCloneObject()

◆ beforeCreate()

◆ beforeCreateMetaData()

◆ beforeDelete()

◆ beforeMDUpdateListener()

◆ beforeUpdate()

◆ beforeUpdateMetaData()

◆ cloneDependencies()

◆ cloneMetaData()

◆ cloneObject()

◆ countReferences()

◆ create()

◆ createMetaData()

◆ createReference()

◆ delete()

◆ deleteMetaData()

◆ doCloneObject()

◆ doCreate()

◆ doCreateMetaData()

◆ doDelete()

◆ doMDUpdateListener()

◆ doRead()

◆ doUpdate()

◆ doUpdateMetaData()

◆ getCreateDate()

◆ getDescription()

◆ getId()

◆ getImportId()

◆ getLastUpdateDate()

◆ getLongDescription()

◆ getOwner()

◆ getOwnerName()

◆ getPresentationTitle()

◆ getRefId()

◆ getTitle()

◆ getType()

◆ getUntranslatedTitle()

◆ initDefaultRoles()

◆ initType()

◆ isUserRegistered()

◆ MDUpdateListener()

◆ putInTree()

◆ read()

◆ requireRegistration()

◆ setDescription()