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

Inheritance diagram for ilLMObject:

Collaboration diagram for ilLMObject:

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

	MDUpdateListener (string $a_element)
	Meta data update listener Important note: Do never call create() or update() method of ilObject here. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	setDataRecord (array $a_record)
	this method should only be called by class ilLMObjectFactory More...

	read ()

	setTitle (string $a_title)

	getTitle ()

	setShortTitle (string $a_title)

	getShortTitle ()

	setDescription (string $a_description)

	getDescription ()

	setType (string $a_type)

	getType ()

	setLMId (int $a_lm_id)

	getLMId ()

	setContentObject (ilObjLearningModule $a_content_obj)

	getContentObject ()

	setId (int $a_id)

	getId ()

	getImportId ()

	setImportId (string $a_id)

	setLayout (string $a_val)

	getLayout ()

	create (bool $a_upload=false)

	update ()

	delete (bool $a_delete_meta_data=true)

	existsExportID (int $a_lm_id, int $a_exp_id, string $a_type="pg")
	Does export ID exist in lm? More...

	getExportIDInfo (int $a_lm_id, int $a_exp_id, string $a_type="pg")

Static Public Member Functions
static	_lookupNID (int $a_lm_id, int $a_lm_obj_id, string $a_type)
	lookup named identifier (ILIAS_NID) More...

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

static	_lookupTitle (int $a_obj_id)

static	_lookupShortTitle (int $a_obj_id)

static	_lookupType (int $a_obj_id, int $a_lm_id=0)

static	_writeTitle (int $a_obj_id, string $a_title)

static	_writeImportId (int $a_id, string $a_import_id)

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

static	_isPagePublic (int $a_node_id, bool $a_check_public_mode=false)

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

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

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

static	getObjectList (int $lm_id, string $type="")

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

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

static	putInTree (ilLMObject $a_obj, int $a_parent_id=0, int $a_target_node_id=0)
	put this object into content object tree More...

static	getTree (int $a_cont_obj_id)
	Get learning module tree. More...

static	clipboardCut (int $a_cont_obj_id, array $a_ids)
	Copy a set of chapters/pages into the clipboard. More...

static	clipboardCopy (int $a_cont_obj_id, array $a_ids)
	Copy a set of chapters/pages into the clipboard. More...

static	saveTitles (ilObjLearningModule $a_lm, array $a_titles, string $a_lang="-")
	Save titles for lm objects. More...

static	updateInternalLinks (array $a_copied_nodes, string $a_parent_type="lm")
	Update internal links, after multiple pages have been copied. More...

static	uniqueTypesCheck (array $a_items)
	Check for unique types (all pages or all chapters) More...

static	writeLayout (int $a_obj_id, string $a_layout, ?ilObjLearningModule $a_lm=null)
	Write layout setting. More...

static	lookupLayout (int $a_obj_id)
	Lookup type. More...

static	getPagesOfChapter (int $a_lm_id, int $a_chap_id)
	Get pages of chapter. More...

static	_getAllLMObjectsOfLM (int $a_lm_id, string $a_type="")
	Get all objects of learning module. More...

static	saveExportId (int $a_lm_id, int $a_lmobj_id, string $a_exp_id, string $a_type="pg")

static	getExportId (int $a_lm_id, int $a_lmobj_id, string $a_type="pg")

static	getDuplicateExportIDs (int $a_lm_id, string $a_type="pg")
	Get duplicate export IDs (count export ID usages) More...

static	_getNodePresentationTitle (array $a_node, string $a_mode=self::PAGE_TITLE, bool $a_include_numbers=false, bool $a_time_scheduled_activation=false, bool $a_force_content=false, int $a_lm_id=0, string $a_lang="-")

static	getShortTitles (int $a_lm_id, string $a_lang="-")

static	writeShortTitle (int $a_id, string $a_short_title, string $a_lang="-")

Data Fields
const	CHAPTER_TITLE = "st_title"

const	PAGE_TITLE = "pg_title"

const	NO_HEADER = "none"

int	$lm_id = 0

string	$type = ""

int	$id = 0

array	$data_record

ilObjLearningModule	$content_object

string	$title = ""

string	$short_title = ""

