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

Collaboration diagram for ilLMMenuEditor:

Public Member Functions
	__construct ()

	setObjId (int $a_obj_id)

	getObjId ()

	setEntryId (int $a_id)

	getEntryId ()

	setLinkType (string $a_link_type)

	getLinkType ()

	setTitle (string $a_title)

	getTitle ()

	setTarget (string $a_target)

	getTarget ()

	setLinkRefId (int $a_link_ref_id)

	getLinkRefId ()

	setActive (string $a_val)

	getActive ()

	create ()

	getMenuEntries (bool $a_only_active=false)

	delete (int $a_id)

	update ()

	readEntry (int $a_id)

	updateActiveStatus (array $a_entries)
	update active status of all menu entries of lm More...

Static Public Member Functions
static	fixImportMenuItems (int $new_lm_id, array $ref_mapping)

static	writeActive (int $entry_id, bool $active)

Protected Attributes
string	$target = ""

string	$title = ""

int	$entry_id = 0

int	$lm_id = 0

int	$link_ref_id

string	$link_type

string	$active = "n"

ilDBInterface	$db

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 for editing lm menu

Author: Sascha Hofmann sasch.nosp@m.ahof.nosp@m.mann@.nosp@m.gmx..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilLMMenuEditor::__construct ( )

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

    {
        global $DIC;
 
        $ilDB = $DIC->database();
 
        $this->db = $ilDB;
        $this->link_type = "extern";
        $this->link_ref_id = null;
    }

References $DIC, and $ilDB.

Member Function Documentation

◆ create()

ilLMMenuEditor::create ( )

Definition at line 117 of file class.ilLMMenuEditor.php.

                            : void
    {
        $ilDB = $this->db;
 
        $id = $ilDB->nextId("lm_menu");
        $q = "INSERT INTO lm_menu (id, lm_id,link_type,title,target,link_ref_id, active) " .
             "VALUES " .
             "(" .
             $ilDB->quote($id, "integer") . "," .
             $ilDB->quote($this->getObjId(), "integer") . "," .
             $ilDB->quote($this->getLinkType(), "text") . "," .
             $ilDB->quote($this->getTitle(), "text") . "," .
             $ilDB->quote($this->getTarget(), "text") . "," .
             $ilDB->quote($this->getLinkRefId(), "integer") . "," .
             $ilDB->quote($this->getActive(), "text") .
            ")";
        $ilDB->manipulate($q);
        $this->entry_id = $id;
    }

References $db, $id, $ilDB, $q, getActive(), getLinkRefId(), getLinkType(), getObjId(), getTarget(), and getTitle().

Here is the call graph for this function:

◆ delete()

ilLMMenuEditor::delete ( int $a_id )

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

                                     : void
    {
        $ilDB = $this->db;
 
        $q = "DELETE FROM lm_menu WHERE id = " .
            $ilDB->quote($a_id, "integer");
        $ilDB->manipulate($q);
    }

References $ilDB, and $q.

◆ fixImportMenuItems()

static ilLMMenuEditor::fixImportMenuItems	(	int	$new_lm_id,
		array	$ref_mapping
	)

static

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

     : void {
        global $DIC;
 
        $db = $DIC->database();
 
        $set = $db->queryF(
            "SELECT * FROM lm_menu " .
            " WHERE lm_id = %s ",
            array("integer"),
            array($new_lm_id)
        );
        while ($rec = $db->fetchAssoc($set)) {
            // ... only check internal links
            if ($rec["link_type"] == "intern") {
                $link = explode("_", $rec["link_ref_id"]);
                $ref_id = (int) $link[count($link) - 1];
                $new_ref_id = $ref_mapping[$ref_id] ?? 0;
                // if ref id has been imported, update it
                if ($new_ref_id > 0) {
                    $new_target = str_replace((string) $ref_id, (string) $new_ref_id, $rec["target"]);
                    $db->update("lm_menu", array(
                            "link_ref_id" => array("integer", $new_ref_id),
                            "target" => array("text", $new_target)
                        ), array(       // where
                            "id" => array("integer", $rec["id"])
                        ));
                } else {        // if not, delete the menu item
                    $db->manipulateF(
                        "DELETE FROM lm_menu WHERE " .
                        " id = %s",
                        array("integer"),
                        array($rec["id"])
                    );
                }
            }
        }
    }

References $ref_id, ILIAS\Repository\int(), ilDBInterface\manipulateF(), and ilDBInterface\update().

Referenced by ilLearningModuleImporter\finalProcessing().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getActive()

ilLMMenuEditor::getActive ( )

Definition at line 111 of file class.ilLMMenuEditor.php.

                               : string
    {
        return $this->active;
    }

References $active.

Referenced by create().

Here is the caller graph for this function:

◆ getEntryId()

ilLMMenuEditor::getEntryId ( )

Definition at line 61 of file class.ilLMMenuEditor.php.

                                : int
    {
        return $this->entry_id;
    }

References $entry_id.

◆ getLinkRefId()

ilLMMenuEditor::getLinkRefId ( )

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

                                  : int
    {
        return $this->link_ref_id;
    }

References $link_ref_id.

Referenced by create().

Here is the caller graph for this function:

◆ getLinkType()

ilLMMenuEditor::getLinkType ( )

Definition at line 71 of file class.ilLMMenuEditor.php.

                                 : string
    {
        return $this->link_type;
    }

References $link_type.

Referenced by create().

Here is the caller graph for this function:

◆ getMenuEntries()

ilLMMenuEditor::getMenuEntries ( bool $a_only_active = false )

Definition at line 137 of file class.ilLMMenuEditor.php.

     : array {
        $ilDB = $this->db;
 
        $and = "";
 
        $entries = array();
 
        if ($a_only_active === true) {
            $and = " AND active = " . $ilDB->quote("y", "text");
        }
 
        $q = "SELECT * FROM lm_menu " .
             "WHERE lm_id = " . $ilDB->quote($this->lm_id, "integer") .
             $and;
 
        $r = $ilDB->query($q);
 
        while ($row = $ilDB->fetchObject($r)) {
            $entries[] = array('id' => $row->id,
                               'title' => $row->title,
                               'link' => $row->target,
                               'type' => $row->link_type,
                               'ref_id' => $row->link_ref_id,
                               'active' => $row->active
                               );
        }
 
        return $entries;
    }

Referenced by ilLMMenuItemsTableGUI\__construct().

Here is the caller graph for this function:

◆ getObjId()

ilLMMenuEditor::getObjId ( )

Definition at line 51 of file class.ilLMMenuEditor.php.

                              : int
    {
        return $this->lm_id;
    }

References $lm_id.

Referenced by create().

Here is the caller graph for this function:

◆ getTarget()

ilLMMenuEditor::getTarget ( )

Definition at line 91 of file class.ilLMMenuEditor.php.

                               : string
    {
        return $this->target;
    }

References $target.

Referenced by create().

Here is the caller graph for this function:

◆ getTitle()

ilLMMenuEditor::getTitle ( )

Definition at line 81 of file class.ilLMMenuEditor.php.

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by create().

Here is the caller graph for this function:

◆ readEntry()

ilLMMenuEditor::readEntry ( int $a_id )

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

                                        : void
    {
        $ilDB = $this->db;
 
        if (!$a_id) {
            return;
        }
 
        $q = "SELECT * FROM lm_menu WHERE id = " .
            $ilDB->quote($a_id, "integer");
        $r = $ilDB->query($q);
 
        $row = $ilDB->fetchObject($r);
 
        $this->setTitle($row->title);
        $this->setTarget($row->target);
        $this->setLinkType($row->link_type);
        $this->setLinkRefId($row->link_ref_id);
        $this->setEntryId($a_id);
        $this->setActive($row->active);
    }

References $ilDB, and $q.

◆ setActive()

ilLMMenuEditor::setActive ( string $a_val )

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

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

◆ setEntryId()

ilLMMenuEditor::setEntryId ( int $a_id )

Definition at line 56 of file class.ilLMMenuEditor.php.

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

◆ setLinkRefId()

ilLMMenuEditor::setLinkRefId ( int $a_link_ref_id )

