fix for html diff on page with images -- ImageNode $attributes member was incorrectly...
[lhc/web/wiklou.git] / includes / WebRequest.php
index 398fce0..3a845da 100644 (file)
@@ -23,7 +23,7 @@
 
 
 /**
- * Some entry points may use this file without first enabling the 
+ * Some entry points may use this file without first enabling the
  * autoloader.
  */
 if ( !function_exists( '__autoload' ) ) {
@@ -45,18 +45,18 @@ class WebRequest {
        var $data = array();
        var $headers;
        private $_response;
-       
+
        function __construct() {
                /// @fixme This preemptive de-quoting can interfere with other web libraries
                ///        and increases our memory footprint. It would be cleaner to do on
                ///        demand; but currently we have no wrapper for $_SERVER etc.
                $this->checkMagicQuotes();
-               
+
                // POST overrides GET data
                // We don't use $_REQUEST here to avoid interference from cookies...
                $this->data = wfArrayMerge( $_GET, $_POST );
        }
-       
+
        /**
         * Check for title, action, and/or variant data in the URL
         * and interpolate it into the GET variables.
@@ -80,7 +80,7 @@ class WebRequest {
                                $a = parse_url( $url );
                                if( $a ) {
                                        $path = isset( $a['path'] ) ? $a['path'] : '';
-                                       
+
                                        global $wgScript;
                                        if( $path == $wgScript ) {
                                                // Script inside a rewrite path?
@@ -89,17 +89,17 @@ class WebRequest {
                                        }
                                        // Raw PATH_INFO style
                                        $matches = $this->extractTitle( $path, "$wgScript/$1" );
-                                       
+
                                        global $wgArticlePath;
                                        if( !$matches && $wgArticlePath ) {
                                                $matches = $this->extractTitle( $path, $wgArticlePath );
                                        }
-                                       
+
                                        global $wgActionPaths;
                                        if( !$matches && $wgActionPaths ) {
                                                $matches = $this->extractTitle( $path, $wgActionPaths, 'action' );
                                        }
-                                       
+
                                        global $wgVariantArticlePath, $wgContLang;
                                        if( !$matches && $wgVariantArticlePath ) {
                                                $variantPaths = array();
@@ -115,7 +115,7 @@ class WebRequest {
                                // http://bugs.php.net/bug.php?id=31892
                                // Also reported when ini_get('cgi.fix_pathinfo')==false
                                $matches['title'] = substr( $_SERVER['ORIG_PATH_INFO'], 1 );
-                               
+
                        } elseif ( isset( $_SERVER['PATH_INFO'] ) && ($_SERVER['PATH_INFO'] != '') ) {
                                // Regular old PATH_INFO yay
                                $matches['title'] = substr( $_SERVER['PATH_INFO'], 1 );
@@ -125,15 +125,15 @@ class WebRequest {
                        }
                }
        }
-       
+
        /**
         * Internal URL rewriting function; tries to extract page title and,
         * optionally, one other fixed parameter value from a URL path.
         *
-        * @param string $path the URL path given from the client
-        * @param array $bases one or more URLs, optionally with $1 at the end
-        * @param string $key if provided, the matching key in $bases will be
-        *        passed on as the value of this URL parameter
+        * @param $path string: the URL path given from the client
+        * @param $bases array: one or more URLs, optionally with $1 at the end
+        * @param $key string: if provided, the matching key in $bases will be
+        *             passed on as the value of this URL parameter
         * @return array of URL variables to interpolate; empty if no match
         */
        private function extractTitle( $path, $bases, $key=false ) {
@@ -158,7 +158,7 @@ class WebRequest {
        /**
         * Recursively strips slashes from the given array;
         * used for undoing the evil that is magic_quotes_gpc.
-        * @param array &$arr will be modified
+        * @param $arr array: will be modified
         * @return array the original array
         * @private
         */
@@ -193,7 +193,7 @@ class WebRequest {
 
        /**
         * Recursively normalizes UTF-8 strings in the given array.
-        * @param array $data string or array
+        * @param $data string or array
         * @return cleaned-up version of the given
         * @private
         */
@@ -211,9 +211,9 @@ class WebRequest {
        /**
         * Fetch a value from the given array or return $default if it's not set.
         *
-        * @param array $arr
-        * @param string $name
-        * @param mixed $default
+        * @param $arr array
+        * @param $name string
+        * @param $default mixed
         * @return mixed
         * @private
         */
@@ -236,12 +236,12 @@ class WebRequest {
 
        /**
         * Fetch a scalar from the input or return $default if it's not set.
-        * Returns a string. Arrays are discarded. Useful for 
-        * non-freeform text inputs (e.g. predefined internal text keys 
+        * Returns a string. Arrays are discarded. Useful for
+        * non-freeform text inputs (e.g. predefined internal text keys
         * selected by a drop-down menu). For freeform input, see getText().
         *
-        * @param string $name
-        * @param string $default optional default (or NULL)
+        * @param $name string
+        * @param $default string: optional default (or NULL)
         * @return string
         */
        function getVal( $name, $default = NULL ) {
@@ -261,8 +261,8 @@ class WebRequest {
         * If source was scalar, will return an array with a single element.
         * If no source and no default, returns NULL.
         *
-        * @param string $name
-        * @param array $default optional default (or NULL)
+        * @param $name string
+        * @param $default array: optional default (or NULL)
         * @return array
         */
        function getArray( $name, $default = NULL ) {
@@ -273,15 +273,15 @@ class WebRequest {
                        return (array)$val;
                }
        }
-       
+
        /**
         * Fetch an array of integers, or return $default if it's not set.
         * If source was scalar, will return an array with a single element.
         * If no source and no default, returns NULL.
         * If an array is returned, contents are guaranteed to be integers.
         *
-        * @param string $name
-        * @param array $default option default (or NULL)
+        * @param $name string
+        * @param $default array: option default (or NULL)
         * @return array of ints
         */
        function getIntArray( $name, $default = NULL ) {
@@ -296,8 +296,8 @@ class WebRequest {
         * Fetch an integer value from the input or return $default if not set.
         * Guaranteed to return an integer; non-numeric input will typically
         * return 0.
-        * @param string $name
-        * @param int $default
+        * @param $name string
+        * @param $default int
         * @return int
         */
        function getInt( $name, $default = 0 ) {
@@ -308,7 +308,7 @@ class WebRequest {
         * Fetch an integer value from the input or return null if empty.
         * Guaranteed to return an integer or null; non-numeric input will
         * typically return null.
-        * @param string $name
+        * @param $name string
         * @return int
         */
        function getIntOrNull( $name ) {
@@ -322,8 +322,8 @@ class WebRequest {
         * Fetch a boolean value from the input or return $default if not set.
         * Guaranteed to return true or false, with normal PHP semantics for
         * boolean interpretation of strings.
-        * @param string $name
-        * @param bool $default
+        * @param $name string
+        * @param $default bool
         * @return bool
         */
        function getBool( $name, $default = false ) {
@@ -334,7 +334,7 @@ class WebRequest {
         * Return true if the named value is set in the input, whatever that
         * value is (even "0"). Return false if the named value is not set.
         * Example use is checking for the presence of check boxes in forms.
-        * @param string $name
+        * @param $name string
         * @return bool
         */
        function getCheck( $name ) {
@@ -349,11 +349,11 @@ class WebRequest {
         * set. \r is stripped from the text, and with some language modules there
         * is an input transliteration applied. This should generally be used for
         * form <textarea> and <input> fields. Used for user-supplied freeform text
-        * input (for which input transformations may be required - e.g. Esperanto 
+        * input (for which input transformations may be required - e.g. Esperanto
         * x-coding).
         *
-        * @param string $name
-        * @param string $default optional
+        * @param $name string
+        * @param $default string: optional
         * @return string
         */
        function getText( $name, $default = '' ) {
@@ -497,6 +497,8 @@ class WebRequest {
        /**
         * Appends or replaces value of query variables.
         * @param $array Array of values to replace/add to query
+        * @param $onlyquery Bool: whether to only return the query string and not
+        *                   the complete URL
         * @return string
         */
        function appendQueryArray( $array, $onlyquery = false ) {
@@ -505,7 +507,7 @@ class WebRequest {
                unset( $newquery['title'] );
                $newquery = array_merge( $newquery, $array );
                $query = wfArrayToCGI( $newquery );
-               return $onlyquery ? $query : $wgTitle->getLocalURL( $basequery );
+               return $onlyquery ? $query : $wgTitle->getLocalURL( $query );
        }
 
        /**
@@ -578,7 +580,7 @@ class WebRequest {
         *
         * Other than this the name is not verified for being a safe filename.
         *
-        * @param $key String: 
+        * @param $key String:
         * @return string or NULL if no such file.
         */
        function getFileName( $key ) {
@@ -594,22 +596,22 @@ class WebRequest {
                wfDebug( "WebRequest::getFileName() '" . $_FILES[$key]['name'] . "' normalized to '$name'\n" );
                return $name;
        }
-       
+
        /**
-        * Return a handle to WebResponse style object, for setting cookies, 
+        * Return a handle to WebResponse style object, for setting cookies,
         * headers and other stuff, for Request being worked on.
         */
        function response() {
                /* Lazy initialization of response object for this request */
                if (!is_object($this->_response)) {
                        $this->_response = new WebResponse;
-               } 
+               }
                return $this->_response;
        }
 
        /**
         * Get a request header, or false if it isn't set
-        * @param string $name Case-insensitive header name
+        * @param $name String: case-insensitive header name
         */
        function getHeader( $name ) {
                $name = strtoupper( $name );
@@ -644,9 +646,9 @@ class FauxRequest extends WebRequest {
        var $wasPosted = false;
 
        /**
-        * @param array $data Array of *non*-urlencoded key => value pairs, the
+        * @param $data Array of *non*-urlencoded key => value pairs, the
         *   fake GET/POST values
-        * @param bool $wasPosted Whether to treat the data as POST
+        * @param $wasPosted Bool: whether to treat the data as POST
         */
        function FauxRequest( $data, $wasPosted = false ) {
                if( is_array( $data ) ) {
@@ -688,5 +690,3 @@ class FauxRequest extends WebRequest {
        }
 
 }
-
-