string	$description = ""

bool	$active = true

Static Protected Member Functions
static	_lookup (int $a_obj_id, string $a_field)

Protected Attributes
string	$layout = ""

string	$import_id = ""

ilObjUser	$user

ilDBInterface	$db

Static Protected Attributes
static	$data_records = array()

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilLMObject

Base class for ilStructureObjects and ilPageObjects (see ILIAS DTD)

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

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

Constructor & Destructor Documentation

◆ __construct()

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

Reimplemented in ilStructureObject.

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

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

References $DIC, ilObject\getId(), read(), setContentObject(), setLMId(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

◆ _deleteAllObjectData()

static ilLMObject::_deleteAllObjectData ( ilObjLearningModule $a_cobj )

static

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

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

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

References ilLMObjectFactory\getInstance().

Here is the call graph for this function:

◆ _exists()

static ilLMObject::_exists ( int $a_id )

static

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

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

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

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

Referenced by ilCourseObjectiveMaterials\__read(), ilInternalLink\_exists(), ilLinksTableGUI\fillRow(), 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	(	int	$a_lm_id,
		string	$a_type = `""`
	)

static

Get all objects of learning module.

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

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

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

Here is the caller graph for this function:

◆ _getAllObjectsForImportId()

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

static

Get all items for an import ID.

(only for items notnot in trash)

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

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

Referenced by updateInternalLinks().

Here is the caller graph for this function:

◆ _getIdForImportId()

static ilLMObject::_getIdForImportId ( string $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

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

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

References $DIC, $ilDB, 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:

◆ _getNodePresentationTitle()

static ilLMObject::_getNodePresentationTitle	(	array	$a_node,
		string	$a_mode = `self::PAGE_TITLE`,
		bool	$a_include_numbers = `false`,
		bool	$a_time_scheduled_activation = `false`,
		bool	$a_force_content = `false`,
		int	$a_lm_id = `0`,
		string	$a_lang = `"-"`
	)

static

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

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

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

Here is the caller graph for this function:

◆ _isPagePublic()

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

static

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

     : bool {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilLog = $DIC["ilLog"];
 
        if (empty($a_node_id)) {
            $message = '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 $message.

Referenced by ilLMContentRendererGUI\determineStatus(), ilLMNavigationStatus\determineStatus(), ilLMNavigationStatus\getPredecessorPageId(), ilLMNavigationStatus\getSuccessorPageId(), ilLMTOCExplorerGUI\isNodeClickable(), ilLMPresentationGUI\showPrintView(), and ilLMPresentationGUI\showPrintViewSelection().

Here is the caller graph for this function:

◆ _lookup()

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

staticprotected

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

                                                                     : string
    {
        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] ?? "";
    }

References $DIC, $ilDB, and $query.

Referenced by _lookupShortTitle(), and _lookupTitle().

Here is the caller graph for this function:

◆ _lookupContObjID()

static ilLMObject::_lookupContObjID ( int $a_id )

static

get learning module id for lm object

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

                                                      : int
    {
        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 (int) ($obj_rec["lm_id"] ?? 0);
    }

References $DIC, $ilDB, and $query.

Referenced by ilStartUpGUI\_checkGoto(), ilObjContentObjectAccess\_checkGoto(), _getIdForImportId(), ilStructureObject\_getPresentationTitle(), ilLMPageObjectGUI\_goto(), ilLMEditorGUI\checkRequestParameters(), ilLMNavigationStatus\determineStatus(), ilLinksTableGUI\fillRow(), ilLearningModuleImporter\finalProcessing(), ilLMPageObjectGUI\getLinkXML(), ilPageLinker\getLinkXML(), ilLearningModuleDataSet\importRecord(), ilLMEditShortTitlesGUI\save(), and updateInternalLinks().

Here is the caller graph for this function:

◆ _lookupNID()

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

static

lookup named identifier (ILIAS_NID)

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

                                                                                     : ?string
    {
        $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 null;
    }

References $id.

◆ _lookupShortTitle()

static ilLMObject::_lookupShortTitle ( int $a_obj_id )

static

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

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

References _lookup().

Here is the call graph for this function:

◆ _lookupTitle()

static ilLMObject::_lookupTitle ( int $a_obj_id )

static

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

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

References _lookup().

Referenced by ilObjContentObjectGUI\confirmedDelete(), ilCourseObjectiveMaterialAssignmentTableGUI\fillRow(), ilCourseObjectivesTableGUI\fillRow(), ilTermUsagesTableGUI\fillRow(), ilLinksTableGUI\fillRow(), ilLMQuestionListTableGUI\fillRow(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ilLMTracker\getBlockedUsersInformation(), ilObjLearningModuleSubItemListGUI\getHTML(), ilLinkInputGUI\getTranslatedValue(), ilCourseObjectiveMaterialAssignmentTableGUI\parse(), ilLMContentRendererGUI\renderDeactivatedPageMessage(), ilLMContentRendererGUI\renderNoPageInChapterMessage(), ilLMContentRendererGUI\renderPreconditionsOfPage(), ilHelpGUI\search(), ilHelpGUI\showHelp(), ilHelpGUI\showPage(), and ilObjContentObject\validatePages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupType()

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

static

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

                                                                       : string
    {
        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"];
            }
        }
 
        $and = "";
        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 $DIC, $ilDB, and $query.

Referenced by ilStructureObjectGUI\activatePages(), ilLMContentRendererGUI\determineStatus(), ilLMNavigationStatus\determineStatus(), ilObjLearningModuleSubItemListGUI\getHTML(), ilLMTOCExplorerGUI\getRootNode(), ilLMNavigationStatus\getSuccessorPageId(), ilPageObject\moveIntLinks(), ilObjContentObjectGUI\saveExportIds(), ilLMPresentationGUI\showPrintView(), uniqueTypesCheck(), updateInternalLinks(), and ilCourseObjectivesGUI\updateMaterialAssignment().

Here is the caller graph for this function:

◆ _writeImportId()

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

static

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

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

References $DIC, and $ilDB.

Referenced by ilQuestionPageParser\handlerEndTag().

Here is the caller graph for this function:

◆ _writePublicAccessStatus()

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

static

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

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

     : void {
        global $DIC;
 
        $ilDB = $DIC->database();
        $ilLog = $DIC["ilLog"];
        $ilErr = $DIC["ilErr"];
 
        if (!is_array($a_pages)) {
            $a_pages = array(0);
        }
 
        if (empty($a_cont_obj_id)) {
            $message = 'ilLMObject::_writePublicAccessStatus(): Invalid parameter! $a_cont_obj_id is empty';
            $ilLog->write($message, $ilLog->WARNING);
            $ilErr->raiseError($message, $ilErr->MESSAGE);
            return;
        }
 
        // 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)) {
                    $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);
    }

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

Here is the caller graph for this function:

◆ _writeTitle()

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

static

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

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

References $DIC, $ilDB, and $query.

Referenced by MDUpdateListener().

Here is the caller graph for this function:

◆ clipboardCopy()

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

static

Copy a set of chapters/pages into the clipboard.

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

     : void {
        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"],
                            ilStr::subStr($subnode["title"], 0, 70),
                            $subnode["parent"],
                            $time,
                            $subnode["lft"]
                        );
                    }
                }
            }
            $order = (($curnode["lft"] ?? 0) > 0)
                ? $curnode["lft"]
                : (int) ($order + 1);
            $ilUser->addObjectToClipboard(
                $id,
                self::_lookupType($id),
                ilStr::subStr(self::_lookupTitle($id), 0, 70),
                0,
                $time,
                $order
            );
        }
    }

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

