GUI class for object translation handling. More...

Collaboration diagram for ilMultilingualismGUI:

Public Member Functions
	__construct ($a_obj_id, $a_type)
	ilTranslationGUI constructor. More...

	setTitleDescrOnlyMode ($a_val)
	Set enable title/description only mode. More...

	getTitleDescrOnlyMode ()
	Get enable title/description only mode. More...

	executeCommand ()
	Execute command. More...

	listTranslations ($a_get_post_values=false, $a_add=false)
	List translations. More...

	addToolbar ()

	saveTranslations ()
	Save translations. More...

	deleteTranslations ()
	Remove translation. More...

	getMultiLangForm ($a_add=false)
	Get multi language form. More...

	confirmDeactivateContentMultiLang ()
	Confirm page translation creation. More...

	addLanguages (ilPropertyFormGUI $form=null)
	Add language. More...

	saveLanguages ()
	Save languages. More...

	confirmRemoveLanguages ()
	Confirm remove languages. More...

	removeLanguages ()
	Remove languages. More...

	setStartValues ($a_title, $a_description)

Protected Attributes
	$lng

	$ctrl

	$tpl

	$toolbar

	$user

	$obj_trans

	$title_descr_only = true

	$start_title = ""

	$start_description = ""

Detailed Description

GUI class for object translation handling.

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

Version: $Id$

@ilCtrl_IsCalledBy ilTranslationGUI: ilDidacticTemplateSettingsGUI

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

Constructor & Destructor Documentation

◆ __construct()

ilMultilingualismGUI::__construct	(	$a_obj_id,
		$a_type
	)

ilTranslationGUI constructor.

Parameters

int	$a_obj_id
stirng	$a_type

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

    {
        global $DIC;
 
        $this->toolbar = $DIC->toolbar();
        $this->user = $DIC->user();
        $lng = $DIC->language();
        $ilCtrl = $DIC->ctrl();
        $tpl = $DIC["tpl"];
 
        $this->lng = $lng;
        $this->ctrl = $ilCtrl;
        $this->tpl = $tpl;
 
        include_once("./Services/Multilingualism/classes/class.ilMultilingualism.php");
        $this->obj_trans = ilMultilingualism::getInstance($a_obj_id, $a_type);
    }

References $a_type, $DIC, $ilCtrl, $lng, $tpl, ilMultilingualism\getInstance(), and user().

Here is the call graph for this function:

Member Function Documentation

◆ addLanguages()

ilMultilingualismGUI::addLanguages ( ilPropertyFormGUI $form = null )

Add language.

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

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

References $form, $tpl, and getMultiLangForm().

Referenced by saveLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addToolbar()

ilMultilingualismGUI::addToolbar ( )

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

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

References $toolbar, and getTitleDescrOnlyMode().

Referenced by listTranslations().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ confirmDeactivateContentMultiLang()

ilMultilingualismGUI::confirmDeactivateContentMultiLang ( )

Confirm page translation creation.

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

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
        $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 $ctrl, $ilCtrl, $lng, $tpl, and getTitleDescrOnlyMode().

Here is the call graph for this function:

◆ confirmRemoveLanguages()

ilMultilingualismGUI::confirmRemoveLanguages ( )

Confirm remove languages.

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

    {
        $ilCtrl = $this->ctrl;
        $tpl = $this->tpl;
        $lng = $this->lng;
 
        $lng->loadLanguageModule("meta");
 
        if (!is_array($_POST["lang"]) || count($_POST["lang"]) == 0) {
            ilUtil::sendInfo($lng->txt("no_checkbox"), true);
            $ilCtrl->redirect($this, "listTranslations");
        } else {
            include_once("./Services/Utilities/classes/class.ilConfirmationGUI.php");
            $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 ($_POST["lang"] as $i) {
                $cgui->addItem("lang[]", $i, $lng->txt("meta_l_" . $i));
            }
 
            $tpl->setContent($cgui->getHTML());
        }
    }

References $_POST, $ctrl, $i, $ilCtrl, $lng, $tpl, and ilUtil\sendInfo().

Here is the call graph for this function:

◆ deleteTranslations()

ilMultilingualismGUI::deleteTranslations ( )

