Inheritance diagram for ilLMPageObject:

Collaboration diagram for ilLMPageObject:

Public Member Functions
	ilLMPageObject (&$a_content_obj, $a_id=0, $a_halt=true)
	Constructor public. More...

	_ilLMPageObject ()

	read ()

	create ($a_upload=false)

	delete ($a_delete_meta_data=true)

	copy ($a_target_lm)
	copy page More...

&	copyToOtherContObject (&$a_cont_obj, &$a_copied_nodes)
	copy a page to another content object (learning module / dlib book) More...

	_splitPage ($a_page_id, $a_pg_parent_type, $a_hier_id)
	split page at hierarchical id More...

	_splitPageNext ($a_page_id, $a_pg_parent_type, $a_hier_id)
	split page to next page at hierarchical id More...

	assignPageObject (&$a_page_obj)
	assign page object More...

&	getPageObject ()
	get assigned page object More...

	setId ($a_id)
	set id More...

	getId ()

	setAlias ($a_is_alias)
	set wether page object is an alias More...

	isAlias ()

	setOriginID ($a_id)

	getOriginID ()

	getPageList ($lm_id)
	static More...

	getPagesWithLinksList ($a_lm_id, $a_par_type)
	Get all pages of lm that contain any internal links. More...

	exportXML (&$a_xml_writer, $a_mode="normal", $a_inst=0)
	export page object to xml (see ilias_co.dtd) More...

	_exportXMLAlias (&$a_xml_writer, $a_id, $a_inst=0)
	export page alias to xml More...

	exportXMLMetaData (&$a_xml_writer)
	export page objects meta data to xml (see ilias_co.dtd) More...

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

	getQuestionIds ()
	Get question ids. More...

	getMediaObjectIds ()
	get ids of all media objects within the page More...

	getFileItemIds ()
	get ids of all file items within the page More...

	exportFO (&$a_xml_writer)
	export page object to fo More...

	queryQuestionsOfLearningModule ($a_lm_id, $a_order_field, $a_order_dir, $a_offset, $a_limit)
	Get questions of learning module. More...

Public Member Functions inherited from ilLMObject
	ilLMObject ($a_content_obj, $a_id=0)

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	_lookupNID ($a_lm_id, $a_lm_obj_id, $a_type)
	lookup named identifier (ILIAS_NID) More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	setDataRecord ($a_record)
	this method should only be called by class ilLMObjectFactory More...

	read ()

	setTitle ($a_title)
	set title of lm object More...

	getTitle ()
	get title of lm object More...

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

	setLayout ($a_val)
	Set layout. More...

	getLayout ()
	Get layout. More...

	_writeImportId ($a_id, $a_import_id)
	write import id to db (static) More...

	create ($a_upload=false)

	update ()
	update complete object More...

	delete ($a_delete_meta_data=true)
	delete lm object data More...

	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

	_getAllObjectsForImportId ($a_import_id, $a_in_lm=0)
	Get all items for an import ID. More...

	_exists ($a_id)
	checks wether a lm content object with specified id exists or not More...

	getObjectList ($lm_id, $type="")
	static More...

	_deleteAllObjectData (&$a_cobj)
	delete all objects of content object (digi book / learning module) More...

	_lookupContObjID ($a_id)
	get learning module / digibook id for lm object More...

	clipboardCut ($a_cont_obj_id, $a_ids)
	Copy a set of chapters/pages into the clipboard. More...

	existsExportID ($a_lm_id, $a_exp_id, $a_type="pg")
	Does export ID exist in lm? More...

	getExportIDInfo ($a_lm_id, $a_exp_id, $a_type="pg")
	Does export ID exist in lm? More...

Static Public Member Functions
static	_getPresentationTitle ($a_pg_id, $a_mode=IL_CHAPTER_TITLE, $a_include_numbers=false, $a_time_scheduled_activation=false, $a_force_content=false, $a_lm_id=0, $a_lang="-")
	presentation title doesn't have to be page title, it may be chapter title + page title or chapter title only, depending on settings More...

Static Public Member Functions inherited from ilLMObject
static	preloadDataByLM ($a_lm_id)
	Preload data records by lm. More...

static	_lookupTitle ($a_obj_id)
	Lookup title. More...

static	_lookupType ($a_obj_id, $a_lm_id=0)
	Lookup type. More...

	_writePublicAccessStatus ($a_pages, $a_cont_obj_id)
	update public access flags in lm_data for all pages of a content object More...

static	_isPagePublic ($a_node_id, $a_check_public_mode=false)

static	putInTree ($a_obj, $a_parent_id="", $a_target_node_id="")
	put this object into content object tree More...

static	getTree ($a_cont_obj_id)
	Get learningmodule tree. More...

static	clipboardCopy ($a_cont_obj_id, $a_ids)
	Copy a set of chapters/pages into the clipboard. More...

static	pasteTree ($a_target_lm, $a_item_id, $a_parent_id, $a_target, $a_insert_time, &$a_copied_nodes, $a_as_copy=false, $a_source_lm=null)
	Paste item (tree) from clipboard to current lm. More...

static	saveTitles ($a_lm, $a_titles, $a_lang="-")
	Save titles for lm objects. More...

static	updateInternalLinks ($a_copied_nodes, $a_parent_type="lm")
	Update internal links, after multiple pages have been copied. More...

static	uniqueTypesCheck ($a_items)
	Check for unique types (all pages or all chapters) More...

static	writeLayout ($a_obj_id, $a_layout, $a_lm=null)
	Write layout setting. More...

static	lookupLayout ($a_obj_id)
	Lookup type. More...

static	getPagesOfChapter ($a_lm_id, $a_chap_id)
	Get pages of chapter. More...

static	saveExportId ($a_lm_id, $a_lmobj_id, $a_exp_id, $a_type="pg")
	Save export id. More...

static	getExportId ($a_lm_id, $a_lmobj_id, $a_type="pg")
	Get export ID. More...

static	getDuplicateExportIDs ($a_lm_id, $a_type="pg")
	Get duplicate export IDs (count export ID usages) More...

static	_getPresentationTitle ($a_node, $a_mode=IL_PAGE_TITLE, $a_include_numbers=false, $a_time_scheduled_activation=false, $a_force_content=false, $a_lm_id=0, $a_lang="-")
	Get affective title. More...

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 Protected Attributes inherited from ilLMObject
static	$data_records = array()

Detailed Description

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.

Author: Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

Definition at line 29 of file class.ilLMPageObject.php.

Member Function Documentation

◆ _exportXMLAlias()

ilLMPageObject::_exportXMLAlias	(	&	$a_xml_writer,
			$a_id,
			$a_inst = `0`
	)

export page alias to xml

Definition at line 557 of file class.ilLMPageObject.php.

Referenced by ilStructureObject\exportXMLPageObjects().

         {
                 $attrs = array();
                 $a_xml_writer->xmlStartTag("PageObject", $attrs);
 
                 $attrs = array();
                 $attrs["OriginId"] = "il_".$a_inst.
                         "_pg_".$a_id;
                 $a_xml_writer->xmlElement("PageAlias", $attrs);
 
                 $a_xml_writer->xmlEndTag("PageObject");
         }

Here is the caller graph for this function:

◆ _getPresentationTitle()

static ilLMPageObject::_getPresentationTitle	(	$a_pg_id,
		$a_mode = `IL_CHAPTER_TITLE`,
		$a_include_numbers = `false`,
		$a_time_scheduled_activation = `false`,
		$a_force_content = `false`,
		$a_lm_id = `0`,
		$a_lang = `"-"`
	)

static

presentation title doesn't have to be page title, it may be chapter title + page title or chapter title only, depending on settings

Parameters

string $a_mode IL_CHAPTER_TITLE | IL_PAGE_TITLE | IL_NO_HEADER

Definition at line 416 of file class.ilLMPageObject.php.

References ilLMObject\$active, ilLMObject\$title, ilStructureObject\_getPresentationTitle(), ilPageObject\_lookupActivationData(), ilPageObject\_lookupActive(), ilLMObject\_lookupContObjID(), ilLMObject\_lookupTitle(), ilObject\_lookupType(), ilLMTree\getInstance(), ilObjectTranslation\getInstance(), IL_NO_HEADER, IL_PAGE_TITLE, and ilUtil\now().

