ilMultilingualismGUI 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 ilMultilingualismGUI:

Public Member Functions
	__construct (int $a_obj_id, string $a_type)
	setTitleDescrOnlyMode (bool $a_val)
	Set enable title/description only mode. More...
	getTitleDescrOnlyMode ()
	Get enable title/description only mode. More...
	executeCommand ()
	listTranslations (bool $a_get_post_values=false, bool $a_add=false)
	addToolbar ()
	saveTranslations (bool $delete_checked=false)
	deleteTranslations ()
	getMultiLangForm (bool $a_add=false)
	Get multi language form. More...
	confirmDeactivateContentMultiLang ()
	Confirm page translation creation. More...
	addLanguages (?ilPropertyFormGUI $form=null)
	Add language. More...
	saveLanguages ()
	confirmRemoveLanguages ()
	Confirm remove languages. More...
	removeLanguages ()
	Remove languages. More...
	setStartValues (string $a_title, string $a_description)

Protected Attributes
ILIAS DidacticTemplate Multilingualism StandardGUIRequest	$request
ilLanguage	$lng
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilToolbarGUI	$toolbar
ilObjUser	$user
LOMServices	$lom_services
ilMultilingualism	$obj_trans
bool	$title_descr_only = true
string	$start_title = ""
string	$start_description = ""

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 object translation handling.

Author

Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de @ilCtrl_IsCalledBy ilMultilingualismeGUI: ilDidacticTemplateSettingsGUI

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

Constructor & Destructor Documentation

__construct()

ilMultilingualismGUI::__construct	(	int	$a_obj_id,
		string	$a_type
	)

Definition at line 40 of file class.ilMultilingualismGUI.php.

      {
        global $DIC;
 
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('obj');
        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lom_services = $DIC->learningObjectMetadata();
 
        $this->obj_trans = ilMultilingualism::getInstance($a_obj_id, $a_type);
        $this->request = new \ILIAS\Multilingualism\StandardGUIRequest(
            $DIC->http(),
            $DIC->refinery()
        );
    }

References $DIC, ILIAS\Repository\ctrl(), ilMultilingualism\getInstance(), ILIAS\Repository\lng(), ILIAS\Repository\toolbar(), and ILIAS\Repository\user().

Here is the call graph for this function:

Member Function Documentation

addLanguages()

ilMultilingualismGUI::addLanguages

(

?ilPropertyFormGUI

$form = null

)

Add language.

Definition at line 304 of file class.ilMultilingualismGUI.php.

                                                                 : void
    {
        $tpl = $this->tpl;
 
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->getMultiLangForm(true);
        }
        $tpl->setContent($form->getHTML());
    }

References ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

addToolbar()

ilMultilingualismGUI::addToolbar

(

)

Definition at line 139 of file class.ilMultilingualismGUI.php.

                                : void
    {
        $ilToolbar = $this->toolbar;
        if ($this->getTitleDescrOnlyMode()) {
            $ilToolbar->addButton(
                $this->lng->txt("obj_add_languages"),
                $this->ctrl->getLinkTarget($this, "addLanguages")
            );
        }
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

confirmDeactivateContentMultiLang()

ilMultilingualismGUI::confirmDeactivateContentMultiLang

(

)

Confirm page translation creation.

Definition at line 282 of file class.ilMultilingualismGUI.php.

                                                       : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $cgui = new ilConfirmationGUI();
        $cgui->setFormAction($ilCtrl->getFormAction($this));
        if ($this->getTitleDescrOnlyMode()) {
            $cgui->setHeaderText($lng->txt("obj_deactivate_content_transl_conf"));
        } else {
            $cgui->setHeaderText($lng->txt("obj_deactivate_multilang_conf"));
        }
 
        $cgui->setCancel($lng->txt("cancel"), "listTranslations");
        $cgui->setConfirm($lng->txt("confirm"), "deactivateContentMultiLang");
        $tpl->setContent($cgui->getHTML());
    }

References $lng, and ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

confirmRemoveLanguages()

ilMultilingualismGUI::confirmRemoveLanguages

(

)

Confirm remove languages.

Definition at line 354 of file class.ilMultilingualismGUI.php.

                                            : void
    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $lng->loadLanguageModule("meta");
        $langs = $this->request->getLanguages();
 
        if (count($langs) === 0) {
            $this->tpl->setOnScreenMessage('info', $lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listTranslations");
        } else {
            $cgui = new ilConfirmationGUI();
            $cgui->setFormAction($ilCtrl->getFormAction($this));
            $cgui->setHeaderText($lng->txt("obj_conf_delete_lang"));
            $cgui->setCancel($lng->txt("cancel"), "listTranslations");
            $cgui->setConfirm($lng->txt("remove"), "removeLanguages");
 
            foreach ($langs as $i) {
                $cgui->addItem("lang[]", $i, $lng->txt("meta_l_" . $i));
            }
 
            $tpl->setContent($cgui->getHTML());
        }
    }

References $lng, and ILIAS\UICore\GlobalTemplate\setContent().

