This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilLMPageObject:

Collaboration diagram for ilLMPageObject:

Public Member Functions
	__construct (ilObjLearningModule $a_content_obj, int $a_id=0, bool $a_halt=true)

	read ()

	create (bool $a_upload=false, bool $a_omit_page_object_creation=false, int $a_layout_id=0)

	delete (bool $a_delete_meta_data=true)

	copy (ilObjLearningModule $a_target_lm)

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

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

	getPageObject ()
	get assigned page object More...

	setId (int $a_id)

	getId ()

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

	exportXMLMetaData (ilXmlWriter $a_xml_writer)

	modifyExportIdentifier (string $a_tag, string $a_param, string $a_value)

	exportXMLPageContent (ilXmlWriter $a_xml_writer, int $a_inst=0)

	getQuestionIds ()
	Get question ids note: this method must be called afer exportXMLPageContent. More...

	getMediaObjectIds ()
	get ids of all media objects within the page note: this method must be called afer exportXMLPageContent More...

	getFileItemIds ()
	get ids of all file items within the page note: this method must be called afer exportXMLPageContent More...

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

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

	MDUpdateListener (string $a_element)
	Meta data update listener Important note: Do never call create() or update() method of ilObject here. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

	read ()

	setTitle (string $a_title)

	getTitle ()

	setShortTitle (string $a_title)

	getShortTitle ()

	setDescription (string $a_description)

	getDescription ()

	setType (string $a_type)

	getType ()

	setLMId (int $a_lm_id)

	getLMId ()

	setContentObject (ilObjLearningModule $a_content_obj)

	getContentObject ()

	setId (int $a_id)

	getId ()

	getImportId ()

	setImportId (string $a_id)

	setLayout (string $a_val)

	getLayout ()

	create (bool $a_upload=false)

	update ()

	delete (bool $a_delete_meta_data=true)

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

	getExportIDInfo (int $a_lm_id, int $a_exp_id, string $a_type="pg")

