This class encapsulates "magic words" such as "#redirect", __NOTOC__, etc. More...

Public Member Functions
	__construct ($id=0, $syn=array(), $cs=false)
	#@-
	addToArray (&$array, $value)
	Adds all the synonyms of this MagicWord to an array, to allow quick lookup in a list of magic words.
	compareStringLength ($s1, $s2)
	A comparison function that returns -1, 0 or 1 depending on whether the first string is longer, the same length or shorter than the second string.
	getBaseRegex ()
	regex without the slashes and what not
	getId ()
	getRegex ()
	Gets a regex representing matching the word.
	getRegexCase ()
	Gets the regexp case modifier to use, i.e.
	getRegexStart ()
	Gets a regex matching the word, if it is at the string start.
	getSynonym ($i)
	Accesses the synonym list directly.
	getSynonyms ()
	getVariableRegex ()
	Matches the word, where $1 is a wildcard.
	getVariableStartToEndRegex ()
	Matches the entire string, where $1 is a wildcard.
	getWasModified ()
	Returns true if the last call to replace() or substituteCallback() returned a modified text, otherwise false.
	initRegex ()
	Preliminary initialisation.
	isCaseSensitive ()
	load ($id)
	Initialises this object with an ID.
	match ($text)
	Returns true if the text contains the word.
	matchAndRemove (&$text)
	Returns true if the text matches the word, and alters the input string, removing all instances of the word.
	matchStart ($text)
	Returns true if the text starts with the word.
	matchStartAndRemove (&$text)
	matchVariableStartToEnd ($text)
	Returns NULL if there's no match, the value of $1 otherwise The return code is the matched string, if there's no variable part in the regex and the matched variable part ($1) if there is one.
	pregRemoveAndRecord ()
	Used in matchAndRemove()
	replace ($replacement, $subject, $limit=-1)
	Replaces the word with something else.
	replaceMultiple ($magicarr, $subject, &$result)
	$magicarr is an associative array of (magic word ID => replacement) This method uses the php feature to do several replacements at the same time, thereby gaining some efficiency.
	substituteCallback ($text, $callback)
	Variable handling: {{SUBST:xxx}} style words Calls back a function to determine what to replace xxx with Input word must contain $1.
Static Public Member Functions
static	clearCache ()
	Clear the self::$mObjects variable For use in parser tests.
static &	get ($id)
	Factory: creates an object representing an ID.
static	getCacheTTL ($id)
	Allow external reads of TTL array.
static	getDoubleUnderscoreArray ()
	Get a MagicWordArray of double-underscore entities.
static	getSubstIDs ()
	Get an array of parser substitution modifier IDs.
static	getVariableIDs ()
	Get an array of parser variable IDs.
Public Attributes
	$mBaseRegex = ''
	$mCaseSensitive
	$mFound = false
	$mId
	#@+
	$mModified = false
	$mRegex = ''
	$mRegexStart = ''
	$mSynonyms
	$mVariableRegex = ''
	$mVariableStartToEndRegex = ''
Static Public Attributes
static	$mCacheTTLs
static	$mDoubleUnderscoreArray = null
static	$mDoubleUnderscoreIDs
static	$mObjects = array()
static	$mSubstIDs
static	$mVariableIDs
static	$mVariableIDsInitialised = false

Detailed Description

This class encapsulates "magic words" such as "#redirect", __NOTOC__, etc.

Usage:

     if (MagicWord::get( 'redirect' )->match( $text ) ) {
       // some code
     }

Possible future improvements: * Simultaneous searching for a number of magic words * MagicWord::$mObjects in shared memory

Please avoid reading the data out of one of these objects and then writing special case code. If possible, add another match()-like function here.

To add magic words in an extension, use $magicWords in a file listed in $wgExtensionMessagesFiles[].

Example:

 $magicWords = array();

 $magicWords['en'] = array(
    'magicwordkey' => array( 0, 'case_insensitive_magic_word' ),
    'magicwordkey2' => array( 1, 'CASE_sensitive_magic_word2' ),
 );

For magic words which are also Parser variables, add a MagicWordwgVariableIDs hook. Use string keys.

Definition at line 61 of file MagicWord.php.

Constructor & Destructor Documentation

MagicWord::__construct	(	$	id = `0`,
		$	syn = `array()`,
		$	cs = `false`
	)

#@-

Definition at line 223 of file MagicWord.php.

References array().

Member Function Documentation

MagicWord::addToArray	(	&$	array,
		$	value
	)

Adds all the synonyms of this MagicWord to an array, to allow quick lookup in a list of magic words.

Parameters:

$array
$value

Definition at line 622 of file MagicWord.php.

References $value, $wgContLang, as, and global.

static MagicWord::clearCache ( ) [static]

Clear the self::$mObjects variable For use in parser tests.

Definition at line 298 of file MagicWord.php.

References array().

Referenced by ExtraParserTest\setUp(), and NewParserTest\setupGlobals().

MagicWord::compareStringLength	(	$	s1,
		$	s2
	)

A comparison function that returns -1, 0 or 1 depending on whether the first string is longer, the same length or shorter than the second string.

Parameters:

$s1	string
$s2	string

Returns:: int

Definition at line 356 of file MagicWord.php.

static& MagicWord::get ( $ id ) [static]

Factory: creates an object representing an ID.

Parameters:

$id

Returns:: MagicWord

Definition at line 236 of file MagicWord.php.

Referenced by MagicWordArray\getBaseRegex(), MagicWordArray\getHash(), WikitextContent\getRedirectTarget(), WikitextContentHandler\makeRedirectContent(), CoreParserFunctions\matchAgainstMagicword(), replaceMultiple(), DoubleRedirectJob\run(), and JavaScriptContentTest\testMatchMagicWord().

MagicWord::getBaseRegex ( )

regex without the slashes and what not

Returns:: string

Definition at line 412 of file MagicWord.php.

References initRegex().

static MagicWord::getCacheTTL ( $ id ) [static]

Allow external reads of TTL array.

Parameters:

$id int

Returns:: array

Definition at line 273 of file MagicWord.php.

static MagicWord::getDoubleUnderscoreArray ( ) [static]

Get a MagicWordArray of double-underscore entities.

Returns:: MagicWordArray

Definition at line 286 of file MagicWord.php.

References $mDoubleUnderscoreArray, array(), and wfRunHooks().

Referenced by InfoAction\pageInfo().

MagicWord::getId ( )

Returns:: int

Definition at line 639 of file MagicWord.php.

MagicWord::getRegex ( )

Gets a regex representing matching the word.

Returns:: string

Definition at line 373 of file MagicWord.php.

References initRegex().

Referenced by match(), matchAndRemove(), and replace().

MagicWord::getRegexCase ( )

Gets the regexp case modifier to use, i.e.

i or nothing, to be used if one is using MagicWord::getBaseRegex(), otherwise it'll be included in the complete expression

Returns:: string

Definition at line 387 of file MagicWord.php.

References initRegex().

MagicWord::getRegexStart ( )

Gets a regex matching the word, if it is at the string start.

Returns:: string

Definition at line 400 of file MagicWord.php.

References initRegex().

Referenced by matchStart(), and matchStartAndRemove().

static MagicWord::getSubstIDs ( ) [static]

Get an array of parser substitution modifier IDs.

Returns:: array

Definition at line 263 of file MagicWord.php.

References $mSubstIDs.

MagicWord::getSynonym ( $ i )

Accesses the synonym list directly.

Parameters:

$i int

Returns:: string

Definition at line 568 of file MagicWord.php.

MagicWord::getSynonyms ( )

Returns:: array

Definition at line 575 of file MagicWord.php.

static MagicWord::getVariableIDs ( ) [static]

Get an array of parser variable IDs.

Returns:: array

Definition at line 250 of file MagicWord.php.

References $mVariableIDs, array(), and wfRunHooks().

Referenced by ApiQuerySiteinfo\appendVariables().

MagicWord::getVariableRegex ( )

Matches the word, where $1 is a wildcard.

Returns:: string

Definition at line 542 of file MagicWord.php.

References initRegex().

Referenced by substituteCallback().

MagicWord::getVariableStartToEndRegex ( )

Matches the entire string, where $1 is a wildcard.

Returns:: string

Definition at line 554 of file MagicWord.php.

References initRegex().

Referenced by matchVariableStartToEnd().

MagicWord::getWasModified ( )

Returns true if the last call to replace() or substituteCallback() returned a modified text, otherwise false.

Returns:: bool

Definition at line 585 of file MagicWord.php.

MagicWord::initRegex ( )

Preliminary initialisation.

Access:: private

Definition at line 325 of file MagicWord.php.

References array(), and as.

Referenced by getBaseRegex(), getRegex(), getRegexCase(), getRegexStart(), getVariableRegex(), and getVariableStartToEndRegex().

MagicWord::isCaseSensitive ( )

Returns:: bool

Definition at line 632 of file MagicWord.php.

MagicWord::load ( $ id )

Initialises this object with an ID.

Parameters:

$id

Exceptions:

MWException

Definition at line 308 of file MagicWord.php.

References $wgContLang, array(), global, wfProfileIn(), and wfProfileOut().

MagicWord::match ( $ text )

Returns true if the text contains the word.

Parameters:

$text string

Returns:: bool

Definition at line 426 of file MagicWord.php.

References getRegex().

Referenced by WikitextContent\matchMagicWord().

MagicWord::matchAndRemove ( &$ text )

Returns true if the text matches the word, and alters the input string, removing all instances of the word.

Parameters:

$text string

Returns:: bool

Definition at line 480 of file MagicWord.php.

References array(), and getRegex().

MagicWord::matchStart ( $ text )

Returns true if the text starts with the word.

Parameters:

$text string

Returns:: bool

Definition at line 437 of file MagicWord.php.

References getRegexStart().

MagicWord::matchStartAndRemove ( &$ text )

Parameters:

$text

Returns:: bool

Definition at line 490 of file MagicWord.php.

References array(), and getRegexStart().

MagicWord::matchVariableStartToEnd ( $ text )

Returns NULL if there's no match, the value of $1 otherwise The return code is the matched string, if there's no variable part in the regex and the matched variable part ($1) if there is one.

Parameters:

$text string

Returns:: string

Definition at line 451 of file MagicWord.php.

References $matches, array(), and getVariableStartToEndRegex().

MagicWord::pregRemoveAndRecord ( )

Used in matchAndRemove()

Returns:: string

Definition at line 501 of file MagicWord.php.

MagicWord::replace	(	$	replacement,
		$	subject,
		$	limit = `-1`
	)

Replaces the word with something else.

Parameters:

$replacement
$subject
$limit	int

Returns:: string

Definition at line 515 of file MagicWord.php.

References $limit, $res, StringUtils\escapeRegexReplacement(), and getRegex().

MagicWord::replaceMultiple	(	$	magicarr,
		$	subject,
		&$	result
	)

$magicarr is an associative array of (magic word ID => replacement) This method uses the php feature to do several replacements at the same time, thereby gaining some efficiency.

The result is placed in the out variable $result. The return value is true if something was replaced.

Todo:: Should this be static? It doesn't seem to be used at all

Parameters:

$magicarr
$subject
$result

Returns:: bool

Definition at line 602 of file MagicWord.php.

References $result, array(), as, and get().

MagicWord::substituteCallback	(	$	text,
		$	callback
	)

Variable handling: {{SUBST:xxx}} style words Calls back a function to determine what to replace xxx with Input word must contain $1.

Parameters:

$text	string
$callback

Returns:: string

Definition at line 531 of file MagicWord.php.

References $res, and getVariableRegex().

Member Data Documentation

MagicWord::$mBaseRegex = ''

Definition at line 68 of file MagicWord.php.

MagicWord::$mCacheTTLs [static]

Definition at line 155 of file MagicWord.php.

MagicWord::$mCaseSensitive

Definition at line 65 of file MagicWord.php.

MagicWord::$mDoubleUnderscoreArray = null [static]

Definition at line 219 of file MagicWord.php.

Referenced by getDoubleUnderscoreArray().

MagicWord::$mDoubleUnderscoreIDs [static]

Initial value:

 array(
        'notoc',
        'nogallery',
        'forcetoc',
        'toc',
        'noeditsection',
        'newsectionlink',
        'nonewsectionlink',
        'hiddencat',
        'index',
        'noindex',
        'staticredirect',
        'notitleconvert',
        'nocontentconvert',
    )

Definition at line 197 of file MagicWord.php.

MagicWord::$mFound = false

Definition at line 72 of file MagicWord.php.

MagicWord::$mId

#@+

Access:: private

Definition at line 65 of file MagicWord.php.

MagicWord::$mModified = false

Definition at line 71 of file MagicWord.php.

MagicWord::$mObjects = array() [static]

Definition at line 218 of file MagicWord.php.

MagicWord::$mRegex = ''

Definition at line 66 of file MagicWord.php.

MagicWord::$mRegexStart = ''

Definition at line 67 of file MagicWord.php.

MagicWord::$mSubstIDs [static]

Initial value:

 array(
        'subst',
        'safesubst',
    )

Definition at line 213 of file MagicWord.php.

Referenced by getSubstIDs().

MagicWord::$mSynonyms

Definition at line 65 of file MagicWord.php.

MagicWord::$mVariableIDs [static]

Definition at line 75 of file MagicWord.php.

Referenced by getVariableIDs().

MagicWord::$mVariableIDsInitialised = false [static]

Definition at line 74 of file MagicWord.php.

MagicWord::$mVariableRegex = ''

Definition at line 69 of file MagicWord.php.

MagicWord::$mVariableStartToEndRegex = ''

Definition at line 70 of file MagicWord.php.

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

includes/MagicWord.php

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation