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

Inheritance diagram for ilStructureObject:

Collaboration diagram for ilStructureObject:

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

	delete (bool $a_delete_meta_data=true)

	copy (ilObjLearningModule $a_target_lm)
	copy chapter More...

	exportXML (ilXmlWriter $a_xml_writer, int $a_inst, ilLog $expLog)

	exportXMLMetaData (ilXmlWriter $a_xml_writer)

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

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

	exportXMLStructureObjects (ilXmlWriter $a_xml_writer, int $a_inst, ilLog $expLog)

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

Static Public Member Functions
static	_getPresentationTitle (int $a_st_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	getChapterList (int $a_lm_id)

Static Public Member Functions inherited from ilLMObject
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	_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	saveTitle (int $id, string $title, string $lang="-")

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
string	$origin_id

ilLMTree	$tree

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
ILIAS Help Map MapManager	$help_map

LOMServices	$lom_services

Protected Attributes inherited from ilLMObject
string	$layout = ""

string	$import_id = ""

ilObjUser	$user

ilDBInterface	$db

LOMServices	$lom_services

Private Member Functions
	delete_rec (ilLMTree $a_tree, bool $a_delete_meta_data=true)
	Delete sub tree. More...

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

static	getPathToExportIDInLOM ()

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 StructureObjects of ILIAS Learning Modules (see ILIAS DTD)

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilStructureObject::__construct	(	ilObjLearningModule	$a_content_obj,
		int	$a_id = `0`
	)

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

References $DIC, ILIAS\GlobalScreen\Provider\__construct(), ilLMObject\getLMId(), and ilLMObject\setType().

       {
         global $DIC;
 
         $this->setType("st");
         parent::__construct($a_content_obj, $a_id);
         $this->tree = new ilLMTree($this->getLMId());
         $this->help_map = $DIC->help()->internal()->domain()->map();
         $this->lom_services = $DIC->learningObjectMetadata();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _getPresentationTitle()

static ilStructureObject::_getPresentationTitle	(	int	$a_st_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

Definition at line 157 of file class.ilStructureObject.php.

References $DIC, $ilDB, ilLMObject\$title, ilLMObject\_lookupContObjID(), ilLMObject\_lookupShortTitle(), ilLMObject\_lookupTitle(), ilDBConstants\FETCHMODE_ASSOC, ilTree\getChildSequenceNumber(), ilLMTree\getInstance(), ilObjectTranslation\getInstance(), ilLMObjTranslation\getTitle(), and ilTree\isInTree().

Referenced by ilLMObject\_getNodePresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilLMNavigationRendererGUI\addDropdown(), ilLMTOCExplorerGUI\getNodeContent(), ilLMPresentationGUI\ilLocator(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

      : string {
         global $DIC;
 
         $ilDB = $DIC->database();
 
         if ($a_lm_id == 0) {
             $a_lm_id = ilLMObject::_lookupContObjID($a_st_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_st_id));
         }
         if ($title == "") {
             $title = ilLMObject::_lookupTitle($a_st_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_st_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_st_id, $ot->getFallbackLanguage());
                 $trans_title = $lmobjtrans->getTitle();
             }
             if ($trans_title != "") {
                 $title = $trans_title;
             }
         }
 
         $tree = ilLMTree::getInstance($a_lm_id);
 
         $nr = "";
         if ($a_include_numbers) {
             // this is optimized, since isInTree is cached
             if ($tree->isInTree($a_st_id)) {
                 // optimization needed from here
 
                 // get chapter tree node
                 $query = "SELECT * FROM lm_tree WHERE child = " .
                     $ilDB->quote($a_st_id, "integer") . " AND lm_id = " .
                     $ilDB->quote($a_lm_id, "integer");
                 $tree_set = $ilDB->query($query);
                 $tree_node = $tree_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
                 $depth = $tree_node["depth"];
 
                 $nr = $tree->getChildSequenceNumber($tree_node, "st") . " ";
                 for ($i = $depth - 1; $i > 1; $i--) {
                     // get next parent tree node
                     $query = "SELECT * FROM lm_tree WHERE child = " .
                         $ilDB->quote($tree_node["parent"], "integer") . " AND lm_id = " .
                         $ilDB->quote($a_lm_id, "integer");
                     $tree_set = $ilDB->query($query);
                     $tree_node = $tree_set->fetchRow(ilDBConstants::FETCHMODE_ASSOC);
                     $seq = $tree->getChildSequenceNumber($tree_node, "st");
 
                     $nr = $seq . "." . $nr;
                 }
             }
         }
 
         return $nr . $title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ copy()

ilStructureObject::copy ( ilObjLearningModule $a_target_lm )

copy chapter

Definition at line 82 of file class.ilStructureObject.php.

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

      : ilStructureObject {
         $chap = new ilStructureObject($a_target_lm);
         $chap->setTitle($this->getTitle());
         if ($this->getLMId() != $a_target_lm->getId()) {
             $chap->setImportId("il__st_" . $this->getId());
         }
         $chap->setLMId($a_target_lm->getId());
         $chap->setType($this->getType());
         $chap->setDescription($this->getDescription());
         $chap->create(true);
         $a_copied_nodes[$this->getId()] = $chap->getId();
 
         // copy meta data
         $this->lom_services->derive()
                            ->fromObject($this->getLMId(), $this->getId(), $this->getType())
                            ->forObject($a_target_lm->getId(), $chap->getId(), $this->getType());
 
         // copy translations
         ilLMObjTranslation::copy($this->getId(), $chap->getId());
 
 
         return $chap;
     }

Here is the call graph for this function:

◆ delete()

ilStructureObject::delete ( bool $a_delete_meta_data = true )

Definition at line 46 of file class.ilStructureObject.php.

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

                                                            : void
     {
         // only relevant for online help authoring
         $this->help_map->removeScreenIdsOfChapter($this->getId());
 
         $node_data = $this->tree->getNodeData($this->getId());
         $this->delete_rec($this->tree, $a_delete_meta_data);
         $this->tree->deleteTree($node_data);
     }

Here is the call graph for this function:

◆ delete_rec()

ilStructureObject::delete_rec	(	ilLMTree	$a_tree,
		bool	$a_delete_meta_data = `true`
	)

private

Delete sub tree.

Definition at line 59 of file class.ilStructureObject.php.

References ilTree\getChilds(), ilLMObject\getId(), and ilLMObjectFactory\getInstance().

Referenced by delete().

      : void {
         $childs = $a_tree->getChilds($this->getId());
         foreach ($childs as $child) {
             $obj = ilLMObjectFactory::getInstance($this->content_object, $child["obj_id"], false);
             if (is_object($obj)) {
                 if ($obj->getType() == "st") {
                     $obj->delete_rec($a_tree, $a_delete_meta_data);
                 }
                 if ($obj->getType() == "pg") {
                     $obj->delete($a_delete_meta_data);
                 }
             }
             unset($obj);
         }
         parent::delete($a_delete_meta_data);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXML()

ilStructureObject::exportXML	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst,
		ilLog	$expLog
	)

Definition at line 108 of file class.ilStructureObject.php.

References exportXMLMetaData(), exportXMLPageObjects(), exportXMLStructureObjects(), ilLMObject\getId(), ilLog\write(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

      : void {
         $expLog->write(date("[y-m-d H:i:s] ") . "Structure Object " . $this->getId());
         $attrs = array();
         $a_xml_writer->xmlStartTag("StructureObject", $attrs);
 
         // MetaData
         $this->exportXMLMetaData($a_xml_writer);
 
         // StructureObjects
         $this->exportXMLPageObjects($a_xml_writer, $a_inst);
 
         // PageObjects
         $this->exportXMLStructureObjects($a_xml_writer, $a_inst, $expLog);
 
         $a_xml_writer->xmlEndTag("StructureObject");
     }

Here is the call graph for this function:

◆ exportXMLMetaData()

ilStructureObject::exportXMLMetaData ( ilXmlWriter $a_xml_writer )

Definition at line 129 of file class.ilStructureObject.php.

Referenced by exportXML().

      : void {
         /*
          * As far as I can tell, this is unused.
          *
          * I traced usages of this method up to ilObjContentObjectGUI::export and
          * ilObjMediaPoolGUI::export (both via ilObjContentObject::exportXML), which have
          * both been made redundant by the usual export mechanisms.
          */
         /*$md2xml = new ilMD2XML($this->getLMId(), $this->getId(), $this->getType());
         $md2xml->setExportMode(true);
         $md2xml->startExport();
         $a_xml_writer->appendXML($md2xml->getXML());*/
     }

Here is the caller graph for this function:

◆ exportXMLPageObjects()

ilStructureObject::exportXMLPageObjects	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst = `0`
	)

Definition at line 244 of file class.ilStructureObject.php.

References ilLMPageObject\_exportXMLAlias(), and ilLMObject\getId().

Referenced by exportXML().

      : void {
         $childs = $this->tree->getChilds($this->getId());
         foreach ($childs as $child) {
             if ($child["type"] != "pg") {
                 continue;
             }
 
             // export xml to writer object
             ilLMPageObject::_exportXMLAlias($a_xml_writer, $child["obj_id"], $a_inst);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ exportXMLStructureObjects()

ilStructureObject::exportXMLStructureObjects	(	ilXmlWriter	$a_xml_writer,
		int	$a_inst,
		ilLog	$expLog
	)

Definition at line 259 of file class.ilStructureObject.php.

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

Referenced by exportXML().

      : void {
         $childs = $this->tree->getChilds($this->getId());
         foreach ($childs as $child) {
             if ($child["type"] != "st") {
                 continue;
             }
 
             // export xml to writer object
             $structure_obj = new ilStructureObject(
                 $this->getContentObject(),
                 $child["obj_id"]
             );
             $structure_obj->exportXML($a_xml_writer, $a_inst, $expLog);
             unset($structure_obj);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChapterList()

static ilStructureObject::getChapterList ( int $a_lm_id )

static

Definition at line 281 of file class.ilStructureObject.php.

References ilTree\getNodeData(), ilTree\getSubTree(), and ilTree\readRootId().

Referenced by ilExportIDTableGUI\__construct(), and ilHelpMappingTableGUI\getChapters().

      : array {
         $tree = new ilLMTree($a_lm_id);
 
         $chapters = array();
         $ndata = $tree->getNodeData($tree->readRootId());
         $childs = $tree->getSubTree($ndata);
         foreach ($childs as $child) {
             if ($child["type"] == "st") {
                 $chapters[] = $child;
             }
         }
         return $chapters;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ modifyExportIdentifier()

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

Definition at line 145 of file class.ilStructureObject.php.

References ilLMObject\getId(), and IL_INST_ID.

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

Here is the call graph for this function:

Field Documentation

◆ $help_map

ILIAS Help Map MapManager ilStructureObject::$help_map

protected

Definition at line 28 of file class.ilStructureObject.php.

◆ $lom_services

LOMServices ilStructureObject::$lom_services

protected

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

◆ $origin_id

string ilStructureObject::$origin_id

Definition at line 30 of file class.ilStructureObject.php.

◆ $tree

ilLMTree ilStructureObject::$tree

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

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

components/ILIAS/LearningModule/classes/class.ilStructureObject.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getPresentationTitle()

◆ copy()

◆ delete()

◆ delete_rec()

◆ exportXML()

◆ exportXMLMetaData()

◆ exportXMLPageObjects()

◆ exportXMLStructureObjects()

◆ getChapterList()

◆ modifyExportIdentifier()

Field Documentation

◆ $help_map

◆ $lom_services

◆ $origin_id

◆ $tree