Inheritance diagram for ilCachedLanguage:

Collaboration diagram for ilCachedLanguage:

Public Member Functions
	getContainerKey ()

	isForced ()

	isActive ()
	Return whether the global cache is active. More...

	writeToCache ()
	Write to global cache. More...

	deleteInCache ()
	Delete the cache entry for this language without flushing the whole global cache Using this function avoids a flush loop when languages are updated A missing entry will cause the next request to refill the cache in the constructor of this class. More...

	flush ()

	setLanguageKey (string $language_key)
	Set language key. More...

	getLanguageKey ()
	Return language key. More...

	setLoaded (bool $loaded)

	getLoaded ()

	setTranslations (array $translations)
	Set translations. More...

	getTranslations ()
	Return translations as array. More...

Static Public Member Functions
static	getInstance ($key)

Protected Member Functions
	__construct (string $language_key)
	ilCachedLanguage constructor. More...

	readFromCache ()
	Read from cache. More...

	readFromDB ()
	Read data from table lng_module from DB. More...

Protected Attributes
ILIAS Cache Container Container	$language_cache

bool	$loaded = false

string	$language_key = "en"

array	$translations = array()

Static Protected Attributes
static array	$instances = array()

Detailed Description

Class ilCachedLanguage.

Author: Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Version: 1.0.0

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

Constructor & Destructor Documentation

◆ __construct()

ilCachedLanguage::__construct ( string $language_key )

protected

ilCachedLanguage constructor.

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

References $DIC, getLoaded(), readFromCache(), readFromDB(), setLanguageKey(), setLoaded(), and writeToCache().

     {
         global $DIC;
         $this->setLanguageKey($language_key);
         $this->language_cache = $DIC->globalCache()->get($this);
         $this->readFromCache();
         if (!$this->getLoaded()) {
             $this->readFromDB();
             $this->writeToCache();
             $this->setLoaded(true);
         }
     }

Here is the call graph for this function:

Member Function Documentation

◆ deleteInCache()

ilCachedLanguage::deleteInCache ( )

Delete the cache entry for this language without flushing the whole global cache Using this function avoids a flush loop when languages are updated A missing entry will cause the next request to refill the cache in the constructor of this class.

See also: mantis #28818

Definition at line 112 of file class.ilCachedLanguage.php.

References getLanguageKey(), and setLoaded().

                                    : void
     {
         $this->language_cache->delete("translations_" . $this->getLanguageKey());
         $this->setLoaded(false);
     }

Here is the call graph for this function:

◆ flush()

ilCachedLanguage::flush ( )

Definition at line 151 of file class.ilCachedLanguage.php.

References readFromDB(), and writeToCache().

                            : void
     {
         $this->language_cache->flush();
         $this->readFromDB();
         $this->writeToCache();
     }

Here is the call graph for this function:

◆ getContainerKey()

ilCachedLanguage::getContainerKey ( )

Implements ILIAS\Cache\Container\Request.

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

                                      : string
     {
         return 'clng';
     }

◆ getInstance()

static ilCachedLanguage::getInstance ( $key )

static

Definition at line 142 of file class.ilCachedLanguage.php.

References ILIAS\LTI\ToolProvider\$key.

Referenced by ilLanguage\__construct(), ilObjLanguageExt\_saveValues(), ilObjLanguage\insert(), and ilObjLanguageDBAccess\replaceLangModules().

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

Here is the caller graph for this function:

◆ getLanguageKey()

ilCachedLanguage::getLanguageKey ( )

Return language key.

Definition at line 169 of file class.ilCachedLanguage.php.

References $language_key.

Referenced by deleteInCache(), readFromCache(), readFromDB(), and writeToCache().

                                     : string
     {
         return $this->language_key;
     }

Here is the caller graph for this function:

◆ getLoaded()

ilCachedLanguage::getLoaded ( )

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

References $loaded.

Referenced by __construct().

                                : bool
     {
         return $this->loaded;
     }

Here is the caller graph for this function:

◆ getTranslations()

ilCachedLanguage::getTranslations ( )

Return translations as array.

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

References $translations.

Referenced by writeToCache().

                                      : array
     {
         return $this->translations;
     }

Here is the caller graph for this function:

◆ isActive()

ilCachedLanguage::isActive ( )

Return whether the global cache is active.

Definition at line 68 of file class.ilCachedLanguage.php.

                               : bool
     {
         return true;
     }

◆ isForced()

ilCachedLanguage::isForced ( )

Implements ILIAS\Cache\Container\Request.

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

                               : bool
     {
         return true;
     }

◆ readFromCache()

ilCachedLanguage::readFromCache ( )

protected

Read from cache.

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

References ILIAS\LTI\ToolProvider\$key, getLanguageKey(), setLoaded(), and setTranslations().

Referenced by __construct().

                                       : void
     {
         $key = "translations_" . $this->getLanguageKey();
         if ($this->language_cache->has($key)) {
             // This is a workaround for the fact that transformatuin cannot be created by
             // $DIC->refinery()->xy() since we are in a hell of dependencies. E.g. we cant instantiate the
             // caching service with $DIC->refinery() since the Refinery needs ilLanguage, but ilLanguage
             // needs the caching service and so on...
             $always = new Transformation(
                 function ($v) {
                     return is_array($v) ? $v : null;
                 }
             );
 
             $translations = $this->language_cache->get($key, $always);
             if (is_array($translations)) {
                 $this->setTranslations($translations);
                 $this->setLoaded(true);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ readFromDB()

ilCachedLanguage::readFromDB ( )

protected

Read data from table lng_module from DB.

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

References $DIC, $ilDB, $q, $res, getLanguageKey(), and setTranslations().

Referenced by __construct(), and flush().

                                    : void
     {
         global $DIC;
         $ilDB = $DIC->database();
 
         $q = 'SELECT module, lang_array FROM lng_modules WHERE lang_key = %s';
         $res = $ilDB->queryF($q, array( "text" ), array( $this->getLanguageKey() ));
         $translations = array();
         while ($set = $ilDB->fetchObject($res)) {
             try {
                 $lang_array = unserialize($set->lang_array, ['allowed_classes' => false]);
             } catch (Throwable $t) {
                 continue;
             }
             if (is_array($lang_array)) {
                 $translations[$set->module] = $lang_array;
             }
         }
         $this->setTranslations($translations);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLanguageKey()

ilCachedLanguage::setLanguageKey ( string $language_key )

Set language key.

Definition at line 161 of file class.ilCachedLanguage.php.

References $language_key.

Referenced by __construct().

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

Here is the caller graph for this function:

◆ setLoaded()

ilCachedLanguage::setLoaded ( bool $loaded )

Definition at line 174 of file class.ilCachedLanguage.php.

References $loaded.

Referenced by __construct(), deleteInCache(), and readFromCache().

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

Here is the caller graph for this function:

◆ setTranslations()

ilCachedLanguage::setTranslations ( array $translations )

Set translations.

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

References $translations.

Referenced by readFromCache(), and readFromDB().

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

Here is the caller graph for this function:

◆ writeToCache()

ilCachedLanguage::writeToCache ( )

Write to global cache.

Definition at line 101 of file class.ilCachedLanguage.php.

References getLanguageKey(), and getTranslations().

Referenced by __construct(), and flush().

                                   : void
     {
         $this->language_cache->set("translations_" . $this->getLanguageKey(), $this->getTranslations());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $instances

array ilCachedLanguage::$instances = array()

staticprotected

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

◆ $language_cache

ILIAS Cache Container Container ilCachedLanguage::$language_cache

protected

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

◆ $language_key

string ilCachedLanguage::$language_key = "en"

protected

Definition at line 34 of file class.ilCachedLanguage.php.

Referenced by getLanguageKey(), and setLanguageKey().

◆ $loaded

bool ilCachedLanguage::$loaded = false

protected

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

Referenced by getLoaded(), and setLoaded().

◆ $translations

array ilCachedLanguage::$translations = array()

protected

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

Referenced by getTranslations(), and setTranslations().

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

Services/Language/classes/class.ilCachedLanguage.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ deleteInCache()

◆ flush()

◆ getContainerKey()

◆ getInstance()

◆ getLanguageKey()

◆ getLoaded()

◆ getTranslations()

◆ isActive()

◆ isForced()

◆ readFromCache()

◆ readFromDB()

◆ setLanguageKey()

◆ setLoaded()

◆ setTranslations()

◆ writeToCache()

Field Documentation

◆ $instances

◆ $language_cache

◆ $language_key

◆ $loaded

◆ $translations