(bug 22647) Add category details in search results. Contributed by Lejonel.
[lhc/web/wiklou.git] / includes / MagicWord.php
index aad267b..d741832 100644 (file)
@@ -161,8 +161,14 @@ class MagicWord {
                'index',
                'noindex',
                'staticredirect',
+               'notitleconvert',
+               'nocontentconvert',
        );
 
+       static public $mSubstIDs = array(
+               'subst',
+               'safesubst',
+       );
 
        static public $mObjects = array();
        static public $mDoubleUnderscoreArray = null;
@@ -214,6 +220,13 @@ class MagicWord {
                return self::$mVariableIDs;
        }
 
+       /**
+        * Get an array of parser substitution modifier IDs
+        */
+       static function getSubstIDs() {
+               return self::$mSubstIDs; 
+       }
+
        /* Allow external reads of TTL array */
        static function getCacheTTL($id) {
                if (array_key_exists($id,self::$mCacheTTLs)) {
@@ -318,19 +331,19 @@ class MagicWord {
        }
 
        /**
-        * Returns the number of times the text contains the word
-        * @return int
+        * Returns true if the text contains the word
+        * @return bool
         */
        function match( $text ) {
-               return preg_match( $this->getRegex(), $text );
+               return (bool)preg_match( $this->getRegex(), $text );
        }
 
        /**
-        * Returns if the text starts with the word
-        * @return int
+        * Returns true if the text starts with the word
+        * @return bool
         */
        function matchStart( $text ) {
-               return preg_match( $this->getRegexStart(), $text );
+               return (bool)preg_match( $this->getRegexStart(), $text );
        }
 
        /**
@@ -343,7 +356,7 @@ class MagicWord {
                $matches = array();
                $matchcount = preg_match( $this->getVariableStartToEndRegex(), $text, $matches );
                if ( $matchcount == 0 ) {
-                       return NULL;
+                       return null;
                } else {
                        # multiple matched parts (variable match); some will be empty because of
                        # synonyms. The variable will be the second non-empty one so remove any
@@ -557,7 +570,7 @@ class MagicWordArray {
        }
 
        /**
-        * Get an unanchored regex
+        * Get an unanchored regex that does not match parameters
         */
        function getRegex() {
                if ( is_null( $this->regex ) ) {
@@ -574,14 +587,29 @@ class MagicWordArray {
        }
 
        /**
-        * Get a regex for matching variables
+        * Get a regex for matching variables with parameters
         */
        function getVariableRegex() {
                return str_replace( "\\$1", "(.*?)", $this->getRegex() );
        }
 
        /**
-        * Get an anchored regex for matching variables
+        * Get a regex anchored to the start of the string that does not match parameters
+        */
+       function getRegexStart() {
+               $base = $this->getBaseRegex();
+               $newRegex = array( '', '' );
+               if ( $base[0] !== '' ) {
+                       $newRegex[0] = "/^(?:{$base[0]})/iuS";
+               }
+               if ( $base[1] !== '' ) {
+                       $newRegex[1] = "/^(?:{$base[1]})/S"; 
+               }
+               return $newRegex;
+       }
+
+       /**
+        * Get an anchored regex for matching variables with parameters
         */
        function getVariableStartToEndRegex() {
                $base = $this->getBaseRegex();
@@ -678,4 +706,29 @@ class MagicWordArray {
                }
                return $found;
        }
+
+       /**
+        * Return the ID of the magic word at the start of $text, and remove
+        * the prefix from $text.
+        * Return false if no match found and $text is not modified.
+        * Does not match parameters.
+        */
+       public function matchStartAndRemove( &$text ) {
+               $regexes = $this->getRegexStart();
+               foreach ( $regexes as $regex ) {
+                       if ( $regex === '' ) {
+                               continue;
+                       }
+                       if ( preg_match( $regex, $text, $m ) ) {
+                               list( $id, $param ) = $this->parseMatch( $m );
+                               if ( strlen( $m[0] ) >= strlen( $text ) ) {
+                                       $text = '';
+                               } else {
+                                       $text = substr( $text, strlen( $m[0] ) );
+                               }
+                               return $id;
+                       }
+               }
+               return false;
+       }
 }