Class ilAdvancedMDFieldTranslations. More...

Collaboration diagram for ilAdvancedMDFieldTranslations:

Public Member Functions
	getRecordId ()

	getDefaultLanguage ()

	getActivatedLanguages (int $field_id, bool $with_default=true)

	isConfigured (int $field_id, string $lang_key)

	getTranslation (int $field_id, string $lang_key)

	getTranslations (int $field_id)

	getDefaultTranslation (int $field_id)

	read ()

	getFormTranslationInfo (int $field_id, string $active_language)

	modifyTranslationInfoForTitle (int $field_id, ilPropertyFormGUI $form, ilTextInputGUI $title, string $active_language)

	modifyTranslationInfoForDescription (int $field_id, ilPropertyFormGUI $form, ilTextAreaInputGUI $description, string $active_language)

	updateFromForm (int $field_id, string $active_language, ilPropertyFormGUI $form)

	getTitleForLanguage (int $field_id, string $language)

	getDescriptionForLanguage (int $field_id, string $language)

Static Public Member Functions
static	getInstanceByRecordId (int $record_id)

Private Member Functions
	__construct (int $record_id)

Private Attributes
int	$record_id

ilAdvancedMDRecord	$record

array	$definitions

array	$translations = []

ilAdvancedMDRecordTranslations	$record_translations

string	$default_language = ''

ilDBInterface	$db

ilLanguage	$lng

Static Private Attributes
static array	$instances = []

Detailed Description

Class ilAdvancedMDFieldTranslations.

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDFieldTranslations::__construct ( int $record_id )

private

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

    {
        global $DIC;
 
        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('meta');
 
        $this->record_id = $record_id;
        $this->record_translations = ilAdvancedMDRecordTranslations::getInstanceByRecordId($this->record_id);
        $this->read();
    }

References $DIC, $record_id, ilAdvancedMDRecordTranslations\getInstanceByRecordId(), ILIAS\Repository\lng(), and read().

Here is the call graph for this function:

Member Function Documentation

◆ getActivatedLanguages()

ilAdvancedMDFieldTranslations::getActivatedLanguages	(	int	$field_id,
		bool	$with_default = `true`
	)

Parameters

int	$field_id
bool	$with_default

Returns: array<int, string>

Definition at line 93 of file class.ilAdvancedMDFieldTranslations.php.

                                                                                   : array
    {
        $activated = [];
        foreach ($this->getTranslations($field_id) as $language => $translation) {
            if ($language == self::getDefaultLanguage() && !$with_default) {
                continue;
            }
            $activated[] = $language;
        }
        return $activated;
    }

References getTranslations().

Here is the call graph for this function:

◆ getDefaultLanguage()

ilAdvancedMDFieldTranslations::getDefaultLanguage ( )

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

                                        : string
    {
        return $this->default_language;
    }

References $default_language.

◆ getDefaultTranslation()

ilAdvancedMDFieldTranslations::getDefaultTranslation ( int $field_id )

Returns: ilAdvancedMDRecordTranslation | null

Definition at line 135 of file class.ilAdvancedMDFieldTranslations.php.

                                                        : ?ilAdvancedMDFieldTranslation
    {
        foreach ($this->getTranslations($field_id) as $translation) {
            if ($translation->getLangKey() == $this->default_language) {
                return $translation;
            }
        }
        return null;
    }

References getTranslations().

Here is the call graph for this function:

◆ getDescriptionForLanguage()

ilAdvancedMDFieldTranslations::getDescriptionForLanguage	(	int	$field_id,
		string	$language
	)

Definition at line 261 of file class.ilAdvancedMDFieldTranslations.php.

                                                                              : string
    {
        if ($this->getTranslation($field_id, $language) && strlen($this->getTranslation(
            $field_id,
            $language
        )->getDescription())) {
            return $this->getTranslation($field_id, $language)->getDescription();
        }
        if ($this->getTranslation($field_id, $this->getDefaultLanguage()) &&
            strlen($this->getTranslation($field_id, $this->getDefaultLanguage())->getDescription())
        ) {
            return $this->getTranslation($field_id, $this->getDefaultLanguage())->getDescription();
        }
        if ($this->definitions[$field_id] instanceof ilAdvancedMDFieldDefinition) {
            return $this->definitions[$field_id]->getDescription();
        }
        return '';
    }

◆ getFormTranslationInfo()

ilAdvancedMDFieldTranslations::getFormTranslationInfo	(	int	$field_id,
		string	$active_language
	)

