Class ilAdvancedMDRecordTranslation. More...

Collaboration diagram for ilAdvancedMDRecordTranslations:

Public Member Functions
	getDefaultLanguage ()

	getRecordId ()

	isConfigured (string $lang_key)

	getTranslation (string $lang_key)

	getTranslations ()
	array<string, ilAdvancedMDRecordTranslation> More...

	getDefaultTranslation ()

	cloneRecord (int $new_record_id)

	addTranslationEntry (string $language_code, bool $default=false)

	updateDefault (string $default)

	getFormTranslationInfo (string $active_language)

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

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

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

	getTitleForLanguage (string $language)

	getDescriptionForLanguage (string $language)

	toXML (ilXmlWriter $writer)

Static Public Member Functions
static	getInstanceByRecordId (int $record_id)

Private Member Functions
	__construct (int $record_id)

	read ()

Private Attributes
int	$record_id

ilAdvancedMDRecord	$record

	$translations = []

string	$default_language = ''

ilDBInterface	$db

ilLanguage	$lng

Static Private Attributes
static	$instances = null

Detailed Description

Class ilAdvancedMDRecordTranslation.

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

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDRecordTranslations::__construct ( int $record_id )

private

Definition at line 30 of file class.ilAdvancedMDRecordTranslations.php.

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addTranslationEntry()

ilAdvancedMDRecordTranslations::addTranslationEntry	(	string	$language_code,
		bool	$default = `false`
	)

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

                                                                                      : void
     {
         $this->translations[$language_code] = new ilAdvancedMDRecordTranslation(
             $this->record_id,
             '',
             '',
             $language_code,
             $default
         );
         $this->translations[$language_code]->insert();
     }

◆ cloneRecord()

ilAdvancedMDRecordTranslations::cloneRecord ( int $new_record_id )

Definition at line 91 of file class.ilAdvancedMDRecordTranslations.php.

References getTranslations().

                                                    : void
     {
         foreach ($this->getTranslations() as $recordTranslation) {
             $recordTranslation->setRecordId($new_record_id);
             $recordTranslation->insert();
         }
     }

Here is the call graph for this function:

◆ getDefaultLanguage()

ilAdvancedMDRecordTranslations::getDefaultLanguage ( )

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

References $default_language.

Referenced by toXML().

                                         : string
     {
         return $this->default_language;
     }

Here is the caller graph for this function:

◆ getDefaultTranslation()

ilAdvancedMDRecordTranslations::getDefaultTranslation ( )

Definition at line 81 of file class.ilAdvancedMDRecordTranslations.php.

References $default_language, and getTranslations().

Referenced by modifyTranslationInfoForDescription(), and modifyTranslationInfoForTitle().

                                            : ?ilAdvancedMDRecordTranslation
     {
         foreach ($this->getTranslations() 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()

ilAdvancedMDRecordTranslations::getDescriptionForLanguage ( string $language )

Definition at line 215 of file class.ilAdvancedMDRecordTranslations.php.

References getTranslation().

                                                                : string
     {
         if ($this->getTranslation($language) && strlen($this->getTranslation($language)->getDescription())) {
             return $this->getTranslation($language)->getDescription();
         }
         return $this->record->getDescription();
     }

Here is the call graph for this function:

◆ getFormTranslationInfo()

ilAdvancedMDRecordTranslations::getFormTranslationInfo ( string $active_language )

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

References $default_language, $txt, and ILIAS\Repository\lng().

                                                                    : string
     {
         if (count($this->translations) <= 1) {
             return '';
         }
         $txt = '';
         $txt = $this->lng->txt('md_adv_int_current') . ' ' . $this->lng->txt('meta_l_' . $active_language);
         $txt .= ', ';
         foreach ($this->translations as $translation) {
             if ($translation->getLangKey() == $this->default_language) {
                 $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 ilAdvancedMDRecordTranslations::getInstanceByRecordId ( int $record_id )

static

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

References $record_id.

Referenced by ilAdvancedMDRecordLanguageTableGUI\__construct(), ilObjectMetaDataBlockGUI\__construct(), ilAdvancedMDFieldTranslations\__construct(), ilAdvancedMDRecord\_clone(), ilAdvancedMDTranslationGUI\getAvailableLanguagesOptions(), ilAdvancedMDSettingsGUI\initForm(), ilAdvancedMDSettingsGUI\initLanguage(), ilAdvancedMDSettingsGUI\loadRecordFormData(), ilAdvancedMDRecordGUI\parseEditor(), ilAdvancedMDRecordGUI\parseInfoPage(), ilAdvancedMDRecordGUI\parseSearch(), ilLuceneAdvancedSearchFields\readSections(), ilAdvancedMDTranslationGUI\saveAdditionalTranslations(), ilAdvancedMDSettingsGUI\saveRecord(), ilAdvancedMDRecordTranslationGUI\saveTranslations(), ilAdvancedMDSettingsGUI\showLanguageSwitch(), ilAdvancedMDRecordParser\storeRecords(), ilAdvancedMDRecord\toXML(), and ilAdvancedMDSettingsGUI\updateRecord().

                                                                 : ilAdvancedMDRecordTranslations
     {
         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()

ilAdvancedMDRecordTranslations::getRecordId ( )

Definition at line 55 of file class.ilAdvancedMDRecordTranslations.php.

References $record_id.

Referenced by read().

                                  : int
     {
         return $this->record_id;
     }

Here is the caller graph for this function:

◆ getTitleForLanguage()

ilAdvancedMDRecordTranslations::getTitleForLanguage ( string $language )

Definition at line 207 of file class.ilAdvancedMDRecordTranslations.php.

References getTranslation().

                                                          : string
     {
         if ($this->getTranslation($language) && strlen($this->getTranslation($language)->getTitle())) {
             return $this->getTranslation($language)->getTitle();
         }
         return $this->record->getTitle();
     }

Here is the call graph for this function:

◆ getTranslation()

ilAdvancedMDRecordTranslations::getTranslation ( string $lang_key )

Definition at line 65 of file class.ilAdvancedMDRecordTranslations.php.

References isConfigured().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTranslations()

ilAdvancedMDRecordTranslations::getTranslations ( )

array<string, ilAdvancedMDRecordTranslation>

Definition at line 76 of file class.ilAdvancedMDRecordTranslations.php.

References $translations.

Referenced by cloneRecord(), getDefaultTranslation(), toXML(), and updateDefault().

                                      : array
     {
         return $this->translations;
     }

Here is the caller graph for this function:

◆ isConfigured()

ilAdvancedMDRecordTranslations::isConfigured ( string $lang_key )

Definition at line 60 of file class.ilAdvancedMDRecordTranslations.php.

Referenced by getTranslation().

                                                   : bool
     {
         return isset($this->translations[$lang_key]);
     }

Here is the caller graph for this function:

◆ modifyTranslationInfoForDescription()

ilAdvancedMDRecordTranslations::modifyTranslationInfoForDescription	(	ilPropertyFormGUI	$form,
		ilTextAreaInputGUI	$description,
		string	$active_language
	)

Definition at line 179 of file class.ilAdvancedMDRecordTranslations.php.

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

      : void {
         if (count($this->translations) <= 1) {
             return;
         }
         $default = $this->getDefaultTranslation();
         if ($default->getLangKey() != $active_language) {
             $description->setInfo($default->getLangKey() . ': ' . $default->getDescription());
         }
         if ($this->getTranslation($active_language) instanceof ilAdvancedMDRecordTranslation) {
             $description->setValue($this->getTranslation($active_language)->getDescription());
         }
     }

Here is the call graph for this function:

◆ modifyTranslationInfoForTitle()

ilAdvancedMDRecordTranslations::modifyTranslationInfoForTitle	(	ilPropertyFormGUI	$form,
		ilTextInputGUI	$title,
		string	$active_language
	)

Definition at line 162 of file class.ilAdvancedMDRecordTranslations.php.

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

      : void {
         if (count($this->translations) <= 1) {
             return;
         }
         $default = $this->getDefaultTranslation();
         if ($default->getLangKey() != $active_language) {
             $title->setInfo($default->getLangKey() . ': ' . $default->getTitle());
         }
         if ($this->getTranslation($active_language) instanceof ilAdvancedMDRecordTranslation) {
             $title->setValue($this->getTranslation($active_language)->getTitle());
         }
     }

Here is the call graph for this function:

◆ read()

ilAdvancedMDRecordTranslations::read ( )

private

Definition at line 99 of file class.ilAdvancedMDRecordTranslations.php.

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

Referenced by __construct().

                            : void
     {
         $query = 'select * from ' . ilAdvancedMDRecordTranslation::TABLE_NAME . ' ' .
             'where record_id = ' . $this->db->quote($this->getRecordId(), ilDBConstants::T_INTEGER);
         $res = $this->db->query($query);
 
         $this->translations = [];
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             $this->translations[(string) $row->lang_code] = new ilAdvancedMDRecordTranslation(
                 (int) $row->record_id,
                 (string) $row->title,
                 (string) $row->description,
                 (string) $row->lang_code
             );
         }
 
         $this->record = ilAdvancedMDRecord::_getInstanceByRecordId($this->record_id);
         $this->default_language = $this->record->getDefaultLanguage();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toXML()

ilAdvancedMDRecordTranslations::toXML ( ilXmlWriter $writer )

Definition at line 223 of file class.ilAdvancedMDRecordTranslations.php.

References getDefaultLanguage(), getTranslations(), ilXmlWriter\xmlElement(), ilXmlWriter\xmlEndTag(), and ilXmlWriter\xmlStartTag().

                                               : ilXmlWriter
     {
         if (!count($this->getTranslations())) {
             return $writer;
         }
 
         $writer->xmlStartTag(
             'RecordTranslations',
             [
                 'defaultLanguage' => $this->getDefaultLanguage()
             ]
         );
         foreach ($this->getTranslations() as $translation) {
             $writer->xmlStartTag(
                 'RecordTranslation',
                 [
                     'language' => $translation->getLangKey()
                 ]
             );
             $writer->xmlElement('RecordTranslationTitle', [], $translation->getTitle());
             $writer->xmlElement('RecordTranslationDescription', [], $translation->getDescription());
             $writer->xmlEndTag('RecordTranslation');
         }
         $writer->xmlEndTag('RecordTranslations');
         return $writer;
     }

Here is the call graph for this function:

◆ updateDefault()

ilAdvancedMDRecordTranslations::updateDefault ( string $default )

Definition at line 131 of file class.ilAdvancedMDRecordTranslations.php.

References getTranslations().

                                                   : void
     {
         foreach ($this->getTranslations() as $translation) {
             if ($translation->getLangKey() != $default) {
                 $translation->setLangDefault(false);
                 $translation->update();
             }
             if ($translation->getLangKey() == $default) {
                 $translation->setLangDefault(true);
                 $translation->update();
             }
         }
     }

Here is the call graph for this function:

◆ updateTranslations()

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

Definition at line 196 of file class.ilAdvancedMDRecordTranslations.php.

References getTranslation().

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