Here is the call graph for this function:

deleteTranslations()

ilMultilingualismGUI::deleteTranslations

(

)

Definition at line 203 of file class.ilMultilingualismGUI.php.

                                        : void
    {
        $default = $this->request->getDefault();
        $langs = $this->request->getLanguages();
        $titles = $this->request->getTitles();
        $descs = $this->request->getDescriptions();
        $check = $this->request->getCheck();
        foreach ($titles as $k => $v) {
            if ($check[$k] ?? false) {
                // default translation cannot be deleted
                if ($k != $default) {
                    unset($titles[$k], $descs[$k], $langs[$k]);
                } else {
                    $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_default_language"));
                    $this->listTranslations();
                    return;
                }
            }
        }
        $this->saveTranslations(true);
    }

References $check, and ILIAS\Repository\lng().

Here is the call graph for this function:

executeCommand()

ilMultilingualismGUI::executeCommand

(

)

Definition at line 77 of file class.ilMultilingualismGUI.php.

                                    : void
    {
        $next_class = $this->ctrl->getNextClass($this);
 
        switch ($next_class) {
            default:
                $cmd = $this->ctrl->getCmd("listTranslations");
                if (in_array($cmd, array("listTranslations", "saveTranslations",
                    "addTranslation", "deleteTranslations", "activateContentMultilinguality",
                    "confirmRemoveLanguages", "removeLanguages", "confirmDeactivateContentMultiLang", "saveLanguages",
                    "saveContentTranslationActivation", "deactivateContentMultiLang", "addLanguages"))) {
                    $this->$cmd();
                }
                break;
        }
    }

References ILIAS\Repository\ctrl().

Here is the call graph for this function:

getMultiLangForm()

ilMultilingualismGUI::getMultiLangForm

(

bool

$a_add = false

)

Get multi language form.

Definition at line 232 of file class.ilMultilingualismGUI.php.

                                                         : ilPropertyFormGUI
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        $form = new ilPropertyFormGUI();
 
        $options = [];
        foreach ($this->lom_services->dataHelper()->getAllLanguages() as $language) {
            $options[$language->value()] = $language->presentableLabel();
        }
 
        // master language
        if (!$a_add) {
            $si = new ilSelectInputGUI($lng->txt("obj_base_lang"), "master_lang");
            $si->setOptions($options);
            $si->setValue($ilUser->getLanguage());
            $form->addItem($si);
        }
 
        // additional languages
        if ($a_add) {
            $options = array("" => $lng->txt("please_select")) + $options;
            $si = new ilSelectInputGUI($lng->txt("obj_additional_langs"), "additional_langs");
            $si->setOptions($options);
            $si->setMulti(true);
            $form->addItem($si);
        }
 
        if ($a_add) {
            $form->setTitle($lng->txt("obj_add_languages"));
            $form->addCommandButton("saveLanguages", $lng->txt("save"));
        } else {
            if ($this->getTitleDescrOnlyMode()) {
                $form->setTitle($lng->txt("obj_activate_content_lang"));
            } else {
                $form->setTitle($lng->txt("obj_activate_multilang"));
            }
            $form->addCommandButton("saveContentTranslationActivation", $lng->txt("save"));
        }
        $form->addCommandButton("listTranslations", $lng->txt("cancel"));
        $form->setFormAction($ilCtrl->getFormAction($this));
 
        return $form;
    }

References $lng, and ILIAS\UI\Implementation\Component\Input\Field\$options.

getTitleDescrOnlyMode()

ilMultilingualismGUI::getTitleDescrOnlyMode

(

)

Get enable title/description only mode.

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

                                           : bool
    {
        return $this->title_descr_only;
    }

References $title_descr_only.

listTranslations()

ilMultilingualismGUI::listTranslations	(	bool	$a_get_post_values = false,
		bool	$a_add = false
	)

Definition at line 94 of file class.ilMultilingualismGUI.php.

     : void {
        $this->lng->loadLanguageModule("translation");
 
 
        $this->addToolbar();
 
        $titles = $this->request->getTitles();
        $langs = $this->request->getLanguages();
        $descs = $this->request->getDescriptions();
        $default = $this->request->getDefault();
 
        $table = new ilMultilingualismTableGUI(
            $this,
            "listTranslations",
            true,
            "Translation"
        );
        if ($a_get_post_values) {
            $vals = array();
            foreach ($titles as $k => $v) {
                $vals[] = array("title" => $v,
                    "desc" => $descs[$k],
                    "lang" => $langs[$k],
                    "default" => ($default == $k));
            }
            $table->setData($vals);
        } else {
            $k = 0;
            $data = $this->obj_trans->getLanguages();
            foreach ($data as $k => $v) {
                $data[$k]["default"] = $v["lang_default"];
                $data[$k]["desc"] = $v["description"];
                $data[$k]["lang"] = $v["lang_code"];
            }
            if ($a_add) {
                $data["Fobject"][++$k]["title"] = "";
            }
            $table->setData($data);
        }
        $this->tpl->setContent($table->getHTML());
    }

