ILIAS  release_7 Revision v7.30-3-g800a261c036
ilObject2 Class Reference

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...
 
 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)
 
 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...
 
 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 ()
 
 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, $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)
 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 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 _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 ()
 If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned. More...
 
 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
 
 $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 inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

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
integerreference_id or object_id
booleantreat the id as reference_id (true) or object_id (false)

Reimplemented from ilObject.

Reimplemented in ilObjContentPageAdministration, ilObjLearningSequenceAdmin, ilObjStudyProgrammeAdmin, ilStudyProgrammeLeafMock, ilRemoteObjectBase, ilObjBlog, ilObjCmiXapi, ilObjContentPage, ilObjItemGroup, ilObjPoll, ilObjPortfolioBase, ilObjWorkspaceFolder, ilObjWorkspaceRootFolder, ilObjTermsOfService, ilVerificationObject, and ilObjCloud.

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

23 {
24 $this->initType();
25 parent::__construct($a_id, $a_reference);
26 }
__construct(Container $dic, ilPlugin $plugin)
@inheritDoc

References ILIAS\GlobalScreen\Provider\__construct(), and 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
integerobject id or reference id
booleantrue if id is a reference, else false (default)
stringrestrict on a certain type.
Returns
boolean true if object exists

Reimplemented from ilObject.

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

368 {
369 return parent::_exists($a_id, $a_reference, $a_type);
370 }

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

◆ _getIcon()

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

Get icon for repository item.

Parameters
intobject id
stringsize (big, small, tiny)
stringobject type
booleantrue: offline, false: online

Reimplemented from ilObject.

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

429 {
430 return parent::_getIcon($a_obj_id, $a_size, $a_type, $a_offline);
431 }

Referenced by ilLSItemsDB\getIconPathForType(), ilLSItemsDB\getLSItems(), and 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_idimport id
Returns
int id

Reimplemented from ilObject.

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

245 {
246 return parent::_getIdForImportId($a_import_id);
247 }

◆ _getIdsForTitle()

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

Reimplemented from ilObject.

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

261 {
262 return parent::_getIdsForTitle($title, $type, $partialmatch);
263 }

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 272 of file class.ilObject2.php.

273 {
274 return parent::_getLastUpdateOfObjects($a_objs);
275 }

◆ _getObjectsByType()

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

Get objects by type.

Reimplemented from ilObject.

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

386 {
387 return parent::_getObjectsByType($a_obj_type, $a_owner);
388 }

Referenced by ilFileUtils\getExplicitlyBlockedFiles(), and ILIAS\PersonalDesktop\PDMainBarProvider\getStaticSubItems().

+ Here is the caller graph for this function:

◆ _getObjectsDataForType()

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

get all objects of a certain type

Parameters
string$a_typedesired object type
boolean$a_omit_trashomit 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 320 of file class.ilObject2.php.

321 {
322 return parent::_getObjectsDataForType($a_type, $a_omit_trash);
323 }

◆ _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 312 of file class.ilObject2.php.

313 {
314 return parent::_hasUntrashedReference($a_obj_id);
315 }

◆ _isInTrash()

static ilObject2::_isInTrash (   $a_ref_id)
staticfinal

checks wether object is in trash

Reimplemented from ilObject.

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

309 {
310 return parent::_isInTrash($a_ref_id);
311 }

◆ _lookupDeletedDate()

static ilObject2::_lookupDeletedDate (   $a_ref_id)
staticfinal

only called in ilObjectGUI::insertSavedNodes

Reimplemented from ilObject.

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

289 {
290 return parent::_lookupDeletedDate($a_ref_id);
291 }

◆ _lookupDescription()

static ilObject2::_lookupDescription (   $a_id)
staticfinal

lookup object description

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

265 {
266 return parent::_lookupDescription($a_id);
267 }

◆ _lookupLastUpdate()

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

lookup last update

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

269 {
270 return parent::_lookupLastUpdate($a_id, $a_as_string);
271 }

◆ _lookupObjectId()

◆ _lookupObjId()

static ilObject2::_lookupObjId (   $a_id)
staticfinal

Reimplemented from ilObject.

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

277 {
278 return parent::_lookupObjId($a_id);
279 }

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 99 of file class.ilObject2.php.

100 {
101 return parent::_lookupObjIdByImportId($a_import_id);
102 }

◆ _lookupOwner()

static ilObject2::_lookupOwner (   $a_id)
staticfinal

lookup object owner

Parameters
int$a_idobject id

Reimplemented from ilObject.

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

257 {
258 return parent::_lookupOwner($a_id);
259 }

Referenced by ilPortfolioPageGUI\makePlaceHoldersClickable(), ilPortfolioRepositoryGUI\setOffline(), ilPortfolioRepositoryGUI\setOnline(), and ilObjPortfolioGUI\setOnlineAndShare().

+ Here is the caller graph for this function:

◆ _lookupOwnerName()

static ilObject2::_lookupOwnerName (   $a_owner_id)
staticfinal

lookup owner name for owner id

Reimplemented from ilObject.

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

112 {
113 return parent::_lookupOwnerName($a_owner_id);
114 }

◆ _lookupTitle()

◆ _lookupType()

◆ _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
Parameters
array$a_ref_ids
string$new_type
bool$show_path
Returns
array

Reimplemented from ilObject.

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

391 {
392 return parent::_prepareCloneSelection($a_ref_ids, $new_type, $a_show_path);
393 }

◆ _resetDeletedDate()

static ilObject2::_resetDeletedDate (   $a_ref_id)
staticfinal

only called in ilObjectGUI::insertSavedNodes

Reimplemented from ilObject.

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

285 {
286 return parent::_resetDeletedDate($a_ref_id);
287 }

◆ _setDeletedDate()

static ilObject2::_setDeletedDate (   $a_ref_id,
  $a_deleted_by 
)
staticfinal
Parameters
$a_ref_id
int$a_deleted_by

Reimplemented from ilObject.

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

281 {
282 return parent::_setDeletedDate($a_ref_id, $a_deleted_by);
283 }

◆ _writeDescription()

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

write description to db (static)

Parameters
int$a_obj_idobject id
string$a_descdescription @access public

Reimplemented from ilObject.

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

297 {
298 return parent::_writeDescription($a_obj_id, $a_desc);
299 }

◆ _writeImportId()

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

write import id to db (static)

Parameters
int$a_obj_idobject id
string$a_import_idimport id @access public

Reimplemented from ilObject.

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

301 {
302 return parent::_writeImportId($a_obj_id, $a_import_id);
303 }

◆ _writeTitle()

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

write title to db (static)

Parameters
int$a_obj_idobject id
string$a_titletitle @access public

Reimplemented from ilObject.

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

293 {
294 return parent::_writeTitle($a_obj_id, $a_title);
295 }

◆ 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
intcopy_id

Reimplemented from ilObject.

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

395 {
396 return parent::appendCopyInfo($a_target_id, $a_copy_id);
397 }

◆ beforeCloneObject()

ilObject2::beforeCloneObject ( )
protected

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

419 {
420 return true;
421 }

Referenced by cloneObject().

+ Here is the caller graph for this function:

◆ beforeCreate()

ilObject2::beforeCreate ( )
protected

If overwritten this method should return true, there is currently no "abort" handling for cases where "false" is returned.

Returns
bool

Reimplemented in ilRemoteObjectBase.

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

149 {
150 return true;
151 }

Referenced by create().

+ Here is the caller graph for this function:

◆ beforeCreateMetaData()

ilObject2::beforeCreateMetaData ( )
protected

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

212 {
213 return true;
214 }

Referenced by createMetaData().

+ Here is the caller graph for this function:

◆ beforeDelete()

ilObject2::beforeDelete ( )
protected

Reimplemented in ilObjFile.

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

358 {
359 return true;
360 }

Referenced by delete().

+ Here is the caller graph for this function:

◆ beforeMDUpdateListener()

ilObject2::beforeMDUpdateListener (   $a_element)
protected

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

192 {
193 return true;
194 }

Referenced by MDUpdateListener().

+ Here is the caller graph for this function:

◆ beforeUpdate()

ilObject2::beforeUpdate ( )
protected

Reimplemented in ilObjFile.

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

172 {
173 return true;
174 }

Referenced by update().

+ Here is the caller graph for this function:

◆ beforeUpdateMetaData()

ilObject2::beforeUpdateMetaData ( )
protected

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

232 {
233 return true;
234 }

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
intref_id of target object
intcopy_id

Reimplemented from ilObject.

Reimplemented in ilObjItemGroup, and ilObjWorkspaceFolder.

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

424 {
425 return parent::cloneDependencies($a_target_id, $a_copy_id);
426 }

◆ cloneMetaData()

ilObject2::cloneMetaData (   $target_obj)
final

Copy meta data.

@access public

Parameters
objecttarget object

Reimplemented from ilObject.

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

399 {
400 return parent::cloneMetaData($target_obj);
401 }

Referenced by ilObjCmiXapi\doCloneObject().

+ Here is the caller graph for this function:

◆ cloneObject()

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

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

404 {
405 if ($this->beforeCloneObject()) {
406 $new_obj = parent::cloneObject($a_target_id, $a_copy_id, $a_omit_tree);
407 if ($new_obj) {
408 $this->doCloneObject($new_obj, $a_target_id, $a_copy_id);
409 return $new_obj;
410 }
411 }
412 }
doCloneObject($new_obj, $a_target_id, $a_copy_id=null)

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 336 of file class.ilObject2.php.

337 {
338 return parent::countReferences();
339 }

◆ create()

ilObject2::create (   $a_clone_mode = false)
final

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

129 {
130 if ($this->beforeCreate()) {
131 $id = parent::create();
132 if ($id) {
133 $this->doCreate($a_clone_mode);
134 return $id;
135 }
136 }
137 }
beforeCreate()
If overwritten this method should return true, there is currently no "abort" handling for cases where...

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 196 of file class.ilObject2.php.

197 {
198 if ($this->beforeCreateMetaData()) {
199 if (parent::createMetaData()) {
200 $this->doCreateMetaData();
201 return true;
202 }
203 }
204 return false;
205 }

References beforeCreateMetaData(), and doCreateMetaData().

+ Here is the call 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 332 of file class.ilObject2.php.

333 {
334 return parent::createReference();
335 }

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 341 of file class.ilObject2.php.

342 {
343 if ($this->beforeDelete()) {
344 if (parent::delete()) {
345 $this->doDelete();
346 $this->id = null;
347 return true;
348 }
349 }
350 return false;
351 }

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 236 of file class.ilObject2.php.

237 {
238 return parent::deleteMetaData();
239 }

Referenced by ilObjCmiXapi\doDelete(), and 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 ilObjTaxonomy, ilObjWorkspaceFolder, ilObjPoll, and ilObjPortfolioTemplate.

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

415 {
416 }

Referenced by cloneObject().

+ Here is the caller graph for this function:

◆ doCreate()

ilObject2::doCreate ( )
protected

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

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

140 {
141 }

Referenced by create().

+ Here is the caller graph for this function:

◆ doCreateMetaData()

ilObject2::doCreateMetaData ( )
protected

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

208 {
209 }

Referenced by createMetaData().

+ Here is the caller graph for this function:

◆ doDelete()

ilObject2::doDelete ( )
protected

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

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

354 {
355 }

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

+ Here is the caller graph for this function:

◆ doMDUpdateListener()

ilObject2::doMDUpdateListener (   $a_element)
protected

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

188 {
189 }

Referenced by MDUpdateListener().

+ Here is the caller graph for this function:

◆ doRead()

ilObject2::doRead ( )
protected

◆ doUpdate()

ilObject2::doUpdate ( )
protected

◆ doUpdateMetaData()

ilObject2::doUpdateMetaData ( )
protected

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

228 {
229 }

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 119 of file class.ilObject2.php.

120 {
121 return parent::getCreateDate();
122 }

◆ getDescription()

ilObject2::getDescription ( )
final

get object description

@access public

Returns
string object description

Reimplemented from ilObject.

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

80 {
81 return parent::getDescription();
82 }

Referenced by ilObjLTIConsumer\buildLaunchParameters(), ilObjTaxonomy\doCloneObject(), ilObjFile\doCreate(), ilObjFile\doUpdate(), ilObjCmiXapi\getStatementContextActivities(), ilObjCmiXapi\getStatementObject(), and ilRemoteObjectBase\sendNewContentNotification().

+ 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 91 of file class.ilObject2.php.

92 {
93 return parent::getImportId();
94 }

◆ getLastUpdateDate()

ilObject2::getLastUpdateDate ( )
final

get last update date @access public

Returns
string date of last update

Reimplemented from ilObject.

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

124 {
125 return parent::getLastUpdateDate();
126 }

◆ getLongDescription()

ilObject2::getLongDescription ( )
final

get object long description (stored in object_description)

@access public

Returns
string object description

Reimplemented from ilObject.

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

88 {
89 return parent::getLongDescription();
90 }

Referenced by ilObjContentPage\doUpdate().

+ Here is the caller graph for this function:

◆ getOwner()

ilObject2::getOwner ( )
final

get object owner

@access public

Returns
integer owner id

Reimplemented from ilObject.

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

104 {
105 return parent::getOwner();
106 }

◆ getOwnerName()

ilObject2::getOwnerName ( )
final

Reimplemented from ilObject.

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

108 {
109 return parent::getOwnerName();
110 }

◆ getPresentationTitle()

ilObject2::getPresentationTitle ( )
final

get presentation title Normally same as title Overwritten for sessions

@access public

Parameters

return

Reimplemented from ilObject.

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

64 {
65 return parent::getPresentationTitle();
66 }

◆ getRefId()

ilObject2::getRefId ( )
final

get reference id @access public

Returns
integer reference id

Reimplemented from ilObject.

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