Here is the caller graph for this function:

◆ clipboardCut()

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

static

Copy a set of chapters/pages into the clipboard.

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

     : void {
        $tree = ilLMObject::getTree($a_cont_obj_id);
        $cut_ids = [];
 
        if (!is_array($a_ids)) {
            return;
        } 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);
            }
        }
    }

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

Here is the caller graph for this function:

◆ create()

ilLMObject::create ( bool $a_upload = false )

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

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

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

Here is the call graph for this function:

◆ createMetaData()

ilLMObject::createMetaData ( )

create meta data entry

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

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

References $ilUser, $user, 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 ( bool $a_delete_meta_data = true )

Reimplemented in ilLMPageObject, and ilStructureObject.

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

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

References $ilDB, $query, and ILIAS\Survey\Mode\getId().

Here is the call graph for this function:

◆ deleteMetaData()

ilLMObject::deleteMetaData ( )

delete meta data entry

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

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

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

Here is the call graph for this function:

◆ existsExportID()

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

Does export ID exist in lm?

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

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

◆ getContentObject()

ilLMObject::getContentObject ( )

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

                                      : ilObjLearningModule
    {
        return $this->content_object;
    }

References $content_object.

◆ getDescription()

ilLMObject::getDescription ( )

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

                                    : string
    {
        return $this->description;
    }

