ilLMObject Class Reference

Class ilLMObject. More...

Inheritance diagram for ilLMObject:

Collaboration diagram for ilLMObject:

Public Member Functions
	__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	_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
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

Static Protected Member Functions
static	_lookup ($a_obj_id, $a_field)
	Lookup title. More...

Protected Attributes
	$user
	$db

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 15 of file class.ilLMObject.php.

Constructor & Destructor Documentation

__construct()

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

Parameters

object

$a_content_obj

content object (digi book or learning module)

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

References $DIC, read(), setContentObject(), setLMId(), and user().

    {
        global $DIC;
        $this->user = $DIC->user();

        $this->db = $DIC->database();

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

Here is the call graph for this function:

Member Function Documentation

_deleteAllObjectData()

static ilLMObject::_deleteAllObjectData ( &  $a_cobj )

static

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

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

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

Referenced by ilObjContentObject\delete().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $query = "SELECT * FROM lm_data " .
            "WHERE lm_id= " . $ilDB->quote($a_cobj->getId(), "integer");
        $obj_set = $ilDB->query($query);

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

Here is the call graph for this function:

Here is the caller graph for this function:

_exists()

static ilLMObject::_exists (   $a_id )

static

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 705 of file class.ilLMObject.php.

References $DIC, $ilDB, and ilInternalLink\_extractObjIdOfTarget().

Referenced by ilCourseObjectiveMaterials\__read(), ilInternalLink\_exists(), ilLinksTableGUI\fillRow(), getDuplicateExportIDs(), ilLMContentRendererGUI\render(), ilHelpGUI\showHelp(), and ilLMPresentationGUI\showPrintView().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        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;
        }
    }

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

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

References $a_type, $DIC, and $ilDB.

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

    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

_getAllObjectsForImportId()

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

static

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 671 of file class.ilLMObject.php.

References $DIC, $ilDB, and ilObject\_hasUntrashedReference().

Referenced by updateInternalLinks().

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getIdForImportId()

static ilLMObject::_getIdForImportId (   $a_import_id )

static

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 638 of file class.ilLMObject.php.

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

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

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $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
            $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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getPresentationTitle()

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

static

Get affective title.

Parameters

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

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

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

      {
        if ($a_lang == "") {
            $a_lang = "-";
        }
        
        if ($a_node["type"] == "st") {
            return ilStructureObject::_getPresentationTitle(
                $a_node["child"],
                self::CHAPTER_TITLE,
                $a_include_numbers,
                $a_time_scheduled_activation,
                $a_force_content,
                $a_lm_id,
                $a_lang
            );
        } else {
            return ilLMPageObject::_getPresentationTitle(
                $a_node["child"],
                $a_mode,
                $a_include_numbers,
                $a_time_scheduled_activation,
                $a_force_content,
                $a_lm_id,
                $a_lang
            );
        }
    }

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 579 of file class.ilLMObject.php.

References $DIC, $ilDB, $ilLog, $lm_id, $message, and ilUtil\yn2tf().

Referenced by ilLMNavigationStatus\determineStatus(), ilLMContentRendererGUI\determineStatus(), ilLMPresentationGUI\getCurrentPageId(), ilLMContentRendererGUI\getSuccessorPage(), ilLMPresentationGUI\getSuccessorPage(), ilLMTOCExplorerGUI\isNodeClickable(), ilLMNavigationRendererGUI\render(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilLog = $DIC["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"]);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_lookup()

static ilLMObject::_lookup (   $a_obj_id,   $a_field  )

staticprotected

Lookup title.

Parameters

int	lm object id

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

References $DIC, $ilDB, and $query.

    {
        global $DIC;

        $ilDB = $DIC->database();

        if (isset(self::$data_records[$a_obj_id])) {
            return self::$data_records[$a_obj_id][$a_field];
        }

        $query = "SELECT " . $a_field . " 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[$a_field];
    }

_lookupContObjID()

static ilLMObject::_lookupContObjID (   $a_id )

static

get learning module / digibook id for lm object

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

References $DIC, $ilDB, and $query.

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

    {
        global $DIC;

        $ilDB = $DIC->database();

        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"];
    }

Here is the caller graph for this function:

_lookupNID()

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

static

lookup named identifier (ILIAS_NID)

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

References $a_type, and $id.

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

_lookupShortTitle()

