$out is needed here
[lhc/web/wiklou.git] / includes / MagicWord.php
index 578f18e..7c027d4 100644 (file)
@@ -1,6 +1,8 @@
 <?php
 /**
  * File for magic words
+ * See docs/magicword.txt
+ *
  * @addtogroup Parser
  */
 
@@ -100,6 +102,7 @@ class MagicWord {
                'pagesinnamespace',
                'numberofadmins',
                'defaultsort',
+               'pagesincategory',
        );
        
        /* Array of caching hints for ParserCache */
@@ -140,7 +143,19 @@ class MagicWord {
                'numberofadmins' => 3600,
                );
 
+       static public $mDoubleUnderscoreIDs = array(
+               'notoc',
+               'nogallery',
+               'forcetoc',
+               'toc',
+               'noeditsection',
+               'newsectionlink',
+               'hiddencat',
+       );
+
+
        static public $mObjects = array();
+       static public $mDoubleUnderscoreArray = null;
 
        /**#@-*/
 
@@ -160,11 +175,13 @@ class MagicWord {
         * @static
         */
        static function &get( $id ) {
+               wfProfileIn( __METHOD__ );
                if (!array_key_exists( $id, self::$mObjects ) ) {
                        $mw = new MagicWord();
                        $mw->load( $id );
                        self::$mObjects[$id] = $mw;
                }
+               wfProfileOut( __METHOD__ );
                return self::$mObjects[$id];
        }
 
@@ -195,7 +212,14 @@ class MagicWord {
                        return -1;
                }
        }
-       
+
+       /** Get a MagicWordArray of double-underscore entities */
+       static function getDoubleUnderscoreArray() {
+               if ( is_null( self::$mDoubleUnderscoreArray ) ) {
+                       self::$mDoubleUnderscoreArray = new MagicWordArray( self::$mDoubleUnderscoreIDs );
+               }
+               return self::$mDoubleUnderscoreArray;
+       }
        
        # Initialises this object with an ID
        function load( $id ) {
@@ -447,6 +471,7 @@ class MagicWordArray {
        var $names = array();
        var $hash;
        var $baseRegex, $regex;
+       var $matches;
 
        function __construct( $names = array() ) {
                $this->names = $names;
@@ -553,6 +578,8 @@ 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.
         */
        function parseMatch( $m ) {
                reset( $m );
@@ -611,4 +638,25 @@ class MagicWordArray {
                }
                return false;
        }
+
+       /**
+        * Returns an associative array, ID => param value, for all items that match
+        * Removes the matched items from the input string (passed by reference)
+        */
+       public function matchAndRemove( &$text ) {
+               $found = array();
+               $regexes = $this->getRegex();
+               foreach ( $regexes as $regex ) {
+                       if ( $regex === '' ) {
+                               continue;
+                       }
+                       preg_match_all( $regex, $text, $matches, PREG_SET_ORDER );
+                       foreach ( $matches as $m ) {
+                               list( $name, $param ) = $this->parseMatch( $m );
+                               $found[$name] = $param;
+                       }
+                       $text = preg_replace( $regex, '', $text );
+               }
+               return $found;
+       }
 }