MediaWiki master
|
Cache messages that are defined by MediaWiki-namespace pages or by hooks. More...
Inherits LoggerAwareInterface.
Public Member Functions | |
__construct (WANObjectCache $wanCache, BagOStuff $mainCache, BagOStuff $serverCache, Language $contLang, LanguageConverterFactory $langConverterFactory, LoggerInterface $logger, ServiceOptions $options, LocalisationCache $localisationCache, LanguageNameUtils $languageNameUtils, LanguageFallback $languageFallback, HookContainer $hookContainer, MessageParser $messageParser) | |
clear () | |
Clear all stored messages in global and local cache. | |
disable ( $logReason='') | |
Disable loading of messages from the MediaWiki namespace. | |
enable () | |
Re-enable the MessageCache if it was disabled by a call to disable() | |
figureMessage ( $key) | |
Given a title string possibly containing a slash, determine the message key and language code. | |
get ( $key, $useDB=true, $language=null, $info=null) | |
Get a message from either the content language or the user language. | |
getAllMessageKeys ( $code) | |
Get all message keys stored in the message cache for a given language. | |
getCheckKey ( $code) | |
getMsgFromNamespace ( $title, $code) | |
Get a message from the MediaWiki namespace, with caching. | |
isDisabled () | |
Whether DB/cache usage is disabled for determining messages. | |
normalizeKey (string $key) | |
Normalize message key input. | |
parse ( $text, ?PageReference $page=null, $linestart=true, $interface=false, $language=null) | |
parseWithPostprocessing (string $text, PageReference $contextPage, bool $linestart=true, bool $interface=false, $language=null) | |
refreshAndReplaceInternal (string $code, array $replacements) | |
replace ( $title, $text) | |
Update the cache as necessary when a message page is changed. | |
setLogger (LoggerInterface $logger) | |
transform ( $message, $interface=false, $language=null, ?PageReference $page=null) | |
updateMessageOverride ( $page, ?Content $content=null) | |
Purge message caches when a MediaWiki: page is created, updated, or deleted. | |
Public Attributes | |
const | CONSTRUCTOR_OPTIONS |
Options to be included in the ServiceOptions. | |
const | MAX_REQUEST_LANGUAGES = 10 |
The size of the MapCacheLRU which stores message data. | |
Cache messages that are defined by MediaWiki-namespace pages or by hooks.
Definition at line 63 of file MessageCache.php.
MessageCache::__construct | ( | WANObjectCache | $wanCache, |
BagOStuff | $mainCache, | ||
BagOStuff | $serverCache, | ||
Language | $contLang, | ||
LanguageConverterFactory | $langConverterFactory, | ||
LoggerInterface | $logger, | ||
ServiceOptions | $options, | ||
LocalisationCache | $localisationCache, | ||
LanguageNameUtils | $languageNameUtils, | ||
LanguageFallback | $languageFallback, | ||
HookContainer | $hookContainer, | ||
MessageParser | $messageParser ) |
WANObjectCache | $wanCache | |
BagOStuff | $mainCache | |
BagOStuff | $serverCache | |
Language | $contLang | Content language of site |
LanguageConverterFactory | $langConverterFactory | |
LoggerInterface | $logger | |
ServiceOptions | $options | |
LocalisationCache | $localisationCache | |
LanguageNameUtils | $languageNameUtils | |
LanguageFallback | $languageFallback | |
HookContainer | $hookContainer | |
MessageParser | $messageParser |
Definition at line 180 of file MessageCache.php.
References MediaWiki\Config\ServiceOptions\assertRequiredOptions(), disable(), MediaWiki\Config\ServiceOptions\get(), MediaWiki\Language\Language\getCode(), and MediaWiki\Languages\LanguageConverterFactory\getLanguageConverter().
MessageCache::clear | ( | ) |
Clear all stored messages in global and local cache.
Mainly used after a mass rebuild
Definition at line 1524 of file MessageCache.php.
MessageCache::disable | ( | $logReason = '' | ) |
Disable loading of messages from the MediaWiki namespace.
Use the LocalisationCache only.
string | $logReason | If given, log a message including this reason |
Definition at line 1487 of file MessageCache.php.
Referenced by __construct().
MessageCache::enable | ( | ) |
Re-enable the MessageCache if it was disabled by a call to disable()
Definition at line 1497 of file MessageCache.php.
MessageCache::figureMessage | ( | $key | ) |
Given a title string possibly containing a slash, determine the message key and language code.
No initial letter case normalisation is done.
string | $key |
Definition at line 1539 of file MessageCache.php.
Referenced by replace().
MessageCache::get | ( | $key, | |
$useDB = true, | |||
$language = null, | |||
$info = null ) |
Get a message from either the content language or the user language.
First, assemble a list of languages to attempt getting the message from. This chain begins with the requested language and its fallbacks and then continues with the content language and its fallbacks. For each language in the chain, the following process will occur (in this order):
This process provides a number of guarantees. When changing this code, make sure all of these guarantees are preserved.
string | $key | The message key |
bool | $useDB | If true, look for the message in the DB, false to use only the LocalisationCache. |
bool | string | Language | null | $language | Code of the language to get the message for. This should be a string or null in new code. If null is given, the content language will be used. |
MessageInfo | null | $info | If a default-constructed MessageInfo is passed, it will be populated with information about the retrieved message. |
Definition at line 995 of file MessageCache.php.
MessageCache::getAllMessageKeys | ( | $code | ) |
Get all message keys stored in the message cache for a given language.
If $code is the content language code, this will return all message keys for which MediaWiki:msgkey exists. If $code is another language code, this will ONLY return message keys for which MediaWiki:msgkey/$code exists.
string | $code | Language code |
Definition at line 1568 of file MessageCache.php.
MessageCache::getCheckKey | ( | $code | ) |
string | $code | Language code |
Definition at line 1609 of file MessageCache.php.
Referenced by refreshAndReplaceInternal().
MessageCache::getMsgFromNamespace | ( | $title, | |
$code ) |
Get a message from the MediaWiki namespace, with caching.
The key must first be converted to two-part lang/msg form if necessary.
Unlike self::get(), this function doesn't resolve fallback chains, and some callers require this behavior. LanguageConverter::parseCachedTable() and self::get() are some examples in core.
string | $title | Message cache key with the initial uppercase letter |
string | $code | Code denoting the language to try |
Definition at line 1280 of file MessageCache.php.
MessageCache::isDisabled | ( | ) |
Whether DB/cache usage is disabled for determining messages.
If so, this typically indicates either:
If the DB is ignored, any derived HTML output or cached objects may be wrong. To avoid long-term cache pollution, TTLs can be adjusted accordingly.
Definition at line 1515 of file MessageCache.php.
MessageCache::normalizeKey | ( | string | $key | ) |
Normalize message key input.
string | $key | Input message key to be normalized |
Definition at line 950 of file MessageCache.php.
MessageCache::parse | ( | $text, | |
?PageReference | $page = null, | ||
$linestart = true, | |||
$interface = false, | |||
$language = null ) |
string | $text | |
PageReference | null | $page | |
bool | $linestart | Whether this is at the start of a line |
bool | $interface | Whether this is an interface message |
Language | StubUserLang | string | null | $language | Language code |
Definition at line 1454 of file MessageCache.php.
References $wgTitle, and NS_SPECIAL.
MessageCache::parseWithPostprocessing | ( | string | $text, |
PageReference | $contextPage, | ||
bool | $linestart = true, | ||
bool | $interface = false, | ||
$language = null ) |
string | $text | |
PageReference | $contextPage | |
bool | $linestart | Whether this should be parsed in start-of-line context (defaults to true) |
bool | $interface | Whether this is an interface message (defaults to false) |
Language | StubUserLang | string | null | $language | Language code |
Definition at line 1434 of file MessageCache.php.
MessageCache::refreshAndReplaceInternal | ( | string | $code, |
array | $replacements ) |
string | $code | |
array[] | $replacements | List of (title, message key) pairs |
Definition at line 750 of file MessageCache.php.
References MapCacheLRU\get(), getCheckKey(), and NS_MEDIAWIKI.
MessageCache::replace | ( | $title, | |
$text ) |
Update the cache as necessary when a message page is changed.
string | $title | Message cache key with the initial uppercase letter |
string | false | $text | New contents of the page (false if deleted) |
Definition at line 718 of file MessageCache.php.
References figureMessage().
MessageCache::setLogger | ( | LoggerInterface | $logger | ) |
Definition at line 219 of file MessageCache.php.
MessageCache::transform | ( | $message, | |
$interface = false, | |||
$language = null, | |||
?PageReference | $page = null ) |
string | $message | |
bool | $interface | |
Language | null | $language | |
PageReference | null | $page |
Definition at line 1416 of file MessageCache.php.
MessageCache::updateMessageOverride | ( | $page, | |
?Content | $content = null ) |
Purge message caches when a MediaWiki: page is created, updated, or deleted.
PageIdentity | $page | Message page |
Content | null | $content | New content for edit/create, null on deletion |
Definition at line 1594 of file MessageCache.php.
const MessageCache::CONSTRUCTOR_OPTIONS |
Options to be included in the ServiceOptions.
Definition at line 67 of file MessageCache.php.
const MessageCache::MAX_REQUEST_LANGUAGES = 10 |
The size of the MapCacheLRU which stores message data.
The maximum number of languages which can be efficiently loaded in a given request.
Definition at line 84 of file MessageCache.php.