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

Collaboration diagram for ilGlossaryTermGUI:

Public Member Functions
	__construct (int $a_id=0)

	executeCommand ()

	setOfflineDirectory (string $offdir)

	getOfflineDirectory ()

	setGlossary (ilObjGlossary $a_glossary)

	setPageLinker (\ILIAS\COPage\PageLinker $page_linker)

	editTerm (ilPropertyFormGUI $a_form=null)

	getEditTermForm ()

	updateTerm ()

	getOverlayHTML (string $a_close_el_id, string $a_glo_ov_id="", string $a_lang="", string $a_outputmode="offline")

	output (bool $a_offline=false, ilGlobalTemplateInterface $a_tpl=null, string $a_outputmode="presentation")
	output glossary term definitions used in ilLMPresentationGUI->ilGlossary() More...

	getInternalLinks ()

	setTabs ()

	displayLocator ()

	getTabs ()

	listUsages ()

Static Public Member Functions
static	_goto (string $a_target, int $a_ref_id=0)

Data Fields
ilLanguage	$lng

ilGlobalTemplateInterface	$tpl

ilObjGlossary	$glossary

ilGlossaryTerm	$term

Protected Attributes
ilAdvancedMDRecordGUI	$record_gui

int	$ref_id

ILIAS Glossary Editing EditingGUIRequest	$request

string	$offline_directory

ilCtrl	$ctrl

ilTabsGUI	$tabs_gui

ilHelpGUI	$help

ILIAS COPage PageLinker	$page_linker

ilLogger	$log

ilObjGlossary	$term_glossary = null

ilToolbarGUI	$toolbar

ILIAS Style Content GUIService	$content_style_gui

ILIAS Style Content DomainService	$content_style_domain

ILIAS Glossary InternalDomainService	$domain

ILIAS UI Renderer	$ui_ren

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 terms

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de ilGlossaryTermGUI: ilTermDefinitionEditorGUI, ilGlossaryDefPageGUI, ilPropertyFormGUI ilGlossaryTermGUI: ilObjectMetaDataGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilGlossaryTermGUI::__construct ( int $a_id = 0 )

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

