A localisation cache optimised for loading large amounts of data for many languages. More...
Public Member Functions | |
| getItem ( $code, $key) | |
| getSubitem ( $code, $key, $subkey) | |
| recache ( $code) | |
| unload ( $code) | |
 Public Member Functions inherited from LocalisationCache | |
| __construct ( $conf) | |
| Constructor. More... | |
| disableBackend () | |
| Disable the storage backend. More... | |
| getCompiledPluralRules ( $code) | |
| Get the compiled plural rules for a given language from the XML files. More... | |
| getPluralRules ( $code) | |
| Get the plural rules for a given language from the XML files. More... | |
| getPluralRuleTypes ( $code) | |
| Get the plural rule types for a given language from the XML files. More... | |
| getSubitemList ( $code, $key) | |
| Get the list of subitem keys for a given item. More... | |
| initShallowFallback ( $primaryCode, $fallbackCode) | |
| Create a fallback from one language to another, without creating a complete persistent cache. More... | |
| isExpired ( $code) | |
| Returns true if the cache identified by $code is missing or expired. More... | |
| isMergeableKey ( $key) | |
| Returns true if the given key is mergeable, that is, if it is an associative array which can be merged through a fallback sequence. More... | |
| readJSONFile ( $fileName) | |
| Read a JSON file containing localisation messages. More... | |
| unloadAll () | |
| Unload all data. More... | |
Protected Member Functions | |
| readPHPFile ( $fileName, $fileType) | |
| trimCache () | |
| Unload cached languages until there are less than $this->maxLoadedLangs. More... | |
| Protected Member Functions inherited from LocalisationCache | |
| buildPreload ( $data) | |
| Build the preload item from the given pre-cache data. More... | |
| initLanguage ( $code) | |
| Initialise a language in this object. More... | |
| loadItem ( $code, $key) | |
| Load an item into the cache. More... | |
| loadPluralFile ( $fileName) | |
| Load a plural XML file with the given filename, compile the relevant rules, and save the compiled rules in a process-local cache. More... | |
| loadPluralFiles () | |
| Load the plural XML files. More... | |
| loadSubitem ( $code, $key, $subkey) | |
| Load a subitem into the cache. More... | |
| mergeExtensionItem ( $codeSequence, $key, &$value, $fallbackValue) | |
| Given an array mapping language code to localisation value, such as is found in extension *.i18n.php files, iterate through a fallback sequence to merge the given data with an existing primary value. More... | |
| mergeItem ( $key, &$value, $fallbackValue) | |
| Merge two localisation values, a primary and a fallback, overwriting the primary value in place. More... | |
| mergeMagicWords (&$value, $fallbackValue) | |
| readSourceFilesAndRegisterDeps ( $code, &$deps) | |
| Read the data from the source files for a given language, and register the relevant dependencies in the $deps array. More... | |
Private Attributes | |
| $fileCache = array() | |
| A cache of the contents of data files. More... | |
| $maxLoadedLangs = 10 | |
| Maximum number of languages that may be loaded into $this->data. More... | |
| $mruLangs = array() | |
| Most recently used languages. More... | |
Additional Inherited Members | |
| Static Public Attributes inherited from LocalisationCache | |
| static | $allKeys |
| All item keys. More... | |
| static | $magicWordKeys = array( 'magicWords' ) |
| Keys for items that are formatted like $magicWords. More... | |
| static | $mergeableAliasListKeys = array( 'specialPageAliases' ) |
| Keys for items which contain an array of arrays of equivalent aliases for each subitem. More... | |
| static | $mergeableListKeys = array( 'extraUserToggles' ) |
| Keys for items which are a numbered array. More... | |
| static | $mergeableMapKeys |
| Keys for items which consist of associative arrays, which may be merged by a fallback sequence. More... | |
| static | $optionalMergeKeys = array( 'bookstoreList' ) |
| Keys for items which contain an associative array, and may be merged if the primary value contains the special array key "inherit". More... | |
| static | $preloadedKeys = array( 'dateFormats', 'namespaceNames' ) |
| Keys which are loaded automatically by initLanguage() More... | |
| static | $splitKeys = array( 'messages' ) |
| Keys for items where the subitems are stored in the backend separately. More... | |
| Protected Attributes inherited from LocalisationCache | |
| $data = array() | |
| The cache data. More... | |
Detailed Description
A localisation cache optimised for loading large amounts of data for many languages.
Used by rebuildLocalisationCache.php.
Definition at line 1371 of file LocalisationCache.php.
Member Function Documentation
◆ getItem()
| LocalisationCacheBulkLoad::getItem | ( | $code, | |
| $key | |||
| ) |
- Parameters
-
$code $key
- Returns
- mixed
Reimplemented from LocalisationCache.
Definition at line 1421 of file LocalisationCache.php.
◆ getSubitem()
| LocalisationCacheBulkLoad::getSubitem | ( | $code, | |
| $key, | |||
| $subkey | |||
| ) |
- Parameters
-
$code $key $subkey
- Returns
Reimplemented from LocalisationCache.
Definition at line 1434 of file LocalisationCache.php.
◆ readPHPFile()
|
protected |
- Parameters
-
$fileName $fileType
- Returns
- array|mixed
Reimplemented from LocalisationCache.
Definition at line 1395 of file LocalisationCache.php.
References LocalisationCache\$data.
◆ recache()
| LocalisationCacheBulkLoad::recache | ( | $code | ) |
- Parameters
-
$code
Reimplemented from LocalisationCache.
Definition at line 1444 of file LocalisationCache.php.
References trimCache().
◆ trimCache()
|
protected |
◆ unload()
| LocalisationCacheBulkLoad::unload | ( | $code | ) |
- Parameters
-
$code
Reimplemented from LocalisationCache.
Definition at line 1454 of file LocalisationCache.php.
Referenced by trimCache().
Member Data Documentation
◆ $fileCache
|
private |
A cache of the contents of data files.
Core files are serialized to avoid using ~1GB of RAM during a recache.
Definition at line 1376 of file LocalisationCache.php.
◆ $maxLoadedLangs
|
private |
Maximum number of languages that may be loaded into $this->data.
Definition at line 1388 of file LocalisationCache.php.
◆ $mruLangs
|
private |
Most recently used languages.
Uses the linked-list aspect of PHP hashtables to keep the most recently used language codes at the end of the array, and the language codes that are ready to be deleted at the beginning.
Definition at line 1383 of file LocalisationCache.php.
The documentation for this class was generated from the following file:
- includes/cache/LocalisationCache.php
