Class for caching the contents of localisation files, Messages*.php and *.i18n.php. More...

Inheritance diagram for LocalisationCache:

Collaboration diagram for LocalisationCache:

Public Member Functions
	__construct ($conf)
	Constructor.
	disableBackend ()
	Disable the storage backend.
	getCompiledPluralRules ($code)
	Get the compiled plural rules for a given language from the XML files.
	getItem ($code, $key)
	Get a cache item.
	getPluralRules ($code)
	Get the plural rules for a given language from the XML files.
	getPluralRuleTypes ($code)
	Get the plural rule types for a given language from the XML files.
	getSubitem ($code, $key, $subkey)
	Get a subitem, for instance a single message for a given language.
	getSubitemList ($code, $key)
	Get the list of subitem keys for a given item.
	initShallowFallback ($primaryCode, $fallbackCode)
	Create a fallback from one language to another, without creating a complete persistent cache.
	isExpired ($code)
	Returns true if the cache identified by $code is missing or expired.
	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.
	readJSONFile ($fileName)
	Read a JSON file containing localisation messages.
	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.
	unload ($code)
	Unload the data for a given language from the object cache.
	unloadAll ()
	Unload all data.
Public Attributes
const	VERSION = 2
Static Public Attributes
static	$allKeys
	All item keys.
static	$magicWordKeys = array( 'magicWords' )
	Keys for items that are formatted like $magicWords.
static	$mergeableAliasListKeys = array( 'specialPageAliases' )
	Keys for items which contain an array of arrays of equivalent aliases for each subitem.
static	$mergeableListKeys = array( 'extraUserToggles' )
	Keys for items which are a numbered array.
static	$mergeableMapKeys
	Keys for items which consist of associative arrays, which may be merged by a fallback sequence.
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".
static	$preloadedKeys = array( 'dateFormats', 'namespaceNames' )
	Keys which are loaded automatically by initLanguage()
static	$splitKeys = array( 'messages' )
	Keys for items where the subitems are stored in the backend separately.
Protected Member Functions
	buildPreload ($data)
	Build the preload item from the given pre-cache data.
	initLanguage ($code)
	Initialise a language in this object.
	loadItem ($code, $key)
	Load an item into the cache.
	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.
	loadPluralFiles ()
	Load the plural XML files.
	loadSubitem ($code, $key, $subkey)
	Load a subitem into the cache.
	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.
	mergeItem ($key, &$value, $fallbackValue)
	Merge two localisation values, a primary and a fallback, overwriting the primary value in place.
	mergeMagicWords (&$value, $fallbackValue)
	readPHPFile ($_fileName, $_fileType)
	Read a PHP file containing localisation data.
	readSourceFilesAndRegisterDeps ($code, &$deps)
	Read the data from the source files for a given language, and register the relevant dependencies in the $deps array.
Protected Attributes
	$data = array()
	The cache data.
Private Attributes
	$conf
	Configuration associative array.
	$forceRecache = false
	True to treat all files as expired until they are regenerated by this object.
	$initialisedLangs = array()
	An array where presence of a key indicates that that language has been initialised.
	$loadedItems = array()
	A 2-d associative array, code/key, where presence indicates that the item is loaded.
	$loadedSubitems = array()
	A 3-d associative array, code/key/subkey, where presence indicates that the subitem is loaded.
	$manualRecache = false
	True if recaching should only be done on an explicit call to recache().
	$mergeableKeys = null
	$pluralRules = null
	Associative array of cached plural rules.
	$pluralRuleTypes = null
	Associative array of cached plural rule types.
	$recachedLangs = array()
	An array where the keys are codes that have been recached by this instance.
	$shallowFallbacks = array()
	An array mapping non-existent pseudo-languages to fallback languages.
LCStore	$store
	The persistent store object.

Detailed Description

Class for caching the contents of localisation files, Messages*.php and *.i18n.php.

An instance of this class is available using Language::getLocalisationCache().

The values retrieved from here are merged, containing items from extension files, core messages files and the language fallback sequence (e.g. zh-cn -> zh-hans -> en ). Some common errors are corrected, for example namespace names with spaces instead of underscores, but heavyweight processing, such as grammatical transformation, is done by the caller.

Definition at line 35 of file LocalisationCache.php.

Constructor & Destructor Documentation

LocalisationCache::__construct ( $ conf )

Constructor.

For constructor parameters, see the documentation in DefaultSettings.php for $wgLocalisationCacheConf.

Parameters:

array $conf

Exceptions:

MWException

Definition at line 186 of file LocalisationCache.php.

Member Function Documentation

LocalisationCache::buildPreload ( $ data ) [protected]

Build the preload item from the given pre-cache data.

The preload item will be loaded automatically, improving performance for the commonly-requested items it contains.

Parameters:

array $data

Returns:: array

Definition at line 1033 of file LocalisationCache.php.

LocalisationCache::disableBackend ( )

Disable the storage backend.

Definition at line 1082 of file LocalisationCache.php.

LocalisationCache::getCompiledPluralRules ( $ code )

Get the compiled plural rules for a given language from the XML files.

Since:: 1.20

Parameters:

string $code

Returns:: array|null

Definition at line 580 of file LocalisationCache.php.

LocalisationCache::getItem	(	$	code,
		$	key
	)

Get a cache item.

Warning: this may be slow for split items (messages), since it will need to fetch all of the subitems from the cache individually.

Parameters:

string	$code
string	$key

Returns:: mixed

Reimplemented in LocalisationCacheBulkLoad.

Definition at line 253 of file LocalisationCache.php.

Referenced by LocalisationCacheTest\testRecacheFallbacksWithHooks().

LocalisationCache::getPluralRules ( $ code )

Get the plural rules for a given language from the XML files.

Cached.

Since:: 1.20

Parameters:

string $code

Returns:: array|null

Definition at line 603 of file LocalisationCache.php.

LocalisationCache::getPluralRuleTypes ( $ code )

Get the plural rule types for a given language from the XML files.

Cached.

Since:: 1.22

Parameters:

string $code

Returns:: array|null

Definition at line 621 of file LocalisationCache.php.

LocalisationCache::getSubitem	(	$	code,
		$	key,
		$	subkey
	)

Get a subitem, for instance a single message for a given language.

Parameters:

string	$code
string	$key
string	$subkey

Returns:: mixed|null

Reimplemented in LocalisationCacheBulkLoad.

Definition at line 274 of file LocalisationCache.php.

LocalisationCache::getSubitemList	(	$	code,
		$	key
	)

Get the list of subitem keys for a given item.

This is faster than array_keys($lc->getItem(...)) for the items listed in self::$splitKeys.

Will return null if the item is not found, or false if the item is not an array.

Parameters:

string	$code
string	$key

Returns:: bool|null|string

Definition at line 302 of file LocalisationCache.php.

LocalisationCache::initLanguage ( $ code ) [protected]

Initialise a language in this object.

Rebuild the cache if necessary.

Parameters:

string $code

Exceptions:

MWException

Definition at line 431 of file LocalisationCache.php.

LocalisationCache::initShallowFallback	(	$	primaryCode,
		$	fallbackCode
	)

Create a fallback from one language to another, without creating a complete persistent cache.

Parameters:

string	$primaryCode
string	$fallbackCode

Definition at line 492 of file LocalisationCache.php.

LocalisationCache::isExpired ( $ code )

Returns true if the cache identified by $code is missing or expired.

Parameters:

string $code

Returns:: bool

Definition at line 393 of file LocalisationCache.php.

LocalisationCache::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.

Parameters:

string $key

Returns:: bool

Definition at line 230 of file LocalisationCache.php.

LocalisationCache::loadItem	(	$	code,
		$	key
	)		`[protected]`

Load an item into the cache.

Parameters:

string	$code
string	$key

Definition at line 320 of file LocalisationCache.php.

LocalisationCache::loadPluralFile ( $ fileName ) [protected]

Load a plural XML file with the given filename, compile the relevant rules, and save the compiled rules in a process-local cache.

Parameters:

string $fileName

Definition at line 653 of file LocalisationCache.php.

LocalisationCache::loadPluralFiles ( ) [protected]

Load the plural XML files.

Definition at line 635 of file LocalisationCache.php.

LocalisationCache::loadSubitem	(	$	code,
		$	key,
		$	subkey
	)		`[protected]`

Load a subitem into the cache.

Parameters:

string	$code
string	$key
string	$subkey