References $DIC, $lng, $tpl, ilGlossaryTerm\_lookGlossaryID(), ilObject\_lookupObjectId(), ILIAS\Repository\ctrl(), ilLoggerFactory\getLogger(), ILIAS\Repository\help(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

       {
         global $DIC;
 
         $this->help = $DIC["ilHelp"];
         $lng = $DIC->language();
         $tpl = $DIC["tpl"];
         $ilCtrl = $DIC->ctrl();
         $ilTabs = $DIC->tabs();
 
         $this->lng = $lng;
         $this->tpl = $tpl;
         $this->ctrl = $ilCtrl;
         $this->ctrl->saveParameter($this, array("term_id"));
         $this->tabs_gui = $ilTabs;
         $this->request = $DIC->glossary()
             ->internal()
             ->gui()
             ->editing()
             ->request();
         $this->domain = $DIC->glossary()->internal()->domain();
         $this->ui_ren = $DIC->ui()->renderer();
 
         $this->log = ilLoggerFactory::getLogger('glo');
 
         $this->toolbar = $DIC->toolbar();
 
         $this->ref_id = $this->request->getRefId();
 
         if ($a_id != 0) {
             $this->term = new ilGlossaryTerm($a_id);
             if (ilObject::_lookupObjectId($this->ref_id) == ilGlossaryTerm::_lookGlossaryID($a_id)) {
                 $this->term_glossary = new ilObjGlossary($this->ref_id, true);
             } else {
                 $this->term_glossary = new ilObjGlossary(ilGlossaryTerm::_lookGlossaryID($a_id), false);
             }
         }
         $cs = $DIC->contentStyle();
         $this->content_style_gui = $cs->gui();
         $this->content_style_domain = $cs->domain();
     }

Here is the call graph for this function:

Member Function Documentation

◆ _goto()

static ilGlossaryTermGUI::_goto	(	string	$a_target,
		int	$a_ref_id = `0`
	)

static

Definition at line 409 of file class.ilGlossaryTermGUI.php.

References $DIC, ilObject\_getAllReferences(), ilObjectGUI\_gotoRepositoryRoot(), ilGlossaryTerm\_lookGlossaryID(), ilObject\_lookupTitle(), ilCtrl\redirectByClass(), ROOT_FOLDER_ID, ilCtrl\setParameterByClass(), and ilLanguage\txt().

Referenced by ILIAS\StaticURL\Handler\LegacyGotoHandler\handle().

      : void {
         global $DIC;
         $main_tpl = $DIC->ui()->mainTemplate();
 
         $ctrl = $DIC->ctrl();
         $lng = $DIC->language();
         $ilAccess = $DIC->access();
 
         $glo_id = ilGlossaryTerm::_lookGlossaryID($a_target);//::_lookupContObjID($a_target);
 
         // get all references
         if ($a_ref_id > 0) {
             $ref_ids = array($a_ref_id);
         } else {
             $ref_ids = ilObject::_getAllReferences($glo_id);
         }
 
         // check read permissions
         foreach ($ref_ids as $ref_id) {
             // Permission check
             if ($ilAccess->checkAccess("read", "", $ref_id)) {
                 $ctrl->setParameterByClass("ilGlossaryPresentationGUI", "term_id", $a_target);
                 $ctrl->setParameterByClass("ilGlossaryPresentationGUI", "ref_id", $ref_id);
                 $ctrl->redirectByClass("ilGlossaryPresentationGUI", "listDefinitions");
             }
         }
         if ($ilAccess->checkAccess("read", "", ROOT_FOLDER_ID)) {
             $main_tpl->setOnScreenMessage('failure', sprintf(
                 $lng->txt("msg_no_perm_read_item"),
                 ilObject::_lookupTitle($glo_id)
             ), true);
             ilObjectGUI::_gotoRepositoryRoot();
         }
 
         throw new ilPermissionException($lng->txt("msg_no_perm_read_lm"));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayLocator()

ilGlossaryTermGUI::displayLocator ( )

Definition at line 344 of file class.ilGlossaryTermGUI.php.

Referenced by editTerm(), and listUsages().

                                     : void
     {
         $gloss_loc = new ilGlossaryLocatorGUI();
         $gloss_loc->setGlossary($this->glossary);
         $gloss_loc->display();
     }

Here is the caller graph for this function:

◆ editTerm()

ilGlossaryTermGUI::editTerm ( ilPropertyFormGUI $a_form = null )

Definition at line 151 of file class.ilGlossaryTermGUI.php.

References $ctrl, $tabs_gui, displayLocator(), getEditTermForm(), ilUtil\getImagePath(), ILIAS\Repository\lng(), and setTabs().

Referenced by updateTerm().

      : void {
         $ilTabs = $this->tabs_gui;
         $ilCtrl = $this->ctrl;
 
         //              $this->getTemplate();
         $this->displayLocator();
         $this->setTabs();
         $ilTabs->activateTab("properties");
 
         $this->tpl->setTitle($this->lng->txt("cont_term") . ": " . $this->term->getTerm());
         $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_glo.svg"));
 
         if (!$a_form) {
             $a_form = $this->getEditTermForm();
         }
 
         $this->tpl->setContent($ilCtrl->getHTML($a_form));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ executeCommand()

ilGlossaryTermGUI::executeCommand ( )

Definition at line 90 of file class.ilGlossaryTermGUI.php.

References $tabs_gui, ILIAS\Repository\ctrl(), getEditTermForm(), and setTabs().

                                     : void
     {
         $ilTabs = $this->tabs_gui;
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         $this->log->debug("glossary term, next class " . $next_class . ", cmd: " . $cmd);
 
         switch ($next_class) {
             case "iltermdefinitioneditorgui":
                 $def_edit = new ilTermDefinitionEditorGUI();
                 $this->ctrl->forwardCommand($def_edit);
                 break;
 
             case "ilpropertyformgui":
                 $form = $this->getEditTermForm();
                 $this->ctrl->forwardCommand($form);
                 break;
 
             case "ilobjectmetadatagui":
                 $this->setTabs();
                 $ilTabs->activateTab('meta_data');
                 $md_gui = new ilObjectMetaDataGUI(
                     $this->term_glossary,
                     'term',
                     $this->term->getId()
                 );
                 $this->ctrl->forwardCommand($md_gui);
                 break;
 
             default:
                 $ret = $this->$cmd();
                 break;
         }
     }

Here is the call graph for this function:

◆ getEditTermForm()

ilGlossaryTermGUI::getEditTermForm ( )

Definition at line 172 of file class.ilGlossaryTermGUI.php.

References Vendor\Package\$a, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilAdvancedMDRecordGUI\MODE_EDITOR, ilAdvancedMDRecordGUI\setPropertyForm(), and ilFormPropertyGUI\setRequired().

Referenced by editTerm(), executeCommand(), and updateTerm().

                                      : ilPropertyFormGUI
     {
         $form = new ilPropertyFormGUI();
         $form->setFormAction($this->ctrl->getFormAction($this, "updateTerm"));
         $form->setTitle($this->lng->txt("cont_edit_term"));
 
         $term = new ilTextInputGUI($this->lng->txt("cont_term"), "term");
         $term->setRequired(true);
         $term->setValue($this->term->getTerm());
         $form->addItem($term);
 
         $lang = new ilSelectInputGUI($this->lng->txt("language"), "term_language");
         $lang->setRequired(true);
         $lang->setOptions($this->domain->metadata()->getLOMLanguagesForSelectInputs());
         $lang->setValue($this->term->getLanguage());
         $form->addItem($lang);
 
         // taxonomy
         if ($this->term_glossary->getTaxonomyId() > 0) {
             $tax_node_assign = new ilTaxSelectInputGUI($this->term_glossary->getTaxonomyId(), "tax_node", true);
 
             $ta = new ilTaxNodeAssignment("glo", $this->term_glossary->getId(), "term", $this->term_glossary->getTaxonomyId());
             $assgnmts = $ta->getAssignmentsOfItem($this->term->getId());
             $node_ids = array();
             foreach ($assgnmts as $a) {
                 $node_ids[] = $a["node_id"];
             }
             $tax_node_assign->setValue($node_ids);
 
             $form->addItem($tax_node_assign);
         }
 
         // advanced metadata
         $this->record_gui = new ilAdvancedMDRecordGUI(
             ilAdvancedMDRecordGUI::MODE_EDITOR,
             'glo',
             $this->term_glossary->getId(),
             'term',
             $this->term->getId()
         );
         $this->record_gui->setPropertyForm($form);
         $this->record_gui->parse();
 
         $form->addCommandButton("updateTerm", $this->lng->txt("save"));
 
         return $form;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInternalLinks()

ilGlossaryTermGUI::getInternalLinks ( )

Definition at line 326 of file class.ilGlossaryTermGUI.php.

References ilPageObject\buildDom().

                                       : array
     {
         $term_links = array();
         $page = new ilGlossaryDefPage($this->term->getId());
         $page->buildDom();
         $page_links = $page->getInternalLinks();
         foreach ($page_links as $key => $page_link) {
             $term_links[$key] = $page_link;
         }
 
         return $term_links;
     }

Here is the call graph for this function:

◆ getOfflineDirectory()

ilGlossaryTermGUI::getOfflineDirectory ( )

Definition at line 132 of file class.ilGlossaryTermGUI.php.

References $offline_directory.

Referenced by output().

                                          : string
     {
         return $this->offline_directory;
     }

Here is the caller graph for this function:

◆ getOverlayHTML()

ilGlossaryTermGUI::getOverlayHTML	(	string	$a_close_el_id,
		string	$a_glo_ov_id = `""`,
		string	$a_lang = `""`,
		string	$a_outputmode = `"offline"`
	)

Definition at line 248 of file class.ilGlossaryTermGUI.php.

References $lng, ilGlobalTemplateInterface\get(), ilLanguage\getLangKey(), output(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), ilGlobalTemplateInterface\setVariable(), and ilLanguage\txtlng().

      : string {
         $lng = $this->lng;
 
         if ($a_lang == "") {
             $a_lang = $lng->getLangKey();
         }
 
         $tpl = new ilTemplate("tpl.glossary_overlay.html", true, true, "components/ILIAS/Glossary");
         //              $this->output(true, $tpl);
         if ($a_outputmode == "preview") {
             $a_outputmode = "presentation";
         }
         if ($a_outputmode == "offline") {
             $this->output(true, $tpl, $a_outputmode);
         } else {
             $this->output(false, $tpl, $a_outputmode);
         }
         if ($a_glo_ov_id != "") {
             $tpl->setCurrentBlock("glovlink");
             $tpl->setVariable("TXT_LINK", $lng->txtlng("content", "cont_sco_glossary", $a_lang));
             $tpl->setVariable("ID_LINK", $a_glo_ov_id);
             $tpl->parseCurrentBlock();
         }
         $tpl->setVariable("TXT_CLOSE", $lng->txtlng("common", "close", $a_lang));
         $tpl->setVariable("ID_CLOSE", $a_close_el_id);
         return $tpl->get();
     }

Here is the call graph for this function:

◆ getTabs()

ilGlossaryTermGUI::getTabs ( )

Definition at line 351 of file class.ilGlossaryTermGUI.php.

References $help, $lng, CLIENT_ID, ILIAS\Repository\ctrl(), ilGlossaryTerm\getNumberOfUsages(), ilObjectMetaDataGUI\getTab(), ILIAS\Repository\lng(), ilHelpGUI\setScreenIdComponent(), and ilLanguage\txt().

Referenced by setTabs().

                              : void
     {
         $lng = $this->lng;
         $ilHelp = $this->help;
 
         $ilHelp->setScreenIdComponent("glo_term");
 
         $term_id = 0;
         if (!empty($this->request->getTableGlossaryTermListIds())
             && $this->request->getTableGlossaryTermListIds()[0] > 0) {
             $term_id = $this->request->getTableGlossaryTermListIds()[0];
         } elseif ($this->request->getTermId() > 0) {
             $term_id = $this->request->getTermId();
         }
         if ($term_id > 0) {
             $this->tabs_gui->addTab(
                 "properties",
                 $lng->txt("term"),
                 $this->ctrl->getLinkTarget($this, "editTerm")
             );
 
             $this->tabs_gui->addTab(
                 "usage",
                 $lng->txt("cont_usage") . " (" . ilGlossaryTerm::getNumberOfUsages($term_id) . ")",
                 $this->ctrl->getLinkTarget($this, "listUsages")
             );
 
             $mdgui = new ilObjectMetaDataGUI(
                 $this->term_glossary,
                 "term",
                 $this->term->getId()
             );
             $mdtab = $mdgui->getTab();
             if ($mdtab) {
                 $this->tabs_gui->addTab(
                     "meta_data",
                     $lng->txt("meta_data"),
                     $mdtab
                 );
             }
 
             $this->tabs_gui->addNonTabbedLink(
                 "presentation_view",
                 $this->lng->txt("glo_presentation_view"),
                 ILIAS_HTTP_PATH .
                 "/goto.php?target=" .
                 "git" .
                 "_" . $term_id . "_" . $this->request->getRefId() . "&client_id=" . CLIENT_ID
             );
         }
 
         // back to glossary
         $this->tabs_gui->setBackTarget(
             $this->lng->txt("glossary"),
             $this->ctrl->getLinkTargetByClass("ilobjglossarygui", "listTerms")
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ listUsages()

ilGlossaryTermGUI::listUsages ( )

Definition at line 449 of file class.ilGlossaryTermGUI.php.

References $tabs_gui, $tpl, displayLocator(), ilUtil\getImagePath(), ILIAS\Repository\lng(), ilGlobalTemplateInterface\setContent(), and setTabs().

                                 : void
     {
         $ilTabs = $this->tabs_gui;
         $tpl = $this->tpl;
 
         //$this->displayLocator();
         //              $this->getTemplate();
         $this->displayLocator();
         $this->setTabs();
         $ilTabs->activateTab("usage");
 
         $this->tpl->setTitle($this->lng->txt("cont_term") . ": " . $this->term->getTerm());
         $this->tpl->setTitleIcon(ilUtil::getImagePath("standard/icon_glo.svg"));
 
         $table = $this->domain->table()->getTermUsagesTable($this->request->getTermId())->getComponent();
 
         $tpl->setContent($this->ui_ren->render($table));
     }

Here is the call graph for this function:

◆ output()

ilGlossaryTermGUI::output	(	bool	$a_offline = `false`,
		ilGlobalTemplateInterface	$a_tpl = `null`,
		string	$a_outputmode = `"presentation"`
	)

output glossary term definitions used in ilLMPresentationGUI->ilGlossary()

Definition at line 285 of file class.ilGlossaryTermGUI.php.

References $tpl, ilMathJax\getInstance(), getOfflineDirectory(), ilGlobalTemplateInterface\parseCurrentBlock(), ilGlobalTemplateInterface\setCurrentBlock(), ilPageObjectGUI\setTemplate(), and ilGlobalTemplateInterface\setVariable().

Referenced by getOverlayHTML().

      : void {
         if ($a_tpl != null) {
             $tpl = $a_tpl;
         } else {
             $tpl = $this->tpl;
         }
 
         $tpl->setVariable("TXT_TERM", $this->term->getTerm());
 
         $page_gui = new ilGlossaryDefPageGUI($this->term->getId());
         $page_gui->setTemplate($tpl);
         $page_gui->setSourcecodeDownloadScript("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;ref_id=" . $this->ref_id);
         if ($a_offline) {
             $page_gui->setFullscreenLink("fullscreen.html");    // id is set by xslt
         }
         $page_gui->setFileDownloadLink("ilias.php?baseClass=ilGlossaryPresentationGUI&amp;cmd=downloadFile&amp;ref_id=" . $this->ref_id);
 
         if (!$a_offline) {
             $page_gui->setOutputMode($a_outputmode);
         } else {
             $page_gui->setOutputMode("offline");
             $page_gui->setOfflineDirectory($this->getOfflineDirectory());
         }
 
         //$page_gui->setOutputMode("edit");
         //$page_gui->setPresentationTitle($this->term->getTerm());
         $page_gui->setPageLinker($this->page_linker);
         $page_gui->setTemplateOutput(false);
         $output = $page_gui->presentation($page_gui->getOutputMode());
 
         ilMathJax::getInstance()->includeMathJax($tpl);
 
         $tpl->setCurrentBlock("definition");
         $tpl->setVariable("PAGE_CONTENT", $output);
         $tpl->parseCurrentBlock();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setGlossary()

ilGlossaryTermGUI::setGlossary ( ilObjGlossary $a_glossary )

Definition at line 138 of file class.ilGlossaryTermGUI.php.

                                                           : void
     {
         $this->glossary = $a_glossary;
         if (!is_object($this->term_glossary)) {
             $this->term_glossary = $a_glossary;
         }
     }

◆ setOfflineDirectory()

ilGlossaryTermGUI::setOfflineDirectory ( string $offdir )

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

                                                        : void
     {
         $this->offline_directory = $offdir;
     }

◆ setPageLinker()

ilGlossaryTermGUI::setPageLinker ( \ILIAS\COPage\PageLinker $page_linker )

Definition at line 146 of file class.ilGlossaryTermGUI.php.

References $page_linker.

                                                                         : void
     {
         $this->page_linker = $page_linker;
     }

◆ setTabs()

ilGlossaryTermGUI::setTabs ( )

Definition at line 339 of file class.ilGlossaryTermGUI.php.

References getTabs().

Referenced by editTerm(), executeCommand(), and listUsages().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateTerm()

ilGlossaryTermGUI::updateTerm ( )

Definition at line 220 of file class.ilGlossaryTermGUI.php.

References ILIAS\Repository\ctrl(), ilTaxNodeAssignment\deleteAssignmentsOfItem(), editTerm(), getEditTermForm(), and ILIAS\Repository\lng().

                                 : void
     {
         $form = $this->getEditTermForm();
         if ($form->checkInput() &&
             $this->record_gui->importEditFormPostValues()) {
             // update term
             $this->term->setTerm($form->getInput("term"));
             $this->term->setLanguage($form->getInput("term_language"));
             $this->term->update();
 
             // update taxonomy assignment
             if ($this->term_glossary->getTaxonomyId() > 0) {
                 $ta = new ilTaxNodeAssignment("glo", $this->term_glossary->getId(), "term", $this->term_glossary->getTaxonomyId());
                 $ta->deleteAssignmentsOfItem($this->term->getId());
                 foreach ($this->request->getTaxNodes() as $node_id) {
                     $ta->addAssignment($node_id, $this->term->getId());
                 }
             }
 
             $this->record_gui->writeEditForm();
             $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
             $this->ctrl->redirect($this, "editTerm");
         }
 
         $form->setValuesByPost();
         $this->editTerm($form);
     }