static ilLMObject::_lookupShortTitle (   $a_obj_id )

static

Lookup short title.

Parameters

int

$a_obj_id

object id

Returns

string

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

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

    {
        return self::_lookup($a_obj_id, "short_title");
    }

Here is the caller graph for this function:

_lookupTitle()

static ilLMObject::_lookupTitle (   $a_obj_id )

static

Lookup title.

Parameters

int

$a_obj_id

object id

Returns

string

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

Referenced by ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), clipboardCopy(), ilObjContentObjectGUI\confirmedDelete(), ilObjContentObject\executeDragDrop(), ilLinksTableGUI\fillRow(), ilTermUsagesTableGUI\fillRow(), ilCourseObjectiveMaterialAssignmentTableGUI\fillRow(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilLMQuestionListTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ilCourseObjectivesTableGUI\fillRow(), ilLMTracker\getBlockedUsersInformation(), ilObjLearningModuleSubItemListGUI\getHTML(), ilImageMapEditorGUI\getMapAreaLinkString(), ilLinkInputGUI\getTranslatedValue(), ilCourseObjectiveMaterialAssignmentTableGUI\parse(), ilLMContentRendererGUI\renderDeactivatedPageMessage(), ilLMContentRendererGUI\renderNoPageInChapterMessage(), ilContainerObjectiveGUI\renderObjective(), ilLMContentRendererGUI\renderPreconditionsOfPage(), ilHelpGUI\search(), ilHelpGUI\showHelp(), ilHelpGUI\showPage(), and ilObjContentObject\validatePages().

    {
        return self::_lookup($a_obj_id, "title");
    }

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 320 of file class.ilLMObject.php.

References $DIC, $ilDB, and $query.

Referenced by ilStructureObjectGUI\activatePages(), clipboardCopy(), ilLMNavigationStatus\determineStatus(), ilLMContentRendererGUI\determineStatus(), ilLMPresentationGUI\getCurrentPageId(), ilLMTOCExplorerGUIFactory\getExplorer(), ilObjLearningModuleSubItemListGUI\getHTML(), ilLMTOCExplorerGUI\getRootNode(), ilLMContentRendererGUI\getSuccessorPage(), ilLMPresentationGUI\getSuccessorPage(), ilPageObject\moveIntLinks(), ilSCORM2004Node\pasteTree(), pasteTree(), ilLMNavigationRendererGUI\render(), ilObjContentObjectGUI\saveExportIds(), ilLMPresentationGUI\showPrintView(), uniqueTypesCheck(), updateInternalLinks(), ilCourseObjectivesGUI\updateMaterialAssignment(), and writeLayout().

    {
        global $DIC;

        $ilDB = $DIC->database();

        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"];
    }

Here is the caller graph for this function:

_writeImportId()

static ilLMObject::_writeImportId (   $a_id,   $a_import_id  )

static

write import id to db (static)

Parameters

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

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

References $DIC, and $ilDB.

Referenced by ilContObjParser\handlerEndTag().

    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the caller graph for this function:

_writePublicAccessStatus()

static ilLMObject::_writePublicAccessStatus (   $a_pages,   $a_cont_obj_id  )

static

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

public

Parameters

array	page ids
integer	content object id

Returns

of the jedi

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

References $DIC, $ilDB, $ilErr, $ilLog, and $message.

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

    {
        global $DIC;

        $ilDB = $DIC->database();
        $ilLog = $DIC["ilLog"];
        $ilErr = $DIC["ilErr"];
        
        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;
    }

Here is the caller graph for this function:

_writeTitle()

static ilLMObject::_writeTitle (   $a_obj_id,   $a_title  )

static

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

References $DIC, $ilDB, and $query.

Referenced by MDUpdateListener(), and saveTitles().

    {
        global $DIC;

        $ilDB = $DIC->database();

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

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 903 of file class.ilLMObject.php.

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

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

    {
        global $DIC;

        $ilUser = $DIC->user();
        
        $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
            );
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

clipboardCut()

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

static

Copy a set of chapters/pages into the clipboard.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

create()

ilLMObject::create

(

$a_upload = false

)

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

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

    {
        $ilDB = $this->db;

        // insert object data
        $this->setId($ilDB->nextId("lm_data"));
        $query = "INSERT INTO lm_data (obj_id, title, type, layout, lm_id, import_id, short_title, 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->quote($this->getShortTitle(), "text") .
            ", " . $ilDB->now() . ")";
        $ilDB->manipulate($query);

        // create history entry
        ilHistory::_createEntry(
            $this->getId(),
            "create",
            "",
            $this->content_object->getType() . ":" . $this->getType()
        );

        if (!$a_upload) {
            $this->createMetaData();
        }
    }

Here is the call graph for this function:

createMetaData()

ilLMObject::createMetaData

(

)

create meta data entry

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

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

Referenced by create().

    {
        $ilUser = $this->user;

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

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

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

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

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

        $this->deleteMetaData();
    }

Here is the call graph for this function:

deleteMetaData()

ilLMObject::deleteMetaData

(

)

delete meta data entry

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

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

Referenced by delete().

    {
        // Delete meta data
        $md = new ilMD($this->getLMId(), $this->getId(), $this->getType());
        $md->deleteAll();
    }

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

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

References $a_type, and ilMDIdentifier\existsIdInRbacObject().

Referenced by ilLMPageObject\copy().

    {
        return ilMDIdentifier::existsIdInRbacObject($a_lm_id, $a_type, "ILIAS_NID", $a_exp_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getContentObject()

& ilLMObject::getContentObject

(

)

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

References $content_object.

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

    {
        return $this->content_object;
    }

Here is the caller graph for this function:

getDescription()

ilLMObject::getDescription

(

)

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

References $description.

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

    {
        return $this->description;
    }

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 1458 of file class.ilLMObject.php.

References $a_type, Vendor\Package\$e, $res, _exists(), and ilMDIdentifier\_getEntriesForRbacObj().

Referenced by ilExportIDTableGUI\__construct().

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

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

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

References $a_type, Vendor\Package\$e, and ilMDIdentifier\_getEntriesForObj().

Referenced by ilLMPageObject\copy(), ILIAS\LearningModule\Export\LMHtmlExport\exportHTMLPages(), ilExportIDTableGUI\fillRow(), ilLMPresentationLinker\getLink(), and ilLMTOCExplorerGUI\getNodeHref().

    {
        // look for export id
        $entries = ilMDIdentifier::_getEntriesForObj(
            $a_lm_id,
            $a_lmobj_id,
            $a_type
        );

        foreach ($entries as $e) {
            if ($e["catalog"] == "ILIAS_NID") {
                return $e["entry"];
            }
        }
    }

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

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

References $a_type, $data, and ilMDIdentifier\readIdData().

    {
        $data = ilMDIdentifier::readIdData($a_lm_id, $a_type, "ILIAS_NID", $a_exp_id);
        return $data;
    }

Here is the call graph for this function:

getId()

ilLMObject::getId

(

)

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

References $id.

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

    {
        return $this->id;
    }

Here is the caller graph for this function:

getImportId()

ilLMObject::getImportId

(

)

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

Referenced by create().

    {
        return $this->import_id;
    }

Here is the caller graph for this function:

getLayout()

ilLMObject::getLayout

(

)

Get layout.

Returns

string layout

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

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

    {
        return $this->layout;
    }

Here is the caller graph for this function:

getLMId()

ilLMObject::getLMId

(

)

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

References $lm_id.

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

    {
        return $this->lm_id;
    }

Here is the caller graph for this function:

getObjectList()

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

static

static

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

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

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

    {
        global $DIC;

        $ilDB = $DIC->database();
        
        $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;
    }

Here is the caller graph for this function:

getPagesOfChapter()

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

static

Get pages of chapter.

Parameters

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

Referenced by ilHelpGUI\showHelp().

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

Here is the caller graph for this function:

getShortTitle()

ilLMObject::getShortTitle

(

)

get short title of lm object

Returns

string short title of chapter or page

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

References $short_title.

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

    {
        return $this->short_title;
    }

Here is the caller graph for this function:

getShortTitles()

static ilLMObject::getShortTitles (   $a_lm_id,   $a_lang = "-"  )

static

Get short titles.

Parameters

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

References $db, and $DIC.

Referenced by ilLMEditShortTitlesTableGUI\__construct().

    {
        global $DIC;

        $db = $DIC->database();

        $title_data = array();
        if ($a_lang == "-") {
            $set = $db->query("SELECT t.child, d.obj_id, d.title, d.short_title FROM lm_data d LEFT JOIN lm_tree t ON (d.obj_id = t.child) WHERE d.lm_id = " .
                $db->quote($a_lm_id, "integer") . " ORDER BY t.lft, d.title");
        } else {
            $set = $db->query("SELECT t.child, d.obj_id, tr.title, tr.short_title, d.title default_title, d.short_title default_short_title FROM lm_data d " .
                " LEFT JOIN lm_tree t ON (d.obj_id = t.child) " .
                " LEFT JOIN lm_data_transl tr ON (tr.id = d.obj_id AND tr.lang=" . $db->quote($a_lang, "text") . ") WHERE d.lm_id = " .
                $db->quote($a_lm_id, "integer") . " ORDER BY t.lft, d.title");
        }
        while ($rec = $db->fetchAssoc($set)) {
            $title_data[] = $rec;
        }
        return $title_data;
    }

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 243 of file class.ilLMObject.php.

References $title.

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

    {
        return $this->title;
    }

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 852 of file class.ilLMObject.php.

Referenced by clipboardCopy(), and clipboardCut().

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

Here is the caller graph for this function:

getType()

ilLMObject::getType

(

)

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

References $type.

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

    {
        return $this->type;
    }

Here is the caller graph for this function:

lookupLayout()

static ilLMObject::lookupLayout (   $a_obj_id )

static

Lookup type.

Parameters

int	lm object id

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

References $DIC, $ilDB, and $query.

Referenced by ilLMPagesTableGUI\fillRow().

    {
        global $DIC;

        $ilDB = $DIC->database();

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

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 73 of file class.ilLMObject.php.

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

    {
        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':
                $obj_lp = ilObjectLP::getInstance($this->getLMId());
                if (in_array(
                    $obj_lp->getCurrentMode(),
                    array(ilLPObjSettings::LP_MODE_TLT, ilLPObjSettings::LP_MODE_COLLECTION_TLT)
                )) {
                    ilLPStatusWrapper::_refreshStatus($this->getLMId());
                }
                break;
            
            default:
        }
        return true;
    }

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 952 of file class.ilLMObject.php.

References $DIC, $ilLog, $ilUser, _lookupContObjID(), _lookupType(), ilMD\cloneMD(), ilObjectFactory\getInstanceByObjId(), IL_LAST_NODE, and putInTree().

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

      {
        global $DIC;

        $ilUser = $DIC->user();
        $ilLog = $DIC["ilLog"];
        
        $item_lm_id = ilLMObject::_lookupContObjID($a_item_id);
        $item_type = ilLMObject::_lookupType($a_item_id);
        $lm_obj = ilObjectFactory::getInstanceByObjId($item_lm_id);
        if ($item_type == "st") {
            $item = new ilStructureObject($lm_obj, $a_item_id);
        } elseif ($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
            $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)
    }

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 211 of file class.ilLMObject.php.

References $DIC, and $ilDB.

Referenced by ilLMExplorerGUI\__construct().

    {
        global $DIC;

        $ilDB = $DIC->database();

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

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 802 of file class.ilLMObject.php.

References $DIC, $ilLog, and IL_FIRST_NODE.

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

    {
        global $DIC;

        $ilLog = $DIC["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);
        }
    }

Here is the caller graph for this function:

read()

ilLMObject::read

(

)

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

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

Referenced by __construct().

    {
        $ilDB = $this->db;

        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->setShortTitle($this->data_record["short_title"]);
        $this->setLayout($this->data_record["layout"]);
    }

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

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

References $a_type, $DIC, Vendor\Package\$e, $id, $ilDB, and ilMDIdentifier\_getEntriesForObj().

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

    {
        global $DIC;

        $ilDB = $DIC->database();

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

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 1046 of file class.ilLMObject.php.

References $id, $title, _writeTitle(), ilMD\getGeneral(), ilLMObjectFactory\getInstance(), ilFormPropertyGUI\removeProhibitedCharacters(), and ilMDBase\update().

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

    {
        if ($a_lang == "") {
            $a_lang = "-";
        }
        if (is_array($a_titles)) {
            foreach ($a_titles as $id => $title) {
                // see #20375
                $title = ilFormPropertyGUI::removeProhibitedCharacters($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();
                }
            }
        }
    }

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 387 of file class.ilLMObject.php.

Referenced by __construct().

    {
        $this->content_object = $a_content_obj;
    }

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 181 of file class.ilLMObject.php.

    {
        $this->data_record = $a_record;
    }

setDescription()

ilLMObject::setDescription

(

$a_description

)

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

    {
        $this->description = $a_description;
    }

setId()

ilLMObject::setId

(

$a_id

)

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

Referenced by create().

    {
        $this->id = $a_id;
    }

Here is the caller graph for this function:

setImportId()

ilLMObject::setImportId

(

$a_id

)

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

Referenced by read().

    {
        $this->import_id = $a_id;
    }

Here is the caller graph for this function:

setLayout()

ilLMObject::setLayout

(

$a_val

)

Set layout.

Parameters

string

layout

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

Referenced by read().

    {
        $this->layout = $a_val;
    }

Here is the caller graph for this function:

setLMId()

ilLMObject::setLMId

(

$a_lm_id

)

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

Referenced by __construct().

    {
        $this->lm_id = $a_lm_id;
    }

Here is the caller graph for this function:

setShortTitle()

ilLMObject::setShortTitle

(

$a_title

)

set short title of lm object

Parameters

string

$a_title

short title of chapter or page

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

Referenced by read().

    {
        $this->short_title = $a_title;
    }

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 233 of file class.ilLMObject.php.

Referenced by read().

    {
        $this->title = $a_title;
    }

Here is the caller graph for this function:

setType()

ilLMObject::setType

(

$a_type

)

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

References $a_type.

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

    {
        $this->type = $a_type;
    }

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 1243 of file class.ilLMObject.php.

References $type, and _lookupType().

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

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

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 493 of file class.ilLMObject.php.

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

    {
        $ilDB = $this->db;

        $this->updateMetaData();

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

        $ilDB->manipulate($query);
    }

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 1080 of file class.ilLMObject.php.

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

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

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

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 149 of file class.ilLMObject.php.

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

Referenced by update().

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

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 1265 of file class.ilLMObject.php.

References Vendor\Package\$c, $DIC, $ilDB, $query, and _lookupType().

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

    {
        global $DIC;

        $ilDB = $DIC->database();

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

Here is the call graph for this function:

Here is the caller graph for this function:

writeShortTitle()

static ilLMObject::writeShortTitle (   $a_id,   $a_short_title,   $a_lang = "-"  )

static

Write short title.

Parameters

integer	$a_id	object id
string	$a_short_title	short title

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

References $db, and $DIC.

Referenced by ilLMEditShortTitlesGUI\save().

    {
        global $DIC;

        $db = $DIC->database();

        if ($a_lang != "-" && $a_lang != "") {
            $trans = new ilLMObjTranslation($a_id, $a_lang);
            $trans->setShortTitle($a_short_title);
            $trans->save();
        } else {
            $db->manipulate(
                "UPDATE lm_data SET " .
                " short_title = " . $db->quote($a_short_title, "text") .
                " WHERE obj_id = " . $db->quote($a_id, "integer")
            );
        }
    }

Here is the caller graph for this function:

Field Documentation

$active

ilLMObject::$active = true

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

Referenced by ilLMPageObject\_getPresentationTitle().

$content_object

ilLMObject::$content_object

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

Referenced by getContentObject().

$data_record

ilLMObject::$data_record

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

$data_records

ilLMObject::$data_records = array()

staticprotected

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

$db

ilLMObject::$db

protected

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

Referenced by create(), delete(), getShortTitles(), read(), update(), and writeShortTitle().

$description

ilLMObject::$description

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

Referenced by getDescription().

$id

ilLMObject::$id

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

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

$lm_id

ilLMObject::$lm_id

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

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

$meta_data

ilLMObject::$meta_data

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

$short_title

ilLMObject::$short_title

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

Referenced by getShortTitle().

$title

ilLMObject::$title

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

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

$type

ilLMObject::$type

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

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

$user

ilLMObject::$user

protected

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

Referenced by createMetaData().

CHAPTER_TITLE

const ilLMObject::CHAPTER_TITLE = "st_title"

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

Referenced by ilStructureObjectGUI\subchap().

NO_HEADER

const ilLMObject::NO_HEADER = "none"

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

PAGE_TITLE

const ilLMObject::PAGE_TITLE = "pg_title"

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

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

---

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

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