Merge "Fix trailing whitespace (and mixed spaces) in XSD files"

[lhc/web/wiklou.git] / includes / WebResponse.php

diff --git a/includes/WebResponse.php b/includes/WebResponse.php
index a0f7776..193101b 100644 (file)
--- a/includes/WebResponse.php
+++ b/includes/WebResponse.php
@@ -2,6 +2,21 @@
 /**
  * Classes used to send headers and cookies back to the user
  *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  */
 
@@ -17,67 +32,126 @@ class WebResponse {
         * header()
         * @param $string String: header to output
         * @param $replace Bool: replace current similar header
+        * @param $http_response_code null|int Forces the HTTP response code to the specified value.
         */
-       public function header($string, $replace=true) {
-               header($string,$replace);
+       public function header( $string, $replace = true, $http_response_code = null ) {
+               header( $string, $replace, $http_response_code );
        }
 
-       /** Set the browser cookie
+       /**
+        * Set the browser cookie
         * @param $name String: name of cookie
         * @param $value String: value to give cookie
         * @param $expire Int: number of seconds til cookie expires
+        * @param $prefix String: Prefix to use, if not $wgCookiePrefix (use '' for no prefix)
+        * @param @domain String: Cookie domain to use, if not $wgCookieDomain
         */
-       public function setcookie( $name, $value, $expire = 0 ) {
+       public function setcookie( $name, $value, $expire = 0, $prefix = null, $domain = null ) {
                global $wgCookiePath, $wgCookiePrefix, $wgCookieDomain;
                global $wgCookieSecure,$wgCookieExpiration, $wgCookieHttpOnly;
                if ( $expire == 0 ) {
                        $expire = time() + $wgCookieExpiration;
                }
+               if( $prefix === null ) {
+                       $prefix = $wgCookiePrefix;
+               }
+               if( $domain === null ) {
+                       $domain = $wgCookieDomain;
+               }
                $httpOnlySafe = wfHttpOnlySafe() && $wgCookieHttpOnly;
                wfDebugLog( 'cookie',
                        'setcookie: "' . implode( '", "',
                                array(
-                                       $wgCookiePrefix . $name,
+                                       $prefix . $name,
                                        $value,
                                        $expire,
                                        $wgCookiePath,
-                                       $wgCookieDomain,
+                                       $domain,
                                        $wgCookieSecure,
                                        $httpOnlySafe ) ) . '"' );
-               setcookie( $wgCookiePrefix . $name,
+               setcookie( $prefix . $name,
                        $value,
                        $expire,
                        $wgCookiePath,
-                       $wgCookieDomain,
+                       $domain,
                        $wgCookieSecure,
                        $httpOnlySafe );
        }
 }
 
-
+/**
+ * @ingroup HTTP
+ */
 class FauxResponse extends WebResponse {
        private $headers;
        private $cookies;
+       private $code;
 
-       public function header($string, $replace=true) {
-               list($key, $val) = explode(":", $string, 2);
+       /**
+        * Stores a HTTP header
+        * @param $string String: header to output
+        * @param $replace Bool: replace current similar header
+        * @param $http_response_code null|int Forces the HTTP response code to the specified value.
+        */
+       public function header( $string, $replace = true, $http_response_code = null ) {
+               if ( substr( $string, 0, 5 ) == 'HTTP/' ) {
+                       $parts = explode( ' ', $string, 3 );
+                       $this->code = intval( $parts[1] );
+               } else {
+                       list( $key, $val ) = array_map( 'trim', explode( ":", $string, 2 ) );
 
-               if($replace || !isset($this->headers[$key])) {
-                       $this->headers[$key] = $val;
+                       if( $replace || !isset( $this->headers[$key] ) ) {
+                               $this->headers[$key] = $val;
+                       }
+               }
+
+               if ( $http_response_code !== null ) {
+                       $this->code = intval( $http_response_code );
                }
        }
 
-       public function getheader($key) {
-               return $this->headers[$key];
+       /**
+        * @param $key string
+        * @return string
+        */
+       public function getheader( $key ) {
+               if ( isset( $this->headers[$key] ) ) {
+                       return $this->headers[$key];
+               }
+               return null;
+       }
+
+       /**
+        * Get the HTTP response code, null if not set
+        *
+        * @return Int or null
+        */
+       public function getStatusCode() {
+               return $this->code;
        }
 
-       public function setcookie( $name, $value, $expire = 0 ) {
+       /**
+        * @todo document. It just ignore optional parameters.
+        *
+        * @param $name String: name of cookie
+        * @param $value String: value to give cookie
+        * @param $expire Int: number of seconds til cookie expires (Default: 0)
+        * @param $prefix TODO DOCUMENT (Default: null)
+        * @param $domain TODO DOCUMENT (Default: null)
+        *
+        */
+       public function setcookie( $name, $value, $expire = 0, $prefix = null, $domain = null ) {
                $this->cookies[$name] = $value;
        }
 
+       /**
+        * @param $name string
+        * @return string
+        */
        public function getcookie( $name )  {
-               if ( isset($this->cookies[$name]) ) {
+               if ( isset( $this->cookies[$name] ) ) {
                        return $this->cookies[$name];
                }
+               return null;
        }
 }