Merge "Follow-up I0b781c11 (2a55449): use User::getAutomaticGroups()."

[lhc/web/wiklou.git] / includes / parser / Preprocessor_HipHop.hphp

diff --git a/includes/parser/Preprocessor_HipHop.hphp b/includes/parser/Preprocessor_HipHop.hphp
index b30b096..2593b58 100644 (file)
--- a/includes/parser/Preprocessor_HipHop.hphp
+++ b/includes/parser/Preprocessor_HipHop.hphp
@@ -33,6 +33,9 @@ class Preprocessor_HipHop implements Preprocessor {
 
        const CACHE_VERSION = 1;
 
+       /**
+        * @param $parser Parser
+        */
        function __construct( $parser ) {
                $this->parser = $parser;
        }
@@ -45,7 +48,7 @@ class Preprocessor_HipHop implements Preprocessor {
        }
 
        /**
-        * @param $args
+        * @param $args array
         * @return PPCustomFrame_HipHop
         */
        function newCustomFrame( array $args ) {
@@ -103,6 +106,7 @@ class Preprocessor_HipHop implements Preprocessor {
         * cache may be implemented at a later date which takes further advantage of these strict
         * dependency requirements.
         *
+        * @throws MWException
         * @return PPNode_HipHop_Tree
         */
        function preprocessToObj( string $text, int $flags = 0 ) {
@@ -111,7 +115,9 @@ class Preprocessor_HipHop implements Preprocessor {
                // Check cache.
                global $wgMemc, $wgPreprocessorCacheThreshold;
 
-               $cacheable = ($wgPreprocessorCacheThreshold !== false && strlen( $text ) > $wgPreprocessorCacheThreshold);
+               $lengthText = strlen( $text );
+
+               $cacheable = ($wgPreprocessorCacheThreshold !== false && $lengthText > $wgPreprocessorCacheThreshold);
                if ( $cacheable ) {
                        wfProfileIn( __METHOD__.'-cacheable' );
 
@@ -235,7 +241,7 @@ class Preprocessor_HipHop implements Preprocessor {
                                        $accum->addLiteral( strval( substr( $text, $i, $literalLength ) ) );
                                        $i += $literalLength;
                                }
-                               if ( $i >= strlen( $text ) ) {
+                               if ( $i >= $lengthText ) {
                                        if ( $currentClosing === "\n" ) {
                                                // Do a past-the-end run to finish off the heading
                                                $curChar = '';
@@ -301,12 +307,12 @@ class Preprocessor_HipHop implements Preprocessor {
                                                // Unclosed comment in input, runs to end
                                                $inner = strval( substr( $text, $i ) );
                                                $accum->addNodeWithText( 'comment', $inner );
-                                               $i = strlen( $text );
+                                               $i = $lengthText;
                                        } else {
                                                $endPos = intval( $variantEndPos );
                                                // Search backwards for leading whitespace
                                                if ( $i ) {
-                                                       $wsStart = $i - intval( strspn( $revText, ' ', strlen( $text ) - $i ) );
+                                                       $wsStart = $i - intval( strspn( $revText, ' ', $lengthText - $i ) );
                                                } else {
                                                        $wsStart = 0;
                                                }
@@ -399,7 +405,7 @@ class Preprocessor_HipHop implements Preprocessor {
                                        } else {
                                                // No end tag -- let it run out to the end of the text.
                                                $inner = strval( substr( $text, $tagEndPos + 1 ) );
-                                               $i = strlen( $text );
+                                               $i = $lengthText;
                                                $haveClose = false;
                                        }
                                }
@@ -464,16 +470,16 @@ class Preprocessor_HipHop implements Preprocessor {
                                $part = $piece->getCurrentPart();
                                // Search back through the input to see if it has a proper close
                                // Do this using the reversed string since the other solutions (end anchor, etc.) are inefficient
-                               $wsLength = intval( strspn( $revText, " \t", strlen( $text ) - $i ) );
+                               $wsLength = intval( strspn( $revText, " \t", $lengthText - $i ) );
                                $searchStart = $i - $wsLength;
                                if ( isset( $part->commentEnd ) && $searchStart - 1 == $part->commentEnd ) {
                                        // Comment found at line end
                                        // Search for equals signs before the comment
                                        $searchStart = intval( $part->visualEnd );
-                                       $searchStart -= intval( strspn( $revText, " \t", strlen( $text ) - $searchStart ) );
+                                       $searchStart -= intval( strspn( $revText, " \t", $lengthText - $searchStart ) );
                                }
                                $count = intval( $piece->count );
-                               $equalsLength = intval( strspn( $revText, '=', strlen( $text ) - $searchStart ) );
+                               $equalsLength = intval( strspn( $revText, '=', $lengthText - $searchStart ) );
                                $isTreeNode = false;
                                $resultAccum = $accum;
                                if ( $equalsLength > 0 ) {
@@ -830,16 +836,23 @@ class PPDStack_HipHop {
  * @ingroup Parser
  */
 class PPDStackElement_HipHop {
-       var $open,                      // Opening character (\n for heading)
-               $close,             // Matching closing character
+       var $open,              // Opening character (\n for heading)
+               $close,             // Matching closing character
                $count,             // Number of opening characters found (number of "=" for heading)
                $parts,             // Array of PPDPart objects describing pipe-separated parts.
                $lineStart;         // True if the open char appeared at the start of the input line. Not set for headings.
 
+       /**
+        * @param $obj PPDStackElement_HipHop
+        * @return PPDStackElement_HipHop
+        */
        static function cast( PPDStackElement_HipHop $obj ) {
                return $obj;
        }
 
+       /**
+        * @param $data array
+        */
        function __construct( $data = array() ) {
                $this->parts = array( new PPDPart_HipHop );
 
@@ -848,14 +861,23 @@ class PPDStackElement_HipHop {
                }
        }
 
+       /**
+        * @return PPDAccum_HipHop
+        */
        function getAccum() {
                return PPDAccum_HipHop::cast( $this->parts[count($this->parts) - 1]->out );
        }
 
+       /**
+        * @param $s string
+        */
        function addPart( $s = '' ) {
                $this->parts[] = new PPDPart_HipHop( $s );
        }
 
+       /**
+        * @return PPDPart_HipHop
+        */
        function getCurrentPart() {
                return PPDPart_HipHop::cast( $this->parts[count($this->parts) - 1] );
        }
@@ -876,6 +898,7 @@ class PPDStackElement_HipHop {
        /**
         * Get the accumulator that would result if the close is not found.
         *
+        * @param $openingCount bool
         * @return PPDAccum_HipHop
         */
        function breakSyntax( $openingCount = false ) {
@@ -1041,9 +1064,10 @@ class PPFrame_HipHop implements PPFrame {
         * Create a new child frame
         * $args is optionally a multi-root PPNode or array containing the template arguments
         *
-        * @param $args PPNode_HipHop_Array|array
-        * @param $title Title|false
+        * @param $args PPNode_HipHop_Array|array|bool
+        * @param $title Title|bool
         *
+        * @throws MWException
         * @return PPTemplateFrame_HipHop
         */
        function newChild( $args = false, $title = false ) {
@@ -1293,6 +1317,7 @@ class PPFrame_HipHop implements PPFrame {
        /**
         * Implode with no flags specified
         * This previously called implodeWithFlags but has now been inlined to reduce stack depth
+        * @param $sep
         * @return string
         */
        function implode( $sep /*, ... */ ) {
@@ -1323,6 +1348,7 @@ class PPFrame_HipHop implements PPFrame {
         * Makes an object that, when expand()ed, will be the same as one obtained
         * with implode()
         *
+        * @param $sep
         * @return PPNode_HipHop_Array
         */
        function virtualImplode( $sep /*, ... */ ) {
@@ -1352,6 +1378,9 @@ class PPFrame_HipHop implements PPFrame {
        /**
         * Virtual implode with brackets
         *
+        * @param $start
+        * @param $sep
+        * @param $end
         * @return PPNode_HipHop_Array
         */
        function virtualBracketedImplode( $start, $sep, $end /*, ... */ ) {
@@ -1472,11 +1501,11 @@ class PPTemplateFrame_HipHop extends PPFrame_HipHop {
        var $numberedExpansionCache, $namedExpansionCache;
 
        /**
-        * @param $preprocessor
-        * @param $parent
+        * @param $preprocessor Preprocessor_HipHop
+        * @param $parent bool
         * @param $numberedArgs array
         * @param $namedArgs array
-        * @param $title Title
+        * @param $title Title|bool
         */
        function __construct( $preprocessor, $parent = false, $numberedArgs = array(), $namedArgs = array(), $title = false ) {
                parent::__construct( $preprocessor );
@@ -1723,11 +1752,15 @@ class PPNode_HipHop_Tree implements PPNode {
                return $this->nextSibling;
        }
 
+       /**
+        * @param $name string
+        * @return array
+        */
        function getChildrenOfType( $name ) {
                $children = array();
                for ( $child = $this->firstChild; $child; $child = $child->nextSibling ) {
                        if ( isset( $child->name ) && $child->name === $name ) {
-                               $children[] = $name;
+                               $children[] = $child;
                        }
                }
                return $children;
@@ -1761,6 +1794,7 @@ class PPNode_HipHop_Tree implements PPNode {
         *    index         String index
         *    value         PPNode value
         *
+        * @throws MWException
         * @return array
         */
        function splitArg() {
@@ -1794,6 +1828,7 @@ class PPNode_HipHop_Tree implements PPNode {
         * Split an <ext> node into an associative array containing name, attr, inner and close
         * All values in the resulting array are PPNodes. Inner and close are optional.
         *
+        * @throws MWException
         * @return array
         */
        function splitExt() {
@@ -1821,6 +1856,7 @@ class PPNode_HipHop_Tree implements PPNode {
        /**
         * Split an <h> node
         *
+        * @throws MWException
         * @return array
         */
        function splitHeading() {