ILIAS
Release_4_0_x_branch Revision 61816
|
Class ilLMPageObject. More...
Public Member Functions | |
ilLMPageObject (&$a_content_obj, $a_id=0, $a_halt=true) | |
Constructor public. | |
_ilLMPageObject () | |
read () | |
create ($a_upload=false) | |
delete ($a_delete_meta_data=true) | |
delete lm object data | |
copy ($a_target_lm) | |
copy page | |
& | copyToOtherContObject (&$a_cont_obj, &$a_copied_nodes) |
copy a page to another content object (learning module / dlib book) | |
_splitPage ($a_page_id, $a_pg_parent_type, $a_hier_id) | |
split page at hierarchical id | |
_splitPageNext ($a_page_id, $a_pg_parent_type, $a_hier_id) | |
split page to next page at hierarchical id | |
assignPageObject (&$a_page_obj) | |
assign page object | |
& | getPageObject () |
get assigned page object | |
setId ($a_id) | |
set id | |
getId () | |
setAlias ($a_is_alias) | |
set wether page object is an alias | |
isAlias () | |
setOriginID ($a_id) | |
getOriginID () | |
getPageList ($lm_id) | |
static | |
getPagesWithLinksList ($a_lm_id, $a_par_type) | |
Get all pages of lm that contain any internal links. | |
_getPresentationTitle ($a_pg_id, $a_mode=IL_CHAPTER_TITLE, $a_include_numbers=false, $a_time_scheduled_activation=false) | |
presentation title doesn't have to be page title, it may be chapter title + page title or chapter title only, depending on settings | |
exportXML (&$a_xml_writer, $a_mode="normal", $a_inst=0) | |
export page object to xml (see ilias_co.dtd) | |
_exportXMLAlias (&$a_xml_writer, $a_id, $a_inst=0) | |
export page alias to xml | |
exportXMLMetaData (&$a_xml_writer) | |
export page objects meta data to xml (see ilias_co.dtd) | |
modifyExportIdentifier ($a_tag, $a_param, $a_value) | |
exportXMLPageContent (&$a_xml_writer, $a_inst=0) | |
export page objects meta data to xml (see ilias_co.dtd) | |
getMediaObjectIds () | |
get ids of all media objects within the page | |
getFileItemIds () | |
get ids of all file items within the page | |
exportFO (&$a_xml_writer) | |
export page object to fo | |
Public Member Functions inherited from ilLMObject | |
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 | |
setTitle ($a_title) | |
set title of lm object | |
getTitle () | |
get title of lm object | |
_writeTitle ($a_obj_id, $a_title) | |
setDescription ($a_description) | |
getDescription () | |
setType ($a_type) | |
getType () | |
setLMId ($a_lm_id) | |
getLMId () | |
setContentObject (&$a_content_obj) | |
& | getContentObject () |
getImportId () | |
setImportId ($a_id) | |
setLayout ($a_val) | |
Set layout. | |
getLayout () | |
Get layout. | |
_writeImportId ($a_id, $a_import_id) | |
write import id to db (static) | |
update () | |
update complete object | |
_isPagePublic ($a_node_id, $a_check_public_mode=false) | |
_getIdForImportId ($a_import_id) | |
get current object id for import id (static) | |
_getAllObjectsForImportId ($a_import_id, $a_in_lm=0) | |
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 | |
clipboardCut ($a_cont_obj_id, $a_ids) | |
Copy a set of chapters/pages into the clipboard. |
Data Fields | |
$is_alias | |
$origin_id | |
$id | |
$ilias | |
$dom | |
$page_object | |
Data Fields inherited from ilLMObject | |
$ilias | |
$lm_id | |
$type | |
$id | |
$meta_data | |
$data_record | |
$content_object | |
$title | |
$description | |
$active = true |
Additional Inherited Members | |
Static Public Member Functions inherited from ilLMObject | |
static | _lookupTitle ($a_obj_id) |
Lookup title. | |
static | _lookupType ($a_obj_id) |
Lookup type. | |
_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) | |
static | writeLayout ($a_obj_id, $a_layout) |
Write layout setting. | |
static | lookupLayout ($a_obj_id) |
Lookup type. |
Class ilLMPageObject.
Handles Page Objects of ILIAS Learning Modules
Note: This class has a member variable that contains an instance of class ilPageObject and provides the method getPageObject() to access this instance. ilPageObject handles page objects and their content. Page objects can be assigned to different container like learning modules or glossaries definitions. This class, ilLMPageObject, provides additional methods for the handling of page objects in learning modules.
Definition at line 48 of file class.ilLMPageObject.php.
ilLMPageObject::_exportXMLAlias | ( | & | $a_xml_writer, |
$a_id, | |||
$a_inst = 0 |
|||
) |
export page alias to xml
Definition at line 516 of file class.ilLMPageObject.php.
Referenced by ilStructureObject\exportXMLPageObjects().
ilLMPageObject::_getPresentationTitle | ( | $a_pg_id, | |
$a_mode = IL_CHAPTER_TITLE , |
|||
$a_include_numbers = false , |
|||
$a_time_scheduled_activation = false |
|||
) |
presentation title doesn't have to be page title, it may be chapter title + page title or chapter title only, depending on settings
string | $a_mode | IL_CHAPTER_TITLE | IL_PAGE_TITLE | IL_NO_HEADER |
Definition at line 405 of file class.ilLMPageObject.php.
References ilLMObject\$active, $ilDB, $query, ilPageObject\_lookupActive(), ilObject\_lookupType(), IL_NO_HEADER, and IL_PAGE_TITLE.
Referenced by ilObjContentObjectGUI\addLocations(), ilLMTOCExplorer\buildTitle(), ilTableOfContentsExplorer\buildTitle(), ilContObjLocatorGUI\display(), ilLMPageObjectGUI\executeCommand(), exportFO(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilLMSubMenu(), ilLMPresentationGUI\ilPage(), ilLMPresentationGUI\ilTranslation(), ilObjContentObjectGUI\linkChecker(), ilGlossaryPresentationGUI\listDefinitions(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().
ilLMPageObject::_ilLMPageObject | ( | ) |
Definition at line 86 of file class.ilLMPageObject.php.
ilLMPageObject::_splitPage | ( | $a_page_id, | |
$a_pg_parent_type, | |||
$a_hier_id | |||
) |
split page at hierarchical id
the main reason for this method being static is that a lm page object is not available within ilPageContentGUI where this method is called
Definition at line 193 of file class.ilLMPageObject.php.
References ilLMObject\$lm_id, ilLMObject\$type, ilLMObject\_lookupContObjID(), ilLMObject\_lookupType(), ilMD\cloneMD(), ilLMPageObject(), and ilTree\setTableNames().
Referenced by ilPageContentGUI\splitPage().
ilLMPageObject::_splitPageNext | ( | $a_page_id, | |
$a_pg_parent_type, | |||
$a_hier_id | |||
) |
split page to next page at hierarchical id
the main reason for this method being static is that a lm page object is not available within ilPageContentGUI where this method is called
Definition at line 262 of file class.ilLMPageObject.php.
References ilLMObject\$lm_id, ilLMObject\$type, ilLMObject\_lookupContObjID(), ilLMObject\_lookupType(), ilPageObject\_moveContentAfterHierId(), ilLMPageObject(), and ilTree\setTableNames().
Referenced by ilPageContentGUI\splitPageNext().
ilLMPageObject::assignPageObject | ( | & | $a_page_obj | ) |
assign page object
object | $a_page_obj | page object |
Definition at line 312 of file class.ilLMPageObject.php.
ilLMPageObject::copy | ( | $a_target_lm | ) |
copy page
Definition at line 132 of file class.ilLMPageObject.php.
References ilLMObject\getDescription(), getId(), ilLMObject\getLMId(), ilLMObject\getTitle(), ilLMObject\getType(), and ilLMPageObject().
& ilLMPageObject::copyToOtherContObject | ( | & | $a_cont_obj, |
& | $a_copied_nodes | ||
) |
copy a page to another content object (learning module / dlib book)
Definition at line 160 of file class.ilLMPageObject.php.
References ilLMObject\getDescription(), getId(), ilLMObject\getLMId(), ilLMObject\getTitle(), ilLMObject\getType(), and ilLMPageObject().
ilLMPageObject::create | ( | $a_upload = false | ) |
Reimplemented from ilLMObject.
Definition at line 110 of file class.ilLMPageObject.php.
References getId(), ilLMObject\getLMId(), and ilPageObject\setId().
ilLMPageObject::delete | ( | $a_delete_meta_data = true | ) |
delete lm object data
Reimplemented from ilLMObject.
Definition at line 122 of file class.ilLMPageObject.php.
ilLMPageObject::exportFO | ( | & | $a_xml_writer | ) |
export page object to fo
object | $a_xml_writer | ilXmlWriter object that receives the xml data |
Definition at line 606 of file class.ilLMPageObject.php.
References $ilBench, ilLMObject\$title, _getPresentationTitle(), and getId().
ilLMPageObject::exportXML | ( | & | $a_xml_writer, |
$a_mode = "normal" , |
|||
$a_inst = 0 |
|||
) |
export page object to xml (see ilias_co.dtd)
object | $a_xml_writer | ilXmlWriter object that receives the xml data |
Definition at line 478 of file class.ilLMPageObject.php.
References $ilBench, exportXMLMetaData(), and exportXMLPageContent().
ilLMPageObject::exportXMLMetaData | ( | & | $a_xml_writer | ) |
export page objects meta data to xml (see ilias_co.dtd)
object | $a_xml_writer | ilXmlWriter object that receives the xml data |
Definition at line 536 of file class.ilLMPageObject.php.
References getId(), ilLMObject\getLMId(), and ilLMObject\getType().
Referenced by exportXML().
ilLMPageObject::exportXMLPageContent | ( | & | $a_xml_writer, |
$a_inst = 0 |
|||
) |
export page objects meta data to xml (see ilias_co.dtd)
object | $a_xml_writer | ilXmlWriter object that receives the xml data |
Definition at line 563 of file class.ilLMPageObject.php.
References ilLMObject\getContentObject().
Referenced by exportXML().
ilLMPageObject::getFileItemIds | ( | ) |
get ids of all file items within the page
note: this method must be called afer exportXMLPageContent
Definition at line 595 of file class.ilLMPageObject.php.
ilLMPageObject::getId | ( | ) |
Reimplemented from ilLMObject.
Definition at line 337 of file class.ilLMPageObject.php.
References $id.
Referenced by copy(), copyToOtherContObject(), create(), exportFO(), exportXMLMetaData(), and modifyExportIdentifier().
ilLMPageObject::getMediaObjectIds | ( | ) |
get ids of all media objects within the page
note: this method must be called afer exportXMLPageContent
Definition at line 585 of file class.ilLMPageObject.php.
ilLMPageObject::getOriginID | ( | ) |
Definition at line 362 of file class.ilLMPageObject.php.
References $origin_id.
ilLMPageObject::getPageList | ( | $lm_id | ) |
static
Definition at line 370 of file class.ilLMPageObject.php.
References ilLMObject\$lm_id, and ilLMObject\getObjectList().
Referenced by ilObjContentObject\exportHTMLPages(), ilObjContentObject\exportXMLPageObjects(), getPagesWithLinksList(), SurveyQuestionGUI\linkChilds(), assQuestionGUI\outPageSelector(), ilObjContentObjectGUI\pages(), ilInternalLinkGUI\showLinkHelp(), and ilObjContentObject\validatePages().
& ilLMPageObject::getPageObject | ( | ) |
get assigned page object
Definition at line 323 of file class.ilLMPageObject.php.
References $page_object.
ilLMPageObject::getPagesWithLinksList | ( | $a_lm_id, | |
$a_par_type | |||
) |
Get all pages of lm that contain any internal links.
Definition at line 378 of file class.ilLMPageObject.php.
References $result, getPageList(), and ilPageObject\getPagesWithLinks().
Referenced by ilLinksTableGUI\getLinks().
ilLMPageObject::ilLMPageObject | ( | & | $a_content_obj, |
$a_id = 0 , |
|||
$a_halt = true |
|||
) |
Constructor public.
Definition at line 61 of file class.ilLMPageObject.php.
References $ilBench, $ilias, ilLMObject\ilLMObject(), read(), and ilLMObject\setType().
Referenced by _splitPage(), _splitPageNext(), copy(), and copyToOtherContObject().
ilLMPageObject::isAlias | ( | ) |
Definition at line 350 of file class.ilLMPageObject.php.
References $is_alias.
ilLMPageObject::modifyExportIdentifier | ( | $a_tag, | |
$a_param, | |||
$a_value | |||
) |
Definition at line 545 of file class.ilLMPageObject.php.
References getId().
ilLMPageObject::read | ( | ) |
Reimplemented from ilLMObject.
Definition at line 97 of file class.ilLMPageObject.php.
Referenced by ilLMPageObject().
ilLMPageObject::setAlias | ( | $a_is_alias | ) |
set wether page object is an alias
Definition at line 345 of file class.ilLMPageObject.php.
ilLMPageObject::setId | ( | $a_id | ) |
set id
Reimplemented from ilLMObject.
Definition at line 332 of file class.ilLMPageObject.php.
ilLMPageObject::setOriginID | ( | $a_id | ) |
Definition at line 356 of file class.ilLMPageObject.php.
ilLMPageObject::$dom |
Definition at line 54 of file class.ilLMPageObject.php.
ilLMPageObject::$id |
Definition at line 52 of file class.ilLMPageObject.php.
ilLMPageObject::$ilias |
Definition at line 53 of file class.ilLMPageObject.php.
Referenced by ilLMPageObject().
ilLMPageObject::$is_alias |
Definition at line 50 of file class.ilLMPageObject.php.
Referenced by isAlias().
ilLMPageObject::$origin_id |
Definition at line 51 of file class.ilLMPageObject.php.
Referenced by getOriginID().
ilLMPageObject::$page_object |
Definition at line 55 of file class.ilLMPageObject.php.
Referenced by getPageObject().