Definition at line 96 of file class.ilLMMenuEditor.php.

                                                    : void
    {
        $this->link_ref_id = $a_link_ref_id;
    }

◆ setLinkType()

ilLMMenuEditor::setLinkType ( string $a_link_type )

Definition at line 66 of file class.ilLMMenuEditor.php.

                                                    : void
    {
        $this->link_type = $a_link_type;
    }

◆ setObjId()

ilLMMenuEditor::setObjId ( int $a_obj_id )

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

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

◆ setTarget()

ilLMMenuEditor::setTarget ( string $a_target )

Definition at line 86 of file class.ilLMMenuEditor.php.

                                               : void
    {
        $this->target = $a_target;
    }

◆ setTitle()

ilLMMenuEditor::setTitle ( string $a_title )

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

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

◆ update()

ilLMMenuEditor::update ( )

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

                            : void
    {
        $ilDB = $this->db;
 
        $q = "UPDATE lm_menu SET " .
            " link_type = " . $ilDB->quote($this->getLinkType(), "text") . "," .
            " title = " . $ilDB->quote($this->getTitle(), "text") . "," .
            " target = " . $ilDB->quote($this->getTarget(), "text") . "," .
            " link_ref_id = " . $ilDB->quote($this->getLinkRefId(), "integer") .
            " WHERE id = " . $ilDB->quote($this->getEntryId(), "integer");
        $ilDB->manipulate($q);
    }

References $ilDB, $q, and ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

◆ updateActiveStatus()

ilLMMenuEditor::updateActiveStatus ( array $a_entries )

update active status of all menu entries of lm

Definition at line 216 of file class.ilLMMenuEditor.php.

                                                        : void
    {
        $ilDB = $this->db;
 
        // update active status
        $q = "UPDATE lm_menu SET " .
             "active = CASE " .
             "WHEN " . $ilDB->in("id", $a_entries, false, "integer") . " " .
             "THEN " . $ilDB->quote("y", "text") . " " .
             "ELSE " . $ilDB->quote("n", "text") . " " .
             "END " .
             "WHERE lm_id = " . $ilDB->quote($this->lm_id, "integer");
 
        $ilDB->manipulate($q);
    }

References $ilDB, and $q.

◆ writeActive()

static ilLMMenuEditor::writeActive	(	int	$entry_id,
		bool	$active
	)

static

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

     : void {
        global $DIC;
 
        $db = $DIC->database();
 
        $db->update("lm_menu", array(
                "active" => array("text", ($active ? "y" : "n"))
            ), array(   // where
                "id" => array("", $entry_id)
            ));
    }

Field Documentation

◆ $active

string ilLMMenuEditor::$active = "n"

protected

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

Referenced by getActive().

◆ $db

ilDBInterface ilLMMenuEditor::$db

protected

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

Referenced by create().

◆ $entry_id

int ilLMMenuEditor::$entry_id = 0

protected

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

Referenced by getEntryId().

◆ $link_ref_id

int ilLMMenuEditor::$link_ref_id

protected

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

Referenced by getLinkRefId().

◆ $link_type

string ilLMMenuEditor::$link_type

protected

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

Referenced by getLinkType().

◆ $lm_id

int ilLMMenuEditor::$lm_id = 0

protected

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

Referenced by getObjId().

◆ $target

string ilLMMenuEditor::$target = ""

protected

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

Referenced by getTarget().

◆ $title

string ilLMMenuEditor::$title = ""

protected

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

Referenced by getTitle().

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

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

Public Member Functions

Static Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ create()

◆ delete()

◆ fixImportMenuItems()

◆ getActive()

◆ getEntryId()

◆ getLinkRefId()

◆ getLinkType()

◆ getMenuEntries()

◆ getObjId()

◆ getTarget()

◆ getTitle()

◆ readEntry()

◆ setActive()

◆ setEntryId()

◆ setLinkRefId()

◆ setLinkType()

◆ setObjId()

◆ setTarget()

◆ setTitle()

◆ update()

◆ updateActiveStatus()

◆ writeActive()

Field Documentation

◆ $active

◆ $db

◆ $entry_id

◆ $link_ref_id

◆ $link_type

◆ $lm_id

◆ $target

◆ $title