More parameter documentation

[lhc/web/wiklou.git] / includes / api / ApiQueryRandom.php

diff --git a/includes/api/ApiQueryRandom.php b/includes/api/ApiQueryRandom.php
index a6c2fa1..9c1f9ed 100644 (file)
--- a/includes/api/ApiQueryRandom.php
+++ b/includes/api/ApiQueryRandom.php
@@ -1,9 +1,9 @@
 <?php
 
 /**
- * Created on Monday, January 28, 2008
  *
- * API for MediaWiki 1.8+
+ *
+ * Created on Monday, January 28, 2008
  *
  * Copyright © 2008 Brent Garber
  *
@@ -19,8 +19,10 @@
  *
  * 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.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
  */
 
 if ( !defined( 'MEDIAWIKI' ) ) {
@@ -34,7 +36,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  * @ingroup API
  */
 
- class ApiQueryRandom extends ApiQueryGeneratorBase {
+class ApiQueryRandom extends ApiQueryGeneratorBase {
 
        public function __construct( $query, $moduleName ) {
                parent::__construct( $query, $moduleName, 'rn' );
@@ -48,6 +50,14 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                $this->run( $resultPageSet );
        }
 
+       /**
+        * @param  $randstr
+        * @param  $limit
+        * @param  $namespace
+        * @param $resultPageSet ApiPageSet
+        * @param  $redirect
+        * @return void
+        */
        protected function prepareQuery( $randstr, $limit, $namespace, &$resultPageSet, $redirect ) {
                $this->resetQueryParams();
                $this->addTables( 'page' );
@@ -64,7 +74,6 @@ if ( !defined( 'MEDIAWIKI' ) ) {
        }
 
        protected function runQuery( &$resultPageSet ) {
-               $db = $this->getDB();
                $res = $this->select( __METHOD__ );
                $count = 0;
                foreach ( $res as $row ) {
@@ -120,6 +129,10 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                return $vals;
        }
 
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
        public function getAllowedParams() {
                return array(
                        'namespace' => array(
@@ -161,4 +174,4 @@ if ( !defined( 'MEDIAWIKI' ) ) {
        public function getVersion() {
                return __CLASS__ . ': $Id: ApiQueryRandom.php overlordq$';
        }
-}
\ No newline at end of file
+}