References $description.

Referenced by createMetaData().

Here is the caller graph for this function:

◆ getDuplicateExportIDs()

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

static

Get duplicate export IDs (count export ID usages)

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

     : array {
        $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"])] = ($res[trim($e["entry"])] ?? 0) + 1;
                }
            }
        }
        return $res;
    }

Referenced by ilExportIDTableGUI\__construct().

Here is the caller graph for this function:

◆ getExportId()

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

static

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

     : string {
        // 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"];
            }
        }
        return "";
    }

References Vendor\Package\$e.

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

Here is the caller graph for this function:

◆ getExportIDInfo()

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

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

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

◆ getId()

ilLMObject::getId ( )

Reimplemented in ilLMPageObject.

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

                           : int
    {
        return $this->id;
    }

References $id.

Referenced by create(), createMetaData(), ilStructureObject\delete(), deleteMetaData(), MDUpdateListener(), update(), and updateMetaData().

Here is the caller graph for this function:

◆ getImportId()

ilLMObject::getImportId ( )

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

                                 : string
    {
        return $this->import_id;
    }

References $import_id.

Referenced by create().

Here is the caller graph for this function:

◆ getLayout()

ilLMObject::getLayout ( )

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

                               : string
    {
        return $this->layout;
    }

References $layout.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getLMId()

ilLMObject::getLMId ( )

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

                             : int
    {
        return $this->lm_id;
    }

References $lm_id.

Referenced by ilStructureObject\__construct(), create(), createMetaData(), deleteMetaData(), MDUpdateListener(), update(), and updateMetaData().

Here is the caller graph for this function:

◆ getObjectList()

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

static

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

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

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

Here is the caller graph for this function:

◆ getPagesOfChapter()

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

static

Get pages of chapter.

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

     : array {
        // 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:

◆ getShortTitle()

ilLMObject::getShortTitle ( )

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

                                   : string
    {
        return $this->short_title;
    }

References $short_title.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getShortTitles()

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

static

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

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

Referenced by ilLMEditShortTitlesTableGUI\__construct().

Here is the caller graph for this function:

◆ getTitle()

ilLMObject::getTitle ( )

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

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by create(), createMetaData(), update(), and updateMetaData().

Here is the caller graph for this function:

◆ getTree()

static ilLMObject::getTree ( int $a_cont_obj_id )

static

Get learning module tree.

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

     : ilLMTree {
        $tree = new ilLMTree($a_cont_obj_id);
        $tree->readRootId();
 
        return $tree;
    }

◆ getType()

ilLMObject::getType ( )

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

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by create(), createMetaData(), deleteMetaData(), MDUpdateListener(), and updateMetaData().

Here is the caller graph for this function:

◆ lookupLayout()

static ilLMObject::lookupLayout ( int $a_obj_id )

static

Lookup type.

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

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

References $DIC, $ilDB, and $query.

Referenced by ilLMPagesTableGUI\fillRow().

Here is the caller graph for this function:

◆ MDUpdateListener()

ilLMObject::MDUpdateListener ( string $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

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

                                                       : void
    {
        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:
        }
    }

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:

◆ preloadDataByLM()

static ilLMObject::preloadDataByLM ( int $a_lm_id )

static

Preload data records by lm.

Returns: int number of preloaded records

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

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

References $DIC, and $ilDB.

Referenced by ilLMExplorerGUI\__construct().

Here is the caller graph for this function:

◆ putInTree()

static ilLMObject::putInTree	(	ilLMObject	$a_obj,
		int	$a_parent_id = `0`,
		int	$a_target_node_id = `0`
	)

static

put this object into content object tree

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

     : void {
        global $DIC;
 
        $ilLog = $DIC["ilLog"];
 
        $tree = new ilLMTree($a_obj->getContentObject()->getId());
 
        // determine parent
        $parent_id = ($a_parent_id != 0)
            ? $a_parent_id
            : $tree->getRootId();
 
        // determine target
        if ($a_target_node_id != 0) {
            $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 = ilTree::POS_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);
        }
    }

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