Remove translation.

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

    {
        foreach ($_POST["title"] as $k => $v) {
            if ($_POST["check"][$k]) {
                // default translation cannot be deleted
                if ($k != $_POST["default"]) {
                    unset($_POST["title"][$k]);
                    unset($_POST["desc"][$k]);
                    unset($_POST["lang"][$k]);
                } else {
                    ilUtil::sendFailure($this->lng->txt("msg_no_default_language"));
                    $this->listTranslations();
                    return;
                }
            }
        }
        $this->saveTranslations();
    }

References $_POST, listTranslations(), saveTranslations(), and ilUtil\sendFailure().

Here is the call graph for this function:

◆ executeCommand()

ilMultilingualismGUI::executeCommand ( )

Execute command.

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

    {
        $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;
        }
    }

◆ getMultiLangForm()

ilMultilingualismGUI::getMultiLangForm ( $a_add = false )

Get multi language form.

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

    {
        $tpl = $this->tpl;
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
        $ilUser = $this->user;
 
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $form = new ilPropertyFormGUI();
 
        // master language
        if (!$a_add) {
            include_once("./Services/MetaData/classes/class.ilMDLanguageItem.php");
            $options = ilMDLanguageItem::_getLanguages();
            $si = new ilSelectInputGUI($lng->txt("obj_master_lang"), "master_lang");
            $si->setOptions($options);
            $si->setValue($ilUser->getLanguage());
            $form->addItem($si);
        }
 
        // additional languages
        if ($a_add) {
            include_once("./Services/MetaData/classes/class.ilMDLanguageItem.php");
            $options = ilMDLanguageItem::_getLanguages();
            $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"));
            $form->addCommandButton("listTranslations", $lng->txt("cancel"));
        } 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 $ctrl, $form, $ilCtrl, $ilUser, $lng, $options, $si, $tpl, $user, ilMDLanguageItem\_getLanguages(), and getTitleDescrOnlyMode().

Referenced by addLanguages(), and saveLanguages().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitleDescrOnlyMode()

ilMultilingualismGUI::getTitleDescrOnlyMode ( )

Get enable title/description only mode.

Returns: bool enable title/description only mode

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

    {
        return $this->title_descr_only;
    }

References $title_descr_only.

Referenced by addToolbar(), confirmDeactivateContentMultiLang(), and getMultiLangForm().

Here is the caller graph for this function:

◆ listTranslations()

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

List translations.

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

    {
        $this->lng->loadLanguageModule("translation");
 
 
        $this->addToolbar();
 
        include_once("./Services/Multilingualism/classes/class.ilMultilingualismTableGUI.php");
        $table = new ilMultilingualismTableGUI(
            $this,
            "listTranslations",
            true,
            "Translation"
        );
        if ($a_get_post_values) {
            $vals = array();
            foreach ($_POST["title"] as $k => $v) {
                $vals[] = array("title" => $v,
                    "desc" => $_POST["desc"][$k],
                    "lang" => $_POST["lang"][$k],
                    "default" => ($_POST["default"] == $k));
            }
            $table->setData($vals);
        } else {
            $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());
    }

References $_POST, $data, $table, and addToolbar().

Referenced by deleteTranslations(), and saveTranslations().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeLanguages()

ilMultilingualismGUI::removeLanguages ( )

Remove languages.

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

    {
        $lng = $this->lng;
        $ilCtrl = $this->ctrl;
 
        if (is_array($_POST["lang"])) {
            $langs = $this->obj_trans->getLanguages();
            foreach ($langs as $k => $l) {
                if (in_array($l, $_POST["lang"])) {
                    $this->obj_trans->removeLanguage();
                }
            }
            $this->obj_trans->save();
            ilUtil::sendInfo($lng->txt("msg_obj_modified"), true);
        }
        $ilCtrl->redirect($this, "listTranslations");
    }

References $_POST, $ctrl, $ilCtrl, $l, $lng, and ilUtil\sendInfo().

Here is the call graph for this function:

◆ saveLanguages()

ilMultilingualismGUI::saveLanguages ( )

Save languages.

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

    {
        $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();
            ilUtil::sendInfo($lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "listTranslations");
        } else {
            $form->setValuesByPost();
            ilUtil::sendFailure($lng->txt('err_check_input'));
            $this->addLanguages($form);
        }
    }

