ILIAS\ILIASObject\Properties\Translations\TranslationGUI Class Reference

GUI class for object translation handling. More...

Collaboration diagram for ILIAS\ILIASObject\Properties\Translations\TranslationGUI:

Public Member Functions
	__construct (private readonly \ilObject $object, private readonly \ilLanguage $lng, private readonly \ilAccess $access, private readonly \ilObjUser $user, private readonly \ilCtrl $ctrl, private readonly \ilGlobalTemplateInterface $tpl, private readonly UIFactory $ui_factory, private readonly UIRenderer $ui_renderer, private readonly HTTPService $http, private readonly Refinery $refinery, private readonly \ilToolbarGUI $toolbar)
	supportContentTranslation (bool $content_translation)
	forceContentTranslation ()
	Some objects like learning modules do not support to translate only the title and the description. More...
	executeCommand ()
	listTranslations (?RoundtripModal $lang_modal=null)
	addTranslation ()
	activateContentTranslation ()
	deactivateContentTranslation ()

Private Member Functions
	addAddLanguagesToolbarActionAndRetrieveModal (?RoundtripModal $modal=null)
	getAddLanguageModal ()
	addContentTranslationToolbarActionAndRetrieveModal ()
	getConfirmDeactivateMultilingualityModal (string $text_tag)
	getActivateMultilingualityModal ()
	buildLangSelectionInput ()
	getMasterLangSelectionInput ()
	getArrayWithAddableLanguages ()

Private Attributes
const	CMD_LIST_TRANSLATIONS = 'listTranslations'
const	CMD_ADD_TRANSLATION = 'addTranslation'
const	CMD_DEACTIVATE_CONTENT_MULTILANG = 'deactivateContentTranslation'
const	CMD_SAVE_CONTENT_TRANSLATION_ACTIVATION = 'activateContentTranslation'
Translations	$translations
bool	$force_content_translation = false
bool	$supports_content_translation = true

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

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

Constructor & Destructor Documentation

__construct()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::__construct	(	private readonly \ilObject	$object,
		private readonly \ilLanguage	$lng,
		private readonly \ilAccess	$access,
		private readonly \ilObjUser	$user,
		private readonly \ilCtrl	$ctrl,
		private readonly \ilGlobalTemplateInterface	$tpl,
		private readonly UIFactory	$ui_factory,
		private readonly UIRenderer	$ui_renderer,
		private readonly HTTPService	$http,
		private readonly Refinery	$refinery,
		private readonly \ilToolbarGUI	$toolbar
	)

Definition at line 50 of file class.TranslationGUI.php.

      {
        $this->translations = $this->object->getObjectProperties()->getPropertyTranslations();
    }

Member Function Documentation

activateContentTranslation()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::activateContentTranslation

(

)

Definition at line 165 of file class.TranslationGUI.php.

                                                : void
    {
        $data = $this->getActivateMultilingualityModal()
            ->withRequest($this->http->request())
            ->getData();
 
        if ($data === null) {
            $this->listTranslations();
            return;
        }
 
        $this->translations = $this->translations->withLanguage(
            new Language(
                $data['lang'],
                $this->object->getTitle(),
                $this->object->getDescription(),
                true,
                true
            )
        );
 
        $this->object->getObjectProperties()->storePropertyTranslations(
            $this->translations
        );
        $this->ctrl->redirectByClass(self::class);
    }

References $data, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\object().

Here is the call graph for this function:

addAddLanguagesToolbarActionAndRetrieveModal()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::addAddLanguagesToolbarActionAndRetrieveModal ( ?RoundtripModal  $modal = null )

private

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

     : RoundtripModal {
        $modal ??= $this->getAddLanguageModal();
        $this->toolbar->addComponent(
            $this->ui_factory->button()->standard(
                $this->lng->txt('obj_add_language'),
                $modal->getShowSignal()
            )
        );
 
        return $modal;
    }

addContentTranslationToolbarActionAndRetrieveModal()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::addContentTranslationToolbarActionAndRetrieveModal ( )

private

Definition at line 244 of file class.TranslationGUI.php.

                                                                         : Modal
    {
        $lang_var_postfix = '_multilang';
        $deactivation_modal_text_tag = 'obj_deactivate_multilang_conf';
        if (!$this->force_content_translation) {
            $lang_var_postfix = '_content_lang';
            $deactivation_modal_text_tag = 'obj_deactivate_content_transl_conf';
        }
 
        if (!$this->force_content_translation && !$this->translations->getContentTranslationActivated()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('obj_multilang_title_descr_only'));
        }
 
        if (!$this->translations->getContentTranslationActivated()) {
            $activate_modal = $this->getActivateMultilingualityModal();
            $this->toolbar->addComponent(
                $this->ui_factory->button()->standard(
                    $this->lng->txt('obj_activate' . $lang_var_postfix),
                    $activate_modal->getShowSignal()
                )
            );
            return $activate_modal;
        }
 
        $deactivate_modal = $this->getConfirmDeactivateMultilingualityModal($deactivation_modal_text_tag);
        $this->toolbar->addComponent(
            $this->ui_factory->button()->standard(
                $this->lng->txt('obj_deactivate' . $lang_var_postfix),
                $deactivate_modal->getShowSignal()
            )
        );
        return $deactivate_modal;
    }

References ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Here is the call graph for this function:

addTranslation()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::addTranslation

(

)

Definition at line 147 of file class.TranslationGUI.php.

                                    : void
    {
        $modal = $this->getAddLanguageModal()
            ->withRequest($this->http->request());
        $data = $modal->getData();
        if ($data === null) {
            $this->listTranslations($modal->withOnLoad($modal->getShowSignal()));
            return;
        }
 
        $this->translations = $this->translations->withLanguage($data[0]);
        $this->object->getObjectProperties()->storePropertyTranslations(
            $this->translations
        );
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('saved_successfully'), true);
        $this->ctrl->redirectByClass($this->ctrl->getCurrentClassPath());
    }

References $data, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), and ILIAS\Repository\lng().

Here is the call graph for this function:

buildLangSelectionInput()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::buildLangSelectionInput ( )

private

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

                                              : SelectInput
    {
        return $this->ui_factory->input()->field()->select(
            $this->lng->txt('language'),
            $this->getArrayWithAddableLanguages()
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

deactivateContentTranslation()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::deactivateContentTranslation

(

)

Definition at line 192 of file class.TranslationGUI.php.

                                                  : void
    {
        $this->translations = $this->translations->withDeactivatedContentTranslation();
        $this->object->getObjectProperties()->storePropertyTranslations(
            $this->translations
        );
 
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('obj_cont_transl_deactivated'), true);
        $this->ctrl->redirectByClass(self::class);
    }

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

Here is the call graph for this function:

executeCommand()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::executeCommand

(

)

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

                                    : void
    {
        $commands = [
            self::CMD_LIST_TRANSLATIONS,
            self::CMD_ADD_TRANSLATION,
            self::CMD_SAVE_CONTENT_TRANSLATION_ACTIVATION,
            self::CMD_DEACTIVATE_CONTENT_MULTILANG
        ];
 
        $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd(self::CMD_LIST_TRANSLATIONS);
        if (!$this->access->checkAccess('write', '', $this->object->getRefId())) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('no_permission'));
            $this->ctrl->redirectByClass(get_class($this->object) . 'GUI');
        }
        if (in_array($cmd, $commands)) {
            $this->$cmd();
        }
    }

References ILIAS\Repository\access(), ILIAS\ILIASObject\Properties\Translations\TranslationGUI\CMD_ADD_TRANSLATION, ILIAS\ILIASObject\Properties\Translations\TranslationGUI\CMD_DEACTIVATE_CONTENT_MULTILANG, ILIAS\ILIASObject\Properties\Translations\TranslationGUI\CMD_LIST_TRANSLATIONS, ILIAS\ILIASObject\Properties\Translations\TranslationGUI\CMD_SAVE_CONTENT_TRANSLATION_ACTIVATION, ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Here is the call graph for this function:

forceContentTranslation()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::forceContentTranslation

(

)

Some objects like learning modules do not support to translate only the title and the description.

If they acticate multilinguasm, they translate always title, description AND content. They have to call setTitleDescrOnlyMode(false) to indicate this. Other contexts, e.g. categories allow to only translate title and description and activate the content multilinguasm separately.

Definition at line 78 of file class.TranslationGUI.php.

                                             : void
    {
        $this->force_content_translation = true;
    }

getActivateMultilingualityModal()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::getActivateMultilingualityModal ( )

private

Definition at line 287 of file class.TranslationGUI.php.

                                                      : RoundtripModal
    {
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('confirm'),
            $this->ui_factory->legacy()->content($this->lng->txt('obj_select_base_lang')),
            [
                'lang' => $this->getMasterLangSelectionInput()
            ],
            $this->ctrl->getFormActionByClass(self::class, self::CMD_SAVE_CONTENT_TRANSLATION_ACTIVATION)
        );
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getAddLanguageModal()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::getAddLanguageModal ( )

private

Definition at line 217 of file class.TranslationGUI.php.

                                          : RoundtripModal
    {
        $ff = $this->ui_factory->input()->field();
        return $this->ui_factory->modal()->roundtrip(
            $this->lng->txt('obj_add_language'),
            null,
            [
                $ff->group([
                    'language' => $this->buildLangSelectionInput()
                        ->withRequired(true),
                    'title' => $ff->text($this->lng->txt('title'))
                        ->withRequired(true),
                    'description' => $ff->textarea($this->lng->txt('description'))
                ])->withAdditionalTransformation(
                    $this->refinery->custom()->transformation(
                        static fn(array $vs): Language => new Language(
                            $vs['language'],
                            $vs['title'],
                            $vs['description']
                        )
                    )
                )
            ],
            $this->ctrl->getFormActionByClass(self::class, self::CMD_ADD_TRANSLATION)
        );
    }

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

Here is the call graph for this function:

getArrayWithAddableLanguages()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::getArrayWithAddableLanguages ( )

private

Definition at line 328 of file class.TranslationGUI.php.

                                                   : array
    {
        $enabled_langs = $this->translations->getLanguages();
        return array_reduce(
            $this->lng->getInstalledLanguages(),
            function (array $c, string $v) use ($enabled_langs): array {
                if (!array_key_exists($v, $enabled_langs)) {
                    $c[$v] = $this->lng->txt("meta_l_{$v}");
                }
                return $c;
            },
            []
        );
    }

References Vendor\Package\$c, and ILIAS\Repository\lng().

Here is the call graph for this function:

getConfirmDeactivateMultilingualityModal()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::getConfirmDeactivateMultilingualityModal ( string  $text_tag )

private

Definition at line 278 of file class.TranslationGUI.php.

                                                                               : Modal
    {
        return $this->ui_factory->modal()->interruptive(
            $this->lng->txt('confirm'),
            $this->lng->txt($text_tag),
            $this->ctrl->getFormActionByClass(self::class, self::CMD_DEACTIVATE_CONTENT_MULTILANG)
        )->withActionButtonLabel($this->lng->txt('confirm'));
    }

References ILIAS\Repository\lng().

Here is the call graph for this function:

getMasterLangSelectionInput()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::getMasterLangSelectionInput ( )

private

Definition at line 307 of file class.TranslationGUI.php.

                                                  : Input
    {
        $options = array_reduce(
            $this->lng->getInstalledLanguages(),
            function (array $c, string $v): array {
                $c[$v] = $this->lng->txt("meta_l_{$v}");
                return $c;
            },
            []
        );
 
        return $this->ui_factory->input()->field()->select(
            $this->lng->txt('obj_base_lang'),
            $options
        )->withAdditionalTransformation(
            $this->refinery->custom()->transformation(
                fn($v) => in_array($v, array_keys($options)) ? $v : $this->lng->getDefaultLanguage()
            )
        )->withValue($this->user->getLanguage());
    }

References Vendor\Package\$c, ILIAS\UI\Implementation\Component\Input\Field\$options, ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\user().

Here is the call graph for this function:

listTranslations()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::listTranslations

(

?RoundtripModal

$lang_modal = null

)

Definition at line 103 of file class.TranslationGUI.php.

     : void {
        $this->lng->loadLanguageModule($this->object->getType());
 
        $table = new TranslationsTable(
            $this->ui_factory,
            $this->ui_renderer,
            $this->lng,
            $this->refinery,
            $this->tpl,
            $this->http,
            $this->ctrl,
            $this->translations,
            $this->object->getObjectProperties(),
            (new DataFactory())->uri(
                ILIAS_HTTP_PATH . '/' . $this->ctrl->getFormActionByClass(
                    self::class,
                    self::CMD_LIST_TRANSLATIONS
                )
            )
        );
        $table->runAction();
        $content = [
            'table' => $table->getTable()
        ];
 
        if ($this->translations->migrationMissing()) {
            $this->tpl->setOnScreenMessage('info', $this->lng->txt('missing_migration'));
            $this->tpl->setContent($this->ui_renderer->render($content));
            return;
        }
 
        if ($this->getArrayWithAddableLanguages() !== []) {
            $content['lang_modal'] = $this->addAddLanguagesToolbarActionAndRetrieveModal($lang_modal);
        }
 
        if ($this->supports_content_translation) {
            $content['content_trans_modal'] = $this->addContentTranslationToolbarActionAndRetrieveModal();
        }
 
        $this->tpl->setContent($this->ui_renderer->render($content));
    }

supportContentTranslation()

ILIAS\ILIASObject\Properties\Translations\TranslationGUI::supportContentTranslation

(

bool

$content_translation

)

Definition at line 66 of file class.TranslationGUI.php.

                                                                        : void
    {
        $this->supports_content_translation = $content_translation;
    }

Field Documentation

$force_content_translation

bool ILIAS\ILIASObject\Properties\Translations\TranslationGUI::$force_content_translation = false

private

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

$supports_content_translation

bool ILIAS\ILIASObject\Properties\Translations\TranslationGUI::$supports_content_translation = true

private

Definition at line 48 of file class.TranslationGUI.php.

$translations

Translations ILIAS\ILIASObject\Properties\Translations\TranslationGUI::$translations

private

Definition at line 45 of file class.TranslationGUI.php.

CMD_ADD_TRANSLATION

const ILIAS\ILIASObject\Properties\Translations\TranslationGUI::CMD_ADD_TRANSLATION = 'addTranslation'

private

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

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationGUI\executeCommand().

CMD_DEACTIVATE_CONTENT_MULTILANG

const ILIAS\ILIASObject\Properties\Translations\TranslationGUI::CMD_DEACTIVATE_CONTENT_MULTILANG = 'deactivateContentTranslation'

private

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

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationGUI\executeCommand().

CMD_LIST_TRANSLATIONS

const ILIAS\ILIASObject\Properties\Translations\TranslationGUI::CMD_LIST_TRANSLATIONS = 'listTranslations'

private

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

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationGUI\executeCommand().

CMD_SAVE_CONTENT_TRANSLATION_ACTIVATION

const ILIAS\ILIASObject\Properties\Translations\TranslationGUI::CMD_SAVE_CONTENT_TRANSLATION_ACTIVATION = 'activateContentTranslation'

private

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

Referenced by ILIAS\ILIASObject\Properties\Translations\TranslationGUI\executeCommand().

---

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

• components/ILIAS/ILIASObject/src/Properties/Translations/class.TranslationGUI.php