Merge "Followup I888c616e: Keep IRC line format unchanged."

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

diff --git a/includes/api/ApiQueryRandom.php b/includes/api/ApiQueryRandom.php
index 41aef1a..99854c1 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
  *
@@ -21,20 +21,17 @@
  * 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
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-       // Eclipse helper - will be ignored in production
-       require_once( 'ApiQueryBase.php' );
-}
-
 /**
  * Query module to get list of random pages
  *
  * @ingroup API
  */
 
- class ApiQueryRandom extends ApiQueryGeneratorBase {
+class ApiQueryRandom extends ApiQueryGeneratorBase {
 
        public function __construct( $query, $moduleName ) {
                parent::__construct( $query, $moduleName, 'rn' );
@@ -48,6 +45,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' );
@@ -63,7 +68,11 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                }
        }
 
-       protected function runQuery( &$resultPageSet ) {
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return int
+        */
+       protected function runQuery( $resultPageSet = null ) {
                $res = $this->select( __METHOD__ );
                $count = 0;
                foreach ( $res as $row ) {
@@ -90,6 +99,10 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                return $count;
        }
 
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return void
+        */
        public function run( $resultPageSet = null ) {
                $params = $this->extractRequestParams();
                $result = $this->getResult();
@@ -119,6 +132,10 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                return $vals;
        }
 
+       public function getCacheMode( $params ) {
+               return 'public';
+       }
+
        public function getAllowedParams() {
                return array(
                        'namespace' => array(
@@ -144,6 +161,16 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                );
        }
 
+       public function getResultProperties() {
+               return array(
+                       '' => array(
+                               'id' => 'integer',
+                               'ns' => 'namespace',
+                               'title' => 'string'
+                       )
+               );
+       }
+
        public function getDescription() {
                return array(
                        'Get a set of random pages',
@@ -153,11 +180,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                );
        }
 
-       protected function getExamples() {
+       public function getExamples() {
                return 'api.php?action=query&list=random&rnnamespace=0&rnlimit=2';
        }
-
-       public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryRandom.php overlordq$';
-       }
-}
\ No newline at end of file
+}