Definition at line 174 of file class.ilAdvancedMDFieldTranslations.php.

                                                                                  : string
    {
        if (count($this->getTranslations($field_id)) <= 1) {
            return '';
        }
 
        $txt = '';
        $txt = $this->lng->txt('md_adv_int_current') . ' ' . $this->lng->txt('meta_l_' . $active_language);
        $txt .= ', ';
        foreach ($this->getTranslations($field_id) as $translation) {
            if ($translation->getLangKey() == $this->getDefaultLanguage()) {
                $txt .= ($this->lng->txt('md_adv_int_default') . ' ' . $this->lng->txt('meta_l_' . $translation->getLangKey()));
                break;
            }
        }
        return $txt;
    }

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

Here is the call graph for this function:

◆ getInstanceByRecordId()

static ilAdvancedMDFieldTranslations::getInstanceByRecordId ( int $record_id )

static

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

                                                                : ilAdvancedMDFieldTranslations
    {
        if (!isset(self::$instances[$record_id])) {
            self::$instances[$record_id] = new self($record_id);
        }
        return self::$instances[$record_id];
    }

References $record_id.

Referenced by ilObjectMetaDataBlockGUI\getLegacyContent(), ilAdvancedMDFieldDefinitionText\initADTDefinition(), ILIAS\AdvancedMetaData\Services\SubObjectModes\DataTable\Supplier\initColumns(), ilAdvancedMDSettingsGUI\initFieldForm(), ILIAS\AdvancedMetaData\Services\SubObjectModes\Filter\Supplier\initFilterInputs(), ILIAS\AdvancedMetaData\Services\ObjectModes\Custom\Custom\initSets(), ilAdvancedMDRecordGUI\parseAppointmentPresentationa(), ilAdvancedMDFieldTableGUI\parseDefinitions(), ilAdvancedMDRecordGUI\parseEditor(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDRecordGUI\parseTableHead(), ilAdvancedMDSettingsGUI\saveField(), ilAdvancedMDFieldDefinition\toXML(), and ilAdvancedMDSettingsGUI\updateField().

Here is the caller graph for this function:

◆ getRecordId()

ilAdvancedMDFieldTranslations::getRecordId ( )

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

                                 : int
    {
        return $this->record_id;
    }

References $record_id.

Referenced by read().

Here is the caller graph for this function:

◆ getTitleForLanguage()

ilAdvancedMDFieldTranslations::getTitleForLanguage	(	int	$field_id,
		string	$language
	)

Definition at line 241 of file class.ilAdvancedMDFieldTranslations.php.

                                                                        : string
    {
        if ($this->getTranslation($field_id, $language) && strlen($this->getTranslation(
            $field_id,
            $language
        )->getTitle())) {
            return $this->getTranslation($field_id, $language)->getTitle();
        }
        if (
            $this->getTranslation($field_id, $this->getDefaultLanguage()) &&
            strlen(($this->getTranslation($field_id, $this->getDefaultLanguage())->getTitle()))
        ) {
            return $this->getTranslation($field_id, $this->getDefaultLanguage())->getTitle();
        }
        if ($this->definitions[$field_id] instanceof ilAdvancedMDFieldDefinition) {
            return $this->definitions[$field_id]->getTitle();
        }
        return '';
    }

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle().

Here is the call graph for this function:

◆ getTranslation()

ilAdvancedMDFieldTranslations::getTranslation	(	int	$field_id,
		string	$lang_key
	)

Definition at line 113 of file class.ilAdvancedMDFieldTranslations.php.

                                                                   : ?ilAdvancedMDFieldTranslation
    {
        if (!$this->isConfigured($field_id, $lang_key)) {
            return null;
        }
        return $this->translations[$field_id][$lang_key];
    }

References isConfigured().

Here is the call graph for this function:

◆ getTranslations()

ilAdvancedMDFieldTranslations::getTranslations ( int $field_id )

Returns: array<string, ilAdvancedMDFieldTranslation>

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

                                                  : array
    {
        if (isset($this->translations[$field_id])) {
            return $this->translations[$field_id];
        }
        return [];
    }

Referenced by getActivatedLanguages(), getDefaultTranslation(), and getFormTranslationInfo().

Here is the caller graph for this function:

◆ isConfigured()

ilAdvancedMDFieldTranslations::isConfigured	(	int	$field_id,
		string	$lang_key
	)

Definition at line 105 of file class.ilAdvancedMDFieldTranslations.php.

                                                                 : bool
    {
        if (!$this->record_translations->isConfigured($lang_key)) {
            return false;
        }
        return isset($this->translations[$field_id][$lang_key]);
    }

Referenced by getTranslation().

Here is the caller graph for this function:

◆ modifyTranslationInfoForDescription()

ilAdvancedMDFieldTranslations::modifyTranslationInfoForDescription	(	int	$field_id,
		ilPropertyFormGUI	$form,
		ilTextAreaInputGUI	$description,
		string	$active_language
	)

Definition at line 211 of file class.ilAdvancedMDFieldTranslations.php.

     : void {
        if (!strlen($active_language)) {
            return;
        }
        $show_info = ($active_language !== $this->getDefaultLanguage() && $this->getDefaultLanguage());
        $default = $this->getDefaultTranslation($field_id);
        if ($default instanceof ilAdvancedMDFieldTranslation && $show_info) {
            $description->setInfo($default->getLangKey() . ': ' . $default->getDescription());
        }
        if ($this->getTranslation($field_id, $active_language) instanceof ilAdvancedMDFieldTranslation) {
            $description->setValue($this->getTranslation($field_id, $active_language)->getDescription());
        }
    }

◆ modifyTranslationInfoForTitle()

ilAdvancedMDFieldTranslations::modifyTranslationInfoForTitle	(	int	$field_id,
		ilPropertyFormGUI	$form,
		ilTextInputGUI	$title,
		string	$active_language
	)

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

     : void {
        if (!strlen($active_language)) {
            return;
        }
        $show_info = ($active_language !== $this->getDefaultLanguage() && $this->getDefaultLanguage());
        $default = $this->getDefaultTranslation($field_id);
        if ($default instanceof ilAdvancedMDFieldTranslation && $show_info) {
            $title->setInfo($default->getLangKey() . ': ' . $default->getTitle());
        }
        if ($this->getTranslation($field_id, $active_language) instanceof ilAdvancedMDFieldTranslation) {
            $title->setValue($this->getTranslation($field_id, $active_language)->getTitle());
        }
    }

◆ read()

ilAdvancedMDFieldTranslations::read ( )

Definition at line 145 of file class.ilAdvancedMDFieldTranslations.php.

                          : void
    {
        $query = 'select fi.field_id tfield, de.field_id ofield, fi.title, fi.description, ri.lang_code ' .
            'from adv_md_record_int ri join adv_mdf_definition de on ri.record_id = de.record_id ' .
            'left join adv_md_field_int fi on (ri.lang_code = fi.lang_code and de.field_id = fi.field_id) ' .
            'where ri.record_id = ' . $this->db->quote($this->getRecordId(), ilDBConstants::T_INTEGER);
        $res = $this->db->query($query);
 
        $this->record = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id);
        $this->default_language = $this->record->getDefaultLanguage();
 
        $this->translations = [];
        $this->definitions = ilAdvancedMDFieldDefinition::getInstancesByRecordId($this->record_id, false);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->translations[$row->ofield][$row->lang_code] = new ilAdvancedMDFieldTranslation(
                (int) $row->ofield,
                (string) $row->title,
                (string) $row->description,
                (string) $row->lang_code
            );
            if ((string) $row->lang_code == $this->default_language && $row->tfield == null) {
                $this->translations[(int) $row->ofield][(string) $row->lang_code]->setTitle($this->definitions[(int) $row->ofield]->getTitle());
                $this->translations[(int) $row->ofield][(string) $row->lang_code]->setDescription(
                    $this->definitions[(int) $row->ofield]->getDescription()
                );
            }
        }
    }

References $res, ilAdvancedMDRecord\_getInstanceByRecordId(), ilDBConstants\FETCHMODE_OBJECT, ilAdvancedMDFieldDefinition\getInstancesByRecordId(), getRecordId(), ILIAS\Repository\int(), and ilDBConstants\T_INTEGER.

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateFromForm()

ilAdvancedMDFieldTranslations::updateFromForm	(	int	$field_id,
		string	$active_language,
		ilPropertyFormGUI	$form
	)

Definition at line 230 of file class.ilAdvancedMDFieldTranslations.php.

                                                                                                   : void
    {
        $translation = $this->getTranslation($field_id, $active_language);
        if (!$translation instanceof ilAdvancedMDFieldTranslation) {
            return;
        }
        $translation->setTitle($form->getInput('title'));
        $translation->setDescription($form->getInput('description'));
        $translation->update();
    }