ilAdvancedMDRecordTranslations Class Reference

Class ilAdvancedMDRecordTranslation. More...

Collaboration diagram for ilAdvancedMDRecordTranslations:

Public Member Functions
	getDefaultLanguage ()
	getRecordId ()
	isConfigured (string $lang_key)
	getTranslation (string $lang_key)
	getTranslations ()
	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
	$record_id
	$record
	$translations = []
	$default_language = ''
	$db
	$lng

Static Private Attributes
static	$instances = null

Detailed Description

Class ilAdvancedMDRecordTranslation.

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

Constructor & Destructor Documentation

__construct()

ilAdvancedMDRecordTranslations::__construct ( int  $record_id )

private

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

References $DIC, $record_id, 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 156 of file class.ilAdvancedMDRecordTranslations.php.

    {
        $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 128 of file class.ilAdvancedMDRecordTranslations.php.

References getTranslations().

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

Here is the call graph for this function:

getDefaultLanguage()

ilAdvancedMDRecordTranslations::getDefaultLanguage

(

)

Returns

string

Definition at line 73 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

(

)

Returns

ilAdvancedMDRecordTranslation|null

Definition at line 118 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

)

Parameters

string

$language

Returns

string

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

References getTranslation().

    {
        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

)

Returns

string

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

References $default_language, and $txt.

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

getInstanceByRecordId()

static ilAdvancedMDRecordTranslations::getInstanceByRecordId ( int  $record_id )

static

Parameters

int

$record_id

Returns

ilAdvancedMDRecordTranslations

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

References $record_id.

Referenced by ilObjectMetaDataBlockGUI\__construct(), ilAdvancedMDRecordLanguageTableGUI\__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().

    {
        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

(

)

Returns

int

Definition at line 81 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

)

Parameters

string

$language

Returns

string

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

References getTranslation().

    {
        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

)

Parameters

string

$lang_key

Returns

ilAdvancedMDRecordTranslation|null

Definition at line 99 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

(

)

Returns

ilAdvancedMDRecordTranslation[]

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

References $translations.

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

    {
        return $this->translations;
    }

Here is the caller graph for this function:

isConfigured()

ilAdvancedMDRecordTranslations::isConfigured

(

string

$lang_key

)

Parameters

string

$lang_key

Returns

bool

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

Referenced by getTranslation().

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

Here is the caller graph for this function:

modifyTranslationInfoForDescription()

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

Parameters

ilPropertyFormGUI	$form
ilTextInputGUI	$title

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

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

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

Parameters

ilPropertyFormGUI	$form
ilTextInputGUI	$title

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

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

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

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

Referenced by __construct().

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

)

Parameters

ilXmlWriter

$writer

Returns

ilXmlWriter

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

References getTranslations().

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

Parameters

ilPropertyFormGUI	$form
string	$active_language

Returns

bool

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

References getTranslation().

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

Here is the call graph for this function:

Field Documentation

$db

ilAdvancedMDRecordTranslations::$db

private

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

$default_language

ilAdvancedMDRecordTranslations::$default_language = ''

private

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

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

$instances

ilAdvancedMDRecordTranslations::$instances = null

staticprivate

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

$lng

ilAdvancedMDRecordTranslations::$lng

private

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

$record

ilAdvancedMDRecordTranslations::$record

private

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

$record_id

ilAdvancedMDRecordTranslations::$record_id

private

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

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

$translations

ilAdvancedMDRecordTranslations::$translations = []

private

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

Referenced by getTranslations().

---

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

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