class for editing lm menu More...

Collaboration diagram for ilLMMenuEditor:

Public Member Functions
	__construct ()

	setObjId ($a_obj_id)

	getObjId ()

	setEntryId ($a_id)

	getEntryId ()

	setLinkType ($a_link_type)

	getLinkType ()

	setTitle ($a_title)

	getTitle ()

	setTarget ($a_target)

	getTarget ()

	setLinkRefId ($a_link_ref_id)

	getLinkRefId ()

	setActive ($a_val)
	Set active. More...

	getActive ()
	Get active. More...

	create ()

	getMenuEntries ($a_only_active=false)

	delete ($a_id)
	delete menu entry More...

	update ()
	update menu entry More...

	readEntry ($a_id)

	updateActiveStatus ($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)
	Fix ref ids on import. More...

static	writeActive ($entry_id, $active)
	Write status for entry id. More...

Protected Attributes
	$active = "n"

	$db

Detailed Description

class for editing lm menu

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

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilLMMenuEditor::__construct ( )

Definition at line 41 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 133 of file class.ilLMMenuEditor.php.

    {
        $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((int) $this->getObjId(), "integer") . "," .
             $ilDB->quote($this->getLinkType(), "text") . "," .
             $ilDB->quote($this->getTitle(), "text") . "," .
             $ilDB->quote($this->getTarget(), "text") . "," .
             $ilDB->quote((int) $this->getLinkRefId(), "integer") . "," .
             $ilDB->quote($this->getActive(), "text") .
            ")";
        $r = $ilDB->manipulate($q);
 
        $this->entry_id = $id;
 
        return true;
    }

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

Here is the call graph for this function:

◆ delete()

ilLMMenuEditor::delete ( $a_id )

delete menu entry

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

    {
        $ilDB = $this->db;
        
        if (!$a_id) {
            return false;
        }
        
        $q = "DELETE FROM lm_menu WHERE id = " .
            $ilDB->quote($a_id, "integer");
        $ilDB->manipulate($q);
        
        return true;
    }

References $db, and $ilDB.

◆ fixImportMenuItems()

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

static

Fix ref ids on import.

Parameters

int	$new_lm_id
array	$ref_mapping

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

    {
        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];
                // 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 $db, and $DIC.

Referenced by ilLearningModuleImporter\finalProcessing().

Here is the caller graph for this function:

◆ getActive()

ilLMMenuEditor::getActive ( )

Get active.

Returns: string

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

    {
        return $this->active;
    }

References $active.

Referenced by create().

Here is the caller graph for this function:

◆ getEntryId()

ilLMMenuEditor::getEntryId ( )

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

    {
        return $this->entry_id;
    }

Referenced by update().

Here is the caller graph for this function:

◆ getLinkRefId()

ilLMMenuEditor::getLinkRefId ( )

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

    {
        return $this->link_ref_id;
    }

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getLinkType()

ilLMMenuEditor::getLinkType ( )

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

    {
        return $this->link_type;
    }

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getMenuEntries()

ilLMMenuEditor::getMenuEntries ( $a_only_active = false )

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

    {
        $ilDB = $this->db;
        
        $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;
    }

References $db, $ilDB, $r, and $row.

◆ getObjId()

ilLMMenuEditor::getObjId ( )

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

    {
        return $this->lm_id;
    }

Referenced by create().

Here is the caller graph for this function:

◆ getTarget()

ilLMMenuEditor::getTarget ( )

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

    {
        return $this->target;
    }

References $target.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getTitle()

ilLMMenuEditor::getTitle ( )

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

    {
        return $this->title;
    }

References $title.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ readEntry()

ilLMMenuEditor::readEntry ( $a_id )

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

    {
        $ilDB = $this->db;
        
        if (!$a_id) {
            return false;
        }
        
        $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 $db, $ilDB, $r, $row, setActive(), setLinkRefId(), setLinkType(), setTarget(), and setTitle().

Here is the call graph for this function:

◆ setActive()

ilLMMenuEditor::setActive ( $a_val )

Set active.

Parameters

string $a_val

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

    {
        $this->active = $a_val;
    }

Referenced by readEntry().

Here is the caller graph for this function:

◆ setEntryId()

ilLMMenuEditor::setEntryId ( $a_id )

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

    {
        $this->entry_id = $a_id;
    }

◆ setLinkRefId()

ilLMMenuEditor::setLinkRefId ( $a_link_ref_id )

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

    {
        $this->link_ref_id = $a_link_ref_id;
    }

Referenced by readEntry().

Here is the caller graph for this function:

◆ setLinkType()

ilLMMenuEditor::setLinkType ( $a_link_type )

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

    {
        $this->link_type = $a_link_type;
    }

Referenced by readEntry().

Here is the caller graph for this function:

◆ setObjId()

ilLMMenuEditor::setObjId ( $a_obj_id )

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

    {
        $this->lm_id = $a_obj_id;
    }

◆ setTarget()

ilLMMenuEditor::setTarget ( $a_target )

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

    {
        $this->target = $a_target;
    }

Referenced by readEntry().

Here is the caller graph for this function:

◆ setTitle()

ilLMMenuEditor::setTitle ( $a_title )

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

    {
        $this->title = $a_title;
    }

Referenced by readEntry().

Here is the caller graph for this function:

◆ update()

ilLMMenuEditor::update ( )

update menu entry

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

    {
        $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((int) $this->getLinkRefId(), "integer") .
            " WHERE id = " . $ilDB->quote($this->getEntryId(), "integer");
        $r = $ilDB->manipulate($q);
        
        return true;
    }

References $db, $ilDB, $r, getEntryId(), getLinkRefId(), getLinkType(), getTarget(), and getTitle().

Here is the call graph for this function:

◆ updateActiveStatus()

ilLMMenuEditor::updateActiveStatus ( $a_entries )

update active status of all menu entries of lm

Parameters

array entry ids

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

    {
        $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 $db, and $ilDB.

◆ writeActive()

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

static

Write status for entry id.

Parameters

$entry_id
$active

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

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

References $active, $db, and $DIC.

Referenced by ilObjContentObject\cloneObject().

Here is the caller graph for this function:

Field Documentation

◆ $active

ilLMMenuEditor::$active = "n"

protected

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

Referenced by getActive(), and writeActive().

◆ $db

ilLMMenuEditor::$db

protected

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

Referenced by create(), delete(), fixImportMenuItems(), getMenuEntries(), readEntry(), update(), updateActiveStatus(), and writeActive().

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

Modules/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