Definition at line 357 of file LocalisationCache.php.

LocalisationCache::mergeExtensionItem	(	$	codeSequence,
		$	key,
		&$	value,
		$	fallbackValue
	)		`[protected]`

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.

Returns true if any data from the extension array was used, false otherwise.

Parameters:

array	$codeSequence
string	$key
mixed	$value
mixed	$fallbackValue

Returns:: bool

Definition at line 779 of file LocalisationCache.php.

LocalisationCache::mergeItem	(	$	key,
		&$	value,
		$	fallbackValue
	)		`[protected]`

Merge two localisation values, a primary and a fallback, overwriting the primary value in place.

Parameters:

string	$key
mixed	$value
mixed	$fallbackValue

Definition at line 722 of file LocalisationCache.php.

LocalisationCache::mergeMagicWords	(	&$	value,
		$	fallbackValue
	)		`[protected]`

Parameters:

mixed	$value
mixed	$fallbackValue

Definition at line 752 of file LocalisationCache.php.

LocalisationCache::readJSONFile ( $ fileName )

Read a JSON file containing localisation messages.

Parameters:

string $fileName Name of file to read

Exceptions:

MWException If there is a syntax error in the JSON file

Returns:: array Array with a 'messages' key, or empty array if the file doesn't exist

Definition at line 538 of file LocalisationCache.php.

LocalisationCache::readPHPFile	(	$	_fileName,
		$	_fileType
	)		`[protected]`

Read a PHP file containing localisation data.

Parameters:

string	$_fileName
string	$_fileType

Exceptions:

MWException

Returns:: array

Reimplemented in LocalisationCacheBulkLoad.

Definition at line 506 of file LocalisationCache.php.

LocalisationCache::readSourceFilesAndRegisterDeps	(	$	code,
		&$	deps
	)		`[protected]`

Read the data from the source files for a given language, and register the relevant dependencies in the $deps array.

If the localisation exists, the data array is returned, otherwise false is returned.

Parameters:

string	$code
array	$deps

Returns:: array

Definition at line 687 of file LocalisationCache.php.

LocalisationCache::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.

Parameters:

string $code

Exceptions:

MWException

Reimplemented in LocalisationCacheBulkLoad.

Definition at line 797 of file LocalisationCache.php.

Referenced by LocalisationCacheTest\testRecacheFallbacksWithHooks().

LocalisationCache::unload ( $ code )

Unload the data for a given language from the object cache.

Reduces memory usage.

Parameters:

string $code

Reimplemented in LocalisationCacheBulkLoad.

Definition at line 1056 of file LocalisationCache.php.

LocalisationCache::unloadAll ( )

Unload all data.

Definition at line 1073 of file LocalisationCache.php.

Member Data Documentation

LocalisationCache::$allKeys [static]

Initial value:

 array(
        'fallback', 'namespaceNames', 'bookstoreList',
        'magicWords', 'messages', 'rtl', 'capitalizeAllNouns', 'digitTransformTable',
        'separatorTransformTable', 'fallback8bitEncoding', 'linkPrefixExtension',
        'linkTrail', 'linkPrefixCharset', 'namespaceAliases',
        'dateFormats', 'datePreferences', 'datePreferenceMigrationMap',
        'defaultDateFormat', 'extraUserToggles', 'specialPageAliases',
        'imageFiles', 'preloadedMessages', 'namespaceGenderAliases',
        'digitGroupingPattern', 'pluralRules', 'pluralRuleTypes', 'compiledPluralRules',
    )

All item keys.

Definition at line 104 of file LocalisationCache.php.

LocalisationCache::$conf [private]

Configuration associative array.

Definition at line 39 of file LocalisationCache.php.

LocalisationCache::$data = array() [protected]

The cache data.

3-d array, where the first key is the language code, the second key is the item key e.g. 'messages', and the third key is an item specific subkey index. Some items are not arrays and so for those items, there are no subkeys.

Definition at line 59 of file LocalisationCache.php.

Referenced by LocalisationCacheBulkLoad\readPHPFile().

LocalisationCache::$forceRecache = false [private]

True to treat all files as expired until they are regenerated by this object.

Definition at line 51 of file LocalisationCache.php.

LocalisationCache::$initialisedLangs = array() [private]

