ilMultilingualismGUI Class Reference

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
	$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$

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 26 of file class.ilMultilingualismGUI.php.

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

        {
                global $lng, $ilCtrl, $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);
        }

Here is the call graph for this function:

Member Function Documentation

addLanguages()

ilMultilingualismGUI::addLanguages

(

ilPropertyFormGUI

$form = null

)

Add language.

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

References $tpl, and getMultiLangForm().

Referenced by saveLanguages().

        {
                global $tpl;

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

Here is the call graph for this function:

Here is the caller graph for this function:

addToolbar()

ilMultilingualismGUI::addToolbar

(

)

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

References getTitleDescrOnlyMode().

Referenced by listTranslations().

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

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 275 of file class.ilMultilingualismGUI.php.

References $ilCtrl, $lng, $tpl, and getTitleDescrOnlyMode().

        {
                global $ilCtrl, $tpl, $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());
        }

Here is the call graph for this function:

confirmRemoveLanguages()

ilMultilingualismGUI::confirmRemoveLanguages

(

)

Confirm remove languages.

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

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

        {
                global $ilCtrl, $tpl, $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());
                }
        }

Here is the call graph for this function:

deleteTranslations()

ilMultilingualismGUI::deleteTranslations

(

)

Remove translation.

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

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

        {
                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();
        }

Here is the call graph for this function:

executeCommand()

ilMultilingualismGUI::executeCommand

(

)

Execute command.

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

References $cmd, and array.

        {
                $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 218 of file class.ilMultilingualismGUI.php.

References $ilCtrl, $ilUser, $lng, $options, $si, $tpl, ilMDLanguageItem\_getLanguages(), array, getTitleDescrOnlyMode(), and ilSelectInputGUI\setOptions().

Referenced by addLanguages(), and saveLanguages().

        {
                global $tpl, $lng, $ilCtrl, $ilUser;

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

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 53 of file class.ilMultilingualismGUI.php.

References $title_descr_only.

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

        {
                return $this->title_descr_only;
        }

Here is the caller graph for this function:

listTranslations()

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

List translations.

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

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

Referenced by deleteTranslations(), and saveTranslations().

        {
                $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());

        }

Here is the call graph for this function:

Here is the caller graph for this function:

removeLanguages()

ilMultilingualismGUI::removeLanguages

(

)

Remove languages.

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

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

        {
                global $lng, $ilCtrl;

                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");
        }

Here is the call graph for this function:

saveLanguages()

ilMultilingualismGUI::saveLanguages

(

)

Save languages.

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

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

        {
                global $ilCtrl, $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);
                }
                
        }

Here is the call graph for this function:

saveTranslations()

ilMultilingualismGUI::saveTranslations

(

)

Save translations.

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

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

Referenced by deleteTranslations().

        {
                // 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");

        }

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 417 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 43 of file class.ilMultilingualismGUI.php.

        {
                $this->title_descr_only = $a_val;
        }

Field Documentation

$obj_trans

ilMultilingualismGUI::$obj_trans

protected

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

$start_description

ilMultilingualismGUI::$start_description = ""

protected

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

$start_title

ilMultilingualismGUI::$start_title = ""

protected

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

$title_descr_only

ilMultilingualismGUI::$title_descr_only = true

protected

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

Referenced by getTitleDescrOnlyMode().

---

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

• Services/Multilingualism/classes/class.ilMultilingualismGUI.php