MediaWiki  master
LocalisationCacheBulkLoad Class Reference

A localisation cache optimised for loading large amounts of data for many languages. More...

Inheritance diagram for LocalisationCacheBulkLoad:
Collaboration diagram for LocalisationCacheBulkLoad:

Public Member Functions

 getItem ( $code, $key)
 
 getSubitem ( $code, $key, $subkey)
 
 recache ( $code)
 
 unload ( $code)
 
- Public Member Functions inherited from LocalisationCache
 __construct ( $conf)
 For constructor parameters, see the documentation in DefaultSettings.php for $wgLocalisationCacheConf. More...
 
 disableBackend ()
 Disable the storage backend. More...
 
 getCompiledPluralRules ( $code)
 Get the compiled plural rules for a given language from the XML files. More...
 
 getItem ( $code, $key)
 Get a cache item. More...
 
 getMessagesDirs ()
 Gets the combined list of messages dirs from core and extensions. 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...
 
 getSubitem ( $code, $key, $subkey)
 Get a subitem, for instance a single message for a given language. 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...
 
 recache ( $code)
 Load localisation data for a given language for both core and extensions and save it to the persistent cache store and the process cache. More...
 
 unload ( $code)
 Unload the data for a given language from the object cache. 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)
 
 readPHPFile ( $_fileName, $_fileType)
 Read a PHP file containing localisation data. More...
 
 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 = []
 A cache of the contents of data files. More...
 
 $maxLoadedLangs = 10
 Maximum number of languages that may be loaded into $this->data. More...
 
 $mruLangs = []
 Most recently used languages. More...
 

Additional Inherited Members

- Public Attributes inherited from LocalisationCache
const VERSION = 4
 
- Static Public Attributes inherited from LocalisationCache
static $allKeys
 All item keys. More...
 
static $magicWordKeys = [ 'magicWords' ]
 Keys for items that are formatted like $magicWords. More...
 
static $mergeableAliasListKeys = [ 'specialPageAliases' ]
 Keys for items which contain an array of arrays of equivalent aliases for each subitem. More...
 
static $mergeableListKeys = []
 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 = [ '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 = [ 'dateFormats', 'namespaceNames' ]
 Keys which are loaded automatically by initLanguage() More...
 
static $splitKeys = [ 'messages' ]
 Keys for items where the subitems are stored in the backend separately. More...
 
- Protected Attributes inherited from LocalisationCache
 $data = []
 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 25 of file LocalisationCacheBulkLoad.php.

Member Function Documentation

◆ getItem()

LocalisationCacheBulkLoad::getItem (   $code,
  $key 
)
Parameters
string$code
string$key
Returns
mixed

Definition at line 76 of file LocalisationCacheBulkLoad.php.

References $code.

◆ getSubitem()

LocalisationCacheBulkLoad::getSubitem (   $code,
  $key,
  $subkey 
)
Parameters
string$code
string$key
string$subkey
Returns
mixed

Definition at line 89 of file LocalisationCacheBulkLoad.php.

References $code.

◆ readPHPFile()

LocalisationCacheBulkLoad::readPHPFile (   $fileName,
  $fileType 
)
protected
Parameters
string$fileName
string$fileType
Returns
array|mixed

Definition at line 50 of file LocalisationCacheBulkLoad.php.

References LocalisationCache\$data, serialize(), and unserialize().

◆ recache()

LocalisationCacheBulkLoad::recache (   $code)
Parameters
string$code

Definition at line 99 of file LocalisationCacheBulkLoad.php.

References $code, and trimCache().

◆ trimCache()

LocalisationCacheBulkLoad::trimCache ( )
protected

Unload cached languages until there are less than $this->maxLoadedLangs.

Definition at line 117 of file LocalisationCacheBulkLoad.php.

References $code, data, key, unload(), and wfDebug().

Referenced by recache().

◆ unload()

LocalisationCacheBulkLoad::unload (   $code)
Parameters
string$code

Definition at line 109 of file LocalisationCacheBulkLoad.php.

References $code.

Referenced by trimCache().

Member Data Documentation

◆ $fileCache

LocalisationCacheBulkLoad::$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 31 of file LocalisationCacheBulkLoad.php.

◆ $maxLoadedLangs

LocalisationCacheBulkLoad::$maxLoadedLangs = 10
private

Maximum number of languages that may be loaded into $this->data.

Definition at line 43 of file LocalisationCacheBulkLoad.php.

◆ $mruLangs

LocalisationCacheBulkLoad::$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 38 of file LocalisationCacheBulkLoad.php.


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