Go to the documentation of this file.
104 'currentmonthnamegen',
105 'currentmonthabbrev',
164 'numberofactiveusers',
184 'currentmonth' => 86400,
185 'currentmonth1' => 86400,
186 'currentmonthname' => 86400,
187 'currentmonthnamegen' => 86400,
188 'currentmonthabbrev' => 86400,
189 'currentday' => 3600,
190 'currentday2' => 3600,
191 'currentdayname' => 3600,
192 'currentyear' => 86400,
193 'currenttime' => 3600,
194 'currenthour' => 3600,
195 'localmonth' => 86400,
196 'localmonth1' => 86400,
197 'localmonthname' => 86400,
198 'localmonthnamegen' => 86400,
199 'localmonthabbrev' => 86400,
202 'localdayname' => 3600,
203 'localyear' => 86400,
206 'numberofarticles' => 3600,
207 'numberoffiles' => 3600,
208 'numberofedits' => 3600,
209 'currentweek' => 3600,
210 'currentdow' => 3600,
213 'numberofusers' => 3600,
214 'numberofactiveusers' => 3600,
215 'numberofpages' => 3600,
216 'currentversion' => 86400,
217 'currenttimestamp' => 3600,
218 'localtimestamp' => 3600,
219 'pagesinnamespace' => 3600,
220 'numberofadmins' => 3600,
221 'numberingroup' => 3600,
264 public function __construct( $id =
null, $syn = [], $cs =
false ) {
266 $this->mSynonyms = (
array)$syn;
267 $this->mCaseSensitive = $cs;
277 public static function &
get( $id ) {
278 if ( !isset( self::$mObjects[$id] ) ) {
281 self::$mObjects[$id] = $mw;
283 return self::$mObjects[$id];
292 if ( !self::$mVariableIDsInitialised ) {
294 Hooks::run(
'MagicWordwgVariableIDs', [ &self::$mVariableIDs ] );
295 self::$mVariableIDsInitialised =
true;
315 if ( array_key_exists( $id, self::$mCacheTTLs ) ) {
316 return self::$mCacheTTLs[$id];
328 if ( is_null( self::$mDoubleUnderscoreArray ) ) {
329 Hooks::run(
'GetDoubleUnderscoreIDs', [ &self::$mDoubleUnderscoreIDs ] );
330 self::$mDoubleUnderscoreArray =
new MagicWordArray( self::$mDoubleUnderscoreIDs );
340 self::$mObjects = [];
353 if ( !$this->mSynonyms ) {
354 $this->mSynonyms = [
'brionmademeputthishere' ];
355 throw new MWException(
"Error: invalid magic word '$id'" );
367 usort( $synonyms, [ $this,
'compareStringLength' ] );
370 foreach ( $synonyms
as $synonym ) {
372 $escSyn[] = preg_quote( $synonym,
'/' );
374 $this->mBaseRegex = implode(
'|', $escSyn );
376 $case = $this->mCaseSensitive ?
'' :
'iu';
377 $this->mRegex =
"/{$this->mBaseRegex}/{$case}";
378 $this->mRegexStart =
"/^(?:{$this->mBaseRegex})/{$case}";
379 $this->mRegexStartToEnd =
"/^(?:{$this->mBaseRegex})$/{$case}";
380 $this->mVariableRegex = str_replace(
"\\$1",
"(.*?)", $this->mRegex );
381 $this->mVariableStartToEndRegex = str_replace(
"\\$1",
"(.*?)",
382 "/^(?:{$this->mBaseRegex})$/{$case}" );
400 } elseif ( $l1 > $l2 ) {
413 if ( $this->mRegex ==
'' ) {
427 if ( $this->mRegex ===
'' ) {
431 return $this->mCaseSensitive ?
'' :
'iu';
440 if ( $this->mRegex ==
'' ) {
453 if ( $this->mRegexStartToEnd ==
'' ) {
465 if ( $this->mRegex ==
'' ) {
479 return (
bool)preg_match( $this->
getRegex(), $text );
518 if ( $matchcount == 0 ) {
521 # multiple matched parts (variable match); some will be empty because of
522 # synonyms. The variable will be the second non-empty one so remove any
523 # blank elements and re-sort the indices.
545 $this->mFound =
false;
546 $text = preg_replace_callback(
548 [ $this,
'pregRemoveAndRecord' ],
560 $this->mFound =
false;
561 $text = preg_replace_callback(
563 [ $this,
'pregRemoveAndRecord' ],
576 $this->mFound =
true;
589 public function replace( $replacement, $subject, $limit = -1 ) {
596 $this->mModified =
$res !== $subject;
612 $this->mModified =
$res !== $text;
622 if ( $this->mVariableRegex ==
'' ) {
634 if ( $this->mVariableStartToEndRegex ==
'' ) {
648 return $this->mSynonyms[$i];
677 foreach ( $this->mSynonyms
as $syn ) {
Class for handling an array of magic words.
substituteCallback( $text, $callback)
Variable handling: {{SUBST:xxx}} style words Calls back a function to determine what to replace xxx w...
matchVariableStartToEnd( $text)
Returns NULL if there's no match, the value of $1 otherwise The return code is the matched string,...
__construct( $id=null, $syn=[], $cs=false)
#-
static bool $mVariableIDsInitialised
load( $id)
Initialises this object with an ID.
getRegexStartToEnd()
Gets a regex matching the word from start to end of a string.
static escapeRegexReplacement( $string)
Escape a string to make it suitable for inclusion in a preg_replace() replacement parameter.
getRegex()
Gets a regex representing matching the word.
static string[] $mSubstIDs
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
initRegex()
Preliminary initialisation.
replace( $replacement, $subject, $limit=-1)
Replaces the word with something else.
matchStartToEnd( $text)
Returns true if the text matched the word.
static getVariableIDs()
Get an array of parser variable IDs.
static getCacheTTL( $id)
Allow external reads of TTL array.
static array $mCacheTTLs
Array of caching hints for ParserCache [ string => int ].
getWasModified()
Returns true if the last call to replace() or substituteCallback() returned a modified text,...
string $mVariableStartToEndRegex
when a variable name is used in a it is silently declared as a new masking the global
pregRemoveAndRecord()
Used in matchAndRemove()
This class encapsulates "magic words" such as "#redirect", NOTOC, etc.
getRegexStart()
Gets a regex matching the word, if it is at the string start.
getBaseRegex()
regex without the slashes and what not
static clearCache()
Clear the self::$mObjects variable For use in parser tests.
matchStartAndRemove(&$text)
getVariableRegex()
Matches the word, where $1 is a wildcard.
static string[] $mDoubleUnderscoreIDs
addToArray(&$array, $value)
Adds all the synonyms of this MagicWord to an array, to allow quick lookup in a list of magic words.
static getSubstIDs()
Get an array of parser substitution modifier IDs.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
matchStart( $text)
Returns true if the text starts with the word.
static MagicWordArray $mDoubleUnderscoreArray
static getDoubleUnderscoreArray()
Get a MagicWordArray of double-underscore entities.
static string[] $mVariableIDs
getRegexCase()
Gets the regexp case modifier to use, i.e.
getVariableStartToEndRegex()
Matches the entire string, where $1 is a wildcard.
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
getSynonym( $i)
Accesses the synonym list directly.
compareStringLength( $s1, $s2)
A comparison function that returns -1, 0 or 1 depending on whether the first string is longer,...
matchAndRemove(&$text)
Returns true if the text matches the word, and alters the input string, removing all instances of the...
match( $text)
Returns true if the text contains the word.
the array() calling protocol came about after MediaWiki 1.4rc1.
static array $mObjects
[ string => MagicWord ]
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang