http://www.mediawiki.org/wiki/Special:Code/MediaWiki/89533

Revision: 89533
Author:   reedy
Date:     2011-06-05 21:04:48 +0000 (Sun, 05 Jun 2011)
Log Message:
-----------
Documentation updates and additions

Modified Paths:
--------------
    trunk/phase3/includes/WebResponse.php
    trunk/phase3/includes/api/ApiQueryBase.php
    trunk/phase3/includes/api/ApiQueryBlocks.php

Modified: trunk/phase3/includes/WebResponse.php
===================================================================
--- trunk/phase3/includes/WebResponse.php       2011-06-05 21:03:39 UTC (rev 
89532)
+++ trunk/phase3/includes/WebResponse.php       2011-06-05 21:04:48 UTC (rev 
89533)
@@ -56,11 +56,19 @@
        }
 }
 
-
+/**
+ * @ingroup HTTP
+ */
 class FauxResponse extends WebResponse {
        private $headers;
        private $cookies;
 
+       /**
+        * 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 ) {
                list( $key, $val ) = explode( ":", $string, 2 );
 
@@ -69,17 +77,31 @@
                }
        }
 
+       /**
+        * @param $key string
+        * @return string
+        */
        public function getheader( $key ) {
                return $this->headers[$key];
        }
 
+       /**
+        * @param $name String: name of cookie
+        * @param $value String: value to give cookie
+        * @param $expire Int: number of seconds til cookie expires
+        */
        public function setcookie( $name, $value, $expire = 0 ) {
                $this->cookies[$name] = $value;
        }
 
+       /**
+        * @param $name string
+        * @return string
+        */
        public function getcookie( $name )  {
                if ( isset( $this->cookies[$name] ) ) {
                        return $this->cookies[$name];
                }
+               return null;
        }
 }

Modified: trunk/phase3/includes/api/ApiQueryBase.php
===================================================================
--- trunk/phase3/includes/api/ApiQueryBase.php  2011-06-05 21:03:39 UTC (rev 
89532)
+++ trunk/phase3/includes/api/ApiQueryBase.php  2011-06-05 21:04:48 UTC (rev 
89533)
@@ -359,7 +359,7 @@
 
        /**
         * Get the Query database connection (read-only)
-        * @return Database
+        * @return DatabaseBase
         */
        protected function getDB() {
                if ( is_null( $this->mDb ) ) {

Modified: trunk/phase3/includes/api/ApiQueryBlocks.php
===================================================================
--- trunk/phase3/includes/api/ApiQueryBlocks.php        2011-06-05 21:03:39 UTC 
(rev 89532)
+++ trunk/phase3/includes/api/ApiQueryBlocks.php        2011-06-05 21:04:48 UTC 
(rev 89533)
@@ -30,7 +30,7 @@
 }
 
 /**
- * Query module to enumerate all available pages.
+ * Query module to enumerate all user blocks
  *
  * @ingroup API
  */


_______________________________________________
MediaWiki-CVS mailing list
[email protected]
https://lists.wikimedia.org/mailman/listinfo/mediawiki-cvs

Reply via email to