52 {
53 return parent::getRefId();
54 }

Referenced by ilBiblFactoryFacade\__construct(), ilObjLTIConsumer\buildLaunchParameters(), ilObjItemGroup\cloneDependencies(), ilObjDataCollection\doCloneObject(), ilCmiXapiUser\generateRegistration(), ilObjCmiXapi\getLaunchData(), ilObjBlog\initDefaultRoles(), ilRemoteObjectBase\sendNewContentNotification(), and ilObjContentPage\trackProgress().

+ Here is the caller graph for this function:

◆ getTitle()

ilObject2::getTitle ( )
final

◆ getType()

◆ getUntranslatedTitle()

ilObject2::getUntranslatedTitle ( )
final

get untranslated object title @access public

Returns
string object title

Reimplemented from ilObject.

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

72 {
73 return parent::getUntranslatedTitle();
74 }

◆ 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 362 of file class.ilObject2.php.

363 {
364 return array();
365 }

◆ initType()

◆ isUserRegistered()

ilObject2::isUserRegistered (   $a_user_id = 0)
final

Reimplemented from ilObject.

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

376 {
377 return parent::isUserRegistered($a_user_id);
378 }

◆ 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 176 of file class.ilObject2.php.

177 {
178 if ($this->beforeMDUpdateListener($a_element)) {
179 if (parent::MDUpdateListener($a_element)) {
180 $this->doMDUpdateListener($a_element);
181 return true;
182 }
183 }
184 return false;
185 }
doMDUpdateListener($a_element)
beforeMDUpdateListener($a_element)

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
Parameters
int$a_parent_refRef-ID of the parent object

Reimplemented from ilObject.

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

325 {
326 return parent::putInTree($a_parent_ref);
327 }

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 38 of file class.ilObject2.php.

39 {
40 parent::read();
41 $this->doRead();
42 }

References doRead().

+ Here is the call graph for this function:

◆ requireRegistration()

ilObject2::requireRegistration ( )
final

Reimplemented from ilObject.

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

380 {
381 return parent::requireRegistration();
382 }

◆ setDescription()

ilObject2::setDescription (   $a_desc)
final

set object description

@access public

Parameters
string$a_descobject description

Reimplemented from ilObject.

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

84 {
85 return parent::setDescription($a_desc);
86 }

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

+ Here is the caller graph for this function:

◆ setImportId()

ilObject2::setImportId (   $a_import_id)
final

set import id

@access public

Parameters
string$a_import_idimport id

Reimplemented from ilObject.

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

96 {
97 return parent::setImportId($a_import_id);
98 }

◆ setOwner()

ilObject2::setOwner (   $a_owner)
final

set object owner

@access public

Parameters
integer$a_ownerowner id

Reimplemented from ilObject.

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

116 {
117 return parent::setOwner($a_owner);
118 }

Referenced by ilRemoteObjectBase\beforeCreate().

+ Here is the caller graph for this function:

◆ setPermissions()

ilObject2::setPermissions (   $a_parent_ref)
final

set permissions of object

Parameters
integerreference_id of parent object @access public

Reimplemented from ilObject.

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

329 {
330 return parent::setPermissions($a_parent_ref);
331 }

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_idreference id

Reimplemented from ilObject.

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

48 {
49 return parent::setRefId($a_id);
50 }

◆ setRegisterMode()

ilObject2::setRegisterMode (   $a_bool)
final

Reimplemented from ilObject.

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

372 {
373 return parent::setRegisterMode($a_bool);
374 }

◆ setTitle()

ilObject2::setTitle (   $a_title)
final

set object title

@access public

Parameters
string$a_titleobject title

Reimplemented from ilObject.

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

76 {
77 return parent::setTitle($a_title);
78 }

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

+ Here is the caller graph for this function:

◆ setType()

ilObject2::setType (   $a_type)
final

set object type @access public

Parameters
integer$a_typeobject type

Reimplemented from ilObject.

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

60 {
61 return parent::setType($a_type);
62 }

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 153 of file class.ilObject2.php.

154 {
155 if ($this->beforeUpdate()) {
156 if (!parent::update()) {
157 return false;
158 }
159 $this->doUpdate();
160
161 return true;
162 }
163
164 return false;
165 }

References beforeUpdate(), and doUpdate().

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

+ 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 216 of file class.ilObject2.php.

217 {
218 if ($this->beforeUpdateMetaData()) {
219 if (parent::updateMetaData()) {
220 $this->doUpdateMetaData();
221 return true;
222 }
223 }
224 return false;
225 }

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 240 of file class.ilObject2.php.

241 {
242 return parent::updateOwner();
243 }

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

31 {
32 return parent::withReferences();
33 }

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