Inheritance diagram for ilLMPageObject:

Collaboration diagram for ilLMPageObject:

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

	__desctruct ()

	read ()

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

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

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

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

	exportXML (&$a_xml_writer, $a_mode="normal", $a_inst=0)
	export page object to xml (see ilias_co.dtd) 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...

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

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

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

	setShortTitle ($a_title)
	set short title of lm object More...

	getShortTitle ()
	get short title of lm object More...

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

	create ($a_upload=false)

	update ()
	update complete object More...

	delete ($a_delete_meta_data=true)
	delete lm object data 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	_splitPage ($a_page_id, $a_pg_parent_type, $a_hier_id)
	split page at hierarchical id More...

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

static	getPageList ($lm_id)
	static More...

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

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

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

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

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

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

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

static	_lookupShortTitle ($a_obj_id)
	Lookup short title. More...

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

static	_writeTitle ($a_obj_id, $a_title)

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

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

static	_isPagePublic ($a_node_id, $a_check_public_mode=false)

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

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

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

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

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

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

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	clipboardCut ($a_cont_obj_id, $a_ids)
	Copy a set of chapters/pages into the clipboard. 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	_getAllLMObjectsOfLM ($a_lm_id, $a_type="")
	Get all objects of learning module. 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=self::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...

static	getShortTitles ($a_lm_id, $a_lang="-")
	Get short titles. More...

static	writeShortTitle ($a_id, $a_short_title, $a_lang="-")
	Write short title. More...

Data Fields
	$is_alias

	$origin_id

	$id

	$dom

	$page_object

Data Fields inherited from ilLMObject
const	CHAPTER_TITLE = "st_title"

const	PAGE_TITLE = "pg_title"

const	NO_HEADER = "none"

	$lm_id

	$type

	$id

	$meta_data

	$data_record

	$content_object

	$title

	$short_title

	$description

	$active = true

Additional Inherited Members
Static Protected Member Functions inherited from ilLMObject
static	_lookup ($a_obj_id, $a_field)
	Lookup title. More...

Protected Attributes inherited from ilLMObject
	$user

	$db

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

Constructor & Destructor Documentation

◆ __construct()

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

Constructor @access public.

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

    {
        parent::__construct($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();
        }
    }

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

Here is the call graph for this function:

Member Function Documentation

◆ __desctruct()

ilLMPageObject::__desctruct ( )

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

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

◆ _exportXMLAlias()

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

static

export page alias to xml

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

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

Referenced by ilStructureObject\exportXMLPageObjects().

Here is the caller graph for this function:

◆ _getPresentationTitle()