Here is the caller graph for this function:

◆ read()

ilLMObject::read ( )

Reimplemented in ilLMPageObject.

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

                          : void
    {
        $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((string) $this->data_record["import_id"]);
        $this->setTitle((string) $this->data_record["title"]);
        $this->setShortTitle((string) $this->data_record["short_title"]);
        $this->setLayout((string) $this->data_record["layout"]);
    }

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveExportId()

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

static

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

     : void {
        $entries = ilMDIdentifier::_getEntriesForObj(
            $a_lm_id,
            $a_lmobj_id,
            $a_type
        );
        if (trim($a_exp_id) == "") {
            // delete export ids, if existing
 
            foreach ($entries as $id => $e) {
                if ($e["catalog"] == "ILIAS_NID") {
                    $identifier = new ilMDIdentifier();
                    $identifier->setMetaId($id);
                    $identifier->delete();
                }
            }
        } else {
            // update existing entry
 
            $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();
            }
        }
    }

References Vendor\Package\$e, and $id.

Referenced by ilObjContentObjectGUI\saveExportIds().

Here is the caller graph for this function:

◆ saveTitles()

static ilLMObject::saveTitles	(	ilObjLearningModule	$a_lm,
		array	$a_titles,
		string	$a_lang = `"-"`
	)

static

Save titles for lm objects.

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

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

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

Here is the caller graph for this function:

◆ setContentObject()

ilLMObject::setContentObject ( ilObjLearningModule $a_content_obj )

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

                                                                        : void
    {
        $this->content_object = $a_content_obj;
    }

Referenced by __construct().

Here is the caller graph for this function:

◆ setDataRecord()

ilLMObject::setDataRecord ( array $a_record )

this method should only be called by class ilLMObjectFactory

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

                                                  : void
    {
        $this->data_record = $a_record;
    }

◆ setDescription()

ilLMObject::setDescription ( string $a_description )

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

                                                         : void
    {
        $this->description = $a_description;
    }

◆ setId()

ilLMObject::setId ( int $a_id )

Reimplemented in ilLMPageObject.

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

                                    : void
    {
        $this->id = $a_id;
    }

Referenced by create().

Here is the caller graph for this function:

◆ setImportId()

