Class ilObjDataCollection. More...
Inheritance diagram for ilObjDataCollection:
Collaboration diagram for ilObjDataCollection:
Public Member Functions | |
| initType () | |
| doRead () | |
| doClone () | |
| doUpdate () | |
| reorderTables ($table_order) | |
| doCloneObject ($new_obj, $a_target_id, $a_copy_id=null, $a_omit_tree=false) | |
| Clone DCL. More... | |
| cloneStructure ($original_id) | |
| Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id)) More... | |
| setOnline ($a_val) | |
| setOnline More... | |
| getOnline () | |
| getOnline More... | |
| setRating ($a_val) | |
| setRating More... | |
| getRating () | |
| getRating More... | |
| setPublicNotes ($a_val) | |
| setPublicNotes More... | |
| getPublicNotes () | |
| getPublicNotes More... | |
| setApproval ($a_val) | |
| setApproval More... | |
| getApproval () | |
| getApproval More... | |
| setNotification ($a_val) | |
| setNotification More... | |
| getNotification () | |
| getNotification More... | |
| getTables () | |
| getTableById ($table_id) | |
| getVisibleTables () | |
| getStyleSheetId () | |
| Public Member Functions inherited from ilObject2 | |
| __construct ($a_id=0, $a_reference=true) | |
| Constructor public. More... | |
| withReferences () | |
| read () | |
| Read data from db. More... | |
| getId () | |
| setId ($a_id) | |
| setRefId ($a_id) | |
| getRefId () | |
| getType () | |
| setType ($a_type) | |
| getPresentationTitle () | |
| getTitle () | |
| getUntranslatedTitle () | |
| setTitle ($a_title) | |
| getDescription () | |
| setDescription ($a_desc) | |
| getLongDescription () | |
| getImportId () | |
| setImportId ($a_import_id) | |
| getOwner () | |
| getOwnerName () | |
| setOwner ($a_owner) | |
| getCreateDate () | |
| getLastUpdateDate () | |
| create ($a_clone_mode=false) | |
| update () | |
| MDUpdateListener ($a_element) | |
| createMetaData () | |
| updateMetaData () | |
| deleteMetaData () | |
| updateOwner () | |
| putInTree ($a_parent_ref) | |
| setPermissions ($a_parent_ref) | |
| createReference () | |
| countReferences () | |
| delete () | |
| initDefaultRoles () | |
| setRegisterMode ($a_bool) | |
| isUserRegistered ($a_user_id=0) | |
| requireRegistration () | |
| appendCopyInfo ($a_target_id, $a_copy_id) | |
| cloneMetaData ($target_obj) | |
| cloneObject ($a_target_id, $a_copy_id=null, $a_omit_tree=false) | |
| cloneDependencies ($a_target_id, $a_copy_id) | |
| 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 | _hasWriteAccess ($ref) |
| static | _hasReadAccess ($ref) |
| static | _hasTableByTitle ($title, $obj_id) |
| Checks if a DataCollection has a table with a given title. More... | |
| Static Public Member Functions inherited from ilObject2 | |
| static | _lookupObjIdByImportId ($a_import_id) |
| static | _lookupOwnerName ($a_owner_id) |
| static | _getIdForImportId ($a_import_id) |
| static | _getAllReferences ($a_id) |
| static | _lookupTitle ($a_id) |
| static | _lookupOwner ($a_id) |
| static | _getIdsForTitle ($title, $type='', $partialmatch=false) |
| static | _lookupDescription ($a_id) |
| static | _lookupLastUpdate ($a_id, $a_as_string=false) |
| static | _getLastUpdateOfObjects ($a_objs) |
| static | _lookupObjId ($a_id) |
| static | _setDeletedDate ($a_ref_id) |
| static | _resetDeletedDate ($a_ref_id) |
| static | _lookupDeletedDate ($a_ref_id) |
| static | _writeTitle ($a_obj_id, $a_title) |
| static | _writeDescription ($a_obj_id, $a_desc) |
| static | _writeImportId ($a_obj_id, $a_import_id) |
| static | _lookupType ($a_id, $a_reference=false) |
| static | _isInTrash ($a_ref_id) |
| static | _hasUntrashedReference ($a_obj_id) |
| static | _lookupObjectId ($a_ref_id) |
| static | _getObjectsDataForType ($a_type, $a_omit_trash=false) |
| static | _exists ($a_id, $a_reference=false, $a_type=null) |
| static | _getObjectsByType ($a_obj_type="", $a_owner="") |
| static | _prepareCloneSelection ($a_ref_ids, $new_type, $a_show_path=true) |
| static | _getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false) |
| Static Public Member Functions inherited from ilObject | |
| static | _lookupObjIdByImportId ($a_import_id) |
| static | _lookupImportId ($a_obj_id) |
| static | _lookupOwnerName ($a_owner_id) |
| lookup owner name for owner id More... | |
| static | _getIdForImportId ($a_import_id) |
| get current object id for import id (static) More... | |
| static | _getAllReferences ($a_id) |
| get all reference ids of object More... | |
| static | _lookupTitle ($a_id) |
| lookup object title More... | |
| static | lookupOfflineStatus ($a_obj_id) |
| Lookup offline status using objectDataCache. More... | |
| static | _lookupOwner ($a_id) |
| lookup object owner More... | |
| static | _getIdsForTitle ($title, $type='', $partialmatch=false) |
| static | _lookupDescription ($a_id) |
| lookup object description More... | |
| static | _lookupLastUpdate ($a_id, $a_as_string=false) |
| lookup last update More... | |
| static | _getLastUpdateOfObjects ($a_objs) |
| Get last update for a set of media objects. More... | |
| static | _lookupObjId ($a_id) |
| static | _setDeletedDate ($a_ref_id) |
| 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... | |
Protected Member Functions | |
| doCreate ($clone_mode=false) | |
| doDelete () | |
| Protected Member Functions inherited from ilObject2 | |
| initType () | |
| doRead () | |
| doCreate () | |
| beforeCreate () | |
| doUpdate () | |
| beforeUpdate () | |
| doMDUpdateListener ($a_element) | |
| beforeMDUpdateListener ($a_element) | |
| doCreateMetaData () | |
| beforeCreateMetaData () | |
| doUpdateMetaData () | |
| beforeUpdateMetaData () | |
| doDelete () | |
| beforeDelete () | |
| doCloneObject ($new_obj, $a_target_id, $a_copy_id=null) | |
| beforeCloneObject () | |
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 ilObjDataCollection.
- Version
- Id
- class.ilObjFolder.php 25528 2010-09-03 10:37:11Z smeyer
Definition at line 15 of file class.ilObjDataCollection.php.
Member Function Documentation
◆ _hasReadAccess()
|
static |
- Parameters
-
$ref int the reference id of the datacollection object to check.
- Returns
- bool whether or not the current user has add/edit_entry access to the referenced datacollection
Definition at line 474 of file class.ilObjDataCollection.php.
References ilObjDataCollectionAccess\hasReadAccess().
Here is the call graph for this function:
◆ _hasTableByTitle()
|
static |
Checks if a DataCollection has a table with a given title.
- Parameters
-
$title Title of table $obj_id Obj-ID of the table
- Returns
- bool
Definition at line 531 of file class.ilObjDataCollection.php.
References $DIC, $ilDB, $result, and ilObject\$title.
Referenced by ilDclTableEditGUI\checkInput().
Here is the caller graph for this function:
◆ _hasWriteAccess()
|
static |
- Parameters
-
$ref int the reference id of the datacollection object to check.
- Returns
- bool whether or not the current user has admin/write access to the referenced datacollection
Definition at line 462 of file class.ilObjDataCollection.php.
References ilObjDataCollectionAccess\hasWriteAccess().
Here is the call graph for this function:
◆ cloneStructure()
| ilObjDataCollection::cloneStructure | ( | $original_id | ) |
Attention only use this for objects who have not yet been created (use like: $x = new ilObjDataCollection; $x->cloneStructure($id))
- Parameters
-
$original_id The original ID of the dataselection you want to clone it's structure
Definition at line 336 of file class.ilObjDataCollection.php.
References $table, ilObject2\getId(), getTables(), setApproval(), ilDclCache\setCloneOf(), setNotification(), setPublicNotes(), setRating(), and ilDclCache\TYPE_DATACOLLECTION.
Here is the call graph for this function:
◆ doClone()
| ilObjDataCollection::doClone | ( | ) |
◆ doCloneObject()
| ilObjDataCollection::doCloneObject | ( | $new_obj, | |
| $a_target_id, | |||
$a_copy_id = null, |
|||
$a_omit_tree = false |
|||
| ) |
Clone DCL.
- Parameters
-
ilObjDataCollection $new_obj int $a_target_id ref_id int $a_copy_id
- Returns
- ilObjPoll
Definition at line 285 of file class.ilObjDataCollection.php.
References ilCopyWizardOptions\_getInstance(), getOnline(), and ilObject2\getRefId().
Here is the call graph for this function:
◆ doCreate()
|
protected |
Definition at line 39 of file class.ilObjDataCollection.php.
References $DIC, $ilDB, $ilLog, getApproval(), ilObject2\getId(), getNotification(), getOnline(), getPublicNotes(), getRating(), ilDclCache\getTableCache(), and ilObject2\getTitle().
Here is the call graph for this function:
◆ doDelete()
|
protected |
Definition at line 85 of file class.ilObjDataCollection.php.
References $DIC, $ilDB, $query, $table, ilObject2\getId(), and getTables().
Here is the call graph for this function:
◆ doRead()
| ilObjDataCollection::doRead | ( | ) |
Definition at line 23 of file class.ilObjDataCollection.php.
References $data, $DIC, $ilDB, $result, setApproval(), setNotification(), setOnline(), setPublicNotes(), and setRating().
Here is the call graph for this function:
◆ doUpdate()
| ilObjDataCollection::doUpdate | ( | ) |
Definition at line 99 of file class.ilObjDataCollection.php.
References $_GET, $DIC, $ilDB, $ilUser, $message, $result, $t, $users, ilLanguageFactory\_getLanguageOfUser(), ilLink\_getLink(), ilObjUser\_lookupFullname(), ilObjUser\_lookupLogin(), getApproval(), ilObject2\getId(), ilUserUtil\getNamePresentation(), getNotification(), ilNotification\getNotificationsForObject(), getOnline(), getPublicNotes(), getRating(), ilDclCache\getRecordCache(), ilDclCache\getTableCache(), ilObjDataCollectionAccess\hasWriteAccess(), ilNotification\TYPE_DATA_COLLECTION, and ilNotification\updateNotificationTime().
Here is the call graph for this function:
◆ getApproval()
| ilObjDataCollection::getApproval | ( | ) |
getApproval
Definition at line 432 of file class.ilObjDataCollection.php.
Referenced by doCreate(), and doUpdate().
Here is the caller graph for this function:
◆ getNotification()
| ilObjDataCollection::getNotification | ( | ) |
getNotification
Definition at line 450 of file class.ilObjDataCollection.php.
Referenced by doCreate(), and doUpdate().
Here is the caller graph for this function:
◆ getOnline()
| ilObjDataCollection::getOnline | ( | ) |
getOnline
Definition at line 378 of file class.ilObjDataCollection.php.
Referenced by doCloneObject(), doCreate(), and doUpdate().
Here is the caller graph for this function:
◆ getPublicNotes()
| ilObjDataCollection::getPublicNotes | ( | ) |
getPublicNotes
Definition at line 414 of file class.ilObjDataCollection.php.
Referenced by doCreate(), and doUpdate().
Here is the caller graph for this function:
◆ getRating()
| ilObjDataCollection::getRating | ( | ) |
getRating
Definition at line 396 of file class.ilObjDataCollection.php.
Referenced by doCreate(), and doUpdate().
Here is the caller graph for this function:
◆ getStyleSheetId()
| ilObjDataCollection::getStyleSheetId | ( | ) |
Definition at line 544 of file class.ilObjDataCollection.php.
◆ getTableById()
| ilObjDataCollection::getTableById | ( | $table_id | ) |
Definition at line 501 of file class.ilObjDataCollection.php.
References ilDclCache\getTableCache().
Here is the call graph for this function:
◆ getTables()
| ilObjDataCollection::getTables | ( | ) |
- Returns
- ilDclTable[] Returns an array of tables of this collection with ids of the tables as keys.
Definition at line 483 of file class.ilObjDataCollection.php.
References $DIC, $ilDB, $query, ilObject2\getId(), and ilDclCache\getTableCache().
Referenced by ilDclReferenceFieldRepresentation\buildFieldCreationInput(), cloneStructure(), doDelete(), and getVisibleTables().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ getVisibleTables()
| ilObjDataCollection::getVisibleTables | ( | ) |
- Returns
- array
Definition at line 510 of file class.ilObjDataCollection.php.
References $table, and getTables().
Here is the call graph for this function:
◆ initType()
| ilObjDataCollection::initType | ( | ) |
Definition at line 17 of file class.ilObjDataCollection.php.
◆ reorderTables()
| ilObjDataCollection::reorderTables | ( | $table_order | ) |
- Parameters
-
$table_order
Definition at line 261 of file class.ilObjDataCollection.php.
References $table, ilObject\$title, ilDclTable\_getTableIdByTitle(), ilObject2\getId(), and ilDclCache\getTableCache().
Here is the call graph for this function:
◆ setApproval()
| ilObjDataCollection::setApproval | ( | $a_val | ) |
setApproval
Definition at line 423 of file class.ilObjDataCollection.php.
Referenced by cloneStructure(), and doRead().
Here is the caller graph for this function:
◆ setNotification()
| ilObjDataCollection::setNotification | ( | $a_val | ) |
setNotification
Definition at line 441 of file class.ilObjDataCollection.php.
References notification().
Referenced by cloneStructure(), and doRead().
Here is the call graph for this function:
Here is the caller graph for this function:
◆ setOnline()
| ilObjDataCollection::setOnline | ( | $a_val | ) |
setOnline
Definition at line 369 of file class.ilObjDataCollection.php.
Referenced by doRead().
Here is the caller graph for this function:
◆ setPublicNotes()
| ilObjDataCollection::setPublicNotes | ( | $a_val | ) |
setPublicNotes
Definition at line 405 of file class.ilObjDataCollection.php.
Referenced by cloneStructure(), and doRead().
Here is the caller graph for this function:
◆ setRating()
| ilObjDataCollection::setRating | ( | $a_val | ) |
setRating
Definition at line 387 of file class.ilObjDataCollection.php.
Referenced by cloneStructure(), and doRead().
Here is the caller graph for this function:
The documentation for this class was generated from the following file:
- Modules/DataCollection/classes/class.ilObjDataCollection.php
