ilAdvancedMDTranslationGUI Class Reference

Inheritance diagram for ilAdvancedMDTranslationGUI:

Collaboration diagram for ilAdvancedMDTranslationGUI:

Public Member Functions
	__construct (ilAdvancedMDRecord $record)
	executeCommand ()
	Execute command and save parameter record id. More...

Protected Member Functions
	setTabs (string $active_tab)
	translations ()
	addTranslations (ilPropertyFormGUI $form=null)
	show translation creation form More...
	initCreateTranslationForm ()
	addToolbarLanguageCreation ()
	getAvailableLanguagesOptions ()
	saveAdditionalTranslations ()

Protected Attributes
const	CMD_DEFAULT = 'translations'
const	CMD_ADD_TRANSLATION = 'addTranslations'
const	CMD_SAVE_ADDITIONAL_TRANSLATIONS = 'saveAdditionalTranslations'
ilCtrl	$ctrl
ilGlobalTemplateInterface	$tpl
ilToolbarGUI	$toolbar
ilTabsGUI	$tabs
ilLanguage	$language
RequestInterface	$request
ilLogger	$logger
ilAdvancedMDRecord	$record

Detailed Description

Definition at line 7 of file class.ilAdvancedMDTranslationGUI.php.

Constructor & Destructor Documentation

__construct()

ilAdvancedMDTranslationGUI::__construct

(

ilAdvancedMDRecord

$record

)

PhpUndefinedMethodInspection

Definition at line 22 of file class.ilAdvancedMDTranslationGUI.php.

References $DIC, $record, ILIAS\Repository\ctrl(), ILIAS\UI\examples\Symbol\Glyph\Language\language(), ILIAS\Repository\logger(), ILIAS\Repository\tabs(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->toolbar = $DIC->toolbar();
        $this->tabs = $DIC->tabs();
        $this->language = $DIC->language();
        $this->language->loadLanguageModule('obj');
        $this->request = $DIC->http()->request();
        $this->logger = $DIC->logger()->amet();
        $this->record = $record;
    }

Here is the call graph for this function:

Member Function Documentation

addToolbarLanguageCreation()

ilAdvancedMDTranslationGUI::addToolbarLanguageCreation ( )

protected

Definition at line 106 of file class.ilAdvancedMDTranslationGUI.php.

References ILIAS\Repository\ctrl(), ilLinkButton\getInstance(), and ILIAS\Repository\toolbar().

                                                   : void
    {
        $button = ilLinkButton::getInstance();
        $button->setCaption('obj_add_languages');
        $button->setUrl(
            $this->ctrl->getLinkTargetByClass(
                strtolower(get_class($this)),
                self::CMD_ADD_TRANSLATION
            )
        );
        $this->toolbar->addButtonInstance($button);
    }

Here is the call graph for this function:

addTranslations()

ilAdvancedMDTranslationGUI::addTranslations ( ilPropertyFormGUI  $form = null )

protected

show translation creation form

Definition at line 70 of file class.ilAdvancedMDTranslationGUI.php.

References initCreateTranslationForm(), and ILIAS\Repository\tabs().

Referenced by saveAdditionalTranslations().

    {
        $this->tabs->activateTab(self::CMD_DEFAULT);
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initCreateTranslationForm();
        }
        $this->tpl->setContent($form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilAdvancedMDTranslationGUI::executeCommand

(

)

Execute command and save parameter record id.

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

References ILIAS\Repository\ctrl().

    {
        $this->ctrl->setParameterByClass(
            strtolower(get_class($this)),
            'record_id',
            $this->record->getRecordId()
        );

        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd(self::CMD_DEFAULT);
        switch ($next_class) {
            default:
                $this->$cmd();
        }
    }

Here is the call graph for this function:

getAvailableLanguagesOptions()

ilAdvancedMDTranslationGUI::getAvailableLanguagesOptions ( )

protected

Returns

array<string, string>

Todo:

handle generic isConfigured

Definition at line 123 of file class.ilAdvancedMDTranslationGUI.php.

References ILIAS\LTI\ToolProvider\$key, $language, ilLanguage\_getInstalledLanguages(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by initCreateTranslationForm().

                                                     : array
    {
        $languages = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->record->getRecordId());

        $this->language->loadLanguageModule('meta');
        $installed_languages = ilLanguage::_getInstalledLanguages();
        $options = [];
        $options[''] = $this->language->txt('select_one');
        foreach ($installed_languages as $key => $language) {
            if ($languages->isConfigured($language)) {
                continue;
            }
            $options[$language] = $this->language->txt('meta_l_' . $language);
        }
        return $options;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initCreateTranslationForm()

ilAdvancedMDTranslationGUI::initCreateTranslationForm ( )

protected

Definition at line 79 of file class.ilAdvancedMDTranslationGUI.php.

References ILIAS\Repository\ctrl(), getAvailableLanguagesOptions(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

Referenced by addTranslations(), and saveAdditionalTranslations().

                                                  : ilPropertyFormGUI
    {
        $form = new \ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this));
        $form->setTitle($this->language->txt('obj_add_languages'));

        $language_options = $this->getAvailableLanguagesOptions();
        $languages = new ilSelectInputGUI(
            $this->language->txt('obj_additional_langs'),
            'languages'
        );
        $languages->setOptions($language_options);
        $languages->setMulti(true);
        $languages->setRequired(true);
        $form->addItem($languages);

        $form->addCommandButton(
            self::CMD_SAVE_ADDITIONAL_TRANSLATIONS,
            $this->language->txt('save')
        );
        $form->addCommandButton(
            self::CMD_DEFAULT,
            $this->language->txt('cancel')
        );
        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveAdditionalTranslations()

ilAdvancedMDTranslationGUI::saveAdditionalTranslations ( )

protected

Definition at line 140 of file class.ilAdvancedMDTranslationGUI.php.

References addTranslations(), ILIAS\Repository\ctrl(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), initCreateTranslationForm(), and ILIAS\UI\examples\Symbol\Glyph\Language\language().

                                                   : void
    {
        $form = $this->initCreateTranslationForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            $this->tpl->setOnScreenMessage('failure', $this->language->txt('err_check_input'));
            $this->addTranslations($form);
            return;
        }
        foreach (array_unique((array) $form->getInput('languages')) as $language_code) {
            $languages = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->record->getRecordId());
            $languages->addTranslationEntry($language_code);
        }

        $this->tpl->setOnScreenMessage('success', $this->language->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::CMD_DEFAULT);
    }

Here is the call graph for this function:

setTabs()

ilAdvancedMDTranslationGUI::setTabs ( string  $active_tab )

protected

Definition at line 57 of file class.ilAdvancedMDTranslationGUI.php.

References ILIAS\Repository\tabs(), and translations().

Referenced by ilAdvancedMDRecordTranslationGUI\translations().

    {
        $this->tabs->activateTab($active_tab);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

translations()

ilAdvancedMDTranslationGUI::translations ( )

abstractprotected

Returns

void

Referenced by setTabs().

Here is the caller graph for this function:

Field Documentation

$ctrl

ilCtrl ilAdvancedMDTranslationGUI::$ctrl

protected

Definition at line 13 of file class.ilAdvancedMDTranslationGUI.php.

$language

ilLanguage ilAdvancedMDTranslationGUI::$language

protected

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

Referenced by getAvailableLanguagesOptions().

$logger

ilLogger ilAdvancedMDTranslationGUI::$logger

protected

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

$record

ilAdvancedMDRecord ilAdvancedMDTranslationGUI::$record

protected

Definition at line 20 of file class.ilAdvancedMDTranslationGUI.php.

Referenced by __construct().

$request

RequestInterface ilAdvancedMDTranslationGUI::$request

protected

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

$tabs

ilTabsGUI ilAdvancedMDTranslationGUI::$tabs

protected

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

$toolbar

ilToolbarGUI ilAdvancedMDTranslationGUI::$toolbar

protected

Definition at line 15 of file class.ilAdvancedMDTranslationGUI.php.

$tpl

ilGlobalTemplateInterface ilAdvancedMDTranslationGUI::$tpl

protected

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

CMD_ADD_TRANSLATION

const ilAdvancedMDTranslationGUI::CMD_ADD_TRANSLATION = 'addTranslations'

protected

Definition at line 10 of file class.ilAdvancedMDTranslationGUI.php.

CMD_DEFAULT

const ilAdvancedMDTranslationGUI::CMD_DEFAULT = 'translations'

protected

Definition at line 9 of file class.ilAdvancedMDTranslationGUI.php.

CMD_SAVE_ADDITIONAL_TRANSLATIONS

const ilAdvancedMDTranslationGUI::CMD_SAVE_ADDITIONAL_TRANSLATIONS = 'saveAdditionalTranslations'

protected

Definition at line 11 of file class.ilAdvancedMDTranslationGUI.php.

---

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

• Services/AdvancedMetaData/classes/Translation/class.ilAdvancedMDTranslationGUI.php