static ilLMPageObject::_getPresentationTitle	(	$a_pg_id,
		$a_mode = `self::CHAPTER_TITLE`,
		$a_include_numbers = `false`,
		$a_time_scheduled_activation = `false`,
		$a_force_content = `false`,
		$a_lm_id = `0`,
		$a_lang = `"-"`,
		$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 366 of file class.ilLMPageObject.php.

      {
        if ($a_mode == self::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 = "";
        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() && isset($languages[$a_lang])) {
            $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 != "") {
                $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;
        }
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _splitPage()

static ilLMPageObject::_splitPage	(	$a_page_id,
		$a_pg_parent_type,
		$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 180 of file class.ilLMPageObject.php.

    {
        // 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());
        //echo htmlentities($source_page->copyXMLContent());
        $page->buildDom(true);
        $page->update();
        //              echo "-".$page->getId()."-".$page->getParentType()."-";
 
        // 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;
    }

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

Referenced by ilPageContentGUI\splitPage().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _splitPageNext()

static ilLMPageObject::_splitPageNext	(	$a_page_id,
		$a_pg_parent_type,
		$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 239 of file class.ilLMPageObject.php.

    {
        // 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 $succ["child"];
        }
    }

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

Referenced by ilPageContentGUI\splitPageNext().

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

    {
        $this->page_object = $a_page_obj;
    }

◆ copy()

ilLMPageObject::copy ( $a_target_lm )

copy page

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

    {
        // 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;
    }

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

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

    {
        // 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;
    }

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

Here is the call graph for this function:

◆ create()

ilLMPageObject::create	(	$a_upload = `false`,
		$a_omit_page_object_creation = `false`,
		$a_layout_id = `0`
	)

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

    {
        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($a_upload);
        } else {
            $this->page_object->createWithLayoutId($a_layout_id);
        }
    }

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

Here is the call graph for this function:

◆ delete()

ilLMPageObject::delete ( $a_delete_meta_data = true )

delete lm object data

Reimplemented from ilLMObject.

Definition at line 86 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 604 of file class.ilLMPageObject.php.

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

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

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

    {
        $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;
        }
 
        // Layout
        // not implemented
 
        $a_xml_writer->xmlEndTag("PageObject");
    }

References exportXMLMetaData(), exportXMLPageContent(), and getId().

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

    {
        $md2xml = new ilMD2XML($this->getLMId(), $this->getId(), $this->getType());
        $md2xml->setExportMode(true);
        $md2xml->startExport();
        $a_xml_writer->appendXML($md2xml->getXML());
    }

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

Referenced by exportXML().

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

    {
        $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 = 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();
    }

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

Referenced by exportXML().

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

    {
        return $this->files_contained;
    }

◆ getId()

ilLMPageObject::getId ( )

Reimplemented from ilLMObject.

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

    {
        return $this->id;
    }

References $id.

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

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

    {
        return $this->mobs_contained;
    }

◆ getOriginID()

ilLMPageObject::getOriginID ( )

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

    {
        return $this->origin_id;
    }

References $origin_id.

◆ getPageList()

static ilLMPageObject::getPageList ( $lm_id )

static

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

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

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

Referenced by ilExportIDTableGUI\__construct(), ilLMPagesTableGUI\__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().

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

    {
        return $this->page_object;
    }

References $page_object.

◆ getPagesWithLinksList()

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

static

Get all pages of lm that contain any internal links.

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

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

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

Referenced by ilLinksTableGUI\getLinks().

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

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

References ilPCQuestion\_getQuestionIdsForPage().

Here is the call graph for this function:

◆ insertPagesFromTemplate()

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

static

Insert (multiple) pages templates at node.

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

    {
        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 = IL_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;
    }

References $DIC, $i, ilLMObject\$lm_id, $lng, ilLMObject\$title, IL_FIRST_NODE, and ilLMObject\putInTree().

Referenced by ilStructureObjectGUI\insertPageFromTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isAlias()

ilLMPageObject::isAlias ( )

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

    {
        return $this->is_alias;
    }

References $is_alias.

◆ modifyExportIdentifier()

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

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

    {
        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;
    }

References getId().

Here is the call graph for this function:

◆ queryQuestionsOfLearningModule()

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

static

Get questions of learning module.

Parameters

return

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

      {
        global $DIC;
 
        $ilDB = $DIC->database();
        $rbacreview = $DIC->rbac()->review();
 
 
        // 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;
        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);
    }

References $DIC, $ilDB, $query, and $result.

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

Here is the caller graph for this function:

◆ read()

ilLMPageObject::read ( )

Reimplemented from ilLMObject.

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

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

Referenced by __construct().

Here is the caller graph for this function:

◆ setAlias()

ilLMPageObject::setAlias ( $a_is_alias )

set wether page object is an alias

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

    {
        $this->is_alias = $a_is_alias;
    }

◆ setId()

ilLMPageObject::setId ( $a_id )

set id

Reimplemented from ilLMObject.

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

    {
        $this->id = $a_id;
    }

◆ setOriginID()

ilLMPageObject::setOriginID ( $a_id )

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

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

Field Documentation

◆ $dom

ilLMPageObject::$dom

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

◆ $id

ilLMPageObject::$id

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

Referenced by getId().

◆ $is_alias

ilLMPageObject::$is_alias

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

Referenced by isAlias().

◆ $origin_id

ilLMPageObject::$origin_id

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

Referenced by getOriginID().

◆ $page_object

ilLMPageObject::$page_object

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

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ __desctruct()

◆ _exportXMLAlias()

◆ _getPresentationTitle()

◆ _splitPage()

◆ _splitPageNext()

◆ assignPageObject()

◆ copy()

◆ copyToOtherContObject()

◆ create()

◆ delete()

◆ exportFO()

◆ exportXML()

◆ exportXMLMetaData()

◆ exportXMLPageContent()

◆ getFileItemIds()

◆ getId()

◆ getMediaObjectIds()

◆ getOriginID()

◆ getPageList()

◆ getPageObject()

◆ getPagesWithLinksList()

◆ getQuestionIds()

◆ insertPagesFromTemplate()

◆ isAlias()

◆ modifyExportIdentifier()

◆ queryQuestionsOfLearningModule()

◆ read()

◆ setAlias()

◆ setId()

◆ setOriginID()

Field Documentation

◆ $dom

◆ $id

◆ $is_alias

◆ $origin_id

◆ $page_object