ILIAS\ILIASObject\Properties\Translations\Translations Class Reference

Class handles translation mode for an object. More...

Collaboration diagram for ILIAS\ILIASObject\Properties\Translations\Translations:

Public Member Functions
	__construct (private readonly int $obj_id, private array $languages, private string $default_language, private ?string $base_language, private readonly bool $migration_missing=false)
	migrationMissing ()
	getObjId ()
	getDefaultLanguage ()
	withDefaultLanguage (string $default_language)
	getBaseLanguage ()
	withBaseLanguage (string $base_language)
	getLanguages ()
	getLaguageForCode (string $lang_code)
	withLanguage (Language $lang)
	withoutLanguage (string $lang)
	withResetLanguages ()
	getDefaultTitle ()
	withDefaultTitle (string $title)
	getDefaultDescription ()
	withDefaultDescription (string $description)
	getContentTranslationActivated ()
	withDeactivatedContentTranslation ()
	copy (int $obj_id)
	getEffectiveCOPageLang (string $lang, string $parent_type)

Detailed Description

Class handles translation mode for an object.

Objects may not use any translations at all

• use translations for title/description only or
• use translation for (the page editing) content, too.

Currently, supported by container objects and ILIAS learning modules.

Content base lang vs. default language

• If no translation mode for the content is active no base lang will be set and no record in table obj_content_base_lng will be saved. For the title/descriptions the default will be marked by field lang_default in table object_translation.
• If translation for content is activated a base language must be set (since consent may already exist the language of this content is defined through setting the base language. Components that use this mode will not get informed about this, so they can not internally assign existing content to the base lang
• If translation for content is activated additionally a fallback language can be defined. Users will be presented their language, if content available otherwise the fallback language, if content is available, otherwise the base language

Definition at line 52 of file Translations.php.

Constructor & Destructor Documentation

__construct()

ILIAS\ILIASObject\Properties\Translations\Translations::__construct	(	private readonly int	$obj_id,
		private array	$languages,
		private string	$default_language,
		private ?string	$base_language,
		private readonly bool	$migration_missing = false
	)

Parameters

array

$languages

list<Language>

Definition at line 58 of file Translations.php.

      {
    }

Member Function Documentation

copy()

ILIAS\ILIASObject\Properties\Translations\Translations::copy

(

int

$obj_id

)

Definition at line 224 of file Translations.php.

                                     : self
    {
        return new self(
            $obj_id,
            $this->languages,
            $this->default_language,
            $this->base_language
        );
    }

getBaseLanguage()

ILIAS\ILIASObject\Properties\Translations\Translations::getBaseLanguage

(

)

Definition at line 93 of file Translations.php.

                                     : string
    {
        return $this->base_language ?? '';
    }

Referenced by ilMediaPoolImportGUI\initTranslationImportForm().

Here is the caller graph for this function:

getContentTranslationActivated()

ILIAS\ILIASObject\Properties\Translations\Translations::getContentTranslationActivated

(

)

Definition at line 211 of file Translations.php.

                                                    : bool
    {
        return $this->base_language !== null;
    }

getDefaultDescription()

ILIAS\ILIASObject\Properties\Translations\Translations::getDefaultDescription

(

)

Definition at line 186 of file Translations.php.

                                           : string
    {
        if ($this->default_language !== ''
            && array_key_exists($this->default_language, $this->languages)) {
            return $this->languages[$this->default_language]->getDescription();
        }
 
        if ($this->languages === []) {
            return \ilObject::_lookupTitle($this->getObjId());
        }
        return '';
    }

References ILIAS\ILIASObject\Properties\Translations\Translations\getObjId().

Here is the call graph for this function:

getDefaultLanguage()

ILIAS\ILIASObject\Properties\Translations\Translations::getDefaultLanguage

(

)

Definition at line 79 of file Translations.php.

                                        : string
    {
        return $this->default_language;
    }

Referenced by ilObjStudyProgrammeSettingsGUI\getEditSection(), and ilLMPresentationStatus\getLMPresentationTitle().

Here is the caller graph for this function:

getDefaultTitle()

ILIAS\ILIASObject\Properties\Translations\Translations::getDefaultTitle

(

)

Definition at line 161 of file Translations.php.

                                     : string
    {
        if ($this->default_language !== ''
            && array_key_exists($this->default_language, $this->languages)) {
            return $this->languages[$this->default_language]->getTitle();
        }
 
        if ($this->languages === []) {
            return \ilObject::_lookupTitle($this->getObjId());
        }
        return '';
    }

References ILIAS\ILIASObject\Properties\Translations\Translations\getObjId().

Here is the call graph for this function:

getEffectiveCOPageLang()

ILIAS\ILIASObject\Properties\Translations\Translations::getEffectiveCOPageLang	(	string	$lang,
		string	$parent_type
	)

Definition at line 234 of file Translations.php.

     : string {
        if ($this->base_language === null) {
            return '-';
        }
 
        $page_lang_key = $lang === $this->base_language
            ? '-'
            : $lang;
 
        if (isset($this->languages[$lang])
            && \ilPageObject::_exists($parent_type, $this->getObjId(), $page_lang_key)) {
            return $page_lang_key;
        }
 
        if (isset($this->languages[$this->default_language])
            && \ilPageObject::_exists($parent_type, $this->getObjId(), $this->default_language)) {
            return $this->default_language;
        }
        return '-';
    }

getLaguageForCode()

ILIAS\ILIASObject\Properties\Translations\Translations::getLaguageForCode

(

string

$lang_code

)

Definition at line 117 of file Translations.php.

                                                        : ?Language
    {
        return $this->languages[$lang_code] ?? null;
    }

getLanguages()

ILIAS\ILIASObject\Properties\Translations\Translations::getLanguages

(

)

Returns

list<Language>

Definition at line 112 of file Translations.php.

                                  : array
    {
        return $this->languages;
    }

Referenced by ilLMPresentationStatus\getLMPresentationTitle(), and ilMediaPoolImportGUI\initTranslationImportForm().

Here is the caller graph for this function:

getObjId()

ILIAS\ILIASObject\Properties\Translations\Translations::getObjId

(

)

Definition at line 74 of file Translations.php.

                              : int
    {
        return $this->obj_id;
    }

Referenced by ILIAS\ILIASObject\Properties\Translations\Translations\getDefaultDescription(), ILIAS\ILIASObject\Properties\Translations\Translations\getDefaultTitle(), and ILIAS\ILIASObject\Properties\Translations\CachedRepository\store().

Here is the caller graph for this function:

migrationMissing()

ILIAS\ILIASObject\Properties\Translations\Translations::migrationMissing

(

)

Todo:

: Remove with ILIAS 12

Definition at line 70 of file Translations.php.

                                      : bool
    {
        return $this->migration_missing;
    }

withBaseLanguage()

ILIAS\ILIASObject\Properties\Translations\Translations::withBaseLanguage

(

string

$base_language

)

Definition at line 98 of file Translations.php.

                                                           : self
    {
        $clone = clone $this;
        if ($clone->base_language !== null) {
            $clone->languages[$clone->base_language] = $clone->languages[$clone->base_language]->withBase(false);
        }
        $clone->languages[$base_language] = $clone->languages[$base_language]->withBase(true);
        $clone->base_language = $base_language;
        return $clone;
    }

withDeactivatedContentTranslation()

ILIAS\ILIASObject\Properties\Translations\Translations::withDeactivatedContentTranslation

(

)

Definition at line 216 of file Translations.php.

                                                       : self
    {
        $clone = clone $this;
        $clone->languages[$clone->base_language] = $clone->languages[$this->base_language]->withBase(false);
        $clone->base_language = null;
        return $clone;
    }

withDefaultDescription()

ILIAS\ILIASObject\Properties\Translations\Translations::withDefaultDescription

(

string

$description

)

Definition at line 199 of file Translations.php.

                                                               : self
    {
        if ($this->default_language === ''
            || !isset($this->languages[$this->default_language])) {
            return $this;
        }
 
        $clone = clone $this;
        $clone->languages[$clone->default_language] = $clone->languages[$clone->default_language]->withDescription($description);
        return $clone;
    }

withDefaultLanguage()

ILIAS\ILIASObject\Properties\Translations\Translations::withDefaultLanguage

(

string

$default_language

)

Definition at line 84 of file Translations.php.

                                                                 : self
    {
        $clone = clone $this;
        $clone->languages[$clone->default_language] = $clone->languages[$clone->default_language]->withDefault(false);
        $clone->languages[$default_language] = $clone->languages[$default_language]->withDefault(true);
        $clone->default_language = $default_language;
        return $clone;
    }

withDefaultTitle()

ILIAS\ILIASObject\Properties\Translations\Translations::withDefaultTitle

(

string

$title

)

Definition at line 174 of file Translations.php.

                                                   : self
    {
        if ($this->default_language === ''
            || !isset($this->languages[$this->default_language])) {
            return $this;
        }
 
        $clone = clone $this;
        $clone->languages[$clone->default_language] = $clone->languages[$clone->default_language]->withTitle($title);
        return $clone;
    }

Referenced by ilCourseXMLParser\handlerEndTag().

Here is the caller graph for this function:

withLanguage()

ILIAS\ILIASObject\Properties\Translations\Translations::withLanguage

(

Language

$lang

)

Definition at line 122 of file Translations.php.

                                                : self
    {
        $clone = $this;
        $clone->languages[$lang->getLanguageCode()] = $lang;
        if ($lang->isBase() && $this->base_language !== $lang->getLanguageCode()) {
            if ($this->base_language !== null) {
                $clone->languages[$clone->base_language] = $clone->languages[$clone->base_language]->withBase(false);
            }
            $clone->base_language = $lang->getLanguageCode();
        }
 
        if ($lang->isDefault() && $this->default_language !== $lang->getLanguageCode()) {
            if ($this->default_language !== '') {
                $clone->languages[$clone->default_language] = $this->languages[$clone->default_language]->withDefault(false);
            }
            $clone->default_language = $lang->getLanguageCode();
        }
 
        return $clone;
    }

References $lang.

withoutLanguage()

ILIAS\ILIASObject\Properties\Translations\Translations::withoutLanguage

(

string

$lang

)

Definition at line 143 of file Translations.php.

                                                 : self
    {
        if ($lang === $this->base_language) {
            return $this;
        }
 
        $clone = $this;
        unset($clone->languages[$lang]);
        return $clone;
    }

References $lang.

withResetLanguages()

ILIAS\ILIASObject\Properties\Translations\Translations::withResetLanguages

(

)

Definition at line 154 of file Translations.php.

                                        : self
    {
        $clone = clone $this;
        $clone->languages = [];
        return $clone;
    }

---

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

• components/ILIAS/ILIASObject/src/Properties/Translations/Translations.php