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

Collaboration diagram for MagicWord:

Public Member Functions
	__construct ( $id=0, $syn=[], $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.

	getRegexStartToEnd ()
	Gets a regex matching the word from start to end of a string.

	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)

	matchStartToEnd ( $text)
	Returns true if the text matched the word.

	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
bool	$mCaseSensitive

int	$mId
	#-

array	$mSynonyms

Static Public Attributes
static	$mCacheTTLs

static	$mDoubleUnderscoreArray = null

static	$mDoubleUnderscoreIDs

static	$mObjects = []

static	$mSubstIDs

static	$mVariableIDs

static	$mVariableIDsInitialised = false

Private Attributes
string	$mBaseRegex = ''

bool	$mFound = false

bool	$mModified = false

string	$mRegex = ''

string	$mRegexStart = ''

string	$mRegexStartToEnd = ''

string	$mVariableRegex = ''

string	$mVariableStartToEndRegex = ''

Detailed Description

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

Usage:: if (MagicWord::get( 'redirect' )->match( $text ) ) {

// some code

}

MagicWord\get
static & get( $id)
Factory: creates an object representing an ID.
Definition MagicWord.php:257

MagicWord\match
match( $text)
Returns true if the text contains the word.
Definition MagicWord.php:458

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 = [];

$magicWords['en'] = [

'magicwordkey' => [ 0, 'case_insensitive_magic_word' ],

'magicwordkey2' => [ 1, 'CASE_sensitive_magic_word2' ],

];

$magicWords
magicword txt Magic Words are some phrases used in the wikitext They are used for two that looks like templates but that don t accept any parameter *Parser functions(like {{fullurl:...}}, {{#special:...}}) $magicWords['en']
Definition magicword.txt:33

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

Definition at line 59 of file MagicWord.php.

Constructor & Destructor Documentation

◆ __construct()

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

#-

Definition at line 244 of file MagicWord.php.

References array().

Member Function Documentation

◆ addToArray()

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	$array
string	$value

Definition at line 682 of file MagicWord.php.

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

◆ clearCache()

static MagicWord::clearCache ( )

static

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

Definition at line 319 of file MagicWord.php.

Referenced by ParserTestRunner\perTestSetup(), ExtraParserTest\setUp(), and WikitextContentHandlerTest\testMakeRedirectContent().

◆ compareStringLength()

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

string	$s1
string	$s2

Returns: int

Definition at line 375 of file MagicWord.php.

◆ get()

static & MagicWord::get ( $id )

static

Factory: creates an object representing an ID.

Parameters

int $id

Returns: MagicWord

Definition at line 257 of file MagicWord.php.

Referenced by Parser\braceSubstitution(), Parser\cleanSig(), Parser\doDoubleUnderscore(), MagicWordArray\getBaseRegex(), MagicWordArray\getHash(), WikitextContent\getRedirectTargetAndText(), WikitextContentHandler\makeRedirectContent(), CoreParserFunctions\matchAgainstMagicword(), replaceMultiple(), DoubleRedirectJob\run(), Parser\setFunctionHook(), and JavaScriptContentTest\testMatchMagicWord().

◆ getBaseRegex()

MagicWord::getBaseRegex ( )

regex without the slashes and what not

Returns: string

Definition at line 444 of file MagicWord.php.

References $mBaseRegex, and initRegex().

◆ getCacheTTL()

static MagicWord::getCacheTTL ( $id )

static

Allow external reads of TTL array.

Parameters

int $id

Returns: int

Definition at line 294 of file MagicWord.php.

Referenced by Parser\braceSubstitution().

◆ getDoubleUnderscoreArray()

static MagicWord::getDoubleUnderscoreArray ( )

static

Get a MagicWordArray of double-underscore entities.

Returns: MagicWordArray

Definition at line 307 of file MagicWord.php.

References $mDoubleUnderscoreArray.

Referenced by Parser\doDoubleUnderscore(), and InfoAction\pageInfo().

◆ getId()

MagicWord::getId ( )

Returns: int

Definition at line 699 of file MagicWord.php.

References $mId.

◆ getRegex()

MagicWord::getRegex ( )

Gets a regex representing matching the word.

Returns: string

Definition at line 392 of file MagicWord.php.

References $mRegex, and initRegex().

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

◆ getRegexCase()

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 406 of file MagicWord.php.

References initRegex().

◆ getRegexStart()

MagicWord::getRegexStart ( )

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

Returns: string

Definition at line 419 of file MagicWord.php.

References $mRegexStart, and initRegex().

Referenced by matchStart(), and matchStartAndRemove().

◆ getRegexStartToEnd()

MagicWord::getRegexStartToEnd ( )

Gets a regex matching the word from start to end of a string.

Returns: string

Since: 1.23

Definition at line 432 of file MagicWord.php.

References $mRegexStartToEnd, and initRegex().

Referenced by matchStartToEnd().

◆ getSubstIDs()

static MagicWord::getSubstIDs ( )

static

Get an array of parser substitution modifier IDs.

Returns: array

Definition at line 284 of file MagicWord.php.

References $mSubstIDs.

Referenced by Parser\initialiseVariables().

◆ getSynonym()

MagicWord::getSynonym ( $i )

Accesses the synonym list directly.

Parameters

int $i

Returns: string

Definition at line 627 of file MagicWord.php.

◆ getSynonyms()

MagicWord::getSynonyms ( )

Returns: array

Definition at line 634 of file MagicWord.php.

References $mSynonyms.

◆ getVariableIDs()

static MagicWord::getVariableIDs ( )

static

Get an array of parser variable IDs.

Returns: array

Definition at line 271 of file MagicWord.php.

References $mVariableIDs.

Referenced by ApiQuerySiteinfo\appendVariables(), and Parser\initialiseVariables().

◆ getVariableRegex()

MagicWord::getVariableRegex ( )

Matches the word, where $1 is a wildcard.

Returns: string

Definition at line 601 of file MagicWord.php.

References $mVariableRegex, and initRegex().

Referenced by substituteCallback().

◆ getVariableStartToEndRegex()

MagicWord::getVariableStartToEndRegex ( )

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

Returns: string

Definition at line 613 of file MagicWord.php.

References $mVariableStartToEndRegex, and initRegex().

Referenced by matchVariableStartToEnd().

◆ getWasModified()

MagicWord::getWasModified ( )

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

Returns: bool

Definition at line 644 of file MagicWord.php.

References $mModified.

◆ initRegex()

MagicWord::initRegex ( )

Preliminary initialisation.

Access:\n private

Definition at line 343 of file MagicWord.php.

References $mSynonyms, and as.

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

◆ isCaseSensitive()

MagicWord::isCaseSensitive ( )

Returns: bool

Definition at line 692 of file MagicWord.php.

References $mCaseSensitive.

◆ load()

MagicWord::load ( $id )

Initialises this object with an ID.

Parameters

int $id

Exceptions

MWException

Definition at line 329 of file MagicWord.php.

References $wgContLang, and global.

◆ match()

MagicWord::match ( $text )

Returns true if the text contains the word.

Parameters

string $text

Returns: bool

Definition at line 458 of file MagicWord.php.

References getRegex().

Referenced by WikitextContent\matchMagicWord().

◆ matchAndRemove()

MagicWord::matchAndRemove ( & $text )

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

Parameters

string $text

Returns: bool

Definition at line 524 of file MagicWord.php.

References $mFound, and getRegex().

◆ matchStart()

MagicWord::matchStart ( $text )

Returns true if the text starts with the word.

Parameters

string $text

Returns: bool

Definition at line 469 of file MagicWord.php.

References getRegexStart().

◆ matchStartAndRemove()

MagicWord::matchStartAndRemove ( & $text )

Parameters

string $text

Returns: bool

Definition at line 539 of file MagicWord.php.

References $mFound, and getRegexStart().

◆ matchStartToEnd()

MagicWord::matchStartToEnd ( $text )

Returns true if the text matched the word.

Parameters

string $text

Returns: bool

Since: 1.23

Definition at line 481 of file MagicWord.php.

References getRegexStartToEnd().

◆ matchVariableStartToEnd()

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

string $text

Returns: string

Definition at line 495 of file MagicWord.php.

References $matches, and getVariableStartToEndRegex().

◆ pregRemoveAndRecord()

MagicWord::pregRemoveAndRecord ( )

Used in matchAndRemove()

Returns: string

Definition at line 555 of file MagicWord.php.

◆ replace()

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

Replaces the word with something else.

Parameters

string	$replacement
string	$subject
int	$limit

Returns: string

Definition at line 569 of file MagicWord.php.

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

◆ replaceMultiple()

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.

Deprecated:: since 1.25, unused

Parameters

array	$magicarr
string	$subject
string	$result

Returns: bool

Definition at line 661 of file MagicWord.php.

References as, get(), and wfDeprecated().

◆ substituteCallback()

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

string	$text
callable	$callback

Returns: string

Definition at line 590 of file MagicWord.php.

References $res, and getVariableRegex().

Member Data Documentation

◆ $mBaseRegex

string MagicWord::$mBaseRegex = ''

private

Definition at line 81 of file MagicWord.php.

Referenced by getBaseRegex().

◆ $mCacheTTLs

MagicWord::$mCacheTTLs

static

Definition at line 177 of file MagicWord.php.

◆ $mCaseSensitive

bool MagicWord::$mCaseSensitive

Definition at line 69 of file MagicWord.php.

Referenced by isCaseSensitive().

◆ $mDoubleUnderscoreArray

MagicWord::$mDoubleUnderscoreArray = null

static

Definition at line 240 of file MagicWord.php.

Referenced by getDoubleUnderscoreArray().

◆ $mDoubleUnderscoreIDs

MagicWord::$mDoubleUnderscoreIDs

static

Initial value:

= [
        'notoc',
        'nogallery',
        'forcetoc',
        'toc',
        'noeditsection',
        'newsectionlink',
        'nonewsectionlink',
        'hiddencat',
        'index',
        'noindex',
        'staticredirect',
        'notitleconvert',
        'nocontentconvert',
    ]

Definition at line 218 of file MagicWord.php.

◆ $mFound

bool MagicWord::$mFound = false

private

Definition at line 93 of file MagicWord.php.

Referenced by matchAndRemove(), and matchStartAndRemove().

◆ $mId

int MagicWord::$mId

#-

Definition at line 63 of file MagicWord.php.

Referenced by getId().

◆ $mModified

bool MagicWord::$mModified = false

private

Definition at line 90 of file MagicWord.php.

Referenced by getWasModified().

◆ $mObjects

MagicWord::$mObjects = []

static

Definition at line 239 of file MagicWord.php.

◆ $mRegex

string MagicWord::$mRegex = ''

private

Definition at line 72 of file MagicWord.php.

Referenced by getRegex().

◆ $mRegexStart

string MagicWord::$mRegexStart = ''

private

Definition at line 75 of file MagicWord.php.

Referenced by getRegexStart().

◆ $mRegexStartToEnd

string MagicWord::$mRegexStartToEnd = ''

private

Definition at line 78 of file MagicWord.php.

Referenced by getRegexStartToEnd().

◆ $mSubstIDs

MagicWord::$mSubstIDs

static

Initial value:

= [
        'subst',
        'safesubst',
    ]

Definition at line 234 of file MagicWord.php.

Referenced by getSubstIDs().

◆ $mSynonyms

array MagicWord::$mSynonyms

Definition at line 66 of file MagicWord.php.

Referenced by getSynonyms(), and initRegex().

◆ $mVariableIDs

MagicWord::$mVariableIDs

static

Definition at line 96 of file MagicWord.php.

Referenced by getVariableIDs().

◆ $mVariableIDsInitialised

MagicWord::$mVariableIDsInitialised = false

static

Definition at line 95 of file MagicWord.php.

◆ $mVariableRegex

string MagicWord::$mVariableRegex = ''

private

Definition at line 84 of file MagicWord.php.

Referenced by getVariableRegex().

◆ $mVariableStartToEndRegex

string MagicWord::$mVariableStartToEndRegex = ''

private

Definition at line 87 of file MagicWord.php.

Referenced by getVariableStartToEndRegex().

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

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addToArray()

◆ clearCache()

◆ compareStringLength()

◆ get()

◆ getBaseRegex()

◆ getCacheTTL()

◆ getDoubleUnderscoreArray()

◆ getId()

◆ getRegex()

◆ getRegexCase()

◆ getRegexStart()

◆ getRegexStartToEnd()

◆ getSubstIDs()

◆ getSynonym()

◆ getSynonyms()

◆ getVariableIDs()

◆ getVariableRegex()

◆ getVariableStartToEndRegex()

◆ getWasModified()

◆ initRegex()

◆ isCaseSensitive()

◆ load()

◆ match()

◆ matchAndRemove()

◆ matchStart()

◆ matchStartAndRemove()

◆ matchStartToEnd()

◆ matchVariableStartToEnd()

◆ pregRemoveAndRecord()

◆ replace()

◆ replaceMultiple()

◆ substituteCallback()

Member Data Documentation

◆ $mBaseRegex

◆ $mCacheTTLs

◆ $mCaseSensitive

◆ $mDoubleUnderscoreArray

◆ $mDoubleUnderscoreIDs

◆ $mFound

◆ $mId

◆ $mModified

◆ $mObjects

◆ $mRegex

◆ $mRegexStart

◆ $mRegexStartToEnd

◆ $mSubstIDs

◆ $mSynonyms

◆ $mVariableIDs

◆ $mVariableIDsInitialised

◆ $mVariableRegex

◆ $mVariableStartToEndRegex