API: fix copyright symbol, coding style cleanup, more braces
[lhc/web/wiklou.git] / includes / api / ApiQueryRandom.php
index 5bf9cbb..3135e54 100644 (file)
@@ -1,11 +1,11 @@
 <?php
 
-/*
+/**
  * Created on Monday, January 28, 2008
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2008 Brent Garber
+ * Copyright © 2008 Brent Garber
  *
  * 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
@@ -25,7 +25,7 @@
 
 if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( 'ApiQueryBase.php' );
+       require_once( 'ApiQueryBase.php' );
 }
 
 /**
@@ -37,7 +37,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  class ApiQueryRandom extends ApiQueryGeneratorBase {
 
        public function __construct( $query, $moduleName ) {
-               parent :: __construct( $query, $moduleName, 'rn' );
+               parent::__construct( $query, $moduleName, 'rn' );
        }
 
        public function execute() {
@@ -56,10 +56,11 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                $this->addWhereRange( 'page_random', 'newer', $randstr, null );
                $this->addWhereFld( 'page_is_redirect', $redirect );
                $this->addOption( 'USE INDEX', 'page_random' );
-               if ( is_null( $resultPageSet ) )
+               if ( is_null( $resultPageSet ) ) {
                        $this->addFields( array( 'page_id', 'page_title', 'page_namespace' ) );
-               else
+               } else {
                        $this->addFields( $resultPageSet->getPageTableFields() );
+               }
        }
 
        protected function runQuery( &$resultPageSet ) {
@@ -68,24 +69,23 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                $count = 0;
                while ( $row = $db->fetchObject( $res ) ) {
                        $count++;
-                       if ( is_null( $resultPageSet ) )
-                       {
+                       if ( is_null( $resultPageSet ) ) {
                                // Prevent duplicates
-                               if ( !in_array( $row->page_id, $this->pageIDs ) )
-                               {
+                               if ( !in_array( $row->page_id, $this->pageIDs ) ) {
                                        $fit = $this->getResult()->addValue(
                                                        array( 'query', $this->getModuleName() ),
                                                        null, $this->extractRowInfo( $row ) );
-                                       if ( !$fit )
+                                       if ( !$fit ) {
                                                // We can't really query-continue a random list.
                                                // Return an insanely high value so
                                                // $count < $limit is false
                                                return 1E9;
+                                       }
                                        $this->pageIDs[] = $row->page_id;
                                }
-                       }
-                       else
+                       } else {
                                $resultPageSet->processDbRow( $row );
+                       }
                }
                $db->freeResult( $res );
                return $count;
@@ -95,17 +95,16 @@ if ( !defined( 'MEDIAWIKI' ) ) {
                $params = $this->extractRequestParams();
                $result = $this->getResult();
                $this->pageIDs = array();
-               
+
                $this->prepareQuery( wfRandom(), $params['limit'], $params['namespace'], $resultPageSet, $params['redirect'] );
                $count = $this->runQuery( $resultPageSet );
-               if ( $count < $params['limit'] )
-               {
+               if ( $count < $params['limit'] ) {
                        /* We got too few pages, we probably picked a high value
                         * for page_random. We'll just take the lowest ones, see
                         * also the comment in Title::getRandomTitle()
                         */
-                        $this->prepareQuery( 0, $params['limit'] - $count, $params['namespace'], $resultPageSet, $params['redirect'] );
-                        $this->runQuery( $resultPageSet );
+                       $this->prepareQuery( 0, $params['limit'] - $count, $params['namespace'], $resultPageSet, $params['redirect'] );
+                       $this->runQuery( $resultPageSet );
                }
 
                if ( is_null( $resultPageSet ) ) {
@@ -122,24 +121,24 @@ if ( !defined( 'MEDIAWIKI' ) ) {
        }
 
        public function getAllowedParams() {
-               return array (
+               return array(
                        'namespace' => array(
-                               ApiBase :: PARAM_TYPE => 'namespace',
-                               ApiBase :: PARAM_ISMULTI => true
+                               ApiBase::PARAM_TYPE => 'namespace',
+                               ApiBase::PARAM_ISMULTI => true
                        ),
-                       'limit' => array (
-                               ApiBase :: PARAM_TYPE => 'limit',
-                               ApiBase :: PARAM_DFLT => 1,
-                               ApiBase :: PARAM_MIN => 1,
-                               ApiBase :: PARAM_MAX => 10,
-                               ApiBase :: PARAM_MAX2 => 20
+                       'limit' => array(
+                               ApiBase::PARAM_TYPE => 'limit',
+                               ApiBase::PARAM_DFLT => 1,
+                               ApiBase::PARAM_MIN => 1,
+                               ApiBase::PARAM_MAX => 10,
+                               ApiBase::PARAM_MAX2 => 20
                        ),
                        'redirect' => false,
                );
        }
 
        public function getParamDescription() {
-               return array (
+               return array(
                        'namespace' => 'Return pages in these namespaces only',
                        'limit' => 'Limit how many random pages will be returned',
                        'redirect' => 'Load a random redirect instead of a random page'
@@ -147,10 +146,11 @@ if ( !defined( 'MEDIAWIKI' ) ) {
        }
 
        public function getDescription() {
-               return array(   'Get a set of random pages',
-                               'NOTE: Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, "Main Page" is the first ',
-                               '      random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc.',
-                               'NOTE: If the number of pages in the namespace is lower than rnlimit, you will get fewer pages. You will not get the same page twice.'
+               return array(
+                       'Get a set of random pages',
+                       'NOTE: Pages are listed in a fixed sequence, only the starting point is random. This means that if, for example, "Main Page" is the first ',
+                       '      random page on your list, "List of fictional monkeys" will *always* be second, "List of people on stamps of Vanuatu" third, etc.',
+                       'NOTE: If the number of pages in the namespace is lower than rnlimit, you will get fewer pages. You will not get the same page twice.'
                );
        }