X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;ds=sidebyside;f=includes%2FMagicWord.php;h=563d3a5621f796a6a8794e8d676c93157159c343;hb=65f2772e50d49c08a097b0a0af40d6c7c8bb7e05;hp=d30f7cce5410e624a9165e2cc3eb60499244b971;hpb=783d4e086228c4699efca02b29914aa72013ebf8;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/MagicWord.php b/includes/MagicWord.php index d30f7cce54..563d3a5621 100644 --- a/includes/MagicWord.php +++ b/includes/MagicWord.php @@ -35,6 +35,7 @@ class MagicWord { var $mRegexStart = ''; var $mBaseRegex = ''; var $mVariableRegex = ''; + var $mVariableStartToEndRegex = ''; var $mModified = false; var $mFound = false; @@ -190,21 +191,24 @@ class MagicWord { /** * Factory: creates an object representing an ID + * + * @param $id + * * @return MagicWord */ static function &get( $id ) { - wfProfileIn( __METHOD__ ); if ( !isset( self::$mObjects[$id] ) ) { $mw = new MagicWord(); $mw->load( $id ); self::$mObjects[$id] = $mw; } - wfProfileOut( __METHOD__ ); return self::$mObjects[$id]; } /** * Get an array of parser variable IDs + * + * @return array */ static function getVariableIDs() { if ( !self::$mVariableIDsInitialised ) { @@ -224,21 +228,31 @@ class MagicWord { /** * Get an array of parser substitution modifier IDs + * @return array */ static function getSubstIDs() { - return self::$mSubstIDs; + return self::$mSubstIDs; } - /* Allow external reads of TTL array */ - static function getCacheTTL($id) { - if (array_key_exists($id,self::$mCacheTTLs)) { + /** + * Allow external reads of TTL array + * + * @param $id int + * @return array + */ + static function getCacheTTL( $id ) { + if ( array_key_exists( $id, self::$mCacheTTLs ) ) { return self::$mCacheTTLs[$id]; } else { return -1; } } - /** Get a MagicWordArray of double-underscore entities */ + /** + * Get a MagicWordArray of double-underscore entities + * + * @return MagicWordArray + */ static function getDoubleUnderscoreArray() { if ( is_null( self::$mDoubleUnderscoreArray ) ) { self::$mDoubleUnderscoreArray = new MagicWordArray( self::$mDoubleUnderscoreIDs ); @@ -254,9 +268,14 @@ class MagicWord { self::$mObjects = array(); } - # Initialises this object with an ID + /** + * Initialises this object with an ID + * + * @param $id + */ function load( $id ) { global $wgContLang; + wfProfileIn( __METHOD__ ); $this->mId = $id; $wgContLang->getMagic( $this ); if ( !$this->mSynonyms ) { @@ -264,6 +283,7 @@ class MagicWord { #throw new MWException( "Error: invalid magic word '$id'" ); wfDebugLog( 'exception', "Error: invalid magic word '$id'\n" ); } + wfProfileOut( __METHOD__ ); } /** @@ -291,9 +311,14 @@ class MagicWord { } /** - * 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 + * 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. + * + * @param $s1 string + * @param $s2 string + * + * @return int */ function compareStringLength( $s1, $s2 ) { $l1 = strlen( $s1 ); @@ -309,6 +334,8 @@ class MagicWord { /** * Gets a regex representing matching the word + * + * @return string */ function getRegex() { if ($this->mRegex == '' ) { @@ -321,6 +348,8 @@ class MagicWord { * 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 + * + * @return string */ function getRegexCase() { if ( $this->mRegex === '' ) @@ -331,6 +360,8 @@ class MagicWord { /** * Gets a regex matching the word, if it is at the string start + * + * @return string */ function getRegexStart() { if ($this->mRegex == '' ) { @@ -341,6 +372,8 @@ class MagicWord { /** * regex without the slashes and what not + * + * @return string */ function getBaseRegex() { if ($this->mRegex == '') { @@ -351,6 +384,9 @@ class MagicWord { /** * Returns true if the text contains the word + * + * @param $text string + * * @return bool */ function match( $text ) { @@ -359,6 +395,9 @@ class MagicWord { /** * Returns true if the text starts with the word + * + * @param $text string + * * @return bool */ function matchStart( $text ) { @@ -370,6 +409,10 @@ class MagicWord { * 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. + * + * @param $text string + * + * @return string */ function matchVariableStartToEnd( $text ) { $matches = array(); @@ -384,8 +427,11 @@ class MagicWord { $matches = array_values(array_filter($matches)); - if ( count($matches) == 1 ) { return $matches[0]; } - else { return $matches[1]; } + if ( count($matches) == 1 ) { + return $matches[0]; + } else { + return $matches[1]; + } } } @@ -393,6 +439,10 @@ class MagicWord { /** * Returns true if the text matches the word, and alters the * input string, removing all instances of the word + * + * @param $text string + * + * @return bool */ function matchAndRemove( &$text ) { $this->mFound = false; @@ -400,6 +450,10 @@ class MagicWord { return $this->mFound; } + /** + * @param $text + * @return bool + */ function matchStartAndRemove( &$text ) { $this->mFound = false; $text = preg_replace_callback( $this->getRegexStart(), array( &$this, 'pregRemoveAndRecord' ), $text ); @@ -408,17 +462,24 @@ class MagicWord { /** * Used in matchAndRemove() - * @private - **/ - function pregRemoveAndRecord( ) { + * + * @return string + */ + function pregRemoveAndRecord() { $this->mFound = true; return ''; } /** * Replaces the word with something else - */ - function replace( $replacement, $subject, $limit=-1 ) { + * + * @param $replacement + * @param $subject + * @param $limit int + * + * @return string + */ + function replace( $replacement, $subject, $limit = -1 ) { $res = preg_replace( $this->getRegex(), StringUtils::escapeRegexReplacement( $replacement ), $subject, $limit ); $this->mModified = !($res === $subject); return $res; @@ -428,6 +489,11 @@ class MagicWord { * Variable handling: {{SUBST:xxx}} style words * Calls back a function to determine what to replace xxx with * Input word must contain $1 + * + * @param $text string + * @param $callback + * + * @return string */ function substituteCallback( $text, $callback ) { $res = preg_replace_callback( $this->getVariableRegex(), $callback, $text ); @@ -437,6 +503,8 @@ class MagicWord { /** * Matches the word, where $1 is a wildcard + * + * @return string */ function getVariableRegex() { if ( $this->mVariableRegex == '' ) { @@ -447,6 +515,8 @@ class MagicWord { /** * Matches the entire string, where $1 is a wildcard + * + * @return string */ function getVariableStartToEndRegex() { if ( $this->mVariableStartToEndRegex == '' ) { @@ -457,11 +527,18 @@ class MagicWord { /** * Accesses the synonym list directly + * + * @param $i int + * + * @return string */ function getSynonym( $i ) { return $this->mSynonyms[$i]; } + /** + * @return array + */ function getSynonyms() { return $this->mSynonyms; } @@ -469,6 +546,8 @@ class MagicWord { /** * Returns true if the last call to replace() or substituteCallback() * returned a modified text, otherwise false. + * + * @return bool */ function getWasModified(){ return $this->mModified; @@ -479,9 +558,14 @@ class MagicWord { * 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 * @todo Should this be static? It doesn't seem to be used at all - **/ + * + * @param $magicarr + * @param $subject + * @param $result + * + * @return bool + */ function replaceMultiple( $magicarr, $subject, &$result ){ $search = array(); $replace = array(); @@ -498,6 +582,9 @@ class MagicWord { /** * Adds all the synonyms of this MagicWord to an array, to allow quick * lookup in a list of magic words + * + * @param $array + * @param $value */ function addToArray( &$array, $value ) { global $wgContLang; @@ -506,10 +593,16 @@ class MagicWord { } } + /** + * @return bool + */ function isCaseSensitive() { return $this->mCaseSensitive; } + /** + * @return int + */ function getId() { return $this->mId; } @@ -531,6 +624,8 @@ class MagicWordArray { /** * Add a magic word by name + * + * @param $name string */ public function add( $name ) { $this->names[] = $name; @@ -539,6 +634,8 @@ class MagicWordArray { /** * Add a number of magic words by name + * + * @param $names array */ public function addArray( $names ) { $this->names = array_merge( $this->names, array_values( $names ) ); @@ -607,6 +704,8 @@ class MagicWordArray { /** * Get a regex for matching variables with parameters + * + * @return string */ function getVariableRegex() { return str_replace( "\\$1", "(.*?)", $this->getRegex() ); @@ -614,6 +713,8 @@ class MagicWordArray { /** * Get a regex anchored to the start of the string that does not match parameters + * + * @return array */ function getRegexStart() { $base = $this->getBaseRegex(); @@ -622,13 +723,15 @@ class MagicWordArray { $newRegex[0] = "/^(?:{$base[0]})/iuS"; } if ( $base[1] !== '' ) { - $newRegex[1] = "/^(?:{$base[1]})/S"; + $newRegex[1] = "/^(?:{$base[1]})/S"; } return $newRegex; } /** * Get an anchored regex for matching variables with parameters + * + * @return array */ function getVariableStartToEndRegex() { $base = $this->getBaseRegex(); @@ -646,6 +749,10 @@ class MagicWordArray { * Parse a match array from preg_match * Returns array(magic word ID, parameter value) * If there is no parameter value, that element will be false. + * + * @param $m array + * + * @return array */ function parseMatch( $m ) { reset( $m ); @@ -672,6 +779,10 @@ class MagicWordArray { * Returns an array with the magic word name in the first element and the * parameter in the second element. * Both elements are false if there was no match. + * + * @param $text string + * + * @return array */ public function matchVariableStartToEnd( $text ) { $regexes = $this->getVariableStartToEndRegex(); @@ -689,6 +800,10 @@ class MagicWordArray { /** * Match some text, without parameter capture * Returns the magic word name, or false if there was no capture + * + * @param $text string + * + * @return string|false */ public function matchStartToEnd( $text ) { $hash = $this->getHash(); @@ -706,6 +821,10 @@ class MagicWordArray { /** * Returns an associative array, ID => param value, for all items that match * Removes the matched items from the input string (passed by reference) + * + * @param $text string + * + * @return array */ public function matchAndRemove( &$text ) { $found = array(); @@ -729,6 +848,10 @@ class MagicWordArray { * the prefix from $text. * Return false if no match found and $text is not modified. * Does not match parameters. + * + * @param $text string + * + * @return int|false */ public function matchStartAndRemove( &$text ) { $regexes = $this->getRegexStart();