ilTermDefinitionEditorGUI Class Reference

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

Collaboration diagram for ilTermDefinitionEditorGUI:

Public Member Functions
	__construct ()
	executeCommand ()
	setTabs ()
	getTabs ()
	saveShortText ()

Data Fields
ilGlobalTemplateInterface	$tpl
ilLanguage	$lng
ilObjGlossary	$glossary
ilGlossaryDefinition	$definition
ilGlossaryTerm	$term

Protected Attributes
ilObjGlossary	$term_glossary
ILIAS Glossary Editing EditingGUIRequest	$request
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ILIAS Style Content GUIService	$content_style_gui
ILIAS Style Content Object ObjectFacade	$content_style_domain

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 GUI class for glossary term definition editor

Author

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

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

Constructor & Destructor Documentation

__construct()

ilTermDefinitionEditorGUI::__construct

(

)

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

References $DIC, $lng, $tpl, ilGlossaryTerm\_lookGlossaryID(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

    {
        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->request = $DIC->glossary()
            ->internal()
            ->gui()
            ->editing()
            ->request();


        $this->glossary = new ilObjGlossary($this->request->getRefId(), true);
        $this->definition = new ilGlossaryDefinition($this->request->getDefinitionId());
        $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"));

        $cs = $DIC->contentStyle();
        $this->content_style_gui = $cs->gui();
        $this->content_style_domain = $cs->domain()->styleForRefId($this->glossary->getRefId());
    }

Here is the call graph for this function:

Member Function Documentation

executeCommand()

ilTermDefinitionEditorGUI::executeCommand

(

)

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

References $ctrl, $lng, $tpl, ILIAS\Repository\ctrl(), ilMD\getGeneral(), ilUtil\getImagePath(), ilGlossaryTerm\getNumberOfUsages(), ilPageObjectGUI\getPageObject(), ilObjStyleSheet\getSyntaxStylePath(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), ilPageObjectGUI\setEditPreview(), setTabs(), ilLanguage\txt(), and ilMDBase\update().

                                    : void
    {
        $tpl = $this->tpl;
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        // content style
        $this->content_style_gui->addCss(
            $this->tpl,
            $this->term_glossary->getRefId(),
            $this->term_glossary->getId()
        );

        // 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($this->request->getTermId());
                    if ($nr > 0) {
                        $link = "[<a href='" .
                            $ilCtrl->getLinkTargetByClass("ilglossarytermgui", "listUsages") .
                            "'>" . $lng->txt("glo_list_usages") . "</a>]";
                        $this->tpl->setOnScreenMessage("info", 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());
                // @var ilGlossaryDefPage $page
                $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=" . $this->request->getRefId());
                $page_gui->setFullscreenLink("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;cmd=fullscreen&amp;ref_id=" . $this->request->getRefId());
                $page_gui->setTemplateTargetVar("ADM_CONTENT");
                $page_gui->setOutputMode("edit");

                $page_gui->setStyleId($this->content_style_domain->getEffectiveStyleId());

                $page_gui->setIntLinkReturn($this->ctrl->getLinkTargetByClass(
                    "ilobjglossarygui",
                    "quickList",
                    "",
                    false,
                    false
                ));
                $page_gui->setPageBackTitle($this->lng->txt("cont_definition"));
                $page_gui->setLinkParams("ref_id=" . $this->request->getRefId());
                $page_gui->setHeader($this->term->getTerm());
                $page_gui->setFileDownloadLink("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;cmd=downloadFile&amp;ref_id=" . $this->request->getRefId());
                $page_gui->setPresentationTitle($this->term->getTerm());
                $ret = $this->ctrl->forwardCommand($page_gui);
                if ($ret != "") {
                    $tpl->setContent($ret);
                }
                break;

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

        }
    }

Here is the call graph for this function:

getTabs()

ilTermDefinitionEditorGUI::getTabs

(

)

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

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by setTabs().

                             : void
    {
        // back to glossary
        $this->tabs_gui->setBack2Target(
            $this->lng->txt("glossary"),
            $this->ctrl->getLinkTargetByClass("ilobjglossarygui", "")
        );

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

Here is the call graph for this function:

Here is the caller graph for this function:

saveShortText()

ilTermDefinitionEditorGUI::saveShortText

(

)

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

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

setTabs()

ilTermDefinitionEditorGUI::setTabs

(

)

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

References getTabs().

Referenced by executeCommand().

                             : void
    {
        $this->getTabs();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$content_style_domain

ILIAS Style Content Object ObjectFacade ilTermDefinitionEditorGUI::$content_style_domain

protected

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

$content_style_gui

ILIAS Style Content GUIService ilTermDefinitionEditorGUI::$content_style_gui

protected

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

$ctrl

ilCtrl ilTermDefinitionEditorGUI::$ctrl

protected

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

Referenced by executeCommand().

$definition

ilGlossaryDefinition ilTermDefinitionEditorGUI::$definition

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

$glossary

ilObjGlossary ilTermDefinitionEditorGUI::$glossary

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

$lng

ilLanguage ilTermDefinitionEditorGUI::$lng

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

Referenced by __construct(), and executeCommand().

$request

ILIAS Glossary Editing EditingGUIRequest ilTermDefinitionEditorGUI::$request

protected

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

$tabs_gui

ilTabsGUI ilTermDefinitionEditorGUI::$tabs_gui

protected

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

$term

ilGlossaryTerm ilTermDefinitionEditorGUI::$term

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

$term_glossary

ilObjGlossary ilTermDefinitionEditorGUI::$term_glossary

protected

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

$tpl

ilGlobalTemplateInterface ilTermDefinitionEditorGUI::$tpl

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

Referenced by __construct(), and executeCommand().

---

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

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