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

Collaboration diagram for ilMultilingualism:

Public Member Functions
	setObjId (int $a_val)

	getObjId ()

	setLanguages (array $a_val)

	getLanguages ()

	getType ()

	setType (string $type)

	getDefaultLanguage ()

	addLanguage (string $a_lang, string $a_title, string $a_description, bool $a_default, bool $a_force=false)
	Add language. More...

	getDefaultTitle ()
	Get default title. More...

	setDefaultTitle (string $a_title)
	Set title for default language. More...

	getDefaultDescription ()

	setDefaultDescription (string $a_description)
	Set default description. More...

	removeLanguage (string $a_lang)

	read ()

	delete ()

	save ()

	copy (int $a_obj_id)
	Copy multilinguality settings. More...

	toXml (ilXmlWriter $writer)
	Export to xml. More...

	fromXML (SimpleXMLElement $root)
	xml import More...

Static Public Member Functions
static	getInstance (int $a_obj_id, string $a_type)

Protected Attributes
ilLanguage	$lng

ilDBInterface	$db

int	$obj_id

array	$languages = []

string	$type = ""

Static Protected Attributes
static array	$instances = []

Private Member Functions
	__construct (int $a_obj_id, string $a_type)

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.

Author: Alexander Killing killi.nosp@m.ng@l.nosp@m.eifos.nosp@m..de

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

Constructor & Destructor Documentation

◆ __construct()

ilMultilingualism::__construct	(	int	$a_obj_id,
		string	$a_type
	)

private

Exceptions

ilObjectException

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

References $DIC, $ilDB, getObjId(), ILIAS\Repository\lng(), 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) {
             throw new ilObjectException("ilObjectTranslation: No object ID passed.");
         }
 
         $this->read();
     }

Here is the call graph for this function:

Member Function Documentation

◆ addLanguage()

ilMultilingualism::addLanguage	(	string	$a_lang,
		string	$a_title,
		string	$a_description,
		bool	$a_default,
		bool	$a_force = `false`
	)

Add language.

Parameters

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

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

Referenced by fromXML(), and read().

      : void {
         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] = [
                 "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 ( int $a_obj_id )

Copy multilinguality settings.

Exceptions

ilObjectException

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

References getLanguages(), and getType().

                                        : self
     {
         $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 ( )

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

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

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

References addLanguage().

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

Here is the call graph for this function:

◆ getDefaultDescription()

ilMultilingualism::getDefaultDescription ( )

Returns: string description of default language

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

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

◆ getDefaultLanguage()

ilMultilingualism::getDefaultLanguage ( )

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

References $lng, and ilLanguage\getDefaultLanguage().

Referenced by removeLanguage().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDefaultTitle()

ilMultilingualism::getDefaultTitle ( )

Get default title.

Returns: string title of default language

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

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

◆ getInstance()

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

static

Parameters

int $a_obj_id (repository) object id

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

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

                                                                      : self
     {
         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 ( )

Returns: array<string, array{lang_code: string, lang_default: bool, title: string, description: string}>

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

References $languages.

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

                                   : array
     {
         return $this->languages;
     }

Here is the caller graph for this function:

◆ getObjId()

ilMultilingualism::getObjId ( )

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

References $obj_id.

Referenced by __construct().

                               : int
     {
         return $this->obj_id;
     }

Here is the caller graph for this function:

◆ getType()

ilMultilingualism::getType ( )

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

References $type.

Referenced by copy().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ read()

ilMultilingualism::read ( )

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

References addLanguage(), and setLanguages().

Referenced by __construct().

                           : void
     {
         $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"],
                 (string) $rec["title"],
                 (string) $rec["description"],
                 (bool) $rec["lang_default"]
             );
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeLanguage()

ilMultilingualism::removeLanguage ( string $a_lang )

Parameters

string $a_lang language code

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

References getDefaultLanguage().

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

Here is the call graph for this function:

◆ save()

ilMultilingualism::save ( )

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

References getLanguages().

                           : void
     {
         $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 ( string $a_description )

Set default description.

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

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

◆ setDefaultTitle()

ilMultilingualism::setDefaultTitle ( string $a_title )

Set title for default language.

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

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

◆ setLanguages()

ilMultilingualism::setLanguages ( array $a_val )

Parameters

array<string,array{lang_code string, lang_default: bool, title: string, description: string}> $a_val

Returns: void

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

Referenced by read().

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

Here is the caller graph for this function:

◆ setObjId()

ilMultilingualism::setObjId ( int $a_val )

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

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setType()

ilMultilingualism::setType ( string $type )

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

References $type.

Referenced by __construct().

                                          : void
     {
         $this->type = $type;
     }

Here is the caller graph for this function:

◆ toXml()

ilMultilingualism::toXml ( ilXmlWriter $writer )

Export to xml.

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

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

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

ilDBInterface ilMultilingualism::$db

protected

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

◆ $instances

array ilMultilingualism::$instances = []

staticprotected

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

◆ $languages

array ilMultilingualism::$languages = []

protected

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

Referenced by getLanguages().

◆ $lng

ilLanguage ilMultilingualism::$lng

protected

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

Referenced by getDefaultLanguage().

◆ $obj_id

int ilMultilingualism::$obj_id

protected

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

Referenced by getObjId().

◆ $type

string ilMultilingualism::$type = ""

protected

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

Referenced by getType(), and setType().

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

components/ILIAS/Multilingualism/classes/class.ilMultilingualism.php

Public Member Functions

Static Public Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addLanguage()

◆ copy()

◆ delete()

◆ fromXML()

◆ getDefaultDescription()

◆ getDefaultLanguage()

◆ getDefaultTitle()

◆ getInstance()

◆ getLanguages()

◆ getObjId()

◆ getType()

◆ read()

◆ removeLanguage()

◆ save()

◆ setDefaultDescription()

◆ setDefaultTitle()

◆ setLanguages()

◆ setObjId()

◆ setType()

◆ toXml()

Field Documentation

◆ $db

◆ $instances

◆ $languages

◆ $lng

◆ $obj_id

◆ $type