ilLMObject::setImportId ( string $a_id )

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

                                             : void
    {
        $this->import_id = $a_id;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLayout()

ilLMObject::setLayout ( string $a_val )

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

                                            : void
    {
        $this->layout = $a_val;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setLMId()

ilLMObject::setLMId ( int $a_lm_id )

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

                                         : void
    {
        $this->lm_id = $a_lm_id;
    }

Referenced by __construct(), and ilLMPageObjectGUI\setLMPageObject().

Here is the caller graph for this function:

◆ setShortTitle()

ilLMObject::setShortTitle ( string $a_title )

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

                                                  : void
    {
        $this->short_title = $a_title;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setTitle()

ilLMObject::setTitle ( string $a_title )

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

                                             : void
    {
        $this->title = $a_title;
    }

Referenced by read().

Here is the caller graph for this function:

◆ setType()

ilLMObject::setType ( string $a_type )

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

                                           : void
    {
        $this->type = $a_type;
    }

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

Here is the caller graph for this function:

◆ uniqueTypesCheck()

static ilLMObject::uniqueTypesCheck ( array $a_items )

static

Check for unique types (all pages or all chapters)

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

                                                           : bool
    {
        $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().

Here is the call graph for this function:

◆ update()

ilLMObject::update ( )

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

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

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

Here is the call graph for this function:

◆ updateInternalLinks()

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

static

Update internal links, after multiple pages have been copied.

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

     : void {
        $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 $l2) {
                        $targets[] = array("type" => ilInternalLink::_extractTypeOfTarget($l2["Target"]),
                            "id" => (int) ilInternalLink::_extractObjIdOfTarget($l2["Target"]),
                            "inst" => (int) ilInternalLink::_extractInstOfTarget($l2["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) > 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 (isset($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 (isset($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);
                }
            }
        }
    }

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

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

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

                                    : void
    {
        $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	(	int	$a_obj_id,
		string	$a_layout,
		?ilObjLearningModule	$a_lm = `null`
	)

static

Write layout setting.

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

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

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

Here is the caller graph for this function:

◆ writeShortTitle()

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

static

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

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

Referenced by ilLMEditShortTitlesGUI\save().

Here is the caller graph for this function:

Field Documentation

◆ $active

bool ilLMObject::$active = true

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

◆ $content_object

ilObjLearningModule ilLMObject::$content_object

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

Referenced by getContentObject().

◆ $data_record

array ilLMObject::$data_record

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

◆ $data_records

ilLMObject::$data_records = array()

staticprotected

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

◆ $db

ilDBInterface ilLMObject::$db

protected

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

Referenced by create(), read(), and update().

◆ $description

string ilLMObject::$description = ""

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

Referenced by getDescription().

◆ $id

int ilLMObject::$id = 0

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

Referenced by _lookupNID(), getId(), and MDUpdateListener().

◆ $import_id

string ilLMObject::$import_id = ""

protected

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

Referenced by getImportId().

◆ $layout

string ilLMObject::$layout = ""

protected

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

Referenced by getLayout().

◆ $lm_id

int ilLMObject::$lm_id = 0

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

Referenced by getLMId().

◆ $short_title

string ilLMObject::$short_title = ""

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

Referenced by getShortTitle().

◆ $title

string ilLMObject::$title = ""

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

Referenced by getTitle().

◆ $type

string ilLMObject::$type = ""

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

Referenced by getType().

◆ $user

ilObjUser ilLMObject::$user

protected

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

Referenced by createMetaData().

◆ CHAPTER_TITLE

const ilLMObject::CHAPTER_TITLE = "st_title"

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

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

◆ NO_HEADER

const ilLMObject::NO_HEADER = "none"

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

◆ PAGE_TITLE

const ilLMObject::PAGE_TITLE = "pg_title"

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

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

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

Modules/LearningModule/classes/class.ilLMObject.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _deleteAllObjectData()

◆ _exists()

◆ _getAllLMObjectsOfLM()

◆ _getAllObjectsForImportId()

◆ _getIdForImportId()

◆ _getNodePresentationTitle()

◆ _isPagePublic()

◆ _lookup()

◆ _lookupContObjID()

◆ _lookupNID()

◆ _lookupShortTitle()

◆ _lookupTitle()

◆ _lookupType()

◆ _writeImportId()

◆ _writePublicAccessStatus()

◆ _writeTitle()

◆ clipboardCopy()

◆ clipboardCut()

◆ create()

◆ createMetaData()

◆ delete()

◆ deleteMetaData()

◆ existsExportID()

◆ getContentObject()

◆ getDescription()

◆ getDuplicateExportIDs()

◆ getExportId()

◆ getExportIDInfo()

◆ getId()

◆ getImportId()

◆ getLayout()

◆ getLMId()

◆ getObjectList()

◆ getPagesOfChapter()

◆ getShortTitle()

◆ getShortTitles()

◆ getTitle()

◆ getTree()

◆ getType()

◆ lookupLayout()

◆ MDUpdateListener()

◆ preloadDataByLM()

◆ putInTree()

◆ read()

◆ saveExportId()

◆ saveTitles()

◆ setContentObject()

◆ setDataRecord()

◆ setDescription()

◆ setId()

◆ setImportId()

◆ setLayout()

◆ setLMId()

◆ setShortTitle()

◆ setTitle()

◆ setType()

◆ uniqueTypesCheck()

◆ update()

◆ updateInternalLinks()

◆ updateMetaData()

◆ writeLayout()

◆ writeShortTitle()

Field Documentation

◆ $active

◆ $content_object

◆ $data_record

◆ $data_records

◆ $db

◆ $description

◆ $id