Referenced by ilLMObject\_getPresentationTitle(), ilObjContentObjectGUI\addLocations(), ilLMTOCExplorer\buildTitle(), ilTableOfContentsExplorer\buildTitle(), ilContObjLocatorGUI\display(), ilLMPageObjectGUI\executeCommand(), exportFO(), ilObjContentObjectGUI\formatInvalidLinkArray(), ilLMTOCExplorerGUI\getNodeContent(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilLMSubMenu(), ilLMPresentationGUI\ilPage(), ilGlossaryPresentationGUI\listDefinitions(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

         {
                 if($a_mode == IL_NO_HEADER && !$a_force_content)
                 {
                         return "";
                 }
 
                 if ($a_lm_id == 0)
                 {
                         $a_lm_id = ilLMObject::_lookupContObjID($a_pg_id);
                 }
 
                 if ($a_lm_id == 0)
                 {
                         return "";
                 }
 
                 // this is optimized when ilLMObject::preloadDataByLM is invoked (e.g. done in ilLMExplorerGUI)
                 $title = ilLMObject::_lookupTitle($a_pg_id);
 
                 // this is also optimized since ilObjectTranslation re-uses instances for one lm
                 include_once("./Services/Object/classes/class.ilObjectTranslation.php");
                 $ot = ilObjectTranslation::getInstance($a_lm_id);
                 $languages = $ot->getLanguages();
 
                 if ($a_lang != "-" && $ot->getContentActivated() && isset($languages[$a_lang]))
                 {
                         include_once("./Modules/LearningModule/classes/class.ilLMObjTranslation.php");
                         $lmobjtrans = new ilLMObjTranslation($a_pg_id, $a_lang);
                         if ($lmobjtrans->getTitle() != "")
                         {
                                 $title = $lmobjtrans->getTitle();
                         }
                 }
 
                 if($a_mode == IL_PAGE_TITLE)
                 {
                         return $title;
                 }
 
                 include_once("./Modules/LearningModule/classes/class.ilLMTree.php");
                 $tree = ilLMTree::getInstance($a_lm_id);
 
                 if ($tree->isInTree($a_pg_id))
                 {
                         $pred_node = $tree->fetchPredecessorNode($a_pg_id, "st");
                         $childs = $tree->getChildsByType($pred_node["obj_id"], "pg");
                         $cnt_str = "";
                         if(count($childs) > 1)
                         {
                                 $cnt = 0;
                                 foreach($childs as $child)
                                 {
                                         include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
                                         $active = ilLMPage::_lookupActive($child["obj_id"],
                                                 ilObject::_lookupType($a_lm_id), $a_time_scheduled_activation);
 
                                         if (!$active)
                                         {
                                                 $act_data = ilLMPage::_lookupActivationData((int) $child["obj_id"], ilObject::_lookupType($a_lm_id));
                                                 if ($act_data["show_activation_info"] &&
                                                         (ilUtil::now() < $act_data["activation_start"]))
                                                 {
                                                         $active = true;
                                                 }
                                         }
                                         
                                         if ($child["type"] != "pg" || $active)
                                         {
                                                 $cnt++;
                                         }
                                         if($child["obj_id"] == $a_pg_id)
                                         {
                                                 $cur_cnt = $cnt;
                                         }
                                 }
                                 if ($cnt > 1)
                                 {
                                         $cnt_str = " (".$cur_cnt."/".$cnt.")";
                                 }
                         }
                         require_once("./Modules/LearningModule/classes/class.ilStructureObject.php");
                         //$struct_obj =& new ilStructureObject($pred_node["obj_id"]);
                         //return $struct_obj->getTitle();
                         return ilStructureObject::_getPresentationTitle($pred_node["obj_id"],
                                 $a_include_numbers, false, 0, $a_lang).$cnt_str;
 
                         //return $pred_node["title"].$cnt_str;
                 }
                 else
                 {
                         return $title;
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _ilLMPageObject()

ilLMPageObject::_ilLMPageObject ( )

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

         {
                 if(is_object($this->page_object))
                 {
                         unset($this->page_object);
                 }
         }

◆ _splitPage()

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 199 of file class.ilLMPageObject.php.

References ilLMObject\$lm_id, ilLMObject\$type, ilLMObject\_lookupContObjID(), ilObject\_lookupType(), ilMD\cloneMD(), ilLMPageObject(), and ilTree\setTableNames().

Referenced by ilPageContentGUI\splitPage().

         {
                 // get content object (learning module / digilib book)
                 $lm_id = ilLMObject::_lookupContObjID($a_page_id);
                 $type = ilObject::_lookupType($lm_id, false);
                 switch ($type)
                 {
                         case "lm":
                                 include_once ("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
                                 $cont_obj = new ilObjLearningModule($lm_id, false);
                                 break;
 
                         case "dbk":
                                 include_once ("./Modules/LearningModule/classes/class.ilObjDlBook.php");
                                 $cont_obj = new ilObjDlBook($lm_id, false);
                                 break;
                 }
 
                 $source_lm_page = new ilLMPageObject($cont_obj, $a_page_id);
 
                 // create new page
                 $lm_page = new ilLMPageObject($cont_obj);
                 $lm_page->setTitle($source_lm_page->getTitle());
                 $lm_page->setLMId($source_lm_page->getLMId());
                 $lm_page->setType($source_lm_page->getType());
                 $lm_page->setDescription($source_lm_page->getDescription());
                 $lm_page->create(true);
                 
 
                 // copy complete content of source page to new page
                 $source_page = $source_lm_page->getPageObject();
                 $page = $lm_page->getPageObject();
                 $page->setXMLContent($source_page->copyXMLContent());
 //echo htmlentities($source_page->copyXMLContent());
                 $page->buildDom(true);
                 $page->update();
 //              echo "-".$page->getId()."-".$page->getParentType()."-";
 
                 // copy meta data
                 include_once("Services/MetaData/classes/class.ilMD.php");
                 $md = new ilMD($source_lm_page->getLMId(), $a_page_id, $source_lm_page->getType());
                 $md->cloneMD($source_lm_page->getLMId(), $lm_page->getId(), $source_lm_page->getType());
 
                 // insert new page in tree (after original page)
                 $tree = new ilTree($cont_obj->getId());
                 $tree->setTableNames('lm_tree','lm_data');
                 $tree->setTreeTablePK("lm_id");
                 if ($tree->isInTree($source_lm_page->getId()))
                 {
                         $parent_node = $tree->getParentNodeData($source_lm_page->getId());
                         $tree->insertNode($lm_page->getId(), $parent_node["child"], $source_lm_page->getId());
                 }
 
                 // remove all nodes < hierarchical id from new page (incl. update)
                 $page->addHierIds();
                 $page->deleteContentBeforeHierId($a_hier_id);
 //              $page->update();
 
                 // remove all nodes >= hierarchical id from source page
                 $source_page->buildDom();
                 $source_page->addHierIds();
                 $source_page->deleteContentFromHierId($a_hier_id);
                                 
                 return $lm_page;
                 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _splitPageNext()

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 273 of file class.ilLMPageObject.php.

References ilLMObject\$lm_id, ilLMObject\$type, ilLMObject\_lookupContObjID(), ilObject\_lookupType(), ilPageObject\_moveContentAfterHierId(), ilLMPageObject(), and ilTree\setTableNames().

Referenced by ilPageContentGUI\splitPageNext().

         {
                 // get content object (learning module / digilib book)
                 $lm_id = ilLMObject::_lookupContObjID($a_page_id);
                 $type = ilObject::_lookupType($lm_id, false);
                 switch ($type)
                 {
                         case "lm":
                                 include_once ("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
                                 $cont_obj = new ilObjLearningModule($lm_id, false);
                                 break;
 
                         case "dbk":
                                 include_once ("./Modules/LearningModule/classes/class.ilObjDlBook.php");
                                 $cont_obj = new ilObjDlBook($lm_id, false);
                                 break;
                 }
                 $tree = new ilTree($cont_obj->getId());
                 $tree->setTableNames('lm_tree','lm_data');
                 $tree->setTreeTablePK("lm_id");
 
                 $source_lm_page =& new ilLMPageObject($cont_obj, $a_page_id);
                 $source_page =& $source_lm_page->getPageObject();
                 
                 // get next page
                 $succ = $tree->fetchSuccessorNode($a_page_id, "pg");
                 if ($succ["child"] > 0)
                 {
                         $target_lm_page =& new ilLMPageObject($cont_obj, $succ["child"]);
                         $target_page =& $target_lm_page->getPageObject();
                         $target_page->buildDom();
                         $target_page->addHierIds();
                         
                         // move nodes to target page
                         $source_page->buildDom();
                         $source_page->addHierIds();
                         ilLMPage::_moveContentAfterHierId($source_page, $target_page, $a_hier_id);
                         //$source_page->deleteContentFromHierId($a_hier_id);
                         
                         return $succ["child"];
                 }
                                 
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignPageObject()

ilLMPageObject::assignPageObject ( & $a_page_obj )

assign page object

Parameters

object $a_page_obj page object

Definition at line 323 of file class.ilLMPageObject.php.

         {
                 $this->page_object =& $a_page_obj;
         }

◆ copy()

ilLMPageObject::copy ( $a_target_lm )

copy page

Definition at line 106 of file class.ilLMPageObject.php.

References ilLMObjTranslation\copy(), ilLMObject\existsExportID(), ilLMObject\getDescription(), ilLMObject\getExportId(), getId(), ilLMObject\getLayout(), ilLMObject\getLMId(), ilLMObject\getTitle(), ilLMObject\getType(), ilLMPageObject(), and ilLMObject\saveExportId().

         {
                 // copy page 
                 $lm_page = new ilLMPageObject($a_target_lm);
                 $lm_page->setTitle($this->getTitle());
                 $lm_page->setLayout($this->getLayout());
                 $lm_page->setLMId($a_target_lm->getId());
                 $lm_page->setType($this->getType());
                 $lm_page->setDescription($this->getDescription());
                 $lm_page->setImportId("il__pg_".$this->getId());
                 $lm_page->create(true);         // setting "upload" flag to true prevents creating of meta data
 
                 // check whether export id already exists in the target lm
                 $del_exp_id = false;
                 $exp_id = ilLMPageObject::getExportId($this->getLMId(), $this->getId());
                 if (trim($exp_id) != "")
                 {
                         if (ilLMPageObject::existsExportID($a_target_lm->getId(), $exp_id))
                         {
                                 $del_exp_id = true;
                         }
                 }
 
                 // copy meta data
                 include_once("Services/MetaData/classes/class.ilMD.php");
                 $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
                 $new_md = $md->cloneMD($a_target_lm->getId(), $lm_page->getId(), $this->getType());
 
                 // check whether export id already exists in the target lm
                 if ($del_exp_id)
                 {
                         ilLMPageObject::saveExportId($a_target_lm->getId(), $lm_page->getId(), "");
                 }
                 else
                 {
                         ilLMPageObject::saveExportId($a_target_lm->getId(), $lm_page->getId(),
                                 trim($exp_id));
                 }
 
                 // copy page content and activation
                 $page = $lm_page->getPageObject();
                 $this->page_object->copy($page->getId(), $page->getParentType(), $page->getParentId());
                 /*$page->setXMLContent($this->page_object->copyXMLContent());
                 $page->setActive($this->page_object->getActive());
                 $page->setActivationStart($this->page_object->getActivationStart());
                 $page->setActivationEnd($this->page_object->getActivationEnd());
                 $page->buildDom();
                 $page->update();*/
                 $lm_page->read();       // this gets the updated page object into lm page
 
                 // copy translations
                 include_once("./Modules/LearningModule/classes/class.ilLMObjTranslation.php");
                 ilLMObjTranslation::copy($this->getId(), $lm_page->getId());
 
                 return $lm_page;
         }

Here is the call graph for this function:

◆ copyToOtherContObject()

& ilLMPageObject::copyToOtherContObject	(	&	$a_cont_obj,
		&	$a_copied_nodes
	)

copy a page to another content object (learning module / dlib book)

Definition at line 166 of file class.ilLMPageObject.php.

References ilLMObject\getDescription(), getId(), ilLMObject\getLMId(), ilLMObject\getTitle(), ilLMObject\getType(), and ilLMPageObject().

         {
                 // copy page
                 $lm_page =& new ilLMPageObject($a_cont_obj);
                 $lm_page->setTitle($this->getTitle());
                 $lm_page->setLMId($a_cont_obj->getId());
                 $lm_page->setImportId("il__pg_".$this->getId());
                 $lm_page->setType($this->getType());
                 $lm_page->setDescription($this->getDescription());
                 $lm_page->create(true);         // setting "upload" flag to true prevents creating of meta data
                 $a_copied_nodes[$this->getId()] = $lm_page->getId();
 
                 // copy meta data
                 include_once("Services/MetaData/classes/class.ilMD.php");
                 $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
                 $new_md =& $md->cloneMD($a_cont_obj->getId(), $lm_page->getId(), $this->getType());
 
                 // copy page content
                 $page =& $lm_page->getPageObject();
                 $page->setXMLContent($this->page_object->getXMLContent());
                 $page->buildDom();
                 $page->update();
 
                 return $lm_page;
         }

Here is the call graph for this function:

◆ create()

ilLMPageObject::create ( $a_upload = false )

Definition at line 84 of file class.ilLMPageObject.php.

References getId(), and ilLMObject\getLMId().

         {
                 parent::create($a_upload);
                 if(!is_object($this->page_object))
                 {
                         $this->page_object = new ilLMPage();
                 }
                 $this->page_object->setId($this->getId());
                 $this->page_object->setParentId($this->getLMId());
                 $this->page_object->create($a_upload);
         }

Here is the call graph for this function:

◆ delete()

ilLMPageObject::delete ( $a_delete_meta_data = true )

Definition at line 96 of file class.ilLMPageObject.php.

         {
                 parent::delete($a_delete_meta_data);
                 $this->page_object->delete();
         }

◆ exportFO()

ilLMPageObject::exportFO ( & $a_xml_writer )

export page object to fo

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

Definition at line 661 of file class.ilLMPageObject.php.

References $ilBench, ilLMObject\$title, _getPresentationTitle(), and getId().

         {
                 global $ilBench;
 
                 //$attrs = array();
                 //$a_xml_writer->xmlStartTag("PageObject", $attrs);
                 $title = ilLMPageObject::_getPresentationTitle($this->getId());
                 if ($title != "")
                 {
                         $attrs = array();
                         $attrs["font-family"] = "Times";
                         $attrs["font-size"] = "14pt";
                         $a_xml_writer->xmlElement("fo:block", $attrs, $title);
                 }
 
                 // PageContent
                 $this->page_object->buildDom();
                 $fo = $this->page_object->getFO();
                 $a_xml_writer->appendXML($fo);
 
                 //$a_xml_writer->xmlEndTag("PageObject");
         }

Here is the call graph for this function:

◆ exportXML()

ilLMPageObject::exportXML	(	&	$a_xml_writer,
			$a_mode = `"normal"`,
			$a_inst = `0`
	)

export page object to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

Definition at line 519 of file class.ilLMPageObject.php.

References $ilBench, exportXMLMetaData(), and exportXMLPageContent().

         {
                 global $ilBench;
 
                 $attrs = array();
                 $a_xml_writer->xmlStartTag("PageObject", $attrs);
 
                 switch ($a_mode)
                 {
                         case "normal":
                                 // MetaData
                                 $ilBench->start("ContentObjectExport", "exportPageObject_XML_Meta");
                                 $this->exportXMLMetaData($a_xml_writer);
                                 $ilBench->stop("ContentObjectExport", "exportPageObject_XML_Meta");
 
                                 // PageContent
                                 $ilBench->start("ContentObjectExport", "exportPageObject_XML_PageContent");
                                 $this->exportXMLPageContent($a_xml_writer, $a_inst);
                                 $ilBench->stop("ContentObjectExport", "exportPageObject_XML_PageContent");
                                 break;
 
                         case "alias":
                                 $attrs = array();
                                 $attrs["OriginId"] = "il_".$a_inst.
                                         "_pg_".$this->getId();
                                 $a_xml_writer->xmlElement("PageAlias", $attrs);
                                 break;
                 }
 
                 // Layout
                 // not implemented
 
                 $a_xml_writer->xmlEndTag("PageObject");
         }

Here is the call graph for this function:

◆ exportXMLMetaData()

ilLMPageObject::exportXMLMetaData ( & $a_xml_writer )

export page objects meta data to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

Definition at line 577 of file class.ilLMPageObject.php.

References getId(), ilLMObject\getLMId(), and ilLMObject\getType().

Referenced by exportXML().

         {
                 include_once("Services/MetaData/classes/class.ilMD2XML.php");
                 $md2xml = new ilMD2XML($this->getLMId(), $this->getId(), $this->getType());
                 $md2xml->setExportMode(true);
                 $md2xml->startExport();
                 $a_xml_writer->appendXML($md2xml->getXML());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXMLPageContent()

ilLMPageObject::exportXMLPageContent	(	&	$a_xml_writer,
			$a_inst = `0`
	)

export page objects meta data to xml (see ilias_co.dtd)

Parameters

object $a_xml_writer ilXmlWriter object that receives the xml data

Definition at line 604 of file class.ilLMPageObject.php.

References ilPCFileList\collectFileItems(), and ilLMObject\getContentObject().

Referenced by exportXML().

         {
 //echo "exportxmlpagecontent:$a_inst:<br>";
                 $cont_obj = $this->getContentObject();
 
                 $this->page_object->buildDom();
                 $this->page_object->insertInstIntoIDs($a_inst);
                 $this->mobs_contained = $this->page_object->collectMediaObjects(false);
                 //$this->files_contained = $this->page_object->collectFileItems();
                 include_once("./Services/COPage/classes/class.ilPCFileList.php");
                 $this->files_contained = ilPCFileList::collectFileItems($this->page_object, $this->page_object->getDomDoc());
 //              $this->questions_contained = $this->page_object->getQuestionIds();
                 $xml = $this->page_object->getXMLFromDom(false, false, false, "", true);
                 $xml = str_replace("&","&amp;", $xml);
                 $a_xml_writer->appendXML($xml);
 
                 $this->page_object->freeDom();
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getFileItemIds()

ilLMPageObject::getFileItemIds ( )

get ids of all file items within the page

note: this method must be called afer exportXMLPageContent

Definition at line 650 of file class.ilLMPageObject.php.

         {
                 return $this->files_contained;
         }

◆ getId()

ilLMPageObject::getId ( )

Definition at line 348 of file class.ilLMPageObject.php.

References $id.

Referenced by copy(), copyToOtherContObject(), create(), exportFO(), exportXMLMetaData(), getQuestionIds(), and modifyExportIdentifier().

         {
                 return $this->id;
         }

Here is the caller graph for this function:

◆ getMediaObjectIds()

ilLMPageObject::getMediaObjectIds ( )

get ids of all media objects within the page

note: this method must be called afer exportXMLPageContent

Definition at line 640 of file class.ilLMPageObject.php.

         {
                 return $this->mobs_contained;
         }

◆ getOriginID()

ilLMPageObject::getOriginID ( )

Definition at line 373 of file class.ilLMPageObject.php.

References $origin_id.

         {
                 return $this->origin_id;
         }

◆ getPageList()

ilLMPageObject::getPageList ( $lm_id )

static

Definition at line 381 of file class.ilLMPageObject.php.

References ilLMObject\$lm_id, and ilLMObject\getObjectList().

Referenced by ilLMPagesTableGUI\__construct(), ilExportIDTableGUI\__construct(), ilObjContentObject\copyAllPagesAndChapters(), ilObjContentObject\exportHTMLPages(), ilObjContentObject\exportXMLPageObjects(), getPagesWithLinksList(), SurveyQuestionGUI\linkChilds(), assQuestionGUI\outPageSelector(), ilObjContentObjectGUI\pages(), ilInternalLinkGUI\showLinkHelp(), and ilObjContentObject\validatePages().

         {
                 return ilLMObject::getObjectList($lm_id, "pg");
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPageObject()

& ilLMPageObject::getPageObject ( )

get assigned page object

Returns: object page object

Definition at line 334 of file class.ilLMPageObject.php.

References $page_object.

         {
                 return $this->page_object;
         }

◆ getPagesWithLinksList()

ilLMPageObject::getPagesWithLinksList	(	$a_lm_id,
		$a_par_type
	)

Get all pages of lm that contain any internal links.

Definition at line 389 of file class.ilLMPageObject.php.

References $result, getPageList(), and ilPageObject\getPagesWithLinks().

Referenced by ilLinksTableGUI\getLinks().

         {
                 $pages = ilLMPageObject::getPageList($a_lm_id);
                 $ids = array();
                 foreach($pages as $page)
                 {
                         $ids[] = $page["obj_id"];
                 }
 
                 $linked_pages = ilLMPage::getPagesWithLinks($a_par_type, $a_lm_id);
                 $result = array();
                 foreach($pages as $page)
                 {
                         if (is_array($linked_pages[$page["obj_id"]]))
                         {
                                 $result[] = $page;
                         }
                 }
                 return $result;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getQuestionIds()

ilLMPageObject::getQuestionIds ( )

Get question ids.

note: this method must be called afer exportXMLPageContent

Definition at line 628 of file class.ilLMPageObject.php.

References ilPCQuestion\_getQuestionIdsForPage(), and getId().

         {
                 include_once("./Services/COPage/classes/class.ilPCQuestion.php");
                 return ilPCQuestion::_getQuestionIdsForPage($this->content_object->getType(),
                         $this->getId());
         }

Here is the call graph for this function:

◆ ilLMPageObject()

ilLMPageObject::ilLMPageObject	(	&	$a_content_obj,
			$a_id = `0`,
			$a_halt = `true`
	)

Constructor public.

Definition at line 42 of file class.ilLMPageObject.php.

References $ilBench, $ilias, read(), and ilLMObject\setType().

Referenced by _splitPage(), _splitPageNext(), copy(), and copyToOtherContObject().

         {
                 global $ilias, $ilBench;
 
                 $ilBench->start("ContentPresentation", "ilLMPageObject_Constructor");
 
                 parent::ilLMObject($a_content_obj, $a_id);
                 $this->setType("pg");
                 $this->id = $a_id;
 
                 $this->is_alias = false;
                 $this->contains_int_link = false;
                 $this->mobs_contained  = array();
                 $this->files_contained  = array();
                 $this->halt_on_error = $a_halt;
 
                 if($a_id != 0)
                 {
                         $this->read();
                 }
 
                 $ilBench->stop("ContentPresentation", "ilLMPageObject_Constructor");
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAlias()

ilLMPageObject::isAlias ( )

Definition at line 361 of file class.ilLMPageObject.php.

References $is_alias.

         {
                 return $this->is_alias;
         }

◆ modifyExportIdentifier()

ilLMPageObject::modifyExportIdentifier	(	$a_tag,
		$a_param,
		$a_value
	)

Definition at line 586 of file class.ilLMPageObject.php.

References getId().

         {
                 if ($a_tag == "Identifier" && $a_param == "Entry")
                 {
                         $a_value = "il_".IL_INST_ID."_pg_".$this->getId();
                         //$a_value = ilUtil::insertInstIntoID($a_value);
                 }
 
                 return $a_value;
         }

Here is the call graph for this function:

◆ queryQuestionsOfLearningModule()

ilLMPageObject::queryQuestionsOfLearningModule	(	$a_lm_id,
		$a_order_field,
		$a_order_dir,
		$a_offset,
		$a_limit
	)

Get questions of learning module.

Parameters

Definition at line 690 of file class.ilLMPageObject.php.

References $query, and $result.

Referenced by ilLMQuestionListTableGUI\getItems().

         {
                 global $ilDB, $rbacreview;
 
 
                 // count query
                 $count_query = "SELECT count(pq.question_id) cnt ";
 
                 // basic query
                 $query = "SELECT pq.page_id, pq.question_id ";
 
                 $from = " FROM page_question pq JOIN lm_tree t ON (t.lm_id = ".$ilDB->quote($a_lm_id, "integer").
                         " AND pq.page_id = t.child and pq.page_parent_type = ".$ilDB->quote("lm", "text").") ".
                         " WHERE t.lm_id = ".$ilDB->quote($a_lm_id, "integer");
                 $count_query.= $from;
                 $query.= $from;
 
 
                 // count query
                 $set = $ilDB->query($count_query);
                 $cnt = 0;
                 if ($rec = $ilDB->fetchAssoc($set))
                 {
                         $cnt = $rec["cnt"];
                 }
 
                 $offset = (int) $a_offset;
                 $limit = (int) $a_limit;
                 $ilDB->setLimit($limit, $offset);
 
                 // set query
                 $set = $ilDB->query($query);
                 $result = array();
                 while($rec = $ilDB->fetchAssoc($set))
                 {
                         $result[] = $rec;
                 }
                 return array("cnt" => $cnt, "set" => $result);
         }

Here is the caller graph for this function:

◆ read()

ilLMPageObject::read ( )

Definition at line 77 of file class.ilLMPageObject.php.

Referenced by ilLMPageObject().

         {
                 parent::read();
 
                 $this->page_object = new ilLMPage($this->id, 0);
         }

Here is the caller graph for this function:

◆ setAlias()

ilLMPageObject::setAlias ( $a_is_alias )

set wether page object is an alias

Definition at line 356 of file class.ilLMPageObject.php.

         {
                 $this->is_alias = $a_is_alias;
         }

◆ setId()

ilLMPageObject::setId ( $a_id )

set id

Definition at line 343 of file class.ilLMPageObject.php.

         {
                 $this->id = $a_id;
         }

◆ setOriginID()

ilLMPageObject::setOriginID ( $a_id )

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

         {
                 return $this->origin_id = $a_id;
         }

Field Documentation

◆ $dom

ilLMPageObject::$dom

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

◆ $id

ilLMPageObject::$id

Definition at line 33 of file class.ilLMPageObject.php.

Referenced by getId().

◆ $ilias

ilLMPageObject::$ilias

Definition at line 34 of file class.ilLMPageObject.php.

Referenced by ilLMPageObject().

◆ $is_alias

ilLMPageObject::$is_alias

Definition at line 31 of file class.ilLMPageObject.php.

Referenced by isAlias().

◆ $origin_id

ilLMPageObject::$origin_id

Definition at line 32 of file class.ilLMPageObject.php.

Referenced by getOriginID().

◆ $page_object

ilLMPageObject::$page_object

Definition at line 36 of file class.ilLMPageObject.php.

Referenced by getPageObject().

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

Modules/LearningModule/classes/class.ilLMPageObject.php

Public Member Functions

Static Public Member Functions

Data Fields

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ _exportXMLAlias()

◆ _getPresentationTitle()

◆ _ilLMPageObject()

◆ _splitPage()

◆ _splitPageNext()

◆ assignPageObject()

◆ copy()

◆ copyToOtherContObject()

◆ create()

◆ delete()

◆ exportFO()

◆ exportXML()

◆ exportXMLMetaData()

◆ exportXMLPageContent()

◆ getFileItemIds()

◆ getId()

◆ getMediaObjectIds()

◆ getOriginID()

◆ getPageList()

◆ getPageObject()

◆ getPagesWithLinksList()

◆ getQuestionIds()

◆ ilLMPageObject()

◆ isAlias()

◆ modifyExportIdentifier()

◆ queryQuestionsOfLearningModule()

◆ read()

◆ setAlias()

◆ setId()

◆ setOriginID()

Field Documentation

◆ $dom

◆ $id

◆ $ilias

◆ $is_alias

◆ $origin_id

◆ $page_object