ilTermDefinitionEditorGUI Class Reference

GUI class for glossary term definition editor. More...

Collaboration diagram for ilTermDefinitionEditorGUI:

Public Member Functions
	__construct ()
	Constructor public. More...
	executeCommand ()
	main_header ($a_header_title)
	output main header (title and locator) More...
	setTabs ()
	output tabs More...
	getTabs ()
	get tabs More...
	saveShortText ()

Data Fields
	$tpl
	$lng
	$glossary
	$definition
	$term

Protected Attributes
	$ctrl
	$tabs_gui

Detailed Description

GUI class for glossary term definition editor.

Author

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

Definition at line 11 of file class.ilTermDefinitionEditorGUI.php.

Constructor & Destructor Documentation

__construct()

ilTermDefinitionEditorGUI::__construct

(

)

Constructor public.

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

References $_GET, $DIC, $lng, $tpl, and ilGlossaryTerm\_lookGlossaryID().

    {
        global $DIC;

        $tpl = $DIC["tpl"];
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $ilTabs = $DIC->tabs();

        // initiate variables
        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        $this->glossary = new ilObjGlossary($_GET["ref_id"], true);
        $this->definition = new ilGlossaryDefinition($_GET["def"]);
        $this->term = new ilGlossaryTerm($this->definition->getTermId());
        $this->term_glossary = new ilObjGlossary(ilGlossaryTerm::_lookGlossaryID($this->definition->getTermId()), false);
        $this->tabs_gui = $ilTabs;

        $this->ctrl->saveParameter($this, array("def"));
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilTermDefinitionEditorGUI::executeCommand

(

)

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

References $_GET, $ctrl, $lng, $ret, $tpl, ilObjStyleSheet\getContentStylePath(), ilObjStyleSheet\getEffectiveContentStyleId(), ilMD\getGeneral(), ilUtil\getImagePath(), ilGlossaryTerm\getNumberOfUsages(), ilPageObjectGUI\getPageObject(), ilObjStyleSheet\getSyntaxStylePath(), ilUtil\sendInfo(), ilPageObjectGUI\setEditPreview(), setTabs(), and ilMDBase\update().

    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
        
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

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

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

        $gloss_loc = new ilGlossaryLocatorGUI();
        $gloss_loc->setTerm($this->term);
        $gloss_loc->setGlossary($this->glossary);
        $gloss_loc->setDefinition($this->definition);

        $this->tpl->setTitle($this->term->getTerm() . " - " .
            $this->lng->txt("cont_definition") . " " .
            $this->definition->getNr());
        if ($this->ctrl->getNextClass() == "ilglossarydefpagegui") {
            $this->tpl->setTitleIcon(ilUtil::getImagePath("icon_glo.svg"));
        }

        switch ($next_class) {

            case "ilglossarydefpagegui":
                
                // output number of usages
                if ($ilCtrl->getCmd() == "edit" &&
                    $ilCtrl->getCmdClass() == "ilglossarydefpagegui") {
                    $nr = ilGlossaryTerm::getNumberOfUsages($_GET["term_id"]);
                    if ($nr > 0) {
                        $link = "[<a href='" .
                            $ilCtrl->getLinkTargetByClass("ilglossarytermgui", "listUsages") .
                            "'>" . $lng->txt("glo_list_usages") . "</a>]";
                        ilUtil::sendInfo(sprintf(
                            $lng->txt("glo_term_is_used_n_times"),
                            $nr
                        ) . " " . $link);
                    }
                }
            
                // not so nice, to do: revise locator handling
                if ($this->ctrl->getNextClass() == "ilglossarydefpagegui"
                    || $this->ctrl->getCmdClass() == "ileditclipboardgui") {
                    $gloss_loc->display();
                }
                $this->setTabs();
                $this->ctrl->setReturnByClass("ilGlossaryDefPageGUI", "edit");
                $this->ctrl->setReturn($this, "listDefinitions");
                $page_gui = new ilGlossaryDefPageGUI($this->definition->getId());
                $page = $page_gui->getPageObject();
                $this->definition->assignPageObject($page);
                $page->addUpdateListener($this, "saveShortText");
                $page_gui->setEditPreview(true);
                
                // metadata
                // ... set title to term, if no title is given
                $md = new ilMD($this->term_glossary->getId(), $this->definition->getId(), "gdf");
                $md_gen = $md->getGeneral();
                if ($md_gen->getTitle() == "") {
                    $md_gen->setTitle($this->term->getTerm());
                    $md_gen->update();
                }

                $page_gui->activateMetaDataEditor($this->term_glossary, "gdf", $this->definition->getId());
                
                $page_gui->setSourcecodeDownloadScript("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;ref_id=" . $_GET["ref_id"]);
                $page_gui->setFullscreenLink("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;cmd=fullscreen&amp;ref_id=" . $_GET["ref_id"]);
                $page_gui->setTemplateTargetVar("ADM_CONTENT");
                $page_gui->setOutputMode("edit");

                $page_gui->setStyleId(ilObjStyleSheet::getEffectiveContentStyleId(
                    $this->term_glossary->getStyleSheetId(),
                    "glo"
                ));
                $page_gui->setLocator($gloss_loc);
                $page_gui->setIntLinkReturn($this->ctrl->getLinkTargetByClass(
                    "ilobjglossarygui",
                    "quickList",
                    "",
                    false,
                    false
                ));
                $page_gui->setPageBackTitle($this->lng->txt("cont_definition"));
                $page_gui->setLinkParams("ref_id=" . $_GET["ref_id"]);
                $page_gui->setHeader($this->term->getTerm());
                $page_gui->setFileDownloadLink("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;cmd=downloadFile&amp;ref_id=" . $_GET["ref_id"]);
                $page_gui->setPresentationTitle($this->term->getTerm());
                $ret = $this->ctrl->forwardCommand($page_gui);
                if ($ret != "") {
                    $tpl->setContent($ret);
                }
                break;

            default:
                $this->setTabs();
                $gloss_loc->display();
                $ret = $this->$cmd();
                break;

        }
    }

Here is the call graph for this function:

getTabs()

ilTermDefinitionEditorGUI::getTabs

(

)

get tabs

Definition at line 200 of file class.ilTermDefinitionEditorGUI.php.

Referenced by setTabs().

    {
        // back to glossary
        $this->tabs_gui->setBack2Target(
            $this->lng->txt("glossary"),
            $this->ctrl->getParentReturn($this)
        );

        // back to upper context
        $this->tabs_gui->setBackTarget(
            $this->lng->txt("term"),
            $this->ctrl->getLinkTargetByClass("ilglossarytermgui", "editTerm")
        );
    }

Here is the caller graph for this function:

main_header()

ilTermDefinitionEditorGUI::main_header

(

$a_header_title

)

output main header (title and locator)

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

References $lng.

    {
        $lng = $this->lng;

        $this->tpl->loadStandardTemplate();
        $this->tpl->setTitle($a_header_title);
        $this->displayLocator();
        //$this->setAdminTabs($a_type);
    }

saveShortText()

ilTermDefinitionEditorGUI::saveShortText

(

)

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

    {
        $this->definition->updateShortText();
    }

setTabs()

ilTermDefinitionEditorGUI::setTabs

(

)

output tabs

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

References getTabs().

Referenced by executeCommand().

    {
        // catch feedback message
        $this->getTabs();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$ctrl

ilTermDefinitionEditorGUI::$ctrl

protected

Definition at line 16 of file class.ilTermDefinitionEditorGUI.php.

Referenced by executeCommand().

$definition

ilTermDefinitionEditorGUI::$definition

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

$glossary

ilTermDefinitionEditorGUI::$glossary

Definition at line 25 of file class.ilTermDefinitionEditorGUI.php.

$lng

ilTermDefinitionEditorGUI::$lng

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

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

$tabs_gui

ilTermDefinitionEditorGUI::$tabs_gui

protected

Definition at line 21 of file class.ilTermDefinitionEditorGUI.php.

$term

ilTermDefinitionEditorGUI::$term

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

$tpl

ilTermDefinitionEditorGUI::$tpl

Definition at line 23 of file class.ilTermDefinitionEditorGUI.php.

Referenced by __construct(), and executeCommand().

---

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

• Modules/Glossary/classes/class.ilTermDefinitionEditorGUI.php