ilCachedLanguage 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 ilCachedLanguage:

Public Member Functions
	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
ilGlobalCache	$global_cache
bool	$loaded = false
string	$language_key = "en"
array	$translations = array()

Static Protected Attributes
static array	$instances = array()

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 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 ilGlobalCache\COMP_CLNG, ilGlobalCache\getInstance(), getLoaded(), readFromCache(), readFromDB(), setLanguageKey(), setLoaded(), and writeToCache().

    {
        $this->setLanguageKey($language_key);
        $this->global_cache = ilGlobalCache::getInstance(ilGlobalCache::COMP_CLNG);
        $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 91 of file class.ilCachedLanguage.php.

References getLanguageKey(), and setLoaded().

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

Here is the call graph for this function:

flush()

ilCachedLanguage::flush

(

)

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

References readFromDB(), and writeToCache().

                           : void
    {
        if ($this->global_cache->isActive()) {
            $this->global_cache->flush();
        }
        $this->readFromDB();
        $this->writeToCache();
    }

Here is the call graph for this function:

getInstance()

static ilCachedLanguage::getInstance (   $key )

static

Definition at line 123 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 152 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 162 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 178 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 56 of file class.ilCachedLanguage.php.

                              : bool
    {
        return $this->global_cache->isActive();
    }

readFromCache()

ilCachedLanguage::readFromCache ( )

protected

Read from cache.

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

References getLanguageKey(), setLoaded(), and setTranslations().

Referenced by __construct().

                                      : void
    {
        if ($this->global_cache->isActive()) {
            $translations = $this->global_cache->get("translations_" . $this->getLanguageKey());
            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 102 of file class.ilCachedLanguage.php.

References $DIC, $ilDB, $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 144 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 157 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 170 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 78 of file class.ilCachedLanguage.php.

References getLanguageKey(), and getTranslations().

Referenced by __construct(), and flush().

                                  : void
    {
        if ($this->global_cache->isActive()) {
            $this->global_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

$global_cache

ilGlobalCache ilCachedLanguage::$global_cache

protected

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

$instances

array ilCachedLanguage::$instances = array()

staticprotected

Definition at line 36 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