ILIAS
Release_3_10_x_branch Revision 61812
|
Class ilLMObject. More...
Public Member Functions | |
ilLMObject (&$a_content_obj, $a_id=0) | |
MDUpdateListener ($a_element) | |
Meta data update listener. | |
_lookupNID ($a_lm_id, $a_lm_obj_id, $a_type) | |
lookup named identifier (ILIAS_NID) | |
createMetaData () | |
create meta data entry | |
updateMetaData () | |
update meta data entry | |
deleteMetaData () | |
delete meta data entry | |
setDataRecord ($a_record) | |
this method should only be called by class ilLMObjectFactory | |
read () | |
setTitle ($a_title) | |
set title of lm object | |
getTitle () | |
get title of lm object | |
_lookupTitle ($a_obj_id) | |
_lookupType ($a_obj_id) | |
_writeTitle ($a_obj_id, $a_title) | |
setDescription ($a_description) | |
getDescription () | |
setType ($a_type) | |
getType () | |
setLMId ($a_lm_id) | |
getLMId () | |
setContentObject (&$a_content_obj) | |
& | getContentObject () |
setId ($a_id) | |
getId () | |
getImportId () | |
setImportId ($a_id) | |
setActive ($a_active) | |
set activation | |
getActive () | |
get activation | |
_writeImportId ($a_id, $a_import_id) | |
write import id to db (static) | |
create ($a_upload=false) | |
update () | |
update complete object | |
_isPagePublic ($a_node_id, $a_check_public_mode=false) | |
delete ($a_delete_meta_data=true) | |
delete lm object data | |
_getIdForImportId ($a_import_id) | |
get current object id for import id (static) | |
_getAllObjectsForImportId ($a_import_id) | |
Get all items for an import ID. | |
_exists ($a_id) | |
checks wether a lm content object with specified id exists or not | |
getObjectList ($lm_id, $type="") | |
static | |
_deleteAllObjectData (&$a_cobj) | |
delete all objects of content object (digi book / learning module) | |
_lookupContObjID ($a_id) | |
get learning module / digibook id for lm object | |
_lookupActive ($a_id) | |
lookup activation status | |
_writeActive ($a_id, $a_active) | |
write activation status | |
clipboardCut ($a_cont_obj_id, $a_ids) | |
Copy a set of chapters/pages into the clipboard. |
Static Public Member Functions | |
_writePublicAccessStatus ($a_pages, $a_cont_obj_id) | |
update public access flags in lm_data for all pages of a content object | |
static | putInTree ($a_obj, $a_parent_id="", $a_target_node_id="") |
put this object into content object tree | |
static | getTree ($a_cont_obj_id) |
Get learningmodule tree. | |
static | clipboardCopy ($a_cont_obj_id, $a_ids) |
Copy a set of chapters/pages into the clipboard. | |
static | pasteTree ($a_target_lm, $a_item_id, $a_parent_id, $a_target, $a_insert_time, &$a_copied_nodes, $a_as_copy=false) |
Paste item (tree) from clipboard to current lm. | |
static | saveTitles ($a_lm, $a_titles) |
Save titles for lm objects. | |
static | updateInternalLinks ($a_copied_nodes, $a_parent_type="lm") |
Update internal links, after multiple pages have been copied. | |
static | uniqueTypesCheck ($a_items) |
Check for unique types (all pages or all chapters) |
Data Fields | |
$ilias | |
$lm_id | |
$type | |
$id | |
$meta_data | |
$data_record | |
$content_object | |
$title | |
$description | |
$active = true |
Class ilLMObject.
Base class for ilStructureObjects and ilPageObjects (see ILIAS DTD)
Definition at line 36 of file class.ilLMObject.php.
ilLMObject::_deleteAllObjectData | ( | & | $a_cobj | ) |
delete all objects of content object (digi book / learning module)
Definition at line 659 of file class.ilLMObject.php.
References DB_FETCHMODE_ASSOC, and ilLMObjectFactory\getInstance().
Referenced by ilObjContentObject\delete().
ilLMObject::_exists | ( | $a_id | ) |
checks wether a lm content object with specified id exists or not
int | $id | id |
Definition at line 607 of file class.ilLMObject.php.
References ilInternalLink\_extractObjIdOfTarget(), and DB_FETCHMODE_ASSOC.
Referenced by ilLinksTableGUI\fillRow(), ilLMPresentationGUI\ilPage(), and ilLMPresentationGUI\showPrintView().
ilLMObject::_getAllObjectsForImportId | ( | $a_import_id | ) |
Get all items for an import ID.
(only for items notnot in trash)
int | $a_import_id | import id |
Definition at line 579 of file class.ilLMObject.php.
References ilObject\_hasUntrashedReference(), and DB_FETCHMODE_ASSOC.
Referenced by updateInternalLinks().
ilLMObject::_getIdForImportId | ( | $a_import_id | ) |
get current object id for import id (static)
import ids can exist multiple times (if the same learning module has been imported multiple times). we get the object id of the last imported object, that is not in trash
int | $a_import_id | import id |
Definition at line 549 of file class.ilLMObject.php.
References $lm_id, ilObject\_hasUntrashedReference(), _lookupContObjID(), and DB_FETCHMODE_ASSOC.
Referenced by SurveyQuestion\_resolveInternalLink(), and assQuestion\_resolveInternalLink().
ilLMObject::_isPagePublic | ( | $a_node_id, | |
$a_check_public_mode = false |
|||
) |
Definition at line 493 of file class.ilLMObject.php.
References $ilLog, $lm_id, and ilUtil\yn2tf().
Referenced by ilLMPresentationGUI\executeCommand(), ilPublicSectionSelector\formatObject(), ilLMPresentationGUI\getCurrentPageId(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilPage(), ilLMExplorer\isClickable(), ilShopPublicSectionSelector\isClickable(), ilLMTOCExplorer\isClickable(), ilTableOfContentsExplorer\isClickable(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().
ilLMObject::_lookupActive | ( | $a_id | ) |
lookup activation status
Definition at line 700 of file class.ilLMObject.php.
References DB_FETCHMODE_ASSOC, and ilUtil\yn2tf().
Referenced by ilLMPageObject\_getPresentationTitle(), ilStructureObjectGUI\activatePages(), ilObjContentObjectGUI\activatePages(), ilTableOfContentsExplorer\buildLinkTarget(), ilLMTOCExplorer\buildLinkTarget(), ilChapterHierarchyFormGUI\getChildIcon(), ilChapterHierarchyFormGUI\getChildIconAlt(), ilLMPresentationGUI\getCurrentPageId(), ilLMEditorExplorer\getImage(), ilLMEditorExplorer\getImageAlt(), ilLMPresentationGUI\ilLMNavigation(), ilLMTOCExplorer\isClickable(), ilTableOfContentsExplorer\isClickable(), ilLMTOCExplorer\isVisible(), ilTableOfContentsExplorer\isVisible(), ilObjContentObjectGUI\pages(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showPrintViewSelection(), and ilStructureObjectGUI\view().
ilLMObject::_lookupContObjID | ( | $a_id | ) |
get learning module / digibook id for lm object
Definition at line 686 of file class.ilLMObject.php.
References DB_FETCHMODE_ASSOC.
Referenced by ilObjContentObjectAccess\_checkGoto(), _getIdForImportId(), ilLMPageObjectGUI\_goto(), ilStructureObjectGUI\_goto(), ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), ilLinksTableGUI\fillRow(), ilLMPageObjectGUI\getLinkXML(), ilGlossaryPresentationGUI\getLinkXML(), ilLMPresentationGUI\getLinkXML(), ilObjMediaObject\getParentObjectIdForUsage(), ilGlossaryPresentationGUI\listDefinitions(), ilObjContentObjectGUI\pasteChapter(), ilStructureObjectGUI\pastePage(), ilObjContentObjectGUI\pastePage(), pasteTree(), ilPageObjectGUI\setDefaultLinkXml(), SurveyQuestion\setMaterial(), and updateInternalLinks().
ilLMObject::_lookupNID | ( | $a_lm_id, | |
$a_lm_obj_id, | |||
$a_type | |||
) |
lookup named identifier (ILIAS_NID)
Definition at line 109 of file class.ilLMObject.php.
References $id.
Referenced by ilTableOfContentsExplorer\buildLinkTarget(), ilObjContentObject\exportPageHTML(), and ilLMPresentationGUI\getLink().
ilLMObject::_lookupTitle | ( | $a_obj_id | ) |
Definition at line 246 of file class.ilLMObject.php.
References DB_FETCHMODE_ASSOC.
Referenced by ilSearchResultPresentationGUI\__appendChildLinks(), ilCourseObjectivePresentationGUI\__showLearningMaterials(), clipboardCopy(), ilObjContentObjectGUI\confirmedDelete(), ilStructureObjectGUI\cutPage(), ilObjContentObject\executeDragDrop(), ilLinksTableGUI\fillRow(), ilCourseObjectivesTableGUI\fillRow(), ilCourseObjectiveMaterialAssignmentTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ilImageMapEditorGUI\getMapAreaLinkString(), ilLMPresentationGUI\ilPage(), ilCourseObjectiveMaterialAssignmentTableGUI\parse(), ilStructureObjectGUI\pastePage(), ilContainerObjectiveGUI\renderObjective(), and ilLMPresentationGUI\showPreconditionsOfPage().
ilLMObject::_lookupType | ( | $a_obj_id | ) |
Definition at line 257 of file class.ilLMObject.php.
References DB_FETCHMODE_ASSOC.
Referenced by ilSearchResultPresentationGUI\__appendChildLinks(), ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), ilStructureObjectGUI\activatePages(), clipboardCopy(), ilLMPresentationGUI\getCurrentPageId(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilPage(), ilLMPresentationGUI\ilTOC(), ilPageObject\moveIntLinks(), pasteTree(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showTableOfContents(), uniqueTypesCheck(), updateInternalLinks(), and ilCourseObjectivesGUI\updateMaterialAssignment().
ilLMObject::_writeActive | ( | $a_id, | |
$a_active | |||
) |
write activation status
Definition at line 714 of file class.ilLMObject.php.
References ilUtil\tf2yn().
Referenced by ilStructureObjectGUI\activatePages(), and ilObjContentObjectGUI\activatePages().
ilLMObject::_writeImportId | ( | $a_id, | |
$a_import_id | |||
) |
write import id to db (static)
int | $a_id | lm object id |
string | $a_import_id | import id public |
Definition at line 368 of file class.ilLMObject.php.
Referenced by ilContObjParser\handlerEndTag().
|
static |
update public access flags in lm_data for all pages of a content object
public
array | page ids |
integer | content object id |
Definition at line 432 of file class.ilLMObject.php.
References $ilErr, $ilLog, and ilUtil\quoteArray().
Referenced by ilObjContentObjectGUI\savePublicSection().
ilLMObject::_writeTitle | ( | $a_obj_id, | |
$a_title | |||
) |
Definition at line 269 of file class.ilLMObject.php.
Referenced by MDUpdateListener(), and saveTitles().
|
static |
Copy a set of chapters/pages into the clipboard.
Definition at line 846 of file class.ilLMObject.php.
References $id, _lookupTitle(), _lookupType(), and getTree().
Referenced by clipboardCut(), ilStructureObjectGUI\copyItems(), ilObjContentObjectGUI\copyItems(), and ilObjContentObjectGUI\copyPage().
ilLMObject::clipboardCut | ( | $a_cont_obj_id, | |
$a_ids | |||
) |
Copy a set of chapters/pages into the clipboard.
Definition at line 798 of file class.ilLMObject.php.
References $id, clipboardCopy(), and getTree().
Referenced by ilStructureObjectGUI\cutItems(), ilObjContentObjectGUI\cutItems(), and ilObjContentObjectGUI\movePage().
ilLMObject::create | ( | $a_upload = false | ) |
Reimplemented in ilLMPageObject, and ilStructureObject.
Definition at line 381 of file class.ilLMObject.php.
References ilHistory\_createEntry(), createMetaData(), getActive(), getId(), getImportId(), getLMId(), getTitle(), getType(), setId(), and ilUtil\tf2yn().
ilLMObject::createMetaData | ( | ) |
create meta data entry
Definition at line 137 of file class.ilLMObject.php.
References getDescription(), getId(), getLMId(), getTitle(), and getType().
Referenced by create().
ilLMObject::delete | ( | $a_delete_meta_data = true | ) |
delete lm object data
Reimplemented in ilLMPageObject, and ilStructureObject.
Definition at line 528 of file class.ilLMObject.php.
References deleteMetaData(), and getId().
ilLMObject::deleteMetaData | ( | ) |
delete meta data entry
Definition at line 184 of file class.ilLMObject.php.
References getId(), getLMId(), and getType().
Referenced by delete().
ilLMObject::getActive | ( | ) |
get activation
Definition at line 356 of file class.ilLMObject.php.
References $active.
Referenced by create(), and update().
& ilLMObject::getContentObject | ( | ) |
Definition at line 316 of file class.ilLMObject.php.
References $content_object.
Referenced by ilStructureObject\exportFOPageObjects(), ilLMPageObject\exportXMLPageContent(), and ilStructureObject\exportXMLStructureObjects().
ilLMObject::getDescription | ( | ) |
Definition at line 285 of file class.ilLMObject.php.
References $description.
Referenced by ilStructureObject\copy(), ilLMPageObject\copy(), ilLMPageObject\copyToOtherContObject(), and createMetaData().
ilLMObject::getId | ( | ) |
Reimplemented in ilLMPageObject.
Definition at line 326 of file class.ilLMObject.php.
References $id.
Referenced by ilStructureObject\copy(), create(), createMetaData(), ilStructureObject\delete(), delete(), ilStructureObject\delete_rec(), deleteMetaData(), ilStructureObject\exportFOPageObjects(), ilStructureObject\exportXML(), ilStructureObject\exportXMLMetaData(), ilStructureObject\exportXMLPageObjects(), ilStructureObject\exportXMLStructureObjects(), MDUpdateListener(), ilStructureObject\modifyExportIdentifier(), update(), and updateMetaData().
ilLMObject::getImportId | ( | ) |
Definition at line 331 of file class.ilLMObject.php.
Referenced by create().
ilLMObject::getLMId | ( | ) |
Definition at line 306 of file class.ilLMObject.php.
References $lm_id.
Referenced by ilStructureObject\copy(), ilLMPageObject\copy(), ilLMPageObject\copyToOtherContObject(), ilLMPageObject\create(), create(), createMetaData(), deleteMetaData(), ilStructureObject\exportXMLMetaData(), ilLMPageObject\exportXMLMetaData(), MDUpdateListener(), update(), and updateMetaData().
ilLMObject::getObjectList | ( | $lm_id, | |
$type = "" |
|||
) |
static
Definition at line 633 of file class.ilLMObject.php.
References $lm_id, $type, and DB_FETCHMODE_ASSOC.
Referenced by ilLMPageObject\getPageList().
ilLMObject::getTitle | ( | ) |
get title of lm object
Definition at line 240 of file class.ilLMObject.php.
References $title.
Referenced by ilStructureObject\copy(), ilLMPageObject\copy(), ilLMPageObject\copyToOtherContObject(), create(), createMetaData(), ilStructureObject\exportFO(), update(), and updateMetaData().
|
static |
Get learningmodule tree.
int | learning module object id |
Definition at line 785 of file class.ilLMObject.php.
Referenced by clipboardCopy(), and clipboardCut().
ilLMObject::getType | ( | ) |
Definition at line 295 of file class.ilLMObject.php.
References $type.
Referenced by ilStructureObject\copy(), ilLMPageObject\copy(), ilLMPageObject\copyToOtherContObject(), create(), createMetaData(), deleteMetaData(), ilStructureObject\exportXMLMetaData(), ilLMPageObject\exportXMLMetaData(), MDUpdateListener(), and updateMetaData().
ilLMObject::ilLMObject | ( | & | $a_content_obj, |
$a_id = 0 |
|||
) |
object | $a_content_obj | content object (digi book or learning module) |
Definition at line 52 of file class.ilLMObject.php.
References $ilias, read(), setContentObject(), and setLMId().
Referenced by ilLMPageObject\ilLMPageObject(), and ilStructureObject\ilStructureObject().
ilLMObject::MDUpdateListener | ( | $a_element | ) |
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.
string | $a_element |
Definition at line 77 of file class.ilLMObject.php.
References $id, _writeTitle(), getId(), getLMId(), and getType().
|
static |
Paste item (tree) from clipboard to current lm.
Definition at line 886 of file class.ilLMObject.php.
References $ilias, $ilLog, _lookupContObjID(), _lookupType(), ilMD\cloneMD(), IL_LAST_NODE, and putInTree().
Referenced by ilStructureObjectGUI\insertChapterClip(), ilObjContentObjectGUI\insertChapterClip(), and ilStructureObjectGUI\insertPageClip().
|
static |
put this object into content object tree
Definition at line 727 of file class.ilLMObject.php.
References $ilLog, IL_FIRST_NODE, and ilTree\setTableNames().
Referenced by ilObjContentObjectGUI\insertChapter(), and pasteTree().
ilLMObject::read | ( | ) |
Reimplemented in ilLMPageObject.
Definition at line 202 of file class.ilLMObject.php.
References $ilBench, DB_FETCHMODE_ASSOC, setActive(), setImportId(), setTitle(), and ilUtil\yn2tf().
Referenced by ilLMObject().
|
static |
Save titles for lm objects.
array | titles (key is ID, value is title) |
Definition at line 965 of file class.ilLMObject.php.
References $id, $title, _writeTitle(), ilMD\getGeneral(), ilLMObjectFactory\getInstance(), and ilMDBase\update().
Referenced by ilStructureObjectGUI\saveAllTitles(), and ilObjContentObjectGUI\saveAllTitles().
ilLMObject::setActive | ( | $a_active | ) |
set activation
boolean | $a_active | true/false for active or not |
Definition at line 346 of file class.ilLMObject.php.
Referenced by read().
ilLMObject::setContentObject | ( | & | $a_content_obj | ) |
Definition at line 311 of file class.ilLMObject.php.
Referenced by ilLMObject().
ilLMObject::setDataRecord | ( | $a_record | ) |
this method should only be called by class ilLMObjectFactory
Definition at line 197 of file class.ilLMObject.php.
ilLMObject::setDescription | ( | $a_description | ) |
Definition at line 280 of file class.ilLMObject.php.
ilLMObject::setId | ( | $a_id | ) |
Reimplemented in ilLMPageObject.
Definition at line 321 of file class.ilLMObject.php.
Referenced by create().
ilLMObject::setImportId | ( | $a_id | ) |
Definition at line 336 of file class.ilLMObject.php.
Referenced by read().
ilLMObject::setLMId | ( | $a_lm_id | ) |
Definition at line 300 of file class.ilLMObject.php.
Referenced by ilLMObject().
ilLMObject::setTitle | ( | $a_title | ) |
set title of lm object
string | $a_title | title of chapter or page |
Definition at line 230 of file class.ilLMObject.php.
Referenced by read().
ilLMObject::setType | ( | $a_type | ) |
Definition at line 290 of file class.ilLMObject.php.
Referenced by ilLMPageObject\ilLMPageObject(), and ilStructureObject\ilStructureObject().
|
static |
Check for unique types (all pages or all chapters)
Definition at line 1135 of file class.ilLMObject.php.
References $type, and _lookupType().
Referenced by ilStructureObjectGUI\copyItems(), and ilStructureObjectGUI\cutItems().
ilLMObject::update | ( | ) |
update complete object
Definition at line 408 of file class.ilLMObject.php.
References getActive(), getId(), getLMId(), getTitle(), ilUtil\tf2yn(), and updateMetaData().
|
static |
Update internal links, after multiple pages have been copied.
Definition at line 990 of file class.ilLMObject.php.
References $mobs, ilInternalLink\_extractInstOfTarget(), ilInternalLink\_extractObjIdOfTarget(), ilInternalLink\_extractTypeOfTarget(), _getAllObjectsForImportId(), ilMapArea\_getMobsForTarget(), ilInternalLink\_getSourcesOfTarget(), _lookupContObjID(), _lookupType(), ilObject\_lookupType(), and ilObjMediaObject\lookupUsages().
Referenced by ilStructureObjectGUI\insertChapterClip(), ilObjContentObjectGUI\insertChapterClip(), ilStructureObjectGUI\insertPageClip(), ilObjContentObjectGUI\pasteChapter(), ilStructureObjectGUI\pastePage(), and ilObjContentObjectGUI\pastePage().
ilLMObject::updateMetaData | ( | ) |
update meta data entry
Definition at line 158 of file class.ilLMObject.php.
References getId(), getLMId(), getTitle(), and getType().
Referenced by update().
ilLMObject::$active = true |
Definition at line 47 of file class.ilLMObject.php.
Referenced by getActive().
ilLMObject::$content_object |
Definition at line 44 of file class.ilLMObject.php.
Referenced by getContentObject().
ilLMObject::$data_record |
Definition at line 43 of file class.ilLMObject.php.
ilLMObject::$description |
Definition at line 46 of file class.ilLMObject.php.
Referenced by getDescription().
ilLMObject::$id |
Definition at line 41 of file class.ilLMObject.php.
Referenced by _lookupNID(), clipboardCopy(), clipboardCut(), getId(), MDUpdateListener(), and saveTitles().
ilLMObject::$ilias |
Definition at line 38 of file class.ilLMObject.php.
Referenced by ilLMObject(), and pasteTree().
ilLMObject::$lm_id |
Definition at line 39 of file class.ilLMObject.php.
Referenced by _getIdForImportId(), _isPagePublic(), ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), getLMId(), getObjectList(), and ilLMPageObject\getPageList().
ilLMObject::$meta_data |
Definition at line 42 of file class.ilLMObject.php.
ilLMObject::$title |
Definition at line 45 of file class.ilLMObject.php.
Referenced by ilLMPageObject\exportFO(), getTitle(), and saveTitles().
ilLMObject::$type |
Definition at line 40 of file class.ilLMObject.php.
Referenced by ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), getObjectList(), getType(), and uniqueTypesCheck().