References $ctrl, $form, $ilCtrl, $l, $lng, addLanguages(), ilLoggerFactory\getLogger(), getMultiLangForm(), ilUtil\sendFailure(), and ilUtil\sendInfo().

Here is the call graph for this function:

◆ saveTranslations()

ilMultilingualismGUI::saveTranslations ( )

Save translations.

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

    {
        // default language set?
        if (!isset($_POST["default"])) {
            ilUtil::sendFailure($this->lng->txt("msg_no_default_language"));
            $this->listTranslations(true);
            return;
        }
 
        // all languages set?
        if (array_key_exists("", $_POST["lang"])) {
            ilUtil::sendFailure($this->lng->txt("msg_no_language_selected"));
            $this->listTranslations(true);
            return;
        }
 
        // no single language is selected more than once?
        if (count(array_unique($_POST["lang"])) < count($_POST["lang"])) {
            ilUtil::sendFailure($this->lng->txt("msg_multi_language_selected"));
            $this->listTranslations(true);
            return;
        }
 
        // save the stuff
        $this->obj_trans->setLanguages(array());
 
        foreach ($_POST["title"] as $k => $v) {
            // update object data if default
            $is_default = ($_POST["default"] == $k);
 
            $this->obj_trans->addLanguage(
                ilUtil::stripSlashes($_POST["lang"][$k]),
                ilUtil::stripSlashes($v),
                ilUtil::stripSlashes($_POST["desc"][$k]),
                $is_default
            );
        }
        $this->obj_trans->save();
 
        ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
        $this->ctrl->redirect($this, "listTranslations");
    }

References $_POST, listTranslations(), ilUtil\sendFailure(), ilUtil\sendSuccess(), and ilUtil\stripSlashes().

Referenced by deleteTranslations().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStartValues()

ilMultilingualismGUI::setStartValues	(	$a_title,
		$a_description
	)

Parameters

string	$a_title
string	$a_description

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

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

◆ setTitleDescrOnlyMode()

ilMultilingualismGUI::setTitleDescrOnlyMode ( $a_val )

Set enable title/description only mode.

Parameters

bool $a_val enable title/description only mode

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

    {
        $this->title_descr_only = $a_val;
    }

Field Documentation

◆ $ctrl

ilMultilingualismGUI::$ctrl

protected

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

Referenced by confirmDeactivateContentMultiLang(), confirmRemoveLanguages(), getMultiLangForm(), removeLanguages(), and saveLanguages().

◆ $lng

ilMultilingualismGUI::$lng

protected

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

Referenced by __construct(), confirmDeactivateContentMultiLang(), confirmRemoveLanguages(), getMultiLangForm(), removeLanguages(), and saveLanguages().

◆ $obj_trans

ilMultilingualismGUI::$obj_trans

protected

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

◆ $start_description

ilMultilingualismGUI::$start_description = ""

protected

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

◆ $start_title

ilMultilingualismGUI::$start_title = ""

protected

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

◆ $title_descr_only

ilMultilingualismGUI::$title_descr_only = true

protected

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

Referenced by getTitleDescrOnlyMode().

◆ $toolbar

ilMultilingualismGUI::$toolbar

protected

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

Referenced by addToolbar().

◆ $tpl

ilMultilingualismGUI::$tpl

protected

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

Referenced by __construct(), addLanguages(), confirmDeactivateContentMultiLang(), confirmRemoveLanguages(), and getMultiLangForm().

◆ $user

ilMultilingualismGUI::$user

protected

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

Referenced by getMultiLangForm().

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

Services/Multilingualism/classes/class.ilMultilingualismGUI.php

Public Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLanguages()

◆ addToolbar()

◆ confirmDeactivateContentMultiLang()

◆ confirmRemoveLanguages()

◆ deleteTranslations()

◆ executeCommand()

◆ getMultiLangForm()

◆ getTitleDescrOnlyMode()

◆ listTranslations()

◆ removeLanguages()

◆ saveLanguages()

◆ saveTranslations()

◆ setStartValues()

◆ setTitleDescrOnlyMode()

Field Documentation

◆ $ctrl

◆ $lng

◆ $obj_trans

◆ $start_description

◆ $start_title

◆ $title_descr_only

◆ $toolbar

◆ $tpl

◆ $user