Collaboration diagram for ilCachedLanguage:

Public Member Functions
	isActive ()

	writeToCache ()

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

	getLanguageKey ()

	setLoaded ($loaded)

	getLoaded ()

	setTranslations ($translations)

	getTranslations ()

Static Public Member Functions
static	getInstance ($key)

Protected Member Functions
	readFromCache ()

	readFromDB ()

Protected Attributes
	$global_cache

	$loaded = false

	$language_key = 'en'

	$translations = array()

Static Protected Attributes
static	$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 10 of file class.ilCachedLanguage.php.

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 85 of file class.ilCachedLanguage.php.

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

References getLanguageKey(), and setLoaded().

Here is the call graph for this function:

◆ flush()

ilCachedLanguage::flush ( )

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

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

References readFromDB(), and writeToCache().

Here is the call graph for this function:

◆ getInstance()

static ilCachedLanguage::getInstance ( $key )

static

Parameters

$key

Returns: ilCachedLanguage

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

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

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

Here is the caller graph for this function:

◆ getLanguageKey()

ilCachedLanguage::getLanguageKey ( )

Returns: string

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

    {
        return $this->language_key;
    }

References $language_key.

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

Here is the caller graph for this function:

◆ getLoaded()

ilCachedLanguage::getLoaded ( )

Returns: boolean

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

    {
        return $this->loaded;
    }

References $loaded.

◆ getTranslations()

ilCachedLanguage::getTranslations ( )

Returns: array

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

    {
        return $this->translations;
    }

References $translations.

Referenced by writeToCache().

Here is the caller graph for this function:

◆ isActive()

ilCachedLanguage::isActive ( )

Returns: bool

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

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

◆ readFromCache()

ilCachedLanguage::readFromCache ( )

protected

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

    {
        if ($this->global_cache->isActive()) {
            $translations = $this->global_cache->get('translations_' . $this->getLanguageKey());
            if (is_array($translations)) {
                $this->setTranslations($translations);
                $this->setLoaded(true);
            }
        }
    }

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

Here is the call graph for this function:

◆ readFromDB()

ilCachedLanguage::readFromDB ( )

protected

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

    {
        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)) {
            $lang_array = unserialize($set->lang_array);
            if (is_array($lang_array)) {
                $translations[$set->module] = $lang_array;
            }
        }
        $this->setTranslations($translations);
    }

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

Referenced by flush().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLanguageKey()

ilCachedLanguage::setLanguageKey ( $language_key )

Parameters

string $language_key

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

    {
        $this->language_key = $language_key;
    }

References $language_key.

◆ setLoaded()

ilCachedLanguage::setLoaded ( $loaded )

Parameters

boolean $loaded

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

    {
        $this->loaded = $loaded;
    }

References $loaded.

Referenced by deleteInCache(), and readFromCache().

Here is the caller graph for this function:

◆ setTranslations()

ilCachedLanguage::setTranslations ( $translations )

Parameters

array $translations

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

    {
        $this->translations = $translations;
    }

References $translations.

Referenced by readFromCache(), and readFromDB().

Here is the caller graph for this function:

◆ writeToCache()

ilCachedLanguage::writeToCache ( )

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

    {
        if ($this->global_cache->isActive()) {
            $this->global_cache->set('translations_' . $this->getLanguageKey(), $this->getTranslations());
        }
    }

References getLanguageKey(), and getTranslations().

Referenced by flush().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $global_cache

ilCachedLanguage::$global_cache

protected

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

◆ $instances

ilCachedLanguage::$instances = array()

staticprotected

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

◆ $language_key

ilCachedLanguage::$language_key = 'en'

protected

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

Referenced by getLanguageKey(), and setLanguageKey().

◆ $loaded

ilCachedLanguage::$loaded = false

protected

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

Referenced by getLoaded(), and setLoaded().

◆ $translations

ilCachedLanguage::$translations = array()

protected

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

Referenced by getTranslations(), readFromCache(), readFromDB(), 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

Member Function Documentation

◆ deleteInCache()

◆ flush()

◆ getInstance()

◆ getLanguageKey()

◆ getLoaded()

◆ getTranslations()

◆ isActive()

◆ readFromCache()

◆ readFromDB()

◆ setLanguageKey()

◆ setLoaded()

◆ setTranslations()

◆ writeToCache()

Field Documentation

◆ $global_cache

◆ $instances

◆ $language_key

◆ $loaded

◆ $translations