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 24 of file class.ilAdvancedMDRecordTranslations.php.

Constructor & Destructor Documentation

◆ __construct()

ilAdvancedMDRecordTranslations::__construct ( int $record_id )

private

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

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

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

Here is the call graph for this function:

Member Function Documentation

◆ addTranslationEntry()

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

Definition at line 133 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 105 of file class.ilAdvancedMDRecordTranslations.php.

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

References getTranslations().

Here is the call graph for this function:

◆ getDefaultLanguage()

ilAdvancedMDRecordTranslations::getDefaultLanguage ( )

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

                                        : string
    {
        return $this->default_language;
    }

References $default_language.

◆ getDefaultTranslation()

ilAdvancedMDRecordTranslations::getDefaultTranslation ( )

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

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

References getTranslations().

Here is the call graph for this function:

◆ getDescriptionForLanguage()

ilAdvancedMDRecordTranslations::getDescriptionForLanguage ( string $language )

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

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

◆ getFormTranslationInfo()

ilAdvancedMDRecordTranslations::getFormTranslationInfo ( string $active_language )

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

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

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

Here is the call graph for this function:

◆ getInstanceByRecordId()

static ilAdvancedMDRecordTranslations::getInstanceByRecordId ( int $record_id )

static

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

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

References $record_id.

Here is the caller graph for this function:

◆ getRecordId()

ilAdvancedMDRecordTranslations::getRecordId ( )

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

                                 : int
    {
        return $this->record_id;
    }

References $record_id.

Referenced by read().

Here is the caller graph for this function:

◆ getTitleForLanguage()

ilAdvancedMDRecordTranslations::getTitleForLanguage ( string $language )

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

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

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

Here is the call graph for this function:

◆ getTranslation()

ilAdvancedMDRecordTranslations::getTranslation ( string $lang_key )

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

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

References isConfigured().

Here is the call graph for this function:

◆ getTranslations()

ilAdvancedMDRecordTranslations::getTranslations ( )

array<string, ilAdvancedMDRecordTranslation>

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

                                     : array
    {
        return $this->translations;
    }

References $translations.

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

Here is the caller graph for this function:

◆ isConfigured()

ilAdvancedMDRecordTranslations::isConfigured ( string $lang_key )

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

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

Referenced by getTranslation().

Here is the caller graph for this function:

◆ modifyTranslationInfoForDescription()

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

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

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

◆ modifyTranslationInfoForTitle()

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

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

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

◆ read()

ilAdvancedMDRecordTranslations::read ( )

private

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

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

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

Referenced by __construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toXML()

ilAdvancedMDRecordTranslations::toXML ( ilXmlWriter $writer )

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

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

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

Here is the call graph for this function:

◆ updateDefault()

ilAdvancedMDRecordTranslations::updateDefault ( string $default )

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

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

References getTranslations().

Here is the call graph for this function:

◆ updateTranslations()

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

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

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

Field Documentation

◆ $db

ilDBInterface ilAdvancedMDRecordTranslations::$db

private

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

◆ $default_language

string ilAdvancedMDRecordTranslations::$default_language = ''

private

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

Referenced by getDefaultLanguage().

◆ $instances

ilAdvancedMDRecordTranslations::$instances = null

staticprivate

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

◆ $lng

ilLanguage ilAdvancedMDRecordTranslations::$lng

private

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

◆ $record

ilAdvancedMDRecord ilAdvancedMDRecordTranslations::$record

private

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

◆ $record_id

int ilAdvancedMDRecordTranslations::$record_id

private

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

Referenced by __construct(), getInstanceByRecordId(), and getRecordId().

◆ $translations

ilAdvancedMDRecordTranslations::$translations = []

private

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

Referenced by getTranslations().

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

components/ILIAS/AdvancedMetaData/classes/Translation/class.ilAdvancedMDRecordTranslations.php

Public Member Functions

Static Public Member Functions

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addTranslationEntry()

◆ cloneRecord()

◆ getDefaultLanguage()

◆ getDefaultTranslation()

◆ getDescriptionForLanguage()

◆ getFormTranslationInfo()

◆ getInstanceByRecordId()

◆ getRecordId()

◆ getTitleForLanguage()

◆ getTranslation()

◆ getTranslations()

◆ isConfigured()

◆ modifyTranslationInfoForDescription()

◆ modifyTranslationInfoForTitle()

◆ read()

◆ toXML()

◆ updateDefault()

◆ updateTranslations()

Field Documentation

◆ $db

◆ $default_language

◆ $instances

◆ $lng

◆ $record

◆ $record_id

◆ $translations