ilLMObject Class Reference

Class ilLMObject. More...

Inheritance diagram for ilLMObject:

Collaboration diagram for ilLMObject:

Public Member Functions
	ilLMObject ($a_content_obj, $a_id=0)
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	_lookupNID ($a_lm_id, $a_lm_obj_id, $a_type)
	lookup named identifier (ILIAS_NID) More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	setDataRecord ($a_record)
	this method should only be called by class ilLMObjectFactory More...
	read ()
	setTitle ($a_title)
	set title of lm object More...
	getTitle ()
	get title of lm object More...
	_writeTitle ($a_obj_id, $a_title)
	setDescription ($a_description)
	getDescription ()
	setType ($a_type)
	getType ()
	setLMId ($a_lm_id)
	getLMId ()
	setContentObject (&$a_content_obj)
&	getContentObject ()
	setId ($a_id)
	getId ()
	getImportId ()
	setImportId ($a_id)
	setLayout ($a_val)
	Set layout. More...
	getLayout ()
	Get layout. More...
	_writeImportId ($a_id, $a_import_id)
	write import id to db (static) More...
	create ($a_upload=false)
	update ()
	update complete object More...
	delete ($a_delete_meta_data=true)
	delete lm object data More...
	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
	_getAllObjectsForImportId ($a_import_id, $a_in_lm=0)
	Get all items for an import ID. More...
	_exists ($a_id)
	checks wether a lm content object with specified id exists or not More...
	getObjectList ($lm_id, $type="")
	static More...
	_deleteAllObjectData (&$a_cobj)
	delete all objects of content object (digi book / learning module) More...
	_lookupContObjID ($a_id)
	get learning module / digibook id for lm object More...
	clipboardCut ($a_cont_obj_id, $a_ids)
	Copy a set of chapters/pages into the clipboard. More...
	existsExportID ($a_lm_id, $a_exp_id, $a_type="pg")
	Does export ID exist in lm? More...
	getExportIDInfo ($a_lm_id, $a_exp_id, $a_type="pg")
	Does export ID exist in lm? More...

Static Public Member Functions
static	preloadDataByLM ($a_lm_id)
	Preload data records by lm. More...
static	_lookupTitle ($a_obj_id)
	Lookup title. More...
static	_lookupType ($a_obj_id, $a_lm_id=0)
	Lookup type. More...
	_writePublicAccessStatus ($a_pages, $a_cont_obj_id)
	update public access flags in lm_data for all pages of a content object@access public More...
static	_isPagePublic ($a_node_id, $a_check_public_mode=false)
static	putInTree ($a_obj, $a_parent_id="", $a_target_node_id="")
	put this object into content object tree More...
static	getTree ($a_cont_obj_id)
	Get learningmodule tree. More...
static	clipboardCopy ($a_cont_obj_id, $a_ids)
	Copy a set of chapters/pages into the clipboard. More...
static	pasteTree ($a_target_lm, $a_item_id, $a_parent_id, $a_target, $a_insert_time, &$a_copied_nodes, $a_as_copy=false, $a_source_lm=null)
	Paste item (tree) from clipboard to current lm. More...
static	saveTitles ($a_lm, $a_titles, $a_lang="-")
	Save titles for lm objects. More...
static	updateInternalLinks ($a_copied_nodes, $a_parent_type="lm")
	Update internal links, after multiple pages have been copied. More...
static	uniqueTypesCheck ($a_items)
	Check for unique types (all pages or all chapters) More...
static	writeLayout ($a_obj_id, $a_layout, $a_lm=null)
	Write layout setting. More...
static	lookupLayout ($a_obj_id)
	Lookup type. More...
static	getPagesOfChapter ($a_lm_id, $a_chap_id)
	Get pages of chapter. More...
static	_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=IL_PAGE_TITLE, $a_include_numbers=false, $a_time_scheduled_activation=false, $a_force_content=false, $a_lm_id=0, $a_lang="-")
	Get affective title. More...

Data Fields
	$ilias
	$lm_id
	$type
	$id
	$meta_data
	$data_record
	$content_object
	$title
	$description
	$active = true

Static Protected Attributes
static	$data_records = array()

Detailed Description

Class ilLMObject.

Base class for ilStructureObjects and ilPageObjects (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 17 of file class.ilLMObject.php.

Member Function Documentation

_deleteAllObjectData()

ilLMObject::_deleteAllObjectData

(

&

$a_cobj

)

delete all objects of content object (digi book / learning module)

Definition at line 721 of file class.ilLMObject.php.

        {
                global $ilDB;
                
                include_once './Services/Xml/classes/class.ilNestedSetXML.php';
 
                $query = "SELECT * FROM lm_data ".
                        "WHERE lm_id= ".$ilDB->quote($a_cobj->getId(), "integer");
                $obj_set = $ilDB->query($query);
 
                require_once("./Modules/LearningModule/classes/class.ilLMObjectFactory.php");
                while ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        $lm_obj = ilLMObjectFactory::getInstance($a_cobj, $obj_rec["obj_id"],false);
 
                        if (is_object($lm_obj))
                        {
                                $lm_obj->delete(true);
                        }
                }
 
                return true;
        }

References $ilDB, $query, and ilLMObjectFactory\getInstance().

Referenced by ilObjContentObject\delete().

Here is the call graph for this function:

Here is the caller graph for this function:

_exists()

ilLMObject::_exists

(

$a_id

)

checks wether a lm content object with specified id exists or not

Parameters

int

$id

id

Returns

boolean true, if lm content object exists

Definition at line 666 of file class.ilLMObject.php.

        {
                global $ilDB;
                
                include_once("./Services/Link/classes/class.ilInternalLink.php");
                if (is_int(strpos($a_id, "_")))
                {
                        $a_id = ilInternalLink::_extractObjIdOfTarget($a_id);
                }
 
                $q = "SELECT * FROM lm_data WHERE obj_id = ".
                        $ilDB->quote($a_id, "integer");
                $obj_set = $ilDB->query($q);
                if ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        return true;
                }
                else
                {
                        return false;
                }
 
        }

References $ilDB, and ilInternalLink\_extractObjIdOfTarget().

Referenced by ilInternalLink\_exists(), ilLinksTableGUI\fillRow(), getDuplicateExportIDs(), ilLMPresentationGUI\ilPage(), ilHelpGUI\showHelp(), and ilLMPresentationGUI\showPrintView().

Here is the call graph for this function:

Here is the caller graph for this function:

_getAllLMObjectsOfLM()

static ilLMObject::_getAllLMObjectsOfLM (   $a_lm_id,   $a_type = ""  )

static

Get all objects of learning module.

Parameters

return

Definition at line 1358 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $and = ($a_type != "")
                        ? " AND type = ".$ilDB->quote($a_type, "text")
                        : "";
 
                $set = $ilDB->query("SELECT obj_id FROM lm_data ".
                        " WHERE lm_id = ".$ilDB->quote($a_lm_id, "integer").$and);
                $obj_ids = array();
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        $obj_ids[] = $rec["obj_id"];
                }
 
                return $obj_ids;
        }

References $ilDB.

Referenced by ilLMTableOfContentsExplorerGUI\__construct(), and ilLMTracker\loadLMTrackingData().

Here is the caller graph for this function:

_getAllObjectsForImportId()

ilLMObject::_getAllObjectsForImportId	(		$a_import_id,
			$a_in_lm = 0
	)

Get all items for an import ID.

(only for items notnot in trash)

Parameters

int

$a_import_id

import id

Returns

int id

Definition at line 632 of file class.ilLMObject.php.

        {
                global $ilDB;
                
                $where = ($a_in_lm > 0)
                        ? " AND lm_id = ".$ilDB->quote($a_in_lm, "integer")." "
                        : "";
                
                $q = "SELECT * FROM lm_data WHERE import_id = ".
                        $ilDB->quote($a_import_id, "text")." ".
                        $where.
                        " ORDER BY create_date DESC";
                $obj_set = $ilDB->query($q);
                
                $items = array();
                while ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        // check, whether lm is not trashed
                        if (ilObject::_hasUntrashedReference($obj_rec["lm_id"]))
                        {
                                $items[] = $obj_rec;
                        }
                }
 
                return $items;
        }

References $ilDB, and ilObject\_hasUntrashedReference().

Referenced by updateInternalLinks().

Here is the call graph for this function:

