ilAdvancedMDTranslationGUI Class Reference

Inheritance diagram for ilAdvancedMDTranslationGUI:

Collaboration diagram for ilAdvancedMDTranslationGUI:

Public Member Functions
	__construct (ilAdvancedMDRecord $record)
	ilAdvancedMDTranslationGUI constructor. More...
	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'
	Default command. More...
const	CMD_ADD_TRANSLATION = 'addTranslations'
const	CMD_SAVE_ADDITIONAL_TRANSLATIONS = 'saveAdditionalTranslations'
	$ctrl
	$tpl
	$toolbar
	$tabs
	$language
	$request
	$logger
	$record

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilAdvancedMDTranslationGUI::__construct

(

ilAdvancedMDRecord

$record

)

ilAdvancedMDTranslationGUI constructor.

Parameters

ilAdvancedMDRecord

$record

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

References $DIC, $record, and language().

    {
        global $DIC;

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

Here is the call graph for this function:

Member Function Documentation

addToolbarLanguageCreation()

ilAdvancedMDTranslationGUI::addToolbarLanguageCreation ( )

protected

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

References ilLinkButton\getInstance().

    {
        $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 109 of file class.ilAdvancedMDTranslationGUI.php.

References initCreateTranslationForm().

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 77 of file class.ilAdvancedMDTranslationGUI.php.

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

getAvailableLanguagesOptions()

ilAdvancedMDTranslationGUI::getAvailableLanguagesOptions ( )

protected

Todo:

handle generic isConfigured

Returns

array

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

References $language, ilLanguage\_getInstalledLanguages(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), and language().

Referenced by initCreateTranslationForm().

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

Returns

ilPropertyFormGUI

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

References getAvailableLanguagesOptions(), and language().

Referenced by addTranslations(), and saveAdditionalTranslations().

    {
        $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 185 of file class.ilAdvancedMDTranslationGUI.php.

References addTranslations(), ilAdvancedMDRecordTranslations\getInstanceByRecordId(), initCreateTranslationForm(), language(), and ilUtil\sendFailure().

    {
        $form = $this->initCreateTranslationForm();
        if (!$form->checkInput()) {
            $form->setValuesByPost();
            ilUtil::sendFailure($this->language->txt('err_check_input'));
            return $this->addTranslations($form);
        }
        foreach (array_unique((array) $form->getInput('languages')) as $language_code) {

            $languages = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->record->getRecordId());
            $languages->addTranslationEntry($language_code);
        }

        ilUtil::sendSuccess($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

Parameters

string

$active_tab

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

References 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

ilAdvancedMDTranslationGUI::$ctrl

protected

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

$language

ilAdvancedMDTranslationGUI::$language

protected

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

Referenced by getAvailableLanguagesOptions().

$logger

ilAdvancedMDTranslationGUI::$logger

protected

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

$record

ilAdvancedMDTranslationGUI::$record

protected

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

Referenced by __construct().

$request

ilAdvancedMDTranslationGUI::$request

protected

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

$tabs

ilAdvancedMDTranslationGUI::$tabs

protected

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

$toolbar

ilAdvancedMDTranslationGUI::$toolbar

protected

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

$tpl

ilAdvancedMDTranslationGUI::$tpl

protected

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

CMD_ADD_TRANSLATION

const ilAdvancedMDTranslationGUI::CMD_ADD_TRANSLATION = 'addTranslations'

protected

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

CMD_DEFAULT

const ilAdvancedMDTranslationGUI::CMD_DEFAULT = 'translations'

protected

Default command.

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

CMD_SAVE_ADDITIONAL_TRANSLATIONS

const ilAdvancedMDTranslationGUI::CMD_SAVE_ADDITIONAL_TRANSLATIONS = 'saveAdditionalTranslations'

protected

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

---

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

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