ilCachedLanguage Class Reference

Class ilCachedLanguage. More...

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.

References getLanguageKey(), and setLoaded().

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

References readFromDB(), and writeToCache().

    {
        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

Parameters

$key

Returns

ilCachedLanguage

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

References $key.

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

    {
        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

(

)

Returns

string

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

References $language_key.

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

    {
        return $this->language_key;
    }

Here is the caller graph for this function:

getLoaded()

ilCachedLanguage::getLoaded

(

)

Returns

boolean

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

References $loaded.

    {
        return $this->loaded;
    }

getTranslations()

ilCachedLanguage::getTranslations

(

)

Returns

array

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

References $translations.

Referenced by writeToCache().

    {
        return $this->translations;
    }

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.

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

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

readFromDB()

ilCachedLanguage::readFromDB ( )

protected

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

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

Referenced by flush().

    {
        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);
    }

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

References $language_key.

    {
        $this->language_key = $language_key;
    }

setLoaded()

ilCachedLanguage::setLoaded

(

$loaded

)

Parameters

boolean

$loaded

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

References $loaded.

Referenced by deleteInCache(), and readFromCache().

    {
        $this->loaded = $loaded;
    }

Here is the caller graph for this function:

setTranslations()

ilCachedLanguage::setTranslations

(

$translations

)

Parameters

array

$translations

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

References $translations.

Referenced by readFromCache(), and readFromDB().

    {
        $this->translations = $translations;
    }

Here is the caller graph for this function:

writeToCache()

ilCachedLanguage::writeToCache

(

)

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

References getLanguageKey(), and getTranslations().

Referenced by flush().

    {
        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

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