ilStructureObject Class Reference

Class ilStructreObject. More...

Inheritance diagram for ilStructureObject:

Collaboration diagram for ilStructureObject:

Public Member Functions
	__construct (&$a_content_obj, $a_id=0)
	Constructor public. More...
	create ($a_upload=false)
	delete ($a_delete_meta_data=true)
	Delete Chapter. More...
	copy ($a_target_lm)
	copy chapter More...
	exportXML (&$a_xml_writer, $a_inst, &$expLog)
	export object to xml (see ilias_co.dtd) More...
	exportXMLMetaData (&$a_xml_writer)
	export structure objects meta data to xml (see ilias_co.dtd) More...
	modifyExportIdentifier ($a_tag, $a_param, $a_value)
	exportXMLPageObjects (&$a_xml_writer, $a_inst=0)
	export page objects of structure object (see ilias_co.dtd) More...
	exportXMLStructureObjects (&$a_xml_writer, $a_inst, &$expLog)
	export (sub)structure objects of structure object (see ilias_co.dtd) More...
	exportFO (&$a_xml_writer)
	export object to fo More...
	exportFOPageObjects (&$a_xml_writer)
	export page objects of structure object (see ilias_co.dtd) 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	_getPresentationTitle ( $a_st_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)
	get presentation title More...
static	getChapterList ($a_lm_id)
	export (sub)structure objects of structure object (see ilias_co.dtd) 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 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
	$tree
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

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

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

Handles StructureObjects of ILIAS Learning Modules (see ILIAS DTD)

Author

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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilStructureObject::__construct	(	&	$a_content_obj,
			$a_id = 0
	)

Constructor public.

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

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

    {
        $this->setType("st");
        parent::__construct($a_content_obj, $a_id);
    }

Here is the call graph for this function:

Member Function Documentation

_getPresentationTitle()

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

get presentation title

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

References $DIC, $i, $ilDB, $query, ilLMObject\$title, $tree, ilLMObject\_lookupContObjID(), ilLMObject\_lookupShortTitle(), ilLMObject\_lookupTitle(), ilDBConstants\FETCHMODE_ASSOC, ilLMTree\getInstance(), ilObjectTranslation\getInstance(), and ilLMObjTranslation\getTitle().

Referenced by ilLMPageObject\_getPresentationTitle(), ilLMObject\_getPresentationTitle(), ilLMTOCExplorerGUI\getNodeContent(), ilLMPresentationGUI\ilLocator(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showPrintViewSelection(), and ilStructureObjectGUI\subchap().

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

        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

(

$a_target_lm

)

copy chapter

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

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

    {
        $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
        $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
        $new_md = $md->cloneMD($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:

create()

ilStructureObject::create

(

$a_upload = false

)

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

    {
        parent::create($a_upload);
    }

delete()

ilStructureObject::delete

(

$a_delete_meta_data = true

)

Delete Chapter.

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

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

    {
        // only relevant for online help authoring
        ilHelpMapping::removeScreenIdsOfChapter($this->getId());

        $this->tree = new ilTree($this->getLmId());
        $this->tree->setTableNames('lm_tree', 'lm_data');
        $this->tree->setTreeTablePK("lm_id");
        $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 ( &  $a_tree,   $a_delete_meta_data = true  )

private

Delete sub tree.

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

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

Referenced by delete().

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

exportFO()

ilStructureObject::exportFO

(

&

$a_xml_writer

)

export object to fo

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

References exportFOPageObjects(), and ilLMObject\getTitle().

    {

        // fo:block (complete)
        $attrs = array();
        $attrs["font-family"] = "Times";
        $attrs["font-size"] = "14pt";
        $a_xml_writer->xmlElement("fo:block", $attrs, $this->getTitle());

        // page objects
        $this->exportFOPageObjects($a_xml_writer);
    }

Here is the call graph for this function:

exportFOPageObjects()

ilStructureObject::exportFOPageObjects

(

&

$a_xml_writer

)

export page objects of structure object (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

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

Referenced by exportFO().

    {
        $this->tree = new ilTree($this->getLmId());
        $this->tree->setTableNames('lm_tree', 'lm_data');
        $this->tree->setTreeTablePK("lm_id");

        $childs = $this->tree->getChilds($this->getId());
        foreach ($childs as $child) {
            if ($child["type"] != "pg") {
                continue;
            }

            // export xml to writer object
            $page_obj = new ilLMPageObject($this->getContentObject(), $child["obj_id"]);
            $page_obj->exportFO($a_xml_writer);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

exportXML()

ilStructureObject::exportXML	(	&	$a_xml_writer,
			$a_inst,
		&	$expLog
	)

export object to xml (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

References exportXMLMetaData(), exportXMLPageObjects(), exportXMLStructureObjects(), and ilLMObject\getId().

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

        // Layout
        // not implemented

        $a_xml_writer->xmlEndTag("StructureObject");
    }

Here is the call graph for this function:

exportXMLMetaData()

ilStructureObject::exportXMLMetaData

(

&

$a_xml_writer

)

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

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

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

Referenced by exportXML().

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

exportXMLPageObjects()

ilStructureObject::exportXMLPageObjects	(	&	$a_xml_writer,
			$a_inst = 0
	)

export page objects of structure object (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

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

Referenced by exportXML().

    {
        $this->tree = new ilTree($this->getLmId());
        $this->tree->setTableNames('lm_tree', 'lm_data');
        $this->tree->setTreeTablePK("lm_id");

        $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	(	&	$a_xml_writer,
			$a_inst,
		&	$expLog
	)

export (sub)structure objects of structure object (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

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

Referenced by exportXML().

    {
        $this->tree = new ilTree($this->getLmId());
        $this->tree->setTableNames('lm_tree', 'lm_data');
        $this->tree->setTreeTablePK("lm_id");

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

static

export (sub)structure objects of structure object (see ilias_co.dtd)

Parameters

object

$a_xml_writer

ilXmlWriter object that receives the xml data

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

References $tree.

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

    {
        $tree = new ilTree($a_lm_id);
        $tree->setTableNames('lm_tree', 'lm_data');
        $tree->setTreeTablePK("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 caller graph for this function:

modifyExportIdentifier()

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

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

References ilLMObject\getId(), and IL_INST_ID.

    {
        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

$is_alias

ilStructureObject::$is_alias

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

$origin_id

ilStructureObject::$origin_id

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

$tree

ilStructureObject::$tree

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

Referenced by _getPresentationTitle(), and getChapterList().

---

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

• Modules/LearningModule/classes/class.ilStructureObject.php