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)

	updateTranslations (string $active_language, string $title, string $description)

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

	$record

	$definitions

	$translations = []

	$record_translations = []

	$default_language = ''

	$db

	$lng

Static Private Attributes
static	$instances = null

Detailed Description

Class ilAdvancedMDFieldTranslations.

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDFieldTranslations::__construct ( int $record_id )

private

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ getActivatedLanguages()

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

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

References getTranslations().

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

Here is the call graph for this function:

◆ getDefaultLanguage()

ilAdvancedMDFieldTranslations::getDefaultLanguage ( )

Returns: string

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

References $default_language.

Referenced by getDescriptionForLanguage(), getFormTranslationInfo(), getTitleForLanguage(), modifyTranslationInfoForDescription(), and modifyTranslationInfoForTitle().

                                          :string
     {
         return $this->default_language;
     }

Here is the caller graph for this function:

◆ getDefaultTranslation()

ilAdvancedMDFieldTranslations::getDefaultTranslation ( int $field_id )

Returns: ilAdvancedMDRecordTranslation|null

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

References $default_language, and getTranslations().

Referenced by modifyTranslationInfoForDescription(), and modifyTranslationInfoForTitle().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDescriptionForLanguage()

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

Parameters

string $language

Returns: string

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

References getDefaultLanguage(), and getTranslation().

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

Here is the call graph for this function:

◆ getFormTranslationInfo()

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

Returns: string

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

References $txt, getDefaultLanguage(), and getTranslations().

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

Here is the call graph for this function:

◆ getInstanceByRecordId()

static ilAdvancedMDFieldTranslations::getInstanceByRecordId ( int $record_id )

static

Parameters

int $record_id

Returns: ilAdvancedMDFieldTranslations

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

References $record_id.

Referenced by ilAdvancedMDFieldDefinition\addToFieldDefinitionForm(), ilLuceneAdvancedSearchFields\getFields(), ilObjectMetaDataBlockGUI\getLegacyContent(), ilAdvancedMDFieldDefinitionText\initADTDefinition(), ilAdvancedMDSettingsGUI\initFieldForm(), ilAdvancedMDRecordGUI\parseAppointmentPresentation(), ilAdvancedMDFieldTableGUI\parseDefinitions(), ilAdvancedMDRecordGUI\parseEditor(), ilAdvancedMDRecordGUI\parseFilter(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilAdvancedMDRecordGUI\parseTableHead(), ilAdvancedMDSettingsGUI\saveField(), ilAdvancedMDFieldDefinition\toXML(), and ilAdvancedMDSettingsGUI\updateField().

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

Here is the caller graph for this function:

◆ getRecordId()

ilAdvancedMDFieldTranslations::getRecordId ( )

Returns: int

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

References $record_id.

Referenced by read().

                                   : int
     {
         return $this->record_id;
     }

Here is the caller graph for this function:

◆ getTitleForLanguage()

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

Parameters

string $language

Returns: string

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

References getDefaultLanguage(), and getTranslation().

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

Here is the call graph for this function:

◆ getTranslation()

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

Parameters

string $lang_key

Returns: ilAdvancedMDRecordTranslation|null

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

References isConfigured().

Referenced by getDescriptionForLanguage(), getTitleForLanguage(), modifyTranslationInfoForDescription(), modifyTranslationInfoForTitle(), updateFromForm(), and updateTranslations().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslations()

ilAdvancedMDFieldTranslations::getTranslations ( int $field_id )

Returns: ilAdvancedMDFieldTranslation[]

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

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

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

Here is the caller graph for this function:

◆ isConfigured()

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

Parameters

int	$field_id
string	$lang_key

Returns: bool

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

Referenced by getTranslation().

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

Here is the caller graph for this function:

◆ modifyTranslationInfoForDescription()

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

Parameters

ilPropertyFormGUI	$form
ilTextInputGUI	$title

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

References getDefaultLanguage(), getDefaultTranslation(), getTranslation(), ilFormPropertyGUI\setInfo(), and ilTextAreaInputGUI\setValue().

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

Here is the call graph for this function:

◆ modifyTranslationInfoForTitle()

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

Parameters

ilPropertyFormGUI	$form
ilTextInputGUI	$title

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

References getDefaultLanguage(), getDefaultTranslation(), getTranslation(), ilFormPropertyGUI\setInfo(), and ilTextInputGUI\setValue().

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

Here is the call graph for this function:

◆ read()

ilAdvancedMDFieldTranslations::read ( )

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

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

Referenced by __construct().

     {
         $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 (
                 $row->lang_code == $this->default_language &&
                 $row->tfield == null
             ) {
                 $this->translations[$row->ofield][$row->lang_code]->setTitle($this->definitions[$row->ofield]->getTitle());
                 $this->translations[$row->ofield][$row->lang_code]->setDescription((string) $this->definitions[$row->ofield]->getDescription());
             }
         }
     }

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
	)

Parameters

int	$field_id
string	$active_language
ilPropertyFormGUI	$form

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

References ilPropertyFormGUI\getInput(), and getTranslation().

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

Here is the call graph for this function:

◆ updateTranslations()

ilAdvancedMDFieldTranslations::updateTranslations	(	string	$active_language,
		string	$title,
		string	$description
	)

Parameters

ilPropertyFormGUI	$form
string	$active_language

Returns: bool

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

References getTranslation().

     {
         $translation = $this->getTranslation($active_language);
         if (!$translation instanceof ilAdvancedMDRecordTranslation) {
             return false;
         }
         $translation->setTitle($title);
         $translation->setDescription($description);
         $translation->update();
     }