Static Public Member Functions
static	_splitPage (int $a_page_id, string $a_pg_parent_type, string $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 More...

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

static	getPageList (int $lm_id)

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

static	_getPresentationTitle (int $a_pg_id, string $a_mode=self::CHAPTER_TITLE, bool $a_include_numbers=false, bool $a_time_scheduled_activation=false, bool $a_force_content=false, int $a_lm_id=0, string $a_lang="-", bool $a_include_short=false)
	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	_exportXMLAlias (ilXmlWriter $a_xml_writer, int $a_id, int $a_inst=0)
	export page alias to xml More...

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

static	insertPagesFromTemplate (int $lm_id, int $num, int $node_id, bool $first_child, int $layout_id, string $title="")
	Insert (multiple) pages templates at node. More...

Static Public Member Functions inherited from ilLMObject
static	_lookupNID (int $a_lm_id, int $a_lm_obj_id, string $a_type)
	lookup named identifier (ILIAS_NID) More...

static	preloadDataByLM (int $a_lm_id)
	Preload data records by lm. More...

static	_lookupTitle (int $a_obj_id)

static	_lookupShortTitle (int $a_obj_id)

static	_lookupType (int $a_obj_id, int $a_lm_id=0)

static	_writeTitle (int $a_obj_id, string $a_title)

static	_writeImportId (int $a_id, string $a_import_id)

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

static	_isPagePublic (int $a_node_id, bool $a_check_public_mode=false)

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

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

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

static	getObjectList (int $lm_id, string $type="")

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

static	_lookupContObjID (int $a_id)
	get learning module id for lm object More...

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

static	getTree (int $a_cont_obj_id)
	Get learning module tree. More...

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

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

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

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

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

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

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

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

static	_getAllLMObjectsOfLM (int $a_lm_id, string $a_type="")
	Get all objects of learning module. More...

static	saveExportId (int $a_lm_id, int $a_lmobj_id, string $a_exp_id, string $a_type="pg")

static	getExportId (int $a_lm_id, int $a_lmobj_id, string $a_type="pg")

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

static	_getNodePresentationTitle (array $a_node, string $a_mode=self::PAGE_TITLE, bool $a_include_numbers=false, bool $a_time_scheduled_activation=false, bool $a_force_content=false, int $a_lm_id=0, string $a_lang="-")

static	getShortTitles (int $a_lm_id, string $a_lang="-")

static	writeShortTitle (int $a_id, string $a_short_title, string $a_lang="-")

Data Fields
ilLMPage	$page_object = null

Data Fields inherited from ilLMObject
const	CHAPTER_TITLE = "st_title"

const	PAGE_TITLE = "pg_title"

const	NO_HEADER = "none"

int	$lm_id = 0

string	$type = ""

int	$id = 0

array	$data_record

ilObjLearningModule	$content_object

string	$title = ""

string	$short_title = ""

string	$description = ""

bool	$active = true

Protected Attributes
bool	$halt_on_error

array	$files_contained

array	$mobs_contained

bool	$contains_int_link

Protected Attributes inherited from ilLMObject
string	$layout = ""

string	$import_id = ""

ilObjUser	$user

ilDBInterface	$db

Additional Inherited Members
Static Protected Member Functions inherited from ilLMObject
static	_lookup (int $a_obj_id, string $a_field)

Static Protected Attributes inherited from ilLMObject
static	$data_records = array()

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilLMPageObject::__construct	(	ilObjLearningModule	$a_content_obj,
		int	$a_id = `0`,
		bool	$a_halt = `true`
	)

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

References ILIAS\GlobalScreen\Provider\__construct(), read(), and ilLMObject\setType().

       {
         parent::__construct($a_content_obj, $a_id);
         $this->setType("pg");
         $this->id = $a_id;
 
         $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();
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ _exportXMLAlias()

static ilLMPageObject::_exportXMLAlias	(	ilXmlWriter	$a_xml_writer,
		int	$a_id,
		int	$a_inst = `0`
	)

static

export page alias to xml

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

References ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

Referenced by ilStructureObject\exportXMLPageObjects().

      : void {
         $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 call graph for this function:

Here is the caller graph for this function:

◆ _getPresentationTitle()

static ilLMPageObject::_getPresentationTitle	(	int	$a_pg_id,
		string	$a_mode = `self::CHAPTER_TITLE`,
		bool	$a_include_numbers = `false`,
		bool	$a_time_scheduled_activation = `false`,
		bool	$a_force_content = `false`,
		int	$a_lm_id = `0`,
		string	$a_lang = `"-"`,
		bool	$a_include_short = `false`
	)

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 ilLMOBject::CHAPTER_TITLE | ilLMOBject::PAGE_TITLE | ilLMOBject::NO_HEADER

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

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

Referenced by ilLMObject\_getNodePresentationTitle(), ilObjContentObjectGUI\addLocations(), ilLMPageObjectGUI\executeCommand(), exportFO(), ilLMTOCExplorerGUI\getNodeContent(), ilLearningModuleNotification\getPageTitle(), ilGlossaryPresentationGUI\listDefinitions(), ilLMNavigationRendererGUI\render(), ilLMContentRendererGUI\render(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

      : string {
         if ($a_mode == self::NO_HEADER && !$a_force_content) {
             return "";
         }
 
         $cur_cnt = 0;
 
         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 = "";
         if ($a_include_short) {
             $title = trim(ilLMObject::_lookupShortTitle($a_pg_id));
         }
         if ($title == "") {
             $title = ilLMObject::_lookupTitle($a_pg_id);
         }
 
         // this is also optimized since ilObjectTranslation re-uses instances for one lm
         $ot = ilObjectTranslation::getInstance($a_lm_id);
         $languages = $ot->getLanguages();
 
         if ($a_lang != "-" && $ot->getContentActivated()) {
             $lmobjtrans = new ilLMObjTranslation($a_pg_id, $a_lang);
             $trans_title = "";
             if ($a_include_short) {
                 $trans_title = trim($lmobjtrans->getShortTitle());
             }
             if ($trans_title == "") {
                 $trans_title = $lmobjtrans->getTitle();
             }
             if ($trans_title == "") {
                 $lmobjtrans = new ilLMObjTranslation($a_pg_id, $ot->getFallbackLanguage());
                 $trans_title = $lmobjtrans->getTitle();
             }
             if ($trans_title != "") {
                 $title = $trans_title;
             }
         }
 
         if ($a_mode == self::PAGE_TITLE) {
             return $title;
         }
 
         $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) {
                     $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 . ")";
                 }
             }
             return ilStructureObject::_getPresentationTitle(
                 $pred_node["obj_id"],
                 self::CHAPTER_TITLE,
                 $a_include_numbers,
                 false,
                 false,
                 0,
                 $a_lang,
                 true
             ) . $cnt_str;
         } else {
             return $title;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _splitPage()

static ilLMPageObject::_splitPage	(	int	$a_page_id,
		string	$a_pg_parent_type,
		string	$a_hier_id
	)

static

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

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

Referenced by ilPageContentGUI\splitPage().

      : ilLMPageObject {
         // get content object (learning module / digilib book)
         $lm_id = ilLMObject::_lookupContObjID($a_page_id);
         $type = ilObject::_lookupType($lm_id, false);
         $cont_obj = new ilObjLearningModule($lm_id, false);
         $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());
         $page->buildDom(true);
         $page->update();
 
         // copy meta data
         $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()

static ilLMPageObject::_splitPageNext	(	int	$a_page_id,
		string	$a_pg_parent_type,
		string	$a_hier_id
	)

static

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

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

Referenced by ilPageContentGUI\splitPageNext().

      : int {
         // get content object (learning module / digilib book)
         $lm_id = ilLMObject::_lookupContObjID($a_page_id);
         $type = ilObject::_lookupType($lm_id, false);
         $cont_obj = new ilObjLearningModule($lm_id, false);
         $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 (int) $succ["child"];
         }
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignPageObject()

ilLMPageObject::assignPageObject ( ilLMPage $a_page_obj )

assign page object

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

                                                           : void
     {
         $this->page_object = $a_page_obj;
     }

◆ copy()

ilLMPageObject::copy ( ilObjLearningModule $a_target_lm )

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

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

      : ilLMPageObject {
         // copy page
         $lm_page = new ilLMPageObject($a_target_lm);
         $lm_page->setTitle($this->getTitle());
         $lm_page->setShortTitle($this->getShortTitle());
         $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
         $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());
         $lm_page->read();       // this gets the updated page object into lm page
 
         // copy translations
         ilLMObjTranslation::copy($this->getId(), $lm_page->getId());
 
         return $lm_page;
     }

Here is the call graph for this function:

◆ copyToOtherContObject()

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

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

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

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

      : ilLMPageObject {
         // copy page
         $lm_page = new ilLMPageObject($a_cont_obj);
         $lm_page->setTitle($this->getTitle());
         $lm_page->setShortTitle($this->getShortTitle());
         $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
         $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	(	bool	$a_upload = `false`,
		bool	$a_omit_page_object_creation = `false`,
		int	$a_layout_id = `0`
	)

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

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

      : void {
         parent::create($a_upload);
         if ($a_omit_page_object_creation) {
             return;
         }
         if (!is_object($this->page_object)) {
             $this->page_object = new ilLMPage();
         }
         $this->page_object->setId($this->getId());
         $this->page_object->setParentId($this->getLMId());
         if ($a_layout_id == 0) {
             $this->page_object->create(false);
         } else {
             $this->page_object->createWithLayoutId($a_layout_id);
         }
     }

Here is the call graph for this function:

◆ delete()

ilLMPageObject::delete ( bool $a_delete_meta_data = true )

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

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

◆ exportFO()

ilLMPageObject::exportFO ( ilXmlWriter $a_xml_writer )

export page object to fo

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

References ilLMObject\$title, _getPresentationTitle(), ilXmlWriter\appendXML(), getId(), and ilXmlWriter\xmlElement().

      : void {
         $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);
     }

Here is the call graph for this function:

◆ exportXML()

ilLMPageObject::exportXML	(	ilXmlWriter	$a_xml_writer,
		string	$a_mode = `"normal"`,
		int	$a_inst = `0`
	)

export page object to xml (see ilias_co.dtd)

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

References exportXMLMetaData(), exportXMLPageContent(), getId(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

      : void {
         $attrs = array();
         $a_xml_writer->xmlStartTag("PageObject", $attrs);
 
         switch ($a_mode) {
             case "normal":
                 // MetaData
                 $this->exportXMLMetaData($a_xml_writer);
 
                 // PageContent
                 $this->exportXMLPageContent($a_xml_writer, $a_inst);
                 break;
 
             case "alias":
                 $attrs = array();
                 $attrs["OriginId"] = "il_" . $a_inst .
                     "_pg_" . $this->getId();
                 $a_xml_writer->xmlElement("PageAlias", $attrs);
                 break;
         }
         $a_xml_writer->xmlEndTag("PageObject");
     }

Here is the call graph for this function:

◆ exportXMLMetaData()

ilLMPageObject::exportXMLMetaData ( ilXmlWriter $a_xml_writer )

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

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

Referenced by exportXML().

      : void {
         $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	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst = `0`
	)

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

References $xml, ilXmlWriter\appendXML(), and ilPCFileList\collectFileItems().

Referenced by exportXML().

      : void {
         $this->page_object->buildDom();
         $this->page_object->insertInstIntoIDs($a_inst);
         $this->mobs_contained = $this->page_object->collectMediaObjects(false);
         $this->files_contained = ilPCFileList::collectFileItems($this->page_object, $this->page_object->getDomDoc());
         $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 547 of file class.ilLMPageObject.php.

References $files_contained.

                                     : array
     {
         return $this->files_contained;
     }

◆ getId()

ilLMPageObject::getId ( )

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

References ilLMObject\$id.

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

                            : int
     {
         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 538 of file class.ilLMPageObject.php.

References $mobs_contained.

                                        : array
     {
         return $this->mobs_contained;
     }

◆ getPageList()

static ilLMPageObject::getPageList ( int $lm_id )

static

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

References ilLMObject\getObjectList().

Referenced by ilLMPagesTableGUI\__construct(), ilExportIDTableGUI\__construct(), ilObjContentObject\copyAllPagesAndChapters(), ILIAS\LearningModule\Export\LMHtmlExport\exportHTMLPages(), ilObjContentObject\exportXMLPageObjects(), ilLMMultiSrt\getMobIds(), getPagesWithLinksList(), ilLearningModuleExporter\getXmlExportTailDependencies(), ilLearningModuleExporter\getXmlRepresentation(), SurveyQuestionGUI\linkChilds(), assQuestionGUI\outPageSelector(), ilInternalLinkGUI\showLinkHelp(), and ilObjContentObject\validatePages().

                                                   : array
     {
         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

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

References $page_object.

                                    : ilLMPage
     {
         return $this->page_object;
     }

◆ getPagesWithLinksList()

static ilLMPageObject::getPagesWithLinksList	(	int	$a_lm_id,
		string	$a_par_type
	)

static

Get all pages of lm that contain any internal links.

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

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

Referenced by ilLinksTableGUI\getLinks().

      : array {
         $pages = ilLMPageObject::getPageList($a_lm_id);
         $linked_pages = ilLMPage::getPagesWithLinks($a_par_type, $a_lm_id);
         $result = array();
         foreach ($pages as $page) {
             if (isset($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 526 of file class.ilLMPageObject.php.

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

                                     : array
     {
         return ilPCQuestion::_getQuestionIdsForPage(
             $this->content_object->getType(),
             $this->getId()
         );
     }

Here is the call graph for this function:

◆ insertPagesFromTemplate()

static ilLMPageObject::insertPagesFromTemplate	(	int	$lm_id,
		int	$num,
		int	$node_id,
		bool	$first_child,
		int	$layout_id,
		string	$title = `""`
	)

static

Insert (multiple) pages templates at node.

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

References $DIC, $i, $lng, ilLMObject\$title, ilTree\POS_FIRST_NODE, and ilLMObject\putInTree().

Referenced by ilStructureObjectGUI\insertPageFromTemplate().

      : array {
         global $DIC;
 
         $lng = $DIC->language();
 
         if ($title == "") {
             $title = $lng->txt("cont_new_page");
         }
         $lm_tree = new ilLMTree($lm_id);
         $lm = new ilObjLearningModule($lm_id, false);
         if (!$first_child) {    // insert after node id
             $parent_id = $lm_tree->getParentId($node_id);
             $target = $node_id;
         } else {           // insert as first child
             $parent_id = $node_id;
             $target = ilTree::POS_FIRST_NODE;
         }
 
         $page_ids = array();
         for ($i = 1; $i <= $num; $i++) {
             $page = new ilLMPageObject($lm);
             $page->setTitle($title);
             $page->setLMId($lm->getId());
             $page->create(false, false, $layout_id);
             ilLMObject::putInTree($page, $parent_id, $target);
             $page_ids[] = $page->getId();
         }
         $page_ids = array_reverse($page_ids);
         return $page_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyExportIdentifier()

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

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

References getId(), and IL_INST_ID.

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

Here is the call graph for this function:

◆ queryQuestionsOfLearningModule()

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

static

Get questions of learning module.

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

References $DIC, $ilDB, and $query.

Referenced by ilLMTracker\getBlockedUsersInformation(), ilLMQuestionListTableGUI\getItems(), and ilLMTracker\loadLMTrackingData().

      : array {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         // 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 = $a_offset;
         $limit = $a_limit;
         if ($a_limit > 0) {
             $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 58 of file class.ilLMPageObject.php.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setId()

ilLMPageObject::setId ( int $a_id )

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

                                     : void
     {
         $this->id = $a_id;
     }

Field Documentation

◆ $contains_int_link

bool ilLMPageObject::$contains_int_link

protected

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

◆ $files_contained

array ilLMPageObject::$files_contained

protected

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

Referenced by getFileItemIds().

◆ $halt_on_error

bool ilLMPageObject::$halt_on_error

protected

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

◆ $mobs_contained

array ilLMPageObject::$mobs_contained

protected

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

Referenced by getMediaObjectIds().

◆ $page_object

ilLMPage ilLMPageObject::$page_object = null

Definition at line 37 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

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _exportXMLAlias()

◆ _getPresentationTitle()

◆ _splitPage()

◆ _splitPageNext()

◆ assignPageObject()

◆ copy()

◆ copyToOtherContObject()

◆ create()

◆ delete()

◆ exportFO()

◆ exportXML()

◆ exportXMLMetaData()

◆ exportXMLPageContent()

◆ getFileItemIds()

◆ getId()

◆ getMediaObjectIds()

◆ getPageList()

◆ getPageObject()

◆ getPagesWithLinksList()

◆ getQuestionIds()

◆ insertPagesFromTemplate()

◆ modifyExportIdentifier()

◆ queryQuestionsOfLearningModule()

◆ read()

◆ setId()

Field Documentation

◆ $contains_int_link

◆ $files_contained

◆ $halt_on_error

◆ $mobs_contained

◆ $page_object