eZ Publish  [4.2]
Static Public Member Functions | Public Attributes
eZTranslationCache Class Reference

Cache handling for translations. More...

List of all members.

Static Public Member Functions

static cacheDirectory ()
static cacheTable ()
static canRestoreCache ($key, $timestamp)
static contextCache ($contextName)
static resetGlobals ()
static restoreCache ($key)
static rootCacheDirectory ()
static setContextCache ($contextName, $context)
static storeCache ($key)

Public Attributes

const CODE_DATE = 1058863428

Detailed Description

Cache handling for translations.

Definition at line 43 of file eztranslationcache.php.

Member Function Documentation

static eZTranslationCache::cacheDirectory ( ) [static]
Returns:
the cache directory for translation cache files.

Definition at line 103 of file eztranslationcache.php.

Referenced by canRestoreCache(), restoreCache(), and storeCache().

static eZTranslationCache::cacheTable ( ) [static]
Returns:
the cache table which has cache keys and cache data.

Definition at line 51 of file eztranslationcache.php.

Referenced by canRestoreCache(), contextCache(), restoreCache(), and storeCache().

static eZTranslationCache::canRestoreCache ( $  key,
$  timestamp 
) [static]
Returns:
true if the cache with the key $key can be restored. A cache file is found restorable when it exists and has a timestamp higher or equal to $timestamp.

Definition at line 141 of file eztranslationcache.php.

Referenced by eZTSTranslator\loadTranslationFile().

static eZTranslationCache::contextCache ( $  contextName) [static]
Returns:
the cache translation context which is stored with the cache key $contextName. Returns null if no cache data was found.

Definition at line 65 of file eztranslationcache.php.

Referenced by eZTSTranslator\loadTranslationFile().

static eZTranslationCache::resetGlobals ( ) [static]

Reset values strored in $GLOABLS variable

Definition at line 223 of file eztranslationcache.php.

static eZTranslationCache::restoreCache ( $  key) [static]

Loads the cache with the key $key from a file and sets the result in the cache table.

Returns:
true if the cache was successfully restored.

Definition at line 162 of file eztranslationcache.php.

Referenced by eZTSTranslator\loadTranslationFile().

static eZTranslationCache::rootCacheDirectory ( ) [static]

Definition at line 121 of file eztranslationcache.php.

Referenced by cacheDirectory().

static eZTranslationCache::setContextCache ( $  contextName,
$  context 
) [static]

Sets the translation context $context to be cached with the cache key $contextName.

Note:
Trying to overwrite and existing cache key will give a warning and fail.

Definition at line 80 of file eztranslationcache.php.

Referenced by eZTSTranslator\loadTranslationFile(), and restoreCache().

static eZTranslationCache::storeCache ( $  key) [static]

Stores the data of the cache with the key $key to a file.

Returns:
false if the cache does not exist.

Definition at line 190 of file eztranslationcache.php.

Referenced by eZTSTranslator\loadTranslationFile().

Member Data Documentation

const eZTranslationCache::CODE_DATE = 1058863428

Definition at line 45 of file eztranslationcache.php.

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