Here is the caller graph for this function:

_getIdForImportId()

ilLMObject::_getIdForImportId

(

$a_import_id

)

get current object id for import id (static)

import ids can exist multiple times (if the same learning module has been imported multiple times). we get the object id of the last imported object, that is not in trash

Parameters

int

$a_import_id

import id

Returns

int id

Definition at line 598 of file class.ilLMObject.php.

        {
                global $ilDB;
                
                $q = "SELECT obj_id FROM lm_data WHERE import_id = ".
                        $ilDB->quote($a_import_id, "text")." ".
                        " ORDER BY create_date DESC";
                $obj_set = $ilDB->query($q);
                while ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        $lm_id = ilLMObject::_lookupContObjID($obj_rec["obj_id"]);
 
                        // link only in learning module, that is not trashed
                        include_once("./Services/Help/classes/class.ilObjHelpSettings.php");
                        $ref_ids  = ilObject::_getAllReferences($lm_id);        // will be 0 if import of lm is in progress (new import)
                        if (count($ref_ids) == 0 || ilObject::_hasUntrashedReference($lm_id) ||
                                ilObjHelpSettings::isHelpLM($lm_id))
                        {
                                return $obj_rec["obj_id"];
                        }
                }
 
                return 0;
        }

References $ilDB, $lm_id, ilObject\_getAllReferences(), ilObject\_hasUntrashedReference(), _lookupContObjID(), and ilObjHelpSettings\isHelpLM().

Referenced by ilInternalLink\_getIdForImportId(), SurveyQuestion\_resolveInternalLink(), and assQuestion\_resolveInternalLink().

Here is the call graph for this function:

Here is the caller graph for this function:

_getPresentationTitle()

static ilLMObject::_getPresentationTitle (   $a_node,   $a_mode = IL_PAGE_TITLE,   $a_include_numbers = false,   $a_time_scheduled_activation = false,   $a_force_content = false,   $a_lm_id = 0,   $a_lang = "-"  )

static

Get affective title.

Parameters

return

Reimplemented in ilLMPageObject.

Definition at line 1519 of file class.ilLMObject.php.

        {
                if ($a_lang == "")
                {
                        $a_lang = "-";
                }
                
                if ($a_node["type"] == "st")
                {
                        include_once './Modules/LearningModule/classes/class.ilStructureObject.php';
                        return ilStructureObject::_getPresentationTitle($a_node["child"],
                                $a_include_numbers, $a_time_scheduled_activation, $a_lm_id, $a_lang);
                }
                else
                {
                        include_once './Modules/LearningModule/classes/class.ilLMPageObject.php';
                        return ilLMPageObject::_getPresentationTitle($a_node["child"],
                                $a_mode, $a_include_numbers, $a_time_scheduled_activation,
                                $a_force_content, $a_lm_id, $a_lang);
                }
        }

References ilLMPageObject\_getPresentationTitle(), and ilStructureObject\_getPresentationTitle().

Referenced by ilLMExplorerGUI\getNodeContent(), and ilPublicSectionExplorerGUI\getNodeContent().

Here is the call graph for this function:

Here is the caller graph for this function:

_isPagePublic()

static ilLMObject::_isPagePublic (   $a_node_id,   $a_check_public_mode = false  )

static

Definition at line 539 of file class.ilLMObject.php.

        {
                global $ilDB,$ilLog;
 
                if (empty($a_node_id))
                {
                        $message = sprintf('ilLMObject::_isPagePublic(): Invalid parameter! $a_node_id is empty');
                        $ilLog->write($message,$ilLog->WARNING);
                        return false;
                }
                
                if ($a_check_public_mode === true)
                {
                        $lm_id = ilLMObject::_lookupContObjId($a_node_id);
 
                        $q = "SELECT public_access_mode FROM content_object WHERE id = ".
                                $ilDB->quote($lm_id, "integer");
                        $r = $ilDB->query($q);
                        $row = $ilDB->fetchAssoc($r);
                        
                        if ($row["public_access_mode"] == "complete")
                        {
                                return true;
                        }
                }
 
                $q = "SELECT public_access FROM lm_data WHERE obj_id=".
                        $ilDB->quote($a_node_id, "integer");
                $r = $ilDB->query($q);
                $row = $ilDB->fetchAssoc($r);
                
                return ilUtil::yn2tf($row["public_access"]);
        }

References $ilDB, $ilLog, $lm_id, $r, $row, and ilUtil\yn2tf().

Referenced by ilLMPresentationGUI\executeCommand(), ilLMPresentationGUI\getCurrentPageId(), ilLMPresentationGUI\getSuccessorPage(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilPage(), ilShopPublicSectionSelector\isClickable(), ilLMTOCExplorerGUI\isNodeClickable(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

Here is the call graph for this function:

Here is the caller graph for this function:

_lookupContObjID()

ilLMObject::_lookupContObjID

(

$a_id

)

get learning module / digibook id for lm object

Definition at line 748 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                if (isset(self::$data_records[$a_id]))
                {
                        return self::$data_records[$a_id]["lm_id"];
                }
 
                $query = "SELECT lm_id FROM lm_data WHERE obj_id = ".
                        $ilDB->quote($a_id, "integer");
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
 
                return $obj_rec["lm_id"];
        }

References $ilDB, and $query.

Referenced by ilObjContentObjectAccess\_checkGoto(), ilStartUpGUI\_checkGoto(), _getIdForImportId(), ilLMPageObject\_getPresentationTitle(), ilStructureObject\_getPresentationTitle(), ilLMPageObjectGUI\_goto(), ilStructureObjectGUI\_goto(), ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), SurveyQuestion\addInternalLink(), ilObjMediaObjectAccess\checkAccessGlossaryTerm(), ilLinksTableGUI\fillRow(), ilLearningModuleImporter\finalProcessing(), ilGlossaryPresentationGUI\getLinkXML(), ilLMPageObjectGUI\getLinkXML(), ilLMPresentationGUI\getLinkXML(), ilObjMediaObject\getParentObjectIdForUsage(), ilGlossaryPresentationGUI\listDefinitions(), ilObjContentObjectGUI\pastePage(), pasteTree(), ilPageObjectGUI\setDefaultLinkXml(), SurveyQuestion\setMaterial(), and updateInternalLinks().

Here is the caller graph for this function:

_lookupNID()

ilLMObject::_lookupNID	(		$a_lm_id,
			$a_lm_obj_id,
			$a_type
	)

lookup named identifier (ILIAS_NID)

Definition at line 101 of file class.ilLMObject.php.

        {
                include_once 'Services/MetaData/classes/class.ilMD.php';
//echo "-".$a_lm_id."-".$a_lm_obj_id."-".$a_type."-";
                $md = new ilMD($a_lm_id, $a_lm_obj_id, $a_type);
                $md_gen = $md->getGeneral();
                if (is_object($md_gen))
                {
                        foreach($md_gen->getIdentifierIds() as $id)
                        {
                                $md_id = $md_gen->getIdentifier($id);
                                if ($md_id->getCatalog() == "ILIAS_NID")
                                {
                                        return $md_id->getEntry();
                                }
                        }
                }
                
                return false;
        }

References $id.

_lookupTitle()

static ilLMObject::_lookupTitle (   $a_obj_id )

static

Lookup title.

Parameters

int	lm object id

Definition at line 262 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                if (isset(self::$data_records[$a_obj_id]))
                {
                        return self::$data_records[$a_obj_id]["title"];
                }
 
                $query = "SELECT title FROM lm_data WHERE obj_id = ".
                        $ilDB->quote($a_obj_id, "integer");
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
 
                return $obj_rec["title"];
        }

References $ilDB, and $query.