removeLanguages()

ilMultilingualismGUI::removeLanguages

(

)

Remove languages.

Definition at line 384 of file class.ilMultilingualismGUI.php.

                                     : void
    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        $post_langs = $this->request->getLanguages();
 
        if (count($post_langs) > 0) {
            $langs = $this->obj_trans->getLanguages();
            foreach ($langs as $k => $l) {
                if (in_array($l, $post_langs)) {
                    $this->obj_trans->removeLanguage($l);
                }
            }
            $this->obj_trans->save();
            $this->tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "listTranslations");
    }

References $lng.

saveLanguages()

ilMultilingualismGUI::saveLanguages

(

)

Definition at line 314 of file class.ilMultilingualismGUI.php.

                                   : void
    {
        $ilCtrl = $this->ctrl;
        $lng = $this->lng;
 
        ilLoggerFactory::getLogger('otpl')->debug('Save languages');
 
        $form = $this->getMultiLangForm(true);
        if ($form->checkInput()) {
            $ad = $form->getInput("additional_langs");
 
            ilLoggerFactory::getLogger('otpl')->dump($ad);
 
            if (is_array($ad)) {
                foreach ($ad as $l) {
                    if ($l != "") {
                        $std = false;
 
                        //if no other language is set, set this one as standard
                        if (!count($this->obj_trans->getLanguages())) {
                            $std = true;
                        }
 
                        $this->obj_trans->addLanguage($l, $this->start_title, $this->start_description, $std);
                    }
                }
            }
            $this->obj_trans->save();
            $this->tpl->setOnScreenMessage('info', $lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "listTranslations");
        } else {
            $form->setValuesByPost();
            $this->tpl->setOnScreenMessage('failure', $lng->txt('err_check_input'));
            $this->addLanguages($form);
        }
    }

References $lng, and ilLoggerFactory\getLogger().

Here is the call graph for this function:

saveTranslations()

ilMultilingualismGUI::saveTranslations

(

bool

$delete_checked = false

)

Definition at line 150 of file class.ilMultilingualismGUI.php.

                                                                  : void
    {
        $default = $this->request->getDefault();
        $langs = $this->request->getLanguages();
        $titles = $this->request->getTitles();
        $descs = $this->request->getDescriptions();
 
        // default language set?
        if ($default === "") {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_default_language"));
            $this->listTranslations(true);
            return;
        }
 
        // all languages set?
        if (array_key_exists("", $langs)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_no_language_selected"));
            $this->listTranslations(true);
            return;
        }
 
        // no single language is selected more than once?
        if (count(array_unique($langs)) < count($langs)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt("msg_multi_language_selected"));
            $this->listTranslations(true);
            return;
        }
 
        $check = $this->request->getCheck();
 
        // save the stuff
        $this->obj_trans->setLanguages(array());
 
        foreach ($titles as $k => $v) {
            // update object data if default
            $is_default = ($default == $k);
            if ($delete_checked && !$is_default && isset($check[$k])) {
                continue;
            }
 
            $this->obj_trans->addLanguage(
                $langs[$k],
                $v,
                $descs[$k],
                $is_default
            );
        }
        $this->obj_trans->save();
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "listTranslations");
    }

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

Here is the call graph for this function:

setStartValues()

ilMultilingualismGUI::setStartValues	(	string	$a_title,
		string	$a_description
	)

Definition at line 404 of file class.ilMultilingualismGUI.php.

     : void {
        $this->start_title = $a_title;
        $this->start_description = $a_description;
    }

setTitleDescrOnlyMode()

ilMultilingualismGUI::setTitleDescrOnlyMode

(

bool

$a_val

)

Set enable title/description only mode.

Definition at line 64 of file class.ilMultilingualismGUI.php.

                                                      : void
    {
        $this->title_descr_only = $a_val;
    }

Field Documentation

$ctrl

ilCtrl ilMultilingualismGUI::$ctrl

protected

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

$lng

ilLanguage ilMultilingualismGUI::$lng

protected

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

$lom_services

LOMServices ilMultilingualismGUI::$lom_services

protected

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

$obj_trans

ilMultilingualism ilMultilingualismGUI::$obj_trans

protected

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

$request

ILIAS DidacticTemplate Multilingualism StandardGUIRequest ilMultilingualismGUI::$request

protected

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

$start_description

string ilMultilingualismGUI::$start_description = ""

protected

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

$start_title

string ilMultilingualismGUI::$start_title = ""

protected

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

$title_descr_only

bool ilMultilingualismGUI::$title_descr_only = true

protected

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

Referenced by getTitleDescrOnlyMode().

$toolbar

ilToolbarGUI ilMultilingualismGUI::$toolbar

protected

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

$tpl

ilGlobalTemplateInterface ilMultilingualismGUI::$tpl

protected

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

$user

ilObjUser ilMultilingualismGUI::$user

protected

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

---

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

• components/ILIAS/DidacticTemplate/classes/Multilingualism/class.ilMultilingualismGUI.php