ilLMEditorGUI Class Reference

GUI class for learning module editor. More...

Collaboration diagram for ilLMEditorGUI:

Public Member Functions
	__construct ()
	Constructor public. More...
	executeCommand ()
	showTree ()
	Show tree. More...
	main_header ($a_type)
	output main header (title and locator) More...
	displayLocator ()
	display locator More...

Data Fields
	$tpl
	$lng
	$objDefinition
	$ref_id
	$lm_obj
	$tree
	$obj_id

Protected Member Functions
	checkRequestParameters ()
	Check request parameters. More...

Protected Attributes
	$ctrl
	$rbacsystem
	$nav_history
	$error
	$help

Detailed Description

GUI class for learning module editor.

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version

$Id$

ilLMEditorGUI: ilObjLearningModuleGUI

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

Constructor & Destructor Documentation

__construct()

ilLMEditorGUI::__construct

(

)

Constructor public.

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

References $_GET, $DIC, $ilCtrl, $ilErr, $lng, $objDefinition, $rbacsystem, $tpl, array, checkRequestParameters(), ilObjectFactory\getInstanceByRefId(), and ilTree\setTableNames().

    {
        global $DIC;

        $this->rbacsystem = $DIC->rbac()->system();
        $this->nav_history = $DIC["ilNavigationHistory"];
        $this->error = $DIC["ilErr"];
        $this->help = $DIC["ilHelp"];
        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $objDefinition = $DIC["objDefinition"];
        $ilCtrl = $DIC->ctrl();
        $rbacsystem = $DIC->rbac()->system();
        $ilNavigationHistory = $DIC["ilNavigationHistory"];
        $ilErr = $DIC["ilErr"];
        
        $lng->loadLanguageModule("content");
        $lng->loadLanguageModule("lm");

        // check write permission
        if (!$rbacsystem->checkAccess("write", $_GET["ref_id"])) {
            $ilErr->raiseError($lng->txt("permission_denied"), $ilErr->MESSAGE);
        }


        $this->ctrl = $ilCtrl;

        //$this->ctrl->saveParameter($this, array("ref_id", "obj_id"));
        $this->ctrl->saveParameter($this, array("ref_id", "transl"));

        // initiate variables
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->objDefinition = $objDefinition;
        $this->ref_id = $_GET["ref_id"];
        $this->obj_id = $_GET["obj_id"];

        $this->lm_obj = ilObjectFactory::getInstanceByRefId($this->ref_id);
        $this->tree = new ilTree($this->lm_obj->getId());
        $this->tree->setTableNames('lm_tree', 'lm_data');
        $this->tree->setTreeTablePK("lm_id");


        $ilNavigationHistory->addItem(
            $_GET["ref_id"],
            "ilias.php?baseClass=ilLMEditorGUI&ref_id=" . $_GET["ref_id"],
            "lm"
        );

        $this->checkRequestParameters();
    }

Here is the call graph for this function:

Member Function Documentation

checkRequestParameters()

ilLMEditorGUI::checkRequestParameters ( )

protected

Check request parameters.

Exceptions

ilCtrlException
ilException

Definition at line 119 of file class.ilLMEditorGUI.php.

References ilLMObject\_lookupContObjID().

Referenced by __construct().

    {
        $forwards_to_role = $this->ctrl->checkCurrentPathForClass("ilobjrolegui");

        if (!$forwards_to_role && $this->obj_id > 0 && ilLMObject::_lookupContObjID($this->obj_id) != $this->lm_obj->getId()) {
            throw new ilException("Object ID does not match learning module.");
        }
        if ($_REQUEST["active_node"] > 0 && ilLMObject::_lookupContObjID((int) $_REQUEST["active_node"]) != $this->lm_obj->getId()) {
            throw new ilException("Active node does not match learning module.");
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

displayLocator()

ilLMEditorGUI::displayLocator

(

)

display locator

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

References $key, $lng, $row, $t, $type, ilObject\_lookupObjId(), ilObject\_lookupType(), and ilUtil\getImagePath().

Referenced by executeCommand().

    {
        $lng = $this->lng;

        $this->tpl->addBlockFile("LOCATOR", "locator", "tpl.locator.html", "Services/Locator");

        $modifier = 1;

        $locations = $this->ctrl->getLocations();

        foreach ($locations as $key => $row) {
            if ($key < count($locations)-$modifier) {
                $this->tpl->touchBlock("locator_separator");
            }

            if ($row["ref_id"]> 0 && $row["ref_id"] != ROOT_FOLDER_ID) {
                $oid = ilObject::_lookupObjId($row["ref_id"]);
                $t = ilObject::_lookupType($oid);
                $this->tpl->setCurrentBlock("locator_img");
                $this->tpl->setVariable(
                    "IMG_SRC",
                    ilUtil::getImagePath("icon_" . $t . ".svg")
                );
                $this->tpl->setVariable(
                    "IMG_ALT",
                    $lng->txt("obj_" . $type)
                );
                $this->tpl->parseCurrentBlock();
            }

            if ($row["link"] != "") {
                $this->tpl->setCurrentBlock("locator_item");
                $this->tpl->setVariable("ITEM", $row["title"]);
                $this->tpl->setVariable("LINK_ITEM", $row["link"]);
                if ($row["target"] != "") {
                    $this->tpl->setVariable("LINK_TARGET", ' target="' . $row["target"] . '" ');
                }
                $this->tpl->parseCurrentBlock();
            } else {
                $this->tpl->setCurrentBlock("locator_item");
                $this->tpl->setVariable("PREFIX", $row["title"]);
                $this->tpl->parseCurrentBlock();
            }
        }

        $this->tpl->setCurrentBlock("locator");
        $this->tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilLMEditorGUI::executeCommand

(

)

Exceptions

ilCtrlException
ilException

Definition at line 136 of file class.ilLMEditorGUI.php.

References $_GET, $help, $output, $ret, array, displayLocator(), header, main_header(), and showTree().

    {
        $ilHelp = $this->help;
        
        if ($_GET["to_page"]== 1) {
            $this->ctrl->setParameterByClass("illmpageobjectgui", "obj_id", $_GET["obj_id"]);
            $this->ctrl->redirectByClass(array("ilobjlearningmodulegui", "illmpageobjectgui"), "edit");
        }
        
        if ($cmd != "showTree") {
            $this->showTree();
        }

        $next_class = $this->ctrl->getNextClass($this);
        //echo "lmeditorgui:$next_class:".$this->ctrl->getCmdClass().":$cmd:<br>";

        if ($next_class == "" && ($cmd != "explorer")
            && ($cmd != "showImageMap")) {
            $next_class = "ilobjlearningmodulegui";
        }

        // show footer
        $show_footer = ($cmd == "explorer")
            ? false
            : true;
            
        // if ($this->lm_obj->getType()
        switch ($next_class) {
            case "ilobjlearningmodulegui":
                include_once("./Modules/LearningModule/classes/class.ilObjLearningModule.php");
                include_once("./Modules/LearningModule/classes/class.ilObjLearningModuleGUI.php");
                $this->main_header($this->lm_obj->getType());
                $lm_gui = new ilObjLearningModuleGUI("", $_GET["ref_id"], true, false);
                //$ret =& $lm_gui->executeCommand();
                $ret = $this->ctrl->forwardCommand($lm_gui);
                if (strcmp($cmd, "explorer") != 0) {
                    // don't call the locator in the explorer frame
                    // this prevents a lot of log errors
                    // Helmut Schottmüller, 2006-07-21
                    $this->displayLocator();
                }
//echo "*".$this->tpl->get()."*";
                // (horrible) workaround for preventing template engine
                // from hiding paragraph text that is enclosed
                // in curly brackets (e.g. "{a}", see ilPageObjectGUI::showPage())
//                              $this->tpl->fillTabs();
                $output =  $this->tpl->get("DEFAULT", true, true, $show_footer, true);
                $output = str_replace("&#123;", "{", $output);
                $output = str_replace("&#125;", "}", $output);
                header('Content-type: text/html; charset=UTF-8');
                echo $output;
                break;

            default:
                $ret = $this->$cmd();
                break;
        }
    }

Here is the call graph for this function:

main_header()

ilLMEditorGUI::main_header

(

$a_type

)

output main header (title and locator)

Definition at line 215 of file class.ilLMEditorGUI.php.

References $lng, ilObjStyleSheet\getContentStylePath(), and ilObjStyleSheet\getSyntaxStylePath().

Referenced by executeCommand().

    {
        $lng = $this->lng;

        $this->tpl->getStandardTemplate();

        // content style
        $this->tpl->setCurrentBlock("ContentStyle");
        $this->tpl->setVariable(
            "LOCATION_CONTENT_STYLESHEET",
            ilObjStyleSheet::getContentStylePath($this->lm_obj->getStyleSheetId())
        );
        $this->tpl->parseCurrentBlock();

        // syntax style
        $this->tpl->setCurrentBlock("SyntaxStyle");
        $this->tpl->setVariable(
            "LOCATION_SYNTAX_STYLESHEET",
            ilObjStyleSheet::getSyntaxStylePath()
        );
        $this->tpl->parseCurrentBlock();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showTree()

ilLMEditorGUI::showTree

(

)

Show tree.

Parameters

Definition at line 201 of file class.ilLMEditorGUI.php.

References $tpl.

Referenced by executeCommand().

    {
        $tpl = $this->tpl;

        include_once("./Modules/LearningModule/classes/class.ilLMEditorExplorerGUI.php");
        $exp = new ilLMEditorExplorerGUI($this, "showTree", $this->lm_obj);
        if (!$exp->handleCommand()) {
            $tpl->setLeftNavContent($exp->getHTML());
        }
    }

Here is the caller graph for this function:

Field Documentation

$ctrl

ilLMEditorGUI::$ctrl

protected

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

$error

ilLMEditorGUI::$error

protected

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

$help

ilLMEditorGUI::$help

protected

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

Referenced by executeCommand().

$lm_obj

ilLMEditorGUI::$lm_obj

Definition at line 53 of file class.ilLMEditorGUI.php.

$lng

ilLMEditorGUI::$lng

Definition at line 50 of file class.ilLMEditorGUI.php.

Referenced by __construct(), displayLocator(), and main_header().

$nav_history

ilLMEditorGUI::$nav_history

protected

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

$obj_id

ilLMEditorGUI::$obj_id

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

$objDefinition

ilLMEditorGUI::$objDefinition

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

Referenced by __construct().

$rbacsystem

ilLMEditorGUI::$rbacsystem

protected

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

Referenced by __construct().

$ref_id

ilLMEditorGUI::$ref_id

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

$tpl

ilLMEditorGUI::$tpl

Definition at line 49 of file class.ilLMEditorGUI.php.

Referenced by __construct(), and showTree().

$tree

ilLMEditorGUI::$tree

Definition at line 55 of file class.ilLMEditorGUI.php.

---

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

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