ilObjectTranslation Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilObjectTranslation:

Public Member Functions
	setObjId (int $val)
	getObjId ()
	setMasterLanguage (string $val)
	getMasterLanguage ()
	setLanguages (array $val)
	getLanguages ()
	setFallbackLanguage (string $val)
	getFallbackLanguage ()
	addLanguage (string $lang, string $title, string $description, bool $default, bool $force=false)
	getDefaultTitle ()
	setDefaultTitle (string $title)
	getDefaultDescription ()
	setDefaultDescription (string $description)
	getDefaultLanguage ()
	removeLanguage (string $lang)
	getContentActivated ()
	read ()
	delete ()
	deactivateContentTranslation ()
	save ()
	copy (int $obj_id)
	Copy multilingual settings. More...
	getEffectiveContentLang (string $lang, string $parent_type)
	Get effective language for given language. More...

Static Public Member Functions
static	getInstance (int $obj_id)

Protected Member Functions
	setContentActivated (bool $val)

Protected Attributes
ilDBInterface	$db
int	$obj_id
string	$master_lang = ""
array	$languages = []
bool	$content_activated = false
string	$fallback_language = ""

Static Protected Attributes
static array	$instances = []

Private Member Functions
	__construct (int $obj_id)

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning 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 master lang vs. default language

• If no translation mode for the content is active no master lang will be set and no record in table obj_content_master_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 master language must be set (since consent may already exist the language of this content is defined through setting the master language (in obj_content_master_lng). Modules that use this mode will not get informed about this, so they can not internally assign existing content to the master 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 master language

Author

Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Definition at line 47 of file class.ilObjectTranslation.php.

Constructor & Destructor Documentation

__construct()

ilObjectTranslation::__construct ( int  $obj_id )

private

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

References $DIC, read(), and setObjId().

    {
        global $DIC;
        $this->db = $DIC->database();

        $this->setObjId($obj_id);

        if ($obj_id <= 0) {
            throw new ilObjectException("ilObjectTranslation: No object ID passed.");
        }

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

addLanguage()

ilObjectTranslation::addLanguage	(	string	$lang,
		string	$title,
		string	$description,
		bool	$default,
		bool	$force = false
	)

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

References $lang.

Referenced by read().

     : void {
        if ($lang !== "" && (!isset($this->languages[$lang]) || $force)) {
            if ($default) {
                foreach ($this->languages as $l) {
                    $l->setDefault(false);
                }
            }
            $this->languages[$lang] = new ilObjectTranslationLanguage(
                $lang,
                $title,
                $description,
                $default
            );
        }
    }

Here is the caller graph for this function:

copy()

ilObjectTranslation::copy

(

int

$obj_id

)

Copy multilingual settings.

Definition at line 345 of file class.ilObjectTranslation.php.

References getFallbackLanguage(), getLanguages(), and getMasterLanguage().

                                     : ilObjectTranslation
    {
        $target_ml = new ilObjectTranslation($obj_id);
        $target_ml->setMasterLanguage($this->getMasterLanguage());
        $target_ml->setFallbackLanguage($this->getFallbackLanguage());
        $target_ml->setLanguages($this->getLanguages());
        $target_ml->save();
        return $target_ml;
    }

Here is the call graph for this function:

deactivateContentTranslation()

ilObjectTranslation::deactivateContentTranslation

(

)

Definition at line 292 of file class.ilObjectTranslation.php.

                                                  : void
    {
        $this->db->manipulate(
            "DELETE FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
    }

delete()

ilObjectTranslation::delete

(

)

Definition at line 280 of file class.ilObjectTranslation.php.

                            : void
    {
        $this->db->manipulate(
            "DELETE FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
        $this->db->manipulate(
            "DELETE FROM object_translation " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
    }

getContentActivated()

ilObjectTranslation::getContentActivated

(

)

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

References $content_activated.

Referenced by getEffectiveContentLang().

                                         : bool
    {
        return $this->content_activated;
    }

Here is the caller graph for this function:

getDefaultDescription()

ilObjectTranslation::getDefaultDescription

(

)

Definition at line 187 of file class.ilObjectTranslation.php.

References ilObject\_lookupDescription(), getFallbackLanguage(), and getObjId().

Referenced by ilObjStudyProgrammeSettingsGUI\getEditSection().

                                           : string
    {
        if ($this->getFallbackLanguage() !== ''
            && array_key_exists($this->fallback_language, $this->languages)) {
            return $this->languages[$this->getFallbackLanguage()]->getDescription();
        }
        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                return $l->getDescription();
            }
        }
        if (count($this->languages) == 0) {
            return ilObject::_lookupDescription($this->getObjId());
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultLanguage()

ilObjectTranslation::getDefaultLanguage

(

)

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

References getFallbackLanguage().

Referenced by ilObjStudyProgrammeSettingsGUI\getEditSection().

                                        : string
    {
        if ($this->getFallbackLanguage() !== "") {
            return $this->getFallbackLanguage();
        }
        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                return $l->getLanguageCode();
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultTitle()

ilObjectTranslation::getDefaultTitle

(

)

Definition at line 153 of file class.ilObjectTranslation.php.

References $fallback_language, ilObject\_lookupTitle(), and getObjId().

Referenced by ilObject\appendCopyInfoToTranslations(), and ilObjStudyProgrammeSettingsGUI\getEditSection().

                                     : string
    {
        if ($this->fallback_language !== ""
            && array_key_exists($this->fallback_language, $this->languages)) {
            return $this->languages[$this->fallback_language]->getTitle();
        } else {
            foreach ($this->languages as $l) {
                if ($l->isDefault()) {
                    return $l->getTitle();
                }
            }
        }
        if (count($this->languages) == 0) {
            return ilObject::_lookupTitle($this->getObjId());
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getEffectiveContentLang()

ilObjectTranslation::getEffectiveContentLang	(	string	$lang,
		string	$parent_type
	)

Get effective language for given language.

This checks if

• multilingual is activated and
• the given language is part of the available translations If not a "-" is returned (master language).

Parameters

string	$lang	language
string	$parent_type	page parent type

Returns

string effective language ("-" for master)

Definition at line 366 of file class.ilObjectTranslation.php.

References $lang, ilPageObject\_exists(), getContentActivated(), getFallbackLanguage(), getLanguages(), getMasterLanguage(), and getObjId().

                                                                              : string
    {
        $langs = $this->getLanguages();
        $page_lang_key = ($lang == $this->getMasterLanguage())
            ? "-"
            : $lang;
        if ($this->getContentActivated() &&
            isset($langs[$lang]) &&
            ilPageObject::_exists($parent_type, $this->getObjId(), $page_lang_key)) {
            if ($lang == $this->getMasterLanguage()) {
                return "-";
            }
            return $lang;
        }
        if ($this->getContentActivated() &&
            isset($langs[$this->getFallbackLanguage()]) &&
            ilPageObject::_exists($parent_type, $this->getObjId(), $this->getFallbackLanguage())) {
            return $this->getFallbackLanguage();
        }
        return "-";
    }

Here is the call graph for this function:

getFallbackLanguage()

ilObjectTranslation::getFallbackLanguage

(

)

Definition at line 126 of file class.ilObjectTranslation.php.

References $fallback_language.

Referenced by copy(), getDefaultDescription(), getDefaultLanguage(), getEffectiveContentLang(), ilLMPresentationStatus\getLMPresentationTitle(), save(), setDefaultDescription(), and setDefaultTitle().

                                         : string
    {
        return $this->fallback_language;
    }

Here is the caller graph for this function:

getInstance()

static ilObjectTranslation::getInstance ( int  $obj_id )

static

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

References $obj_id.

Referenced by ILIAS\Container\Page\PageManager\__construct(), ilPageMultiLangGUI\__construct(), ilLMPresentationStatus\__construct(), ILIAS\LearningModule\Export\LMHtmlExport\__construct(), ilLMContentRendererGUI\__construct(), ilContainer\_exportContainerSettings(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilObject\appendCopyInfo(), ilObject\appendCopyInfoToTranslations(), ilObjContentObjectGUI\checkCtrlPath(), ilContainer\create(), ilObjContentPage\doCloneObject(), ilObjItemGroup\doCloneObject(), ilObjItemGroup\doCreate(), ilObjContentObject\doMDUpdateListener(), ilObjItemGroup\doUpdate(), ilObjMediaPoolGUI\executeCommand(), ilObjContentObjectGUI\export(), ilObjMediaPoolGUI\export(), ilObjContentObjectGUI\exportHTML(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData(), ilContentPagePageCommandForwarder\forward(), ilContainerGUI\getContainerPageHTML(), ilObjectDataSet\getDependencies(), ilObjMediaPoolGUI\getEditFormCustomValues(), ILIAS\COPage\Page\PageQueryActionHandler\getMultiLangActions(), ilObjContentObjectGUI\getMultiLangHeader(), ILIAS\COPage\Page\PageQueryActionHandler\getMultiLangInfo(), ilObjContentPageListGUI\getProperties(), ilObjContentObjectGUI\getPropertiesFormValues(), ilObjContentObject\getPublicExportFiles(), ilCourseXMLParser\handlerEndTag(), ilLMImportGUI\importTranslation(), ilLMPresentationGUI\initByRequest(), ilMediaPoolImportGUI\initTranslationImportForm(), ilLMImportGUI\initTranslationImportForm(), ilObjContentPage\initTranslationService(), ilContainer\read(), ilObjContentObjectGUI\saveProperties(), ilObjMediaPoolGUI\updateCustom(), and ilObjContentObject\validatePages().

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

        return self::$instances[$obj_id];
    }

Here is the caller graph for this function:

getLanguages()

ilObjectTranslation::getLanguages

(

)

Returns

array array of language codes

Definition at line 116 of file class.ilObjectTranslation.php.

References $languages.

Referenced by ilObject\appendCopyInfoToTranslations(), copy(), getEffectiveContentLang(), ilLMPresentationStatus\getLMPresentationTitle(), ILIAS\LearningModule\Export\LMHtmlExport\initDirectories(), and save().

                                  : array
    {
        return $this->languages;
    }

Here is the caller graph for this function:

getMasterLanguage()

ilObjectTranslation::getMasterLanguage

(

)

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

References $master_lang.

Referenced by copy(), getEffectiveContentLang(), removeLanguage(), and save().

                                       : string
    {
        return $this->master_lang;
    }

Here is the caller graph for this function:

getObjId()

ilObjectTranslation::getObjId

(

)

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

References $obj_id.

Referenced by getDefaultDescription(), getDefaultTitle(), getEffectiveContentLang(), read(), and save().

                              : int
    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

read()

ilObjectTranslation::read

(

)

Definition at line 251 of file class.ilObjectTranslation.php.

References addLanguage(), getObjId(), setContentActivated(), setFallbackLanguage(), setLanguages(), and setMasterLanguage().

Referenced by __construct().

                          : void
    {
        $sql =
            "SELECT obj_id, master_lang, fallback_lang" . PHP_EOL
            . "FROM obj_content_master_lng" . PHP_EOL
            . "WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer") . PHP_EOL
        ;
        $result = $this->db->query($sql);
        if ($row = $this->db->fetchAssoc($result)) {
            $this->setMasterLanguage($row["master_lang"]);
            $this->setFallbackLanguage($row["fallback_lang"] ?? '');
            $this->setContentActivated(true);
        } else {
            $this->setContentActivated(false);
        }

        $this->setLanguages([]);

        $sql =
            "SELECT title, description, lang_code, lang_default" . PHP_EOL
            . "FROM object_translation" . PHP_EOL
            . "WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer") . PHP_EOL
        ;
        $result = $this->db->query($sql);
        while ($row = $this->db->fetchAssoc($result)) {
            $this->addLanguage($row["lang_code"], (string) $row["title"], (string) $row["description"], (bool) $row["lang_default"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeLanguage()

ilObjectTranslation::removeLanguage

(

string

$lang

)

Definition at line 234 of file class.ilObjectTranslation.php.

References getMasterLanguage().

                                                : void
    {
        if ($lang != $this->getMasterLanguage()) {
            unset($this->languages[$lang]);
        }
    }

Here is the call graph for this function:

save()

ilObjectTranslation::save

(

)

Definition at line 300 of file class.ilObjectTranslation.php.

References getFallbackLanguage(), getLanguages(), getMasterLanguage(), and getObjId().

                          : void
    {
        $this->delete();

        if ($this->getMasterLanguage() != "") {
            $values = [
                "obj_id" => ["integer", $this->getObjId()],
                "master_lang" => ["text", $this->getMasterLanguage()],
                "fallback_lang" => ["text", $this->getFallbackLanguage()]
            ];

            $this->db->insert("obj_content_master_lng", $values);
            // ensure that an entry for the master language exists and is the default
            if (!isset($this->languages[$this->getMasterLanguage()])) {
                $this->languages[$this->getMasterLanguage()] = new ilObjectTranslationLanguage(
                    "",
                    "",
                    $this->getMasterLanguage(),
                    true
                );
            }
            foreach ($this->languages as $trans) {
                if ($trans->getLanguageCode() === $this->getMasterLanguage()) {
                    $trans->setDefault(true);
                } else {
                    $trans->setDefault(false);
                }
            }
        }

        foreach ($this->getLanguages() as $trans) {
            $values = [
                "obj_id" => ["integer", $this->getObjId()],
                "title" => ["text", $trans->getTitle()],
                "description" => ["text", $trans->getDescription()],
                "lang_code" => ["text", $trans->getLanguageCode()],
                "lang_default" => ["integer", $trans->isDefault()],
            ];
            $this->db->insert("object_translation", $values);
        }
    }

Here is the call graph for this function:

setContentActivated()

ilObjectTranslation::setContentActivated ( bool  $val )

protected

Definition at line 241 of file class.ilObjectTranslation.php.

Referenced by read().

                                                     : void
    {
        $this->content_activated = $val;
    }

Here is the caller graph for this function:

setDefaultDescription()

ilObjectTranslation::setDefaultDescription

(

string

$description

)

Definition at line 204 of file class.ilObjectTranslation.php.

References getFallbackLanguage().

                                                              : void
    {
        if ($this->getFallbackLanguage() !== ''
            && isset($this->languages[$this->getFallbackLanguage()])) {
            $this->languages[$this->getFallbackLanguage()]
                ->setDescription($description);
            return;
        }

        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                $l->setDescription($description);
                return;
            }
        }
    }

Here is the call graph for this function:

setDefaultTitle()

ilObjectTranslation::setDefaultTitle

(

string

$title

)

Definition at line 171 of file class.ilObjectTranslation.php.

References getFallbackLanguage().

                                                  : void
    {
        if ($this->getFallbackLanguage() !== ''
            && isset($this->languages[$this->getFallbackLanguage()])) {
            $this->languages[$this->getFallbackLanguage()]->setTitle($title);
            return;
        }

        foreach ($this->languages as $l) {
            if ($l->isDefault()) {
                $l->setTitle($title);
                return;
            }
        }
    }

Here is the call graph for this function:

setFallbackLanguage()

ilObjectTranslation::setFallbackLanguage

(

string

$val

)

Definition at line 121 of file class.ilObjectTranslation.php.

Referenced by read().

                                                    : void
    {
        $this->fallback_language = $val;
    }

Here is the caller graph for this function:

setLanguages()

ilObjectTranslation::setLanguages

(

array

$val

)

Parameters

array

$val

array of language codes

Definition at line 108 of file class.ilObjectTranslation.php.

Referenced by ilObject\appendCopyInfoToTranslations(), and read().

                                            : void
    {
        $this->languages = $val;
    }

Here is the caller graph for this function:

setMasterLanguage()

ilObjectTranslation::setMasterLanguage

(

string

$val

)

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

Referenced by read().

                                                  : void
    {
        $this->master_lang = $val;
    }

Here is the caller graph for this function:

setObjId()

ilObjectTranslation::setObjId

(

int

$val

)

Definition at line 85 of file class.ilObjectTranslation.php.

Referenced by __construct().

                                      : void
    {
        $this->obj_id = $val;
    }

Here is the caller graph for this function:

Field Documentation

$content_activated

bool ilObjectTranslation::$content_activated = false

protected

Definition at line 59 of file class.ilObjectTranslation.php.

Referenced by getContentActivated().

$db

ilDBInterface ilObjectTranslation::$db

protected

Definition at line 51 of file class.ilObjectTranslation.php.

$fallback_language

string ilObjectTranslation::$fallback_language = ""

protected

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

Referenced by getDefaultTitle(), and getFallbackLanguage().

$instances

array ilObjectTranslation::$instances = []

staticprotected

Definition at line 49 of file class.ilObjectTranslation.php.

$languages

array ilObjectTranslation::$languages = []

protected

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

Referenced by getLanguages().

$master_lang

string ilObjectTranslation::$master_lang = ""

protected

Definition at line 54 of file class.ilObjectTranslation.php.

Referenced by getMasterLanguage().

$obj_id

int ilObjectTranslation::$obj_id

protected

Definition at line 52 of file class.ilObjectTranslation.php.

Referenced by getInstance(), and getObjId().

---

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

• Services/Object/classes/Translation/class.ilObjectTranslation.php