class.ilLanguageExtTableGUI.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilLanguageExtTableGUI extends ilTable2GUI
{
    private int $inputsize = 40;
    private int $commentsize = 30;
    private array $params;

    public function __construct(object $a_parent_obj, string $a_parent_cmd, array $a_params = array())
    {
        global $DIC;
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();

        // allow a different sorting/paging for admin and translation tables
        $this->params = $a_params;
        $this->setId("lang_ext_" . (ilObjLanguageAccess::_isPageTranslation() ? "trans" : "admin"));

        parent::__construct($a_parent_obj, $a_parent_cmd);

        $this->setRowTemplate("tpl.lang_items_row.html", "Services/Language");
        $this->setFormAction($ilCtrl->getFormAction($a_parent_obj));
        $this->setDisableFilterHiding(true);

        $this->initFilter();

        // set the compare language
        $compare = $this->getFilterItemByPostVar("compare")->getValue();
        $compare_note = '';
        if ($compare === $this->params["lang_key"]) {
            $compare_note = " " . $lng->txt("language_default_entries");
        }

        $this->addColumn(ucfirst($lng->txt("module")), "module", "10em");
        $this->addColumn(ucfirst($lng->txt("identifier")), "topic", "10em");
        $this->addColumn($lng->txt("meta_l_" . $this->params['lang_key']), "translation");
        $this->addColumn($lng->txt("meta_l_" . $compare) . $compare_note, "default");
        $this->addCommandButton("save", $lng->txt("save"));
    }


    protected function fillRow(array $a_set): void
    {
        global $DIC;
        $ilDB = $DIC->database();
        $ilCtrl = $DIC->ctrl();
        $lng = $DIC->language();

        // mantis #25237
        // @see https://php.net/manual/en/language.variables.external.php
        $a_set["name"] = str_replace(".", "_POSTDOT_", $a_set["name"]);
        $a_set["name"] = str_replace(" ", "_POSTSPACE_", $a_set["name"]);

        if ($this->params["langmode"]) {
            $this->tpl->setCurrentBlock("comment");
            $this->tpl->setVariable(
                "COM_ID",
                ilLegacyFormElementsUtil::prepareFormOutput($a_set["name"] . $lng->separator . "comment")
            );
            $this->tpl->setVariable(
                "COM_NAME",
                ilLegacyFormElementsUtil::prepareFormOutput($a_set["name"] . $lng->separator . "comment")
            );
            $this->tpl->setVariable("COM_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($a_set["comment"]));
            $this->tpl->setVariable("COM_SIZE", $this->commentsize);
            $this->tpl->setVariable("COM_MAX", 250);
            $this->tpl->setVariable("TXT_COMMENT", $lng->txt("comment"));
            $this->tpl->parseCurrentBlock();
        } else {
            $this->tpl->setCurrentBlock("hidden_comment");
            $this->tpl->setVariable(
                "COM_NAME",
                ilLegacyFormElementsUtil::prepareFormOutput($a_set["name"] . $lng->separator . "comment")
            );
            $this->tpl->setVariable("COM_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($a_set["comment"] ?? ""));
            $this->tpl->parseCurrentBlock();
        }

        $this->tpl->setVariable("T_ROWS", ceil(strlen($a_set["translation"] ?? " ") / $this->inputsize));
        $this->tpl->setVariable("T_SIZE", $this->inputsize);
        $this->tpl->setVariable("T_NAME", ilLegacyFormElementsUtil::prepareFormOutput($a_set["name"]));
        $this->tpl->setVariable("T_USER_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($a_set["translation"]));

        $this->tpl->setVariable("MODULE", ilLegacyFormElementsUtil::prepareFormOutput($a_set["module"]));
        $this->tpl->setVariable("TOPIC", ilLegacyFormElementsUtil::prepareFormOutput($a_set["topic"]));

        $this->tpl->setVariable("DEFAULT_VALUE", ilLegacyFormElementsUtil::prepareFormOutput($a_set["default"] ?? ""));
        $this->tpl->setVariable("COMMENT", ilLegacyFormElementsUtil::prepareFormOutput($a_set["default_comment"] ?? ""));
    }

    public function initFilter(): void
    {
        global $DIC;
        $lng = $DIC->language();

        // most filters are only
        if (!ilObjLanguageAccess::_isPageTranslation()) {
            // pattern
            $ti = new ilTextInputGUI($lng->txt("search"), "pattern");
            $ti->setMaxLength(64);
            $ti->setSize(20);
            $this->addFilterItem($ti);
            $ti->readFromSession();

            // module
            $options = array();
            $options["all"] = $lng->txt("language_all_modules");
            $modules = ilObjLanguageExt::_getModules($lng->getLangKey());
            foreach ($modules as $mod) {
                $options[$mod] = $mod;
            }

            $si = new ilSelectInputGUI(ucfirst($lng->txt("module")), "module");
            $si->setOptions($options);
            $this->addFilterItem($si);
            $si->readFromSession();
            if (!$si->getValue()) {
                $si->setValue("administration");
            }

            // identifier
            $ti = new ilTextInputGUI(ucfirst($lng->txt("identifier")), "identifier");
            $ti->setMaxLength(200);
            $ti->setSize(20);
            $this->addFilterItem($ti);
            $ti->readFromSession();

            // mode
            $options = array();
            $options["all"] = $lng->txt("language_scope_global");
            $options["changed"] = $lng->txt("language_scope_local");
            if ($this->params['langmode']) {
                $options["added"] = $lng->txt("language_scope_added");
            }
            $options["unchanged"] = $lng->txt("language_scope_unchanged");
            $options["equal"] = $lng->txt("language_scope_equal");
            $options["different"] = $lng->txt("language_scope_different");
            $options["commented"] = $lng->txt("language_scope_commented");
            if ($this->params['langmode']) {
                $options["dbremarks"] = $lng->txt("language_scope_dbremarks");
            }
            $options["conflicts"] = $lng->txt("language_scope_conflicts");

            $si = new ilSelectInputGUI($lng->txt("filter"), "mode");
            $si->setOptions($options);
            $this->addFilterItem($si);
            $si->readFromSession();
            if (!$si->getValue()) {
                $si->setValue("all");
            }
        }

        //compare
        $options = array();
        $langlist = $lng->getInstalledLanguages();
        foreach ($langlist as $lang_key) {
            $options[$lang_key] = $lng->txt("meta_l_" . $lang_key);
        }

        $si = new ilSelectInputGUI($lng->txt("language_compare"), "compare");
        $si->setOptions($options);
        $this->addFilterItem($si);
        $si->readFromSession();
        if (!$si->getValue()) {
            $si->setValue($lng->getDefaultLanguage());
        }
    }
}