An array where presence of a key indicates that that language has been initialised.

Initialisation includes checking for cache expiry and doing any necessary updates.

Definition at line 87 of file LocalisationCache.php.

LocalisationCache::$loadedItems = array() [private]

A 2-d associative array, code/key, where presence indicates that the item is loaded.

Value arbitrary.

For split items, if set, this indicates that all of the subitems have been loaded.

Definition at line 74 of file LocalisationCache.php.

LocalisationCache::$loadedSubitems = array() [private]

A 3-d associative array, code/key/subkey, where presence indicates that the subitem is loaded.

Only used for the split items, i.e. messages.

Definition at line 80 of file LocalisationCache.php.

LocalisationCache::$magicWordKeys = array( 'magicWords' ) [static]

Keys for items that are formatted like $magicWords.

Definition at line 144 of file LocalisationCache.php.

LocalisationCache::$manualRecache = false [private]

True if recaching should only be done on an explicit call to recache().

Setting this reduces the overhead of cache freshness checking, which requires doing a stat() for every extension i18n file.

Definition at line 46 of file LocalisationCache.php.

LocalisationCache::$mergeableAliasListKeys = array( 'specialPageAliases' ) [static]

Keys for items which contain an array of arrays of equivalent aliases for each subitem.

The aliases may be merged by a fallback sequence.

Definition at line 132 of file LocalisationCache.php.

LocalisationCache::$mergeableKeys = null [private]

Definition at line 176 of file LocalisationCache.php.

LocalisationCache::$mergeableListKeys = array( 'extraUserToggles' ) [static]

Keys for items which are a numbered array.

Definition at line 126 of file LocalisationCache.php.

LocalisationCache::$mergeableMapKeys [static]

Initial value:

 array( 'messages', 'namespaceNames',
        'dateFormats', 'imageFiles', 'preloadedMessages'
    )

Keys for items which consist of associative arrays, which may be merged by a fallback sequence.

Definition at line 119 of file LocalisationCache.php.

LocalisationCache::$optionalMergeKeys = array( 'bookstoreList' ) [static]

Keys for items which contain an associative array, and may be merged if the primary value contains the special array key "inherit".

That array key is removed after the first merge.

Definition at line 139 of file LocalisationCache.php.

LocalisationCache::$pluralRules = null [private]

Associative array of cached plural rules.

The key is the language code, the value is an array of plural rules for that language.

Definition at line 160 of file LocalisationCache.php.

LocalisationCache::$pluralRuleTypes = null [private]

Associative array of cached plural rule types.

The key is the language code, the value is an array of plural rule types for that language. For example, $pluralRuleTypes['ar'] = ['zero', 'one', 'two', 'few', 'many']. The index for each rule type matches the index for the rule in $pluralRules, thus allowing correlation between the two. The reason we don't just use the type names as the keys in $pluralRules is because Language::convertPlural applies the rules based on numeric order (or explicit numeric parameter), not based on the name of the rule type. For example, {{plural:count|wordform1|wordform2|wordform3}}, rather than {{plural:count|one=wordform1|two=wordform2|many=wordform3}}.

Definition at line 174 of file LocalisationCache.php.

LocalisationCache::$preloadedKeys = array( 'dateFormats', 'namespaceNames' ) [static]

Keys which are loaded automatically by initLanguage()

Definition at line 154 of file LocalisationCache.php.

LocalisationCache::$recachedLangs = array() [private]

An array where the keys are codes that have been recached by this instance.

Definition at line 99 of file LocalisationCache.php.

LocalisationCache::$shallowFallbacks = array() [private]

An array mapping non-existent pseudo-languages to fallback languages.

This is filled by initShallowFallback() when data is requested from a language that lacks a Messages*.php file.

Definition at line 94 of file LocalisationCache.php.

LocalisationCache::$splitKeys = array( 'messages' ) [static]

Keys for items where the subitems are stored in the backend separately.

Definition at line 149 of file LocalisationCache.php.

LCStore LocalisationCache::$store [private]

The persistent store object.

An instance of LCStore.

Definition at line 65 of file LocalisationCache.php.

const LocalisationCache::VERSION = 2

Definition at line 36 of file LocalisationCache.php.

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

includes/cache/LocalisationCache.php

Public Member Functions

Public Attributes

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation