ilObjectTranslation Class Reference

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

Collaboration diagram for ilObjectTranslation:

Public Member Functions
	setObjId ($a_val)
	Set object id. More...
	getObjId ()
	Get object id. More...
	setMasterLanguage ($a_val)
	Set master language. More...
	getMasterLanguage ()
	Get master language. More...
	setLanguages (array $a_val)
	Set languages. More...
	getLanguages ()
	Get languages. More...
	setFallbackLanguage ($a_val)
	Set fallback language. More...
	getFallbackLanguage ()
	Get fallback language. More...
	addLanguage ($a_lang, $a_title, $a_description, $a_default, $a_force=false)
	Add language. More...
	getDefaultTitle ()
	Get default title. More...
	setDefaultTitle ($a_title)
	Set default title. More...
	getDefaultDescription ()
	Get default description. More...
	setDefaultDescription ($a_description)
	Set default description. More...
	getDefaultLanguage ()
	Get default language. More...
	removeLanguage ($a_lang)
	Remove language. More...
	getContentActivated ()
	Get activated for content. More...
	read ()
	Read. More...
	delete ()
	Delete. More...
	deactivateContentTranslation ()
	Deactivate content translation. More...
	save ()
	Save. More...
	copy ($a_obj_id)
	Copy multilinguality settings. More...
	getEffectiveContentLang ($a_lang, $a_parent_type)
	Get effective language for given language. More...

Static Public Member Functions
static	getInstance ($a_obj_id)
	Get instance. More...

Protected Member Functions
	setContentActivated ($a_val)
	Set activated for content. More...

Protected Attributes
	$db
	$obj_id
	$master_lang
	$languages = array()
	$content_activated = false
	$fallback_language = ""

Static Protected Attributes
static	$instances = array()

Private Member Functions
	__construct ($a_obj_id)
	Constructor. More...

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 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 concent 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

Version

$Id$

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

Constructor & Destructor Documentation

__construct()

ilObjectTranslation::__construct (   $a_obj_id )

private

Constructor.

Parameters

int

$a_obj_id

object id

Exceptions

ilObjectException

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

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

    {
        global $DIC;

        $ilDB = $DIC->database();

        $this->db = $ilDB;

        $this->setObjId($a_obj_id);

        if ($this->getObjId() <= 0) {
            include_once("./Services/Object/exceptions/class.ilObjectException.php");
            throw new ilObjectException("ilObjectTranslation: No object ID passed.");
        }

        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

addLanguage()

ilObjectTranslation::addLanguage	(		$a_lang,
			$a_title,
			$a_description,
			$a_default,
			$a_force = false
	)

Add language.

Parameters

string	$a_lang	language
string	$a_title	title
string	$a_description	description
bool	$a_default	default language?

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

Referenced by read().

    {
        if ($a_lang != "" && (!isset($this->languages[$a_lang]) || $a_force)) {
            if ($a_default) {
                foreach ($this->languages as $k => $l) {
                    $this->languages[$k]["lang_default"] = false;
                }
            }
            $this->languages[$a_lang] = array("lang_code" => $a_lang, "lang_default" => $a_default,
                "title" => $a_title, "description" => $a_description);
        }
    }

Here is the caller graph for this function:

copy()

ilObjectTranslation::copy

(

$a_obj_id

)

Copy multilinguality settings.

Parameters

string	$a_target_parent_type	parent object type
int	$a_target_parent_id	parent object id

Returns

ilObjectTranslation target multilang object

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

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

    {
        $target_ml = new ilObjectTranslation($a_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

(

)

Deactivate content translation.

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

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

delete()

ilObjectTranslation::delete

(

)

Delete.

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

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

(

)

Get activated for content.

Returns

bool activated for content?

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

References $content_activated.

Referenced by getEffectiveContentLang().

    {
        return $this->content_activated;
    }

Here is the caller graph for this function:

getDefaultDescription()

ilObjectTranslation::getDefaultDescription

(

)

Get default description.

Returns

string description of default language

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

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

Referenced by ilObjStudyProgrammeSettingsGUI\getEditSection().

    {
        if ($this->getFallbackLanguage() != "") {
            return $this->languages[$this->getFallbackLanguage()]["description"];
        }
        foreach ($this->languages as $l) {
            if ($l["lang_default"]) {
                return $l["description"];
            }
        }
        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

(

)

Get default language.

Returns

string default language

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

References getFallbackLanguage().

Referenced by ilObjStudyProgrammeSettingsGUI\getEditSection().

    {
        if ($this->getFallbackLanguage() != "") {
            return $this->getFallbackLanguage();
        }
        foreach ($this->languages as $l) {
            if ($l["lang_default"]) {
                return $l["lang_code"];
            }
        }
        return "";
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDefaultTitle()

ilObjectTranslation::getDefaultTitle

(

)

Get default title.

Returns

string title of default language

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

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

Referenced by ilObjStudyProgrammeSettingsGUI\getEditSection().

    {
        if ($this->getFallbackLanguage() != "") {
            return $this->languages[$this->getFallbackLanguage()]["title"];
        } else {
            foreach ($this->languages as $l) {
                if ($l["lang_default"]) {
                    return $l["title"];
                }
            }
        }
        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	(		$a_lang,
			$a_parent_type
	)

Get effective language for given language.

This checks if

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

Parameters

string	$a_lang	language
string	$a_parent_type	page parent type

Returns

string effective language ("-" for master)

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

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

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

Here is the call graph for this function:

getFallbackLanguage()

ilObjectTranslation::getFallbackLanguage

(

)

Get fallback language.

Returns

string

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

References $fallback_language.

Referenced by copy(), getDefaultDescription(), getDefaultLanguage(), getDefaultTitle(), getEffectiveContentLang(), setDefaultDescription(), and setDefaultTitle().

    {
        return $this->fallback_language;
    }

Here is the caller graph for this function:

getInstance()

static ilObjectTranslation::getInstance (   $a_obj_id )

static

Get instance.

Parameters

integer

$a_obj_id

(repository) object id

Returns

ilObjectTranslation translation object

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

Referenced by ilLMPresentationStatus\__construct(), ilPageMultiLangGUI\__construct(), ilObjectTranslationGUI\__construct(), ILIAS\LearningModule\Export\LMHtmlExport\__construct(), ilLMContentRendererGUI\__construct(), ilContainer\__construct(), ilContainer\_exportContainerSettings(), ilStructureObject\_getPresentationTitle(), ilLMPageObject\_getPresentationTitle(), ilObjContentObject\cloneObject(), ilContainer\create(), ilObjMediaPoolGUI\executeCommand(), ilObjContentObjectGUI\executeCommand(), ilObjContentObjectGUI\export(), ilObjMediaPoolGUI\export(), ilObjContentObjectGUI\exportHTML(), ilContentPagePageCommandForwarder\forward(), ilContainerGUI\getContainerPageHTML(), ILIAS\COPage\Editor\Components\Page\PageQueryActionHandler\getMultiLangActions(), ilObjContentObjectGUI\getMultiLangHeader(), ILIAS\COPage\Editor\Components\Page\PageQueryActionHandler\getMultiLangInfo(), ilObjContentPageListGUI\getProperties(), ilObjContentObjectGUI\getPropertiesFormValues(), ilObjContentObject\getPublicExportFiles(), ilObjectDataSet\importRecord(), ilLMImportGUI\importTranslation(), ilMediaPoolImportGUI\importTranslation(), ilLMPresentationGUI\initByRequest(), ilMediaPoolImportGUI\initTranslationImportForm(), ilLMImportGUI\initTranslationImportForm(), ilObjContentPage\initTranslationService(), ilObjContentObject\MDUpdateListener(), ilContainer\read(), ilObjContentObjectGUI\saveProperties(), and ilObjContentPage\writeStyleSheetId().

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

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

Here is the caller graph for this function:

getLanguages()

ilObjectTranslation::getLanguages

(

)

Get languages.

Returns

array array of language codes

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

References $languages.

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

    {
        return $this->languages;
    }

Here is the caller graph for this function:

getMasterLanguage()

ilObjectTranslation::getMasterLanguage

(

)

Get master language.

Returns

string master language

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

References $master_lang.

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

    {
        return $this->master_lang;
    }

Here is the caller graph for this function:

getObjId()

ilObjectTranslation::getObjId

(

)

Get object id.

Returns

int object id

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

References $obj_id.

Referenced by __construct(), getDefaultDescription(), getDefaultTitle(), and getEffectiveContentLang().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

read()

ilObjectTranslation::read

(

)

Read.

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

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

Referenced by __construct().

    {
        $set = $this->db->query(
            "SELECT * FROM obj_content_master_lng " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
        if ($rec = $this->db->fetchAssoc($set)) {
            $this->setMasterLanguage($rec["master_lang"]);
            $this->setFallbackLanguage($rec["fallback_lang"]);
            $this->setContentActivated(true);
        } else {
            $this->setContentActivated(false);
        }

        $this->setLanguages(array());
        $set = $this->db->query(
            "SELECT * FROM object_translation " .
            " WHERE obj_id = " . $this->db->quote($this->getObjId(), "integer")
        );
        while ($rec = $this->db->fetchAssoc($set)) {
            $this->addLanguage($rec["lang_code"], $rec["title"], $rec["description"], $rec["lang_default"]);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

removeLanguage()

ilObjectTranslation::removeLanguage

(

$a_lang

)

Remove language.

Parameters

string

$a_lang

language code

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

References getMasterLanguage().

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

Here is the call graph for this function:

save()

ilObjectTranslation::save

(

)

Save.

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

References getLanguages(), and getMasterLanguage().

    {
        $this->delete();

        if ($this->getMasterLanguage() != "") {
            $this->db->manipulate("INSERT INTO obj_content_master_lng " .
                "(obj_id, master_lang, fallback_lang) VALUES (" .
                $this->db->quote($this->getObjId(), "integer") . "," .
                $this->db->quote($this->getMasterLanguage(), "text") . "," .
                $this->db->quote($this->getFallbackLanguage(), "text") .
                ")");
            // ensure that an entry for the master language exists and is the default
            if (!isset($this->languages[$this->getMasterLanguage()])) {
                $this->languages[$this->getMasterLanguage()] = array("title" => "",
                    "description" => "", "lang_code" => $this->getMasterLanguage(), "lang_default" => 1);
            }
            foreach ($this->languages as $l => $trans) {
                if ($l == $this->getMasterLanguage()) {
                    $this->languages[$l]["lang_default"] = 1;
                } else {
                    $this->languages[$l]["lang_default"] = 0;
                }
            }
        }
        foreach ($this->getLanguages() as $l => $trans) {
            $this->db->manipulate($t = "INSERT INTO object_translation " .
                "(obj_id, title, description, lang_code, lang_default) VALUES (" .
                $this->db->quote($this->getObjId(), "integer") . "," .
                $this->db->quote($trans["title"], "text") . "," .
                $this->db->quote($trans["description"], "text") . "," .
                $this->db->quote($l, "text") . "," .
                $this->db->quote($trans["lang_default"], "integer") .
                ")");
        }
    }

Here is the call graph for this function:

setContentActivated()

ilObjectTranslation::setContentActivated (   $a_val )

protected

Set activated for content.

Parameters

bool

$a_val

activated for content?

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

Referenced by read().

    {
        $this->content_activated = $a_val;
    }

Here is the caller graph for this function:

setDefaultDescription()

ilObjectTranslation::setDefaultDescription

(

$a_description

)

Set default description.

Parameters

string

$a_description

description

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

References getFallbackLanguage().

    {
        if ($this->getFallbackLanguage() != "") {
            $this->languages[$this->getFallbackLanguage()]["description"] = $a_description;
        } else {
            foreach ($this->languages as $k => $l) {
                if ($l["lang_default"]) {
                    $this->languages[$k]["description"] = $a_description;
                }
            }
        }
    }

Here is the call graph for this function:

setDefaultTitle()

ilObjectTranslation::setDefaultTitle

(

$a_title

)

Set default title.

Parameters

string

$a_title

title

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

References getFallbackLanguage().

    {
        if ($this->getFallbackLanguage() != "") {
            $this->languages[$this->getFallbackLanguage()]["title"] = $a_title;
        } else {
            foreach ($this->languages as $k => $l) {
                if ($l["lang_default"]) {
                    $this->languages[$k]["title"] = $a_title;
                }
            }
        }
    }

Here is the call graph for this function:

setFallbackLanguage()

ilObjectTranslation::setFallbackLanguage

(

$a_val

)

Set fallback language.

Parameters

string

$a_val

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

Referenced by read().

    {
        $this->fallback_language = $a_val;
    }

Here is the caller graph for this function:

setLanguages()

ilObjectTranslation::setLanguages

(

array

$a_val

)

Set languages.

Parameters

array

$a_val

array of language codes

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

Referenced by read().

    {
        $this->languages = $a_val;
    }

Here is the caller graph for this function:

setMasterLanguage()

ilObjectTranslation::setMasterLanguage

(

$a_val

)

Set master language.

Parameters

string

$a_val

master language

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

Referenced by read().

    {
        $this->master_lang = $a_val;
    }

Here is the caller graph for this function:

setObjId()

ilObjectTranslation::setObjId

(

$a_val

)

Set object id.

Parameters

int

$a_val

object id

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

Referenced by __construct().

    {
        $this->obj_id = $a_val;
    }

Here is the caller graph for this function:

Field Documentation

$content_activated

ilObjectTranslation::$content_activated = false

protected

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

Referenced by getContentActivated().

$db

ilObjectTranslation::$db

protected

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

$fallback_language

ilObjectTranslation::$fallback_language = ""

protected

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

Referenced by getFallbackLanguage().

$instances

ilObjectTranslation::$instances = array()

staticprotected

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

$languages

ilObjectTranslation::$languages = array()

protected

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

Referenced by getLanguages().

$master_lang

ilObjectTranslation::$master_lang

protected

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

Referenced by getMasterLanguage().

$obj_id

ilObjectTranslation::$obj_id

protected

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

Referenced by getObjId().

---

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

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