<?php
+/**
+ * File for magic words
+ * @package MediaWiki
+ */
-# This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
-# Usage:
-# if (MagicWord::get( MAG_REDIRECT )->match( $text ) )
-#
-# Possible future improvements:
-# * Simultaneous searching for a number of magic words
-# * $wgMagicWords 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.
+/**
+ * private
+ */
+$wgMagicFound = false;
-/*private*/ $wgMagicFound = false;
define('MAG_REDIRECT', 0);
define('MAG_NOTOC', 1);
MAG_NAMESPACE
);
+/**
+ * This class encapsulates "magic words" such as #redirect, __NOTOC__, etc.
+ * Usage:
+ * if (MagicWord::get( MAG_REDIRECT )->match( $text ) )
+ *
+ * Possible future improvements:
+ * * Simultaneous searching for a number of magic words
+ * * $wgMagicWords 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.
+ *
+ * @package MediaWiki
+ */
class MagicWord {
- /*private*/ var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
- /*private*/ var $mRegexStart, $mBaseRegex, $mVariableRegex;
- /*private*/ var $mModified;
+ /**#@+
+ * @access private
+ */
+ var $mId, $mSynonyms, $mCaseSensitive, $mRegex;
+ var $mRegexStart, $mBaseRegex, $mVariableRegex;
+ var $mModified;
+ /**#@-*/
function MagicWord($id = 0, $syn = '', $cs = false) {
$this->mId = $id;
$this->mModified = false;
}
- # Factory: creates an object representing an ID
- /*static*/ function &get( $id ) {
+ /**
+ * Factory: creates an object representing an ID
+ * @static
+ */
+ function &get( $id ) {
global $wgMagicWords;
if ( !is_array( $wgMagicWords ) ) {
# Initialises this object with an ID
function load( $id ) {
- global $wgLang;
+ global $wgContLang;
$this->mId = $id;
- $wgLang->getMagic( $this );
+ $wgContLang->getMagic( $this );
}
- # Preliminary initialisation
- /* private */ function initRegex() {
+ /**
+ * Preliminary initialisation
+ * @private
+ */
+ function initRegex() {
$variableClass = Title::legalChars();
$escSyn = array_map( 'preg_quote', $this->mSynonyms );
$this->mBaseRegex = implode( '|', $escSyn );
$case = $this->mCaseSensitive ? '' : 'i';
$this->mRegex = "/{$this->mBaseRegex}/{$case}";
- $this->mRegexStart = "/^{$this->mBaseRegex}/{$case}";
+ $this->mRegexStart = "/^({$this->mBaseRegex})/{$case}";
$this->mVariableRegex = str_replace( "\\$1", "([$variableClass]*?)", $this->mRegex );
$this->mVariableStartToEndRegex = str_replace( "\\$1", "([$variableClass]*?)",
"/^({$this->mBaseRegex})$/{$case}" );
}
- # Gets a regex representing matching the word
+ /**
+ * Gets a regex representing matching the word
+ */
function getRegex() {
if ($this->mRegex == '' ) {
$this->initRegex();
return $this->mRegex;
}
- # Gets a regex matching the word, if it is at the
- # string start
+ /**
+ * Gets a regex matching the word, if it is at the string start
+ */
function getRegexStart() {
if ($this->mRegex == '' ) {
$this->initRegex();
return $this->mRegexStart;
}
- # regex without the slashes and what not
+ /**
+ * regex without the slashes and what not
+ */
function getBaseRegex() {
if ($this->mRegex == '') {
$this->initRegex();
return $this->mBaseRegex;
}
- # Returns true if the text contains the word
+ /**
+ * Returns true if the text contains the word
+ * @return bool
+ */
function match( $text ) {
return preg_match( $this->getRegex(), $text );
}
- # Returns true if the text starts with the word
+ /**
+ * Returns true if the text starts with the word
+ * @return bool
+ */
function matchStart( $text ) {
return preg_match( $this->getRegexStart(), $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.
+ /**
+ * 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.
+ */
function matchVariableStartToEnd( $text ) {
$matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
if ( $matchcount == 0 ) {
return NULL;
- } elseif ( count($matches) == 1 ) {
+ } elseif ( count($matches) == 2 ) {
return $matches[0];
} else {
- return $matches[1];
+ return $matches[2];
}
}
- # Returns true if the text matches the word, and alters the
- # input string, removing all instances of the word
+ /**
+ * Returns true if the text matches the word, and alters the
+ * input string, removing all instances of the word
+ */
function matchAndRemove( &$text ) {
global $wgMagicFound;
$wgMagicFound = false;
}
- # Replaces the word with something else
+ /**
+ * Replaces the word with something else
+ */
function replace( $replacement, $subject ) {
$res = preg_replace( $this->getRegex(), $replacement, $subject );
$this->mModified = !($res === $subject);
return $res;
}
- # Variable handling: {{SUBST:xxx}} style words
- # Calls back a function to determine what to replace xxx with
- # Input word must contain $1
+ /**
+ * Variable handling: {{SUBST:xxx}} style words
+ * Calls back a function to determine what to replace xxx with
+ * Input word must contain $1
+ */
function substituteCallback( $text, $callback ) {
$regex = $this->getVariableRegex();
$res = preg_replace_callback( $this->getVariableRegex(), $callback, $text );
return $res;
}
- # Matches the word, where $1 is a wildcard
+ /**
+ * Matches the word, where $1 is a wildcard
+ */
function getVariableRegex() {
if ( $this->mVariableRegex == '' ) {
$this->initRegex();
return $this->mVariableRegex;
}
- # Matches the entire string, where $1 is a wildcard
+ /**
+ * Matches the entire string, where $1 is a wildcard
+ */
function getVariableStartToEndRegex() {
if ( $this->mVariableStartToEndRegex == '' ) {
$this->initRegex();
return $this->mVariableStartToEndRegex;
}
- # Accesses the synonym list directly
+ /**
+ * Accesses the synonym list directly
+ */
function getSynonym( $i ) {
return $this->mSynonyms[$i];
}
- # Returns true if the last call to replace() or substituteCallback()
- # returned a modified text, otherwise false.
+ /**
+ * Returns true if the last call to replace() or substituteCallback()
+ * returned a modified text, otherwise false.
+ */
function getWasModified(){
return $this->mModified;
}
- # $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.
-
- /* static */ function 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.
+ * @static
+ **/
+ function replaceMultiple( $magicarr, $subject, &$result ){
$search = array();
$replace = array();
foreach( $magicarr as $id => $replacement ){
return !($result === $subject);
}
- # Adds all the synonyms of this MagicWord to an array, to allow quick lookup in a list of magic words
+ /**
+ * Adds all the synonyms of this MagicWord to an array, to allow quick
+ * lookup in a list of magic words
+ */
function addToArray( &$array, $value ) {
foreach ( $this->mSynonyms as $syn ) {
$array[$syn] = $value;
}
}
-# Used in matchAndRemove()
-/*private*/ function pregRemoveAndRecord( $match ) {
+/**
+ * Used in matchAndRemove()
+ * @private
+ **/
+function pregRemoveAndRecord( $match ) {
global $wgMagicFound;
$wgMagicFound = true;
return '';
dépôts / lhc / web / wiklou.git / blobdiff