ilMultilingualism Class Reference

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

Collaboration diagram for ilMultilingualism:

Public Member Functions
	setObjId ($a_val)
	Set object id. More...
	getObjId ()
	Get object id. More...
	setLanguages (array $a_val)
	Set languages. More...
	getLanguages ()
	Get languages. More...
	getType ()
	setType ($type)
	getDefaultLanguage ()
	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...
	removeLanguage ($a_lang)
	Remove language. More...
	read ()
	Read. More...
	delete ()
	Delete. More...
	save ()
	Save. More...
	copy ($a_obj_id)
	Copy multilinguality settings. More...
	toXml (ilXmlWriter $writer)
	Export. More...
	fromXML (SimpleXMLElement $root)
	xml import More...

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

Protected Attributes
	$lng
	$db
	$obj_id
	$languages = array()
	$type = ""

Static Protected Attributes
static	$instances = array()

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

Detailed Description

Class handles translation mode for an object.

Author

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

Version

$Id$

Definition at line 12 of file class.ilMultilingualism.php.

Constructor & Destructor Documentation

__construct()

ilMultilingualism::__construct (   $a_obj_id,   $a_type  )

private

Constructor.

Parameters

int	$a_obj_id	object id
string	$a_type	id type

Exceptions

ilObjectException

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

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

    {
        global $DIC;

        $this->lng = $DIC->language();
        $ilDB = $DIC->database();

        $this->db = $ilDB;

        $this->setObjId($a_obj_id);
        $this->setType($a_type);

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

ilMultilingualism::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 146 of file class.ilMultilingualism.php.

Referenced by fromXML(), and 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()

ilMultilingualism::copy

(

$a_obj_id

)

Copy multilinguality settings.

Parameters

string	$a_type	parent object type
int	$a_obj_id	parent object id

Returns

ilObjectTranslation target multilang object

Definition at line 285 of file class.ilMultilingualism.php.

References getLanguages(), and getType().

    {
        $target_ml = new self($a_obj_id, $this->getType());
        $target_ml->setLanguages($this->getLanguages());
        $target_ml->save();
        return $target_ml;
    }

Here is the call graph for this function:

delete()

ilMultilingualism::delete

(

)

Delete.

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

    {
        $this->db->manipulate(
            "DELETE FROM il_translations " .
            " WHERE id = " . $this->db->quote($this->getObjId(), "integer") .
            " AND id_type = " . $this->db->quote($this->getType(), "text")
        );
    }

fromXML()

ilMultilingualism::fromXML

(

SimpleXMLElement

$root

)

xml import

Parameters

SimpleXMLElement

$root

Returns

mixed

Definition at line 321 of file class.ilMultilingualism.php.

References addLanguage().

    {
        if ($root->translations) {
            $root = $root->translations;
        }
        
        foreach ($root->translation as $trans) {
            $this->addLanguage(
                (string) trim($trans["language"]),
                (string) trim($trans->title),
                (string) trim($trans->description),
                (int) $trans["default"] != 0?true:false
                );
        }
    }

Here is the call graph for this function:

getDefaultDescription()

ilMultilingualism::getDefaultDescription

(

)

Get default description.

Returns

string description of default language

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

    {
        foreach ($this->languages as $l) {
            if ($l["lang_default"]) {
                return $l["description"];
            }
        }
        return "";
    }

getDefaultLanguage()

ilMultilingualism::getDefaultLanguage

(

)

Definition at line 124 of file class.ilMultilingualism.php.

References $lng.

Referenced by removeLanguage().

    {
        $lng = $this->lng;
        
        foreach ($this->languages as $k => $v) {
            if ($v["lang_default"]) {
                return $k;
            }
        }
        
        return $lng->getDefaultLanguage();
    }

Here is the caller graph for this function:

getDefaultTitle()

ilMultilingualism::getDefaultTitle

(

)

Get default title.

Returns

string title of default language

Definition at line 164 of file class.ilMultilingualism.php.

    {
        foreach ($this->languages as $l) {
            if ($l["lang_default"]) {
                return $l["title"];
            }
        }
        return "";
    }

getInstance()

static ilMultilingualism::getInstance (   $a_obj_id,   $a_type  )

static

Get instance.

Parameters

integer

$a_obj_id

(repository) object id

Returns

ilMultilingualism translation object

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

Referenced by ilMultilingualismGUI\__construct(), ilDidacticTemplateSetting\getTranslationObject(), and ilDidacticTemplateImport\parseSettings().

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

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

Here is the caller graph for this function:

getLanguages()

ilMultilingualism::getLanguages

(

)

Get languages.

Returns

array array of language codes

Definition at line 103 of file class.ilMultilingualism.php.

References $languages.

Referenced by copy(), save(), and toXml().

    {
        return $this->languages;
    }

Here is the caller graph for this function:

getObjId()

ilMultilingualism::getObjId

(

)

Get object id.

Returns

int object id

Definition at line 83 of file class.ilMultilingualism.php.

References $obj_id.

Referenced by __construct().

    {
        return $this->obj_id;
    }

Here is the caller graph for this function:

getType()

ilMultilingualism::getType

(

)

Returns

string

Definition at line 111 of file class.ilMultilingualism.php.

References $type.

Referenced by copy().

    {
        return $this->type;
    }

Here is the caller graph for this function:

read()

ilMultilingualism::read

(

)

Read.

Definition at line 233 of file class.ilMultilingualism.php.

References addLanguage(), and setLanguages().

Referenced by __construct().

    {
        $this->setLanguages(array());
        $set = $this->db->query(
            "SELECT * FROM il_translations " .
            " WHERE id = " . $this->db->quote($this->getObjId(), "integer") .
            " AND id_type = " . $this->db->quote($this->getType(), "text")
        );
        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()

ilMultilingualism::removeLanguage

(

$a_lang

)

Remove language.

Parameters

string

$a_lang

language code

Definition at line 223 of file class.ilMultilingualism.php.

References getDefaultLanguage().

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

Here is the call graph for this function:

save()

ilMultilingualism::save

(

)

Save.

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

References getLanguages().

    {
        $this->delete();

        foreach ($this->getLanguages() as $l => $trans) {
            $this->db->manipulate($t = "INSERT INTO il_translations " .
                "(id, id_type, title, description, lang_code, lang_default) VALUES (" .
                $this->db->quote($this->getObjId(), "integer") . "," .
                $this->db->quote($this->getType(), "text") . "," .
                $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:

setDefaultDescription()

ilMultilingualism::setDefaultDescription

(

$a_description

)

Set default description.

Parameters

string

$a_description

description

Definition at line 208 of file class.ilMultilingualism.php.

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

setDefaultTitle()

ilMultilingualism::setDefaultTitle

(

$a_title

)

Set default title.

Parameters

string

$a_title

title

Definition at line 179 of file class.ilMultilingualism.php.

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

setLanguages()

ilMultilingualism::setLanguages

(

array

$a_val

)

Set languages.

Parameters

array

$a_val

array of language codes

Definition at line 93 of file class.ilMultilingualism.php.

Referenced by read().

    {
        $this->languages = $a_val;
    }

Here is the caller graph for this function:

setObjId()

ilMultilingualism::setObjId

(

$a_val

)

Set object id.

Parameters

int

$a_val

object id

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

Referenced by __construct().

    {
        $this->obj_id = $a_val;
    }

Here is the caller graph for this function:

setType()

ilMultilingualism::setType

(

$type

)

Parameters

string

$type

Definition at line 119 of file class.ilMultilingualism.php.

References $type.

Referenced by __construct().

    {
        $this->type = $type;
    }

Here is the caller graph for this function:

toXml()

ilMultilingualism::toXml

(

ilXmlWriter

$writer

)

Export.

Parameters

ilXmlWriter

$writer

Returns

ilXmlWriter

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

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

    {
        $writer->xmlStartTag('translations');
        
        foreach ($this->getLanguages() as $k => $v) {
            $writer->xmlStartTag('translation', array('language' => $k, 'default' => $v['lang_default'] ? 1 : 0));
            $writer->xmlElement('title', array(), $v['title']);
            $writer->xmlElement('description', array(), $v['description']);
            $writer->xmlEndTag('translation');
        }
        $writer->xmlEndTag('translations');

        return $writer;
    }

Here is the call graph for this function:

Field Documentation

$db

ilMultilingualism::$db

protected

Definition at line 19 of file class.ilMultilingualism.php.

$instances

ilMultilingualism::$instances = array()

staticprotected

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

$languages

ilMultilingualism::$languages = array()

protected

Definition at line 21 of file class.ilMultilingualism.php.

Referenced by getLanguages().

$lng

ilMultilingualism::$lng

protected

Definition at line 17 of file class.ilMultilingualism.php.

Referenced by getDefaultLanguage().

$obj_id

ilMultilingualism::$obj_id

protected

Definition at line 20 of file class.ilMultilingualism.php.

Referenced by getObjId().

$type

ilMultilingualism::$type = ""

protected

Definition at line 22 of file class.ilMultilingualism.php.

Referenced by getType(), and setType().

---

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

• Services/Multilingualism/classes/class.ilMultilingualism.php