Referenced by ilLMPageObject\_getPresentationTitle(), ilStructureObject\_getPresentationTitle(), clipboardCopy(), ilObjContentObjectGUI\confirmedDelete(), ilObjContentObject\executeDragDrop(), ilObjContentObject\exportHTMLPages(), ilCourseObjectiveMaterialAssignmentTableGUI\fillRow(), ilCourseObjectivesTableGUI\fillRow(), ilTermUsagesTableGUI\fillRow(), ilLinksTableGUI\fillRow(), ilLMQuestionListTableGUI\fillRow(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ilLMTracker\getBlockedUsersInformation(), ilObjLearningModuleSubItemListGUI\getHTML(), ilImageMapEditorGUI\getMapAreaLinkString(), ilLinkInputGUI\getTranslatedValue(), ilLMPresentationGUI\ilPage(), ilCourseObjectiveMaterialAssignmentTableGUI\parse(), ilHelpGUI\search(), ilHelpGUI\showHelp(), ilHelpGUI\showPage(), ilLMPresentationGUI\showPreconditionsOfPage(), and ilObjContentObject\validatePages().

Here is the caller graph for this function:

_lookupType()

static ilLMObject::_lookupType (   $a_obj_id,   $a_lm_id = 0  )

static

Lookup type.

Parameters

int	id of pg st
int	id of lm object [optional]

Definition at line 285 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                if (isset(self::$data_records[$a_obj_id]))
                {
                        if ($a_lm_id == 0 || self::$data_records[$a_obj_id]["lm_id"] == $a_lm_id)
                        {
                                return self::$data_records[$a_obj_id]["type"];
                        }
                }
 
                if($a_lm_id)
                {
                        $and = ' AND lm_id = '.$ilDB->quote($a_lm_id,'integer');
                }
 
                $query = "SELECT type FROM lm_data WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer").$and;
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
 
                return $obj_rec["type"];
        }

References $ilDB, and $query.

Referenced by ilStructureObjectGUI\activatePages(), clipboardCopy(), ilLMPresentationGUI\getCurrentPageId(), ilObjLearningModuleSubItemListGUI\getHTML(), ilLMTOCExplorerGUI\getRootNode(), ilLMPresentationGUI\getSuccessorPage(), ilLMPresentationGUI\ilLMNavigation(), ilLMPresentationGUI\ilPage(), ilLMPresentationGUI\ilTOC(), ilPageObject\moveIntLinks(), pasteTree(), ilSCORM2004Node\pasteTree(), ilObjContentObjectGUI\saveExportIds(), ilLMPresentationGUI\showPrintView(), ilLMPresentationGUI\showTableOfContents(), uniqueTypesCheck(), updateInternalLinks(), ilCourseObjectivesGUI\updateMaterialAssignment(), and writeLayout().

Here is the caller graph for this function:

_writeImportId()

ilLMObject::_writeImportId	(		$a_id,
			$a_import_id
	)

write import id to db (static)

Parameters

int	$a_id	lm object id
string	$a_import_id	import id @access public

Definition at line 409 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $q = "UPDATE lm_data ".
                        "SET ".
                        "import_id = ".$ilDB->quote($a_import_id, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_id, "integer");
 
                $ilDB->manipulate($q);
        }

References $ilDB.

Referenced by ilContObjParser\handlerEndTag().

Here is the caller graph for this function:

_writePublicAccessStatus()

ilLMObject::_writePublicAccessStatus (   $a_pages,   $a_cont_obj_id  )

static

update public access flags in lm_data for all pages of a content object@access public

Parameters

array	page ids
integer	content object id

Returns

of the jedi

Definition at line 478 of file class.ilLMObject.php.

        {
                global $ilDB,$ilLog,$ilErr,$ilTree;
                
                if (!is_array($a_pages))
                {$a_pages = array(0);
                        /*$message = sprintf('ilLMObject::_writePublicAccessStatus(): Invalid parameter! $a_pages must be an array');
                        $ilLog->write($message,$ilLog->WARNING);
                        $ilErr->raiseError($message,$ilErr->MESSAGE);
                        return false;*/
                }
                
                if (empty($a_cont_obj_id))
                {
                        $message = sprintf('ilLMObject::_writePublicAccessStatus(): Invalid parameter! $a_cont_obj_id is empty');
                        $ilLog->write($message,$ilLog->WARNING);
                        $ilErr->raiseError($message,$ilErr->MESSAGE);
                        return false;
                }
                
                // update structure entries: if at least one page of a chapter is public set chapter to public too
                $lm_tree = new ilTree($a_cont_obj_id);
                $lm_tree->setTableNames('lm_tree','lm_data');
                $lm_tree->setTreeTablePK("lm_id");
                $lm_tree->readRootId();
                
                // get all st entries of cont_obj
                $q = "SELECT obj_id FROM lm_data " . 
                         "WHERE lm_id = ".$ilDB->quote($a_cont_obj_id, "integer")." " .
                         "AND type = 'st'";
                $r = $ilDB->query($q);
                
                // add chapters with a public page to a_pages
                while ($row = $ilDB->fetchAssoc($r))
                {
                        $childs = $lm_tree->getChilds($row["obj_id"]);
                        
                        foreach ($childs as $page)
                        {
                                if ($page["type"] == "pg" and in_array($page["obj_id"],$a_pages))
                                {
                                        array_push($a_pages, $row["obj_id"]);
                                        break;
                                }
                        }
                }
                
                // update public access status of all pages of cont_obj
                $q = "UPDATE lm_data SET " .
                         "public_access = CASE " .
                         "WHEN ".$ilDB->in("obj_id", $a_pages, false, "integer")." ".
                         "THEN ".$ilDB->quote("y", "text").
                         "ELSE ".$ilDB->quote("n", "text").
                         "END " .
                         "WHERE lm_id = ".$ilDB->quote($a_cont_obj_id, "integer")." " .
                         "AND ".$ilDB->in("type", array("pg", "st"), false, "text");
                $ilDB->manipulate($q);
                
                return true;
        }

References $ilDB, $ilErr, $ilLog, $r, and $row.

Referenced by ilObjContentObjectGUI\savePublicSection(), and ilObjContentObjectGUI\savePublicSectionPages().

Here is the caller graph for this function:

_writeTitle()

ilLMObject::_writeTitle	(		$a_obj_id,
			$a_title
	)

Definition at line 310 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $query = "UPDATE lm_data SET ".
                        " title = ".$ilDB->quote($a_title, "text").
                        " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");
                $ilDB->manipulate($query);
        }

References $ilDB, and $query.

Referenced by MDUpdateListener(), and saveTitles().

Here is the caller graph for this function:

clipboardCopy()

static ilLMObject::clipboardCopy (   $a_cont_obj_id,   $a_ids  )

static

Copy a set of chapters/pages into the clipboard.

Definition at line 887 of file class.ilLMObject.php.

        {
                global $ilUser;
                
                $tree = ilLMObject::getTree($a_cont_obj_id);
                
                $ilUser->clipboardDeleteObjectsOfType("pg");
                $ilUser->clipboardDeleteObjectsOfType("st");
                
                // put them into the clipboard
                $time = date("Y-m-d H:i:s", time());
                $order = 0;
                foreach ($a_ids as $id)
                {
                        $curnode = array();
                        if ($tree->isInTree($id))
                        {
                                $curnode = $tree->getNodeData($id);
                                $subnodes = $tree->getSubTree($curnode);
                                foreach($subnodes as $subnode)
                                {
                                        if ($subnode["child"] != $id)
                                        {
                                                $ilUser->addObjectToClipboard($subnode["child"],
                                                        $subnode["type"], $subnode["title"],
                                                        $subnode["parent"], $time, $subnode["lft"]);
                                        }
                                }
                        }
                        $order = ($curnode["lft"] > 0)
                                ? $curnode["lft"]
                                : (int) ($order + 1);
                        $ilUser->addObjectToClipboard($id,
                                ilLMObject::_lookupType($id), ilLMObject::_lookupTitle($id), 0, $time,
                                $order);
                }
        }

References $id, $ilUser, _lookupTitle(), _lookupType(), and getTree().

Referenced by clipboardCut(), ilStructureObjectGUI\copyItems(), ilObjContentObjectGUI\copyItems(), and ilObjContentObjectGUI\copyPage().

Here is the call graph for this function:

Here is the caller graph for this function:

clipboardCut()

ilLMObject::clipboardCut	(		$a_cont_obj_id,
			$a_ids
	)

Copy a set of chapters/pages into the clipboard.

Definition at line 839 of file class.ilLMObject.php.

        {
                $tree = ilLMObject::getTree($a_cont_obj_id);
                
                if (!is_array($a_ids))
                {
                        return false;
                }
                else
                {
                        // get all "top" ids, i.e. remove ids, that have a selected parent
                        foreach($a_ids as $id)
                        {
                                $path = $tree->getPathId($id);
                                $take = true;
                                foreach($path as $path_id)
                                {
                                        if ($path_id != $id && in_array($path_id, $a_ids))
                                        {
                                                $take = false;
                                        }
                                }
                                if ($take)
                                {
                                        $cut_ids[] = $id;
                                }
                        }
                }
                
                ilLMObject::clipboardCopy($a_cont_obj_id, $cut_ids);
                
                // remove the objects from the tree
                // note: we are getting chapters which are *not* in the tree
                // we do not delete any pages/chapters here
                foreach ($cut_ids as $id)
                {
                        $curnode = $tree->getNodeData($id);
                        if ($tree->isInTree($id))
                        {
                                $tree->deleteTree($curnode);
                        }
                }
 
        }

References $id, $path, clipboardCopy(), and getTree().

Referenced by ilObjContentObjectGUI\cutItems(), ilStructureObjectGUI\cutItems(), and ilObjContentObjectGUI\movePage().

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilLMObject::create

(

$a_upload = false

)

Reimplemented in ilStructureObject.

Definition at line 422 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                // insert object data
                $this->setId($ilDB->nextId("lm_data"));
                $query = "INSERT INTO lm_data (obj_id, title, type, layout, lm_id, import_id, create_date) ".
                        "VALUES (".
                        $ilDB->quote($this->getId(), "integer").",".
                        $ilDB->quote($this->getTitle(), "text").",".
                        $ilDB->quote($this->getType(), "text").", ".
                        $ilDB->quote($this->getLayout(), "text").", ".
                        $ilDB->quote($this->getLMId(), "integer").",".
                        $ilDB->quote($this->getImportId(), "text").
                        ", ".$ilDB->now().")";
                $ilDB->manipulate($query);
 
                // create history entry
                include_once("./Services/History/classes/class.ilHistory.php");
                ilHistory::_createEntry($this->getId(), "create", "",
                        $this->content_object->getType().":".$this->getType());
 
                if (!$a_upload)
                {
                        $this->createMetaData();
                }
 
        }

References $ilDB, $query, ilHistory\_createEntry(), createMetaData(), getId(), getImportId(), getLayout(), getLMId(), getTitle(), getType(), and setId().

Here is the call graph for this function:

createMetaData()

ilLMObject::createMetaData

(

)

create meta data entry

Definition at line 126 of file class.ilLMObject.php.

        {
                include_once 'Services/MetaData/classes/class.ilMDCreator.php';
 
                global $ilUser;
 
                $md_creator = new ilMDCreator($this->getLMId(), $this->getId(), $this->getType());
                $md_creator->setTitle($this->getTitle());
                $md_creator->setTitleLanguage($ilUser->getPref('language'));
                $md_creator->setDescription($this->getDescription());
                $md_creator->setDescriptionLanguage($ilUser->getPref('language'));
                $md_creator->setKeywordLanguage($ilUser->getPref('language'));
                $md_creator->setLanguage($ilUser->getPref('language'));
                $md_creator->create();
 
                return true;
        }

References $ilUser, getDescription(), getId(), getLMId(), getTitle(), and getType().

Referenced by create().

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilLMObject::delete

(

$a_delete_meta_data = true

)

delete lm object data

Reimplemented in ilLMPageObject, and ilStructureObject.

Definition at line 576 of file class.ilLMObject.php.

        {
                global $ilDB;
                
                $query = "DELETE FROM lm_data WHERE obj_id = ".
                        $ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($query);
 
                $this->deleteMetaData();
        }

References $ilDB, $query, deleteMetaData(), and getId().

Here is the call graph for this function:

deleteMetaData()

ilLMObject::deleteMetaData

(

)

delete meta data entry

Definition at line 173 of file class.ilLMObject.php.

        {
                // Delete meta data
                include_once('Services/MetaData/classes/class.ilMD.php');
                $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
                $md->deleteAll();
        }

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

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

existsExportID()

ilLMObject::existsExportID	(		$a_lm_id,
			$a_exp_id,
			$a_type = "pg"
	)

Does export ID exist in lm?

Parameters

return

Definition at line 1473 of file class.ilLMObject.php.

        {
                include_once("./Services/MetaData/classes/class.ilMDIdentifier.php");
                return ilMDIdentifier::existsIdInRbacObject($a_lm_id, $a_type, "ILIAS_NID", $a_exp_id);
        }

References ilMDIdentifier\existsIdInRbacObject().

Referenced by ilLMPageObject\copy().

Here is the call graph for this function:

Here is the caller graph for this function:

getContentObject()

& ilLMObject::getContentObject

(

)

Definition at line 357 of file class.ilLMObject.php.

        {
                return $this->content_object;
        }

References $content_object.

Referenced by ilStructureObject\exportFOPageObjects(), ilLMPageObject\exportXMLPageContent(), and ilStructureObject\exportXMLStructureObjects().

Here is the caller graph for this function:

getDescription()

ilLMObject::getDescription

(

)

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

        {
                return $this->description;
        }

References $description.

Referenced by ilLMPageObject\copy(), ilStructureObject\copy(), ilLMPageObject\copyToOtherContObject(), and createMetaData().

Here is the caller graph for this function:

getDuplicateExportIDs()

static ilLMObject::getDuplicateExportIDs (   $a_lm_id,   $a_type = "pg"  )

static

Get duplicate export IDs (count export ID usages)

Definition at line 1482 of file class.ilLMObject.php.

        {
                include_once("./Services/MetaData/classes/class.ilMDIdentifier.php");
                $entries = ilMDIdentifier::_getEntriesForRbacObj($a_lm_id, $a_type);
                $res = array();
                foreach ($entries as $e)
                {
                        if ($e["catalog"] == "ILIAS_NID")
                        {
                                if (ilLMObject::_exists($e["obj_id"]))
                                {
                                        $res[trim($e["entry"])]++;
                                }
                        }
                }
                return $res;
        }

References $res, _exists(), and ilMDIdentifier\_getEntriesForRbacObj().

Referenced by ilExportIDTableGUI\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

getExportId()

static ilLMObject::getExportId (   $a_lm_id,   $a_lmobj_id,   $a_type = "pg"  )

static

Get export ID.

Parameters

return

Definition at line 1451 of file class.ilLMObject.php.

        {
                // look for export id
                include_once("./Services/MetaData/classes/class.ilMDIdentifier.php");
                $entries = ilMDIdentifier::_getEntriesForObj(
                        $a_lm_id, $a_lmobj_id, $a_type);
 
                foreach ($entries as $e)
                {
                        if ($e["catalog"] == "ILIAS_NID")
                        {
                                return $e["entry"];
                        }
                }
        }

References ilMDIdentifier\_getEntriesForObj().

Referenced by ilLMPageObject\copy(), ilObjContentObject\exportHTMLPages(), ilExportIDTableGUI\fillRow(), ilLMPresentationGUI\getLink(), and ilLMTOCExplorerGUI\getNodeHref().

Here is the call graph for this function:

Here is the caller graph for this function:

getExportIDInfo()

ilLMObject::getExportIDInfo	(		$a_lm_id,
			$a_exp_id,
			$a_type = "pg"
	)

Does export ID exist in lm?

Parameters

return

Definition at line 1506 of file class.ilLMObject.php.

        {
                include_once("./Services/MetaData/classes/class.ilMDIdentifier.php");
                $data = ilMDIdentifier::readIdData($a_lm_id, $a_type, "ILIAS_NID", $a_exp_id);
                return $data;
        }

References $data, and ilMDIdentifier\readIdData().

Here is the call graph for this function:

getId()

ilLMObject::getId

(

)

Reimplemented in ilLMPageObject.

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

        {
                return $this->id;
        }

References $id.

Referenced by ilStructureObject\copy(), create(), createMetaData(), delete(), ilStructureObject\delete(), ilStructureObject\delete_rec(), deleteMetaData(), ilStructureObject\exportFOPageObjects(), ilStructureObject\exportXML(), ilStructureObject\exportXMLMetaData(), ilStructureObject\exportXMLPageObjects(), ilStructureObject\exportXMLStructureObjects(), MDUpdateListener(), ilStructureObject\modifyExportIdentifier(), update(), and updateMetaData().

Here is the caller graph for this function:

getImportId()

ilLMObject::getImportId

(

)

Definition at line 372 of file class.ilLMObject.php.

        {
                return $this->import_id;
        }

Referenced by create().

Here is the caller graph for this function:

getLayout()

ilLMObject::getLayout

(

)

Get layout.

Returns

string layout

Definition at line 397 of file class.ilLMObject.php.

        {
                return $this->layout;
        }

Referenced by ilLMPageObject\copy(), create(), and update().

Here is the caller graph for this function:

getLMId()

ilLMObject::getLMId

(

)

Definition at line 347 of file class.ilLMObject.php.

        {
                return $this->lm_id;
        }

References $lm_id.

Referenced by ilLMPageObject\copy(), ilStructureObject\copy(), ilLMPageObject\copyToOtherContObject(), create(), ilLMPageObject\create(), createMetaData(), deleteMetaData(), ilLMPageObject\exportXMLMetaData(), ilStructureObject\exportXMLMetaData(), MDUpdateListener(), update(), and updateMetaData().

Here is the caller graph for this function:

getObjectList()

ilLMObject::getObjectList	(		$lm_id,
			$type = ""
	)

static

Definition at line 693 of file class.ilLMObject.php.

        {
                global $ilDB;
                
                $type_str = ($type != "")
                        ? "AND type = ".$ilDB->quote($type, "text")." "
                        : "";
 
                $query = "SELECT * FROM lm_data ".
                        "WHERE lm_id= ".$ilDB->quote($lm_id, "integer")." ".
                        $type_str." ".
                        "ORDER BY title";
                $obj_set = $ilDB->query($query);
                $obj_list = array();
                while($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        $obj_list[] = array("obj_id" => $obj_rec["obj_id"],
                                                                "title" => $obj_rec["title"],
                                                                "import_id" => $obj_rec["import_id"],
                                                                "type" => $obj_rec["type"]);
                }
                return $obj_list;
        }

References $ilDB, $lm_id, $query, and $type.

Referenced by ilLMPageObject\getPageList(), ilLearningModuleExporter\getXmlExportTailDependencies(), ilHelpExporter\getXmlExportTailDependencies(), and ilObjHelpSettings\uploadHelpModule().

Here is the caller graph for this function:

getPagesOfChapter()

static ilLMObject::getPagesOfChapter (   $a_lm_id,   $a_chap_id  )

static

Get pages of chapter.

Parameters

return

Definition at line 1339 of file class.ilLMObject.php.

        {
                // update structure entries: if at least one page of a chapter is public set chapter to public too
                $lm_tree = new ilTree($a_lm_id);
                $lm_tree->setTableNames('lm_tree','lm_data');
                $lm_tree->setTreeTablePK("lm_id");
                $lm_tree->readRootId();
                
                $childs = $lm_tree->getChildsByType($a_chap_id, "pg");
 
                return $childs;
        }

Referenced by ilHelpGUI\showHelp().

Here is the caller graph for this function:

getTitle()

ilLMObject::getTitle

(

)

get title of lm object

Returns

string title of chapter or page

Definition at line 251 of file class.ilLMObject.php.

        {
                return $this->title;
        }

References $title.

Referenced by ilLMPageObject\copy(), ilStructureObject\copy(), ilLMPageObject\copyToOtherContObject(), create(), createMetaData(), ilStructureObject\exportFO(), update(), and updateMetaData().

Here is the caller graph for this function:

getTree()

static ilLMObject::getTree (   $a_cont_obj_id )

static

Get learningmodule tree.

Parameters

int	learning module object id

Returns

object tree object

Definition at line 826 of file class.ilLMObject.php.

        {
                $tree = new ilTree($a_cont_obj_id);
                $tree->setTableNames('lm_tree', 'lm_data');
                $tree->setTreeTablePK("lm_id");
                $tree->readRootId();
                
                return $tree;
        }

Referenced by clipboardCopy(), and clipboardCut().

Here is the caller graph for this function:

getType()

ilLMObject::getType

(

)

Definition at line 336 of file class.ilLMObject.php.

        {
                return $this->type;
        }

References $type.

Referenced by ilLMPageObject\copy(), ilStructureObject\copy(), ilLMPageObject\copyToOtherContObject(), create(), createMetaData(), deleteMetaData(), ilLMPageObject\exportXMLMetaData(), ilStructureObject\exportXMLMetaData(), MDUpdateListener(), and updateMetaData().

Here is the caller graph for this function:

ilLMObject()

ilLMObject::ilLMObject	(		$a_content_obj,
			$a_id = 0
	)

Parameters

object

$a_content_obj

content object (digi book or learning module)

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

        {
                global $ilias;
 
                $this->id = $a_id;
                $this->setContentObject($a_content_obj);
                $this->setLMId($a_content_obj->getId());
                if($a_id != 0)
                {
                        $this->read();
                }
        }

References $ilias, read(), setContentObject(), and setLMId().

Here is the call graph for this function:

lookupLayout()

static ilLMObject::lookupLayout (   $a_obj_id )

static

Lookup type.

Parameters

int	lm object id

Definition at line 1321 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $query = "SELECT layout FROM lm_data WHERE obj_id = ".
                        $ilDB->quote($a_obj_id, "integer");
                $obj_set = $ilDB->query($query);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
 
                return $obj_rec["layout"];
        }

References $ilDB, and $query.

Referenced by ilLMPresentationGUI\determineLayout(), and ilLMPagesTableGUI\fillRow().

Here is the caller graph for this function:

MDUpdateListener()

ilLMObject::MDUpdateListener

(

$a_element

)

Meta data update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Parameters

string

$a_element

md element

Returns

boolean success

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

        {
                include_once 'Services/MetaData/classes/class.ilMD.php';
 
                switch($a_element)
                {
                        case 'General':
 
                                // Update Title and description
                                $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
                                $md_gen = $md->getGeneral();
 
                                ilLMObject::_writeTitle($this->getId(),$md_gen->getTitle());
 
                                foreach($md_gen->getDescriptionIds() as $id)
                                {
                                        $md_des = $md_gen->getDescription($id);
//                                      ilLMObject::_writeDescription($this->getId(),$md_des->getDescription());
                                        break;
                                }                               
                                break;
                                
                        case 'Educational':
                                include_once("./Services/Object/classes/class.ilObjectLP.php");                         
                                $obj_lp = ilObjectLP::getInstance($this->getLMId());
                                if(in_array($obj_lp->getCurrentMode(), 
                                        array(ilLPObjSettings::LP_MODE_TLT, ilLPObjSettings::LP_MODE_COLLECTION_TLT)))
                                {                                                                
                                        include_once("./Services/Tracking/classes/class.ilLPStatusWrapper.php");                                
                                        ilLPStatusWrapper::_refreshStatus($this->getLMId());
                                }
                                break;
                        
                        default:
                }
                return true;
        }

References $id, ilLPStatusWrapper\_refreshStatus(), _writeTitle(), getId(), ilObjectLP\getInstance(), getLMId(), getType(), ilLPObjSettings\LP_MODE_COLLECTION_TLT, and ilLPObjSettings\LP_MODE_TLT.

Here is the call graph for this function:

pasteTree()

static ilLMObject::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  )

static

Paste item (tree) from clipboard to current lm.

Definition at line 928 of file class.ilLMObject.php.

        {
                global $ilUser, $ilias, $ilLog;
                
                include_once("./Modules/LearningModule/classes/class.ilStructureObject.php");
                include_once("./Modules/LearningModule/classes/class.ilLMPageObject.php");
                
                $item_lm_id = ilLMObject::_lookupContObjID($a_item_id);
                $item_type = ilLMObject::_lookupType($a_item_id);
                $lm_obj = $ilias->obj_factory->getInstanceByObjId($item_lm_id);
                if ($item_type == "st")
                {
                        $item = new ilStructureObject($lm_obj, $a_item_id);
                }
                else if ($item_type == "pg")
                {
                        $item = new ilLMPageObject($lm_obj, $a_item_id);
                }
 
                $ilLog->write("Getting from clipboard type ".$item_type.", ".
                        "Item ID: ".$a_item_id.", of original LM: ".$item_lm_id);
 
                if ($item_lm_id != $a_target_lm->getId() && !$a_as_copy)
                {
                        // @todo: check whether st is NOT in tree
                        
                        // "move" metadata to new lm
                        include_once("Services/MetaData/classes/class.ilMD.php");
                        $md = new ilMD($item_lm_id, $item->getId(), $item->getType());
                        $new_md = $md->cloneMD($a_target_lm->getId(), $item->getId(), $item->getType());
                        
                        // update lm object
                        $item->setLMId($a_target_lm->getId());
                        $item->setContentObject($a_target_lm);
                        $item->update();
                        
                        // delete old meta data set
                        $md->deleteAll();
                        
                        if ($item_type == "pg")
                        {
                                $page = $item->getPageObject();
                                $page->buildDom();
                                $page->setParentId($a_target_lm->getId());
                                $page->update();
                        }
                }
 
                if ($a_as_copy)
                {
                        $target_item = $item->copy($a_target_lm);
                        $a_copied_nodes[$item->getId()] = $target_item->getId();
                }
                else
                {
                        $target_item = $item;
                }
                
                $ilLog->write("Putting into tree type ".$target_item->getType().
                        "Item ID: ".$target_item->getId().", Parent: ".$a_parent_id.", ".
                        "Target: ".$a_target.", Item LM:".$target_item->getContentObject()->getId());
                
                ilLMObject::putInTree($target_item, $a_parent_id, $a_target);
                
                if ($a_source_lm == null)
                {
                        $childs = $ilUser->getClipboardChilds($item->getId(), $a_insert_time);
                }
                else
                {
                        $childs = $a_source_lm->lm_tree->getChilds($item->getId());
                        foreach ($childs as $k => $child)
                        {
                                $childs[$k]["id"] = $childs[$k]["child"];
                        }
                }
 
                foreach($childs as $child)
                {
                        ilLMObject::pasteTree($a_target_lm, $child["id"], $target_item->getId(),
                                IL_LAST_NODE, $a_insert_time, $a_copied_nodes, $a_as_copy, $a_source_lm);
                }
                
                return $target_item->getId();
                // @todo: write history (see pastePage)
        }

References $ilias, $ilLog, $ilUser, _lookupContObjID(), _lookupType(), IL_LAST_NODE, pasteTree(), and putInTree().

Referenced by ilObjContentObject\copyAllPagesAndChapters(), ilStructureObjectGUI\insertChapterClip(), ilObjContentObjectGUI\insertChapterClip(), ilStructureObjectGUI\insertPageClip(), and pasteTree().

Here is the call graph for this function:

Here is the caller graph for this function:

preloadDataByLM()

static ilLMObject::preloadDataByLM (   $a_lm_id )

static

Preload data records by lm.

Parameters

integer

$a_lm_id

lm id

Returns

int number of preloaded records

Definition at line 221 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $set = $ilDB->query("SELECT * FROM lm_data ".
                        " WHERE lm_id = ".$ilDB->quote($a_lm_id, "integer")
                        );
                while ($rec = $ilDB->fetchAssoc($set))
                {
                        self::$data_records[$rec["obj_id"]] = $rec;
                }
                return count(self::$data_records);
        }

References $ilDB.

Referenced by ilLMExplorerGUI\__construct().

Here is the caller graph for this function:

putInTree()

static ilLMObject::putInTree (   $a_obj,   $a_parent_id = "",   $a_target_node_id = ""  )

static

put this object into content object tree

Definition at line 768 of file class.ilLMObject.php.

        {
                global $ilLog;
                
                $tree = new ilTree($a_obj->getContentObject()->getId());
                $tree->setTableNames('lm_tree', 'lm_data');
                $tree->setTreeTablePK("lm_id");
 
                // determine parent
                $parent_id = ($a_parent_id != "")
                        ? $a_parent_id
                        : $tree->getRootId();
 
                // determine target
                if ($a_target_node_id != "")
                {
                        $target = $a_target_node_id;
                }
                else
                {
                        // determine last child that serves as predecessor
                        if ($a_obj->getType() == "st")
                        {
                                $s_types = array("st", "pg");
                                $childs =& $tree->getChildsByTypeFilter($parent_id, $s_types);
                        }
                        else
                        {
                                $s_types = "pg";
                                $childs =& $tree->getChildsByType($parent_id, $s_types);
                        }
 
                        if (count($childs) == 0)
                        {
                                $target = IL_FIRST_NODE;
                        }
                        else
                        {
                                $target = $childs[count($childs) - 1]["obj_id"];
                        }
                }
 
                if ($tree->isInTree($parent_id) && !$tree->isInTree($a_obj->getId()))
                {
                        $ilLog->write("LMObject::putInTree: insertNode, ID: ".$a_obj->getId().
                                "Parent ID: ".$parent_id.", Target: ".$target);
 
                        $tree->insertNode($a_obj->getId(), $parent_id, $target);
                }
        }

References $ilLog, and IL_FIRST_NODE.

Referenced by ilObjContentObject\addFirstChapterAndPage(), ilLearningModuleDataSet\importRecord(), ilStructureObjectGUI\insertChapter(), ilObjContentObjectGUI\insertChapter(), ilStructureObjectGUI\insertPage(), and pasteTree().

Here is the caller graph for this function:

read()

ilLMObject::read

(

)

Reimplemented in ilLMPageObject.

Definition at line 191 of file class.ilLMObject.php.

        {
                global $ilBench, $ilDB;
 
                $ilBench->start("ContentPresentation", "ilLMObject_read");
 
                if(!isset($this->data_record))
                {
                        $query = "SELECT * FROM lm_data WHERE obj_id = ".
                                $ilDB->quote($this->id, "integer");
                        $obj_set = $ilDB->query($query);
                        $this->data_record = $ilDB->fetchAssoc($obj_set);
                }
 
                $this->type = $this->data_record["type"];
                $this->setImportId($this->data_record["import_id"]);
                $this->setTitle($this->data_record["title"]);
                $this->setLayout($this->data_record["layout"]);
                //$this->setActive(ilUtil::yn2tf($this->data_record["active"]));
 
                $ilBench->stop("ContentPresentation", "ilLMObject_read");
        }

References $ilBench, $ilDB, $query, setImportId(), setLayout(), and setTitle().

Referenced by ilLMObject().

Here is the call graph for this function:

Here is the caller graph for this function:

saveExportId()

static ilLMObject::saveExportId (   $a_lm_id,   $a_lmobj_id,   $a_exp_id,   $a_type = "pg"  )

static

Save export id.

Parameters

return

Definition at line 1388 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                include_once("Services/MetaData/classes/class.ilMDIdentifier.php");
 
                if (trim($a_exp_id) == "")
                {
                        // delete export ids, if existing
                        $entries = ilMDIdentifier::_getEntriesForObj(
                                $a_lm_id, $a_lmobj_id, $a_type);
 
                        foreach ($entries as $id => $e)
                        {
                                if ($e["catalog"] == "ILIAS_NID")
                                {
                                        $identifier = new ilMDIdentifier();
                                        $identifier->setMetaId($id);
                                        $identifier->delete();
                                }
                        }
                }
                else
                {
                        // update existing entry
                        $entries = ilMDIdentifier::_getEntriesForObj(
                                $a_lm_id, $a_lmobj_id, $a_type);
 
                        $updated = false;
                        foreach ($entries as $id => $e)
                        {
                                if ($e["catalog"] == "ILIAS_NID")
                                {
                                        $identifier = new ilMDIdentifier();
                                        $identifier->setMetaId($id);
                                        $identifier->read();
                                        $identifier->setEntry($a_exp_id);
                                        $identifier->update();
                                        $updated = true;
                                }
                        }
 
                        // nothing updated? create a new one
                        if (!$updated)
                        {
                                include_once("./Services/MetaData/classes/class.ilMD.php");
                                $md = new ilMD($a_lm_id, $a_lmobj_id, $a_type);
                                $md_gen = $md->getGeneral();
                                $identifier = $md_gen->addIdentifier();
                                $identifier->setEntry($a_exp_id);
                                $identifier->setCatalog("ILIAS_NID");
                                $identifier->save();
                        }
                }
 
        }

References $id, $ilDB, and ilMDIdentifier\_getEntriesForObj().

Referenced by ilLMPageObject\copy(), and ilObjContentObjectGUI\saveExportIds().

Here is the call graph for this function:

Here is the caller graph for this function:

saveTitles()

static ilLMObject::saveTitles (   $a_lm,   $a_titles,   $a_lang = "-"  )

static

Save titles for lm objects.

Parameters

array

titles (key is ID, value is title)

Definition at line 1021 of file class.ilLMObject.php.

        {
                include_once("./Modules/LearningModule/classes/class.ilLMObjTranslation.php");
                
                if ($a_lang == "")
                {
                        $a_lang = "-";
                }
                if (is_array($a_titles))
                {
                        include_once("./Services/MetaData/classes/class.ilMD.php");
                        foreach($a_titles as $id => $title)
                        {
                                if ($a_lang == "-")
                                {
                                        $lmobj = ilLMObjectFactory::getInstance($a_lm, $id, false);
                                        if (is_object($lmobj))
                                        {
                                                // Update Title and description
                                                $md = new ilMD($a_lm->getId(), $id, $lmobj->getType());
                                                $md_gen = $md->getGeneral();
                                                if (is_object($md_gen))                 // see bug #0015843
                                                {
                                                        $md_gen->setTitle($title);
                                                        $md_gen->update();
                                                        $md->update();
                                                }
                                                ilLMObject::_writeTitle($id, $title);
                                        }
                                }
                                else
                                {
                                        $lmobjtrans = new ilLMObjTranslation($id, $a_lang);
                                        $lmobjtrans->setTitle($title);
                                        $lmobjtrans->save();
                                }
                        }
                }
        }

References $id, $title, _writeTitle(), and ilLMObjectFactory\getInstance().

Referenced by ilObjContentObjectGUI\saveAllTitles(), and ilStructureObjectGUI\saveAllTitles().

Here is the call graph for this function:

Here is the caller graph for this function:

setContentObject()

ilLMObject::setContentObject

(

&

$a_content_obj

)

Definition at line 352 of file class.ilLMObject.php.

        {
                $this->content_object =& $a_content_obj;
        }

Referenced by ilLMObject().

Here is the caller graph for this function:

setDataRecord()

ilLMObject::setDataRecord

(

$a_record

)

this method should only be called by class ilLMObjectFactory

Definition at line 186 of file class.ilLMObject.php.

        {
                $this->data_record = $a_record;
        }

setDescription()

ilLMObject::setDescription

(

$a_description

)

Definition at line 321 of file class.ilLMObject.php.

        {
                $this->description = $a_description;
        }

setId()

ilLMObject::setId

(

$a_id

)

Reimplemented in ilLMPageObject.

Definition at line 362 of file class.ilLMObject.php.

        {
                $this->id = $a_id;
        }

Referenced by create().

Here is the caller graph for this function:

setImportId()

ilLMObject::setImportId

(

$a_id

)

Definition at line 377 of file class.ilLMObject.php.

        {
                $this->import_id = $a_id;
        }

Referenced by read().

Here is the caller graph for this function:

setLayout()

ilLMObject::setLayout

(

$a_val

)

Set layout.

Parameters

string

layout

Definition at line 387 of file class.ilLMObject.php.

        {
                $this->layout = $a_val;
        }

Referenced by read().

Here is the caller graph for this function:

setLMId()

ilLMObject::setLMId

(

$a_lm_id

)

Definition at line 341 of file class.ilLMObject.php.

        {
                $this->lm_id = $a_lm_id;
 
        }

Referenced by ilLMObject().

Here is the caller graph for this function:

setTitle()

ilLMObject::setTitle

(

$a_title

)

set title of lm object

Parameters

string

$a_title

title of chapter or page

Definition at line 241 of file class.ilLMObject.php.

        {
                $this->title = $a_title;
        }

Referenced by read().

Here is the caller graph for this function:

setType()

ilLMObject::setType

(

$a_type

)

Definition at line 331 of file class.ilLMObject.php.

        {
                $this->type = $a_type;
        }

Referenced by ilLMPageObject\ilLMPageObject(), and ilStructureObject\ilStructureObject().

Here is the caller graph for this function:

uniqueTypesCheck()

static ilLMObject::uniqueTypesCheck (   $a_items )

static

Check for unique types (all pages or all chapters)

Definition at line 1258 of file class.ilLMObject.php.

        {
                $types = array();
                if (is_array($a_items))
                {
                        foreach($a_items as $item)
                        {
                                $type = ilLMObject::_lookupType($item);
                                $types[$type] = $type;
                        }
                }
 
                if (count($types) > 1)
                {
                        return false;
                }
                return true;
        }

References $type, and _lookupType().

Referenced by ilStructureObjectGUI\copyItems(), and ilStructureObjectGUI\cutItems().

Here is the call graph for this function:

Here is the caller graph for this function:

update()

ilLMObject::update

(

)

update complete object

Definition at line 454 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $this->updateMetaData();
 
                $query = "UPDATE lm_data SET ".
                        " lm_id = ".$ilDB->quote($this->getLMId(), "integer").
                        " ,title = ".$ilDB->quote($this->getTitle(), "text").
                        " ,layout = ".$ilDB->quote($this->getLayout(), "text").
                        " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
 
                $ilDB->manipulate($query);
        }

References $ilDB, $query, getId(), getLayout(), getLMId(), getTitle(), and updateMetaData().

Here is the call graph for this function:

updateInternalLinks()

static ilLMObject::updateInternalLinks (   $a_copied_nodes,   $a_parent_type = "lm"  )

static

Update internal links, after multiple pages have been copied.

Definition at line 1064 of file class.ilLMObject.php.

        {
                $all_fixes = array();
                foreach($a_copied_nodes as $original_id => $copied_id)
                {
                        $copied_type = ilLMObject::_lookupType($copied_id);
                        $copy_lm = ilLMObject::_lookupContObjID($copied_id);
                        
                        if ($copied_type == "pg")
                        {
                                foreach (ilPageObject::lookupTranslations($a_parent_type, $copied_id) as $l)
                                {
                                        //
                                        // 1. Outgoing links from the copied page.
                                        //
                                        //$targets = ilInternalLink::_getTargetsOfSource($a_parent_type.":pg", $copied_id);
                                        include_once("./Modules/LearningModule/classes/class.ilLMPage.php");
                                        $tpg = new ilLMPage($copied_id, 0, $l);
                                        $tpg->buildDom();
                                        $il = $tpg->getInternalLinks();
                                        $targets = array();
                                        foreach ($il as $l)
                                        {
                                                $targets[] = array("type" => ilInternalLink::_extractTypeOfTarget($l["Target"]),
                                                        "id" => (int)ilInternalLink::_extractObjIdOfTarget($l["Target"]),
                                                        "inst" => (int)ilInternalLink::_extractInstOfTarget($l["Target"]));
                                        }
                                        $fix = array();
                                        foreach ($targets as $target)
                                        {
                                                if (($target["inst"] == 0 || $target["inst"] = IL_INST_ID) &&
                                                        ($target["type"] == "pg" || $target["type"] == "st"))
                                                {
                                                        // first check, whether target is also within the copied set
                                                        if ($a_copied_nodes[$target["id"]] > 0)
                                                        {
                                                                $fix[$target["id"]] = $a_copied_nodes[$target["id"]];
                                                        } else
                                                        {
                                                                // now check, if a copy if the target is already in the same lm
 
                                                                // only if target is not already in the same lm!
                                                                $trg_lm = ilLMObject::_lookupContObjID($target["id"]);
                                                                if ($trg_lm != $copy_lm)
                                                                {
                                                                        $lm_data = ilLMObject::_getAllObjectsForImportId("il__" . $target["type"] . "_" . $target["id"]);
                                                                        $found = false;
 
                                                                        foreach ($lm_data as $item)
                                                                        {
                                                                                if (!$found && ($item["lm_id"] == $copy_lm))
                                                                                {
                                                                                        $fix[$target["id"]] = $item["obj_id"];
                                                                                        $found = true;
                                                                                }
                                                                        }
                                                                }
                                                        }
                                                }
                                        }
 
                                        // outgoing links to be fixed
                                        if (count($fix) > 0)
                                        {
                                                //echo "<br>--".$copied_id;
                                                //var_dump($fix);
                                                $t = ilObject::_lookupType($copy_lm);
                                                if (is_array($all_fixes[$t . ":" . $copied_id]))
                                                {
                                                        $all_fixes[$t . ":" . $copied_id] += $fix;
                                                } else
                                                {
                                                        $all_fixes[$t . ":" . $copied_id] = $fix;
                                                }
                                        }
                                }
                        }
                        
                        if ($copied_type == "pg" ||
                                $copied_type == "st")
                        {
                                
                                //
                                // 2. Incoming links to the original pages
                                //
                                // A->B                 A2                      (A+B currently copied)
                                // A->C                 B2
                                // B->A
                                // C->A                 C2->A           (C already copied)
                                $original_lm = ilLMObject::_lookupContObjID($original_id);
                                $original_type = ilObject::_lookupType($original_lm);
                                
                                if ($original_lm != $copy_lm)
                                {
                                
                                        // This gets sources that link to A+B (so we have C here)
                                        // (this also does already the trick when instance map areas are given in C)
        // int_link, where target_type, target_id, target_inst -> ok
                                        $sources = ilInternalLink::_getSourcesOfTarget($copied_type,
                                                $original_id, 0);
                                        
                                        // mobs linking to $original_id
        // map_area, where link_type, target -> ok
                                        $mobs = ilMapArea::_getMobsForTarget("int", "il__".$copied_type.
                                                "_".$original_id);
                                        
                                        // pages using these mobs
                                        include_once("./Services/MediaObjects/classes/class.ilObjMediaObject.php");
                                        foreach($mobs as $mob)
                                        {
        // mob_usage, where id -> ok
        // mep_item, where foreign_id, type -> ok
        // mep_tree, where child -> already existed
        // il_news_item, where mob_id -> ok
        // map_area, where link_type, target -> aready existed
        // media_item, where id -> already existed
        // personal_clipboard, where item_id, type -> ok
                                                $usages = ilObjMediaObject::lookupUsages($mob);
                                                foreach($usages as $usage)
                                                {
                                                        if ($usage["type"] == "lm:pg" | $usage["type"] == "lm:st")
                                                        {
                                                                $sources[] = $usage;
                                                        }
                                                }
                                        }
                                        $fix = array();
                                        foreach($sources as $source)
                                        {
                                                $stype = explode(":", $source["type"]);
                                                $source_type = $stype[1];
        
                                                if ($source_type == "pg" || $source_type == "st")
                                                {
                                                        // first of all: source must be in original lm
                                                        $src_lm = ilLMObject::_lookupContObjID($source["id"]);
                                                        
                                                        if ($src_lm == $original_lm)
                                                        {
                                                                // check, if a copy if the source is already in the same lm
                                                                // now we look for the latest copy of C in LM2
                                                                $lm_data = ilLMObject::_getAllObjectsForImportId("il__".$source_type."_".$source["id"],
                                                                        $copy_lm);
                                                                $found = false;
                                                                foreach ($lm_data as $item)
                                                                {
                                                                        if (!$found)
                                                                        {
                                                                                $fix[$item["obj_id"]][$original_id] = $copied_id;
                                                                                $found = true;
                                                                        }
                                                                }
                                                        }
                                                }
                                        }
                                        // outgoing links to be fixed
                                        if (count($fix) > 0)
                                        {
                                                foreach ($fix as $page_id => $fix_array)
                                                {
                                                        $t = ilObject::_lookupType($copy_lm);
                                                        if (is_array($all_fixes[$t.":".$page_id]))
                                                        {
                                                                $all_fixes[$t.":".$page_id] += $fix_array;
                                                        }
                                                        else
                                                        {
                                                                $all_fixes[$t.":".$page_id] = $fix_array;
                                                        }
        
                                                }
                                        }
                                }
                        }
                }
                
                foreach ($all_fixes as $pg => $fixes)
                {
                        $pg = explode(":", $pg);
                        include_once("./Services/COPage/classes/class.ilPageObjectFactory.php");
                        foreach (ilPageObject::lookupTranslations($pg[0], $pg[1]) as $l)
                        {
                                $page = ilPageObjectFactory::getInstance($pg[0], $pg[1], 0, $l);
                                if ($page->moveIntLinks($fixes))
                                {
                                        $page->update(true, true);
                                }
                        }
                }
        }

References $l, $mobs, $t, ilInternalLink\_extractInstOfTarget(), ilInternalLink\_extractObjIdOfTarget(), ilInternalLink\_extractTypeOfTarget(), _getAllObjectsForImportId(), ilMapArea\_getMobsForTarget(), ilInternalLink\_getSourcesOfTarget(), _lookupContObjID(), ilObject\_lookupType(), _lookupType(), ilPageObjectFactory\getInstance(), ilPageObject\lookupTranslations(), and ilObjMediaObject\lookupUsages().

Referenced by ilObjContentObject\copyAllPagesAndChapters(), ilStructureObjectGUI\insertChapterClip(), ilObjContentObjectGUI\insertChapterClip(), ilStructureObjectGUI\insertPageClip(), and ilObjContentObjectGUI\pastePage().

Here is the call graph for this function:

Here is the caller graph for this function:

updateMetaData()

ilLMObject::updateMetaData

(

)

update meta data entry

Definition at line 147 of file class.ilLMObject.php.

        {
                include_once("Services/MetaData/classes/class.ilMD.php");
                include_once("Services/MetaData/classes/class.ilMDGeneral.php");
                include_once("Services/MetaData/classes/class.ilMDDescription.php");
 
                $md =& new ilMD($this->getLMId(), $this->getId(), $this->getType());
                $md_gen =& $md->getGeneral();
                $md_gen->setTitle($this->getTitle());
 
                // sets first description (maybe not appropriate)
                $md_des_ids =& $md_gen->getDescriptionIds();
                if (count($md_des_ids) > 0)
                {
                        $md_des =& $md_gen->getDescription($md_des_ids[0]);
//                      $md_des->setDescription($this->getDescription());
                        $md_des->update();
                }
                $md_gen->update();
 
        }

References getId(), getLMId(), getTitle(), and getType().

Referenced by update().

Here is the call graph for this function:

Here is the caller graph for this function:

writeLayout()

static ilLMObject::writeLayout (   $a_obj_id,   $a_layout,   $a_lm = null  )

static

Write layout setting.

Parameters

int	lm object id
string	layout

Definition at line 1283 of file class.ilLMObject.php.

        {
                global $ilDB;
 
                $t = ilLMObject::_lookupType($a_obj_id);
                
                if ($t == "pg")
                {
                        $query = "UPDATE lm_data SET ".
                                " layout = ".$ilDB->quote($a_layout, "text").
                                " WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");
                        $ilDB->manipulate($query);
                }
                else if ($t == "st" && is_object($a_lm))
                {
                        $node = $a_lm->getLMTree()->getNodeData($a_obj_id);
                        $child_nodes = $a_lm->getLMTree()->getSubTree($node);
                        if (is_array($child_nodes) && count($child_nodes) > 0)
                        {
                                foreach ($child_nodes as $c)
                                {
                                        if ($c["type"] == "pg")
                                        {
                                                $query = "UPDATE lm_data SET ".
                                                        " layout = ".$ilDB->quote($a_layout, "text").
                                                        " WHERE obj_id = ".$ilDB->quote($c["child"], "integer");
                                                $ilDB->manipulate($query);
                                        }
                                }
                        }
                }
        }

References $ilDB, $query, $t, and _lookupType().

Referenced by ilLMPageObjectGUI\saveLayout(), ilObjContentObjectGUI\savePageLayout(), and ilStructureObjectGUI\savePageLayout().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$active

ilLMObject::$active = true

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

Referenced by ilLMPageObject\_getPresentationTitle().

$content_object

ilLMObject::$content_object

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

Referenced by getContentObject().

$data_record

ilLMObject::$data_record

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

$data_records

ilLMObject::$data_records = array()

staticprotected

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

$description

ilLMObject::$description

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

Referenced by getDescription().

$id

ilLMObject::$id

Definition at line 22 of file class.ilLMObject.php.

Referenced by _lookupNID(), clipboardCopy(), clipboardCut(), getId(), MDUpdateListener(), saveExportId(), and saveTitles().

$ilias

ilLMObject::$ilias

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

Referenced by ilLMObject(), and pasteTree().

$lm_id

ilLMObject::$lm_id

Definition at line 20 of file class.ilLMObject.php.

Referenced by _getIdForImportId(), _isPagePublic(), ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), getLMId(), getObjectList(), and ilLMPageObject\getPageList().

$meta_data

ilLMObject::$meta_data

Definition at line 23 of file class.ilLMObject.php.

$title

ilLMObject::$title

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

Referenced by ilLMPageObject\_getPresentationTitle(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\exportFO(), getTitle(), and saveTitles().

$type

ilLMObject::$type

Definition at line 21 of file class.ilLMObject.php.

Referenced by ilLMPageObject\_splitPage(), ilLMPageObject\_splitPageNext(), getObjectList(), getType(), and uniqueTypesCheck().

---

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

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