Fixed parameter name in documentation

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

diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php
index b3caa10..ecc2746 100644 (file)
--- a/includes/api/ApiQuery.php
+++ b/includes/api/ApiQuery.php
@@ -1,10 +1,9 @@
 <?php
-
 /**
- * Created on Sep 7, 2006
- *
  * API for MediaWiki 1.8+
  *
+ * Created on Sep 7, 2006
+ *
  * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21,6 +20,8 @@
  * 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' ) ) {
@@ -58,6 +59,7 @@ class ApiQuery extends ApiBase {
                'extlinks' => 'ApiQueryExternalLinks',
                'categoryinfo' => 'ApiQueryCategoryInfo',
                'duplicatefiles' => 'ApiQueryDuplicateFiles',
+               'pageprops' => 'ApiQueryPageProps',
        );
 
        private $mQueryListModules = array(
@@ -174,7 +176,7 @@ class ApiQuery extends ApiBase {
        function getModules() {
                return array_merge( $this->mQueryPropModules, $this->mQueryListModules, $this->mQueryMetaModules );
        }
-       
+
        /**
         * Get whether the specified module is a prop, list or a meta query module
         * @param $moduleName string Name of the module to find type for
@@ -184,15 +186,15 @@ class ApiQuery extends ApiBase {
                if ( array_key_exists ( $moduleName, $this->mQueryPropModules ) ) {
                        return 'prop';
                }
-               
+
                if ( array_key_exists ( $moduleName, $this->mQueryListModules ) ) {
                        return 'list';
                }
-               
+
                if ( array_key_exists ( $moduleName, $this->mQueryMetaModules ) ) {
                        return 'meta';
                }
-               
+
                return null;
        }
 
@@ -238,7 +240,7 @@ class ApiQuery extends ApiBase {
                if ( isset( $this->params['generator'] ) ) {
                        $generator = $this->newGenerator( $this->params['generator'] );
                        $params = $generator->extractRequestParams();
-                       $cacheMode = $this->mergeCacheMode( $cacheMode, 
+                       $cacheMode = $this->mergeCacheMode( $cacheMode,
                                $generator->getCacheMode( $params ) );
                        $this->executeGeneratorModule( $generator, $modules );
                } else {
@@ -253,7 +255,7 @@ class ApiQuery extends ApiBase {
                // Execute all requested modules.
                foreach ( $modules as $module ) {
                        $params = $module->extractRequestParams();
-                       $cacheMode = $this->mergeCacheMode( 
+                       $cacheMode = $this->mergeCacheMode(
                                $cacheMode, $module->getCacheMode( $params ) );
                        $module->profileIn();
                        $module->execute();
@@ -267,7 +269,7 @@ class ApiQuery extends ApiBase {
 
        /**
         * Update a cache mode string, applying the cache mode of a new module to it.
-        * The cache mode may increase in the level of privacy, but public modules 
+        * The cache mode may increase in the level of privacy, but public modules
         * added to private data do not decrease the level of privacy.
         */
        protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
@@ -338,7 +340,7 @@ class ApiQuery extends ApiBase {
                        $result->setIndexedTagName( $normValues, 'n' );
                        $result->addValue( 'query', 'normalized', $normValues );
                }
-               
+
                // Title conversions
                $convValues = array();
                foreach ( $pageSet->getConvertedTitles() as $rawTitleStr => $titleStr ) {
@@ -351,7 +353,7 @@ class ApiQuery extends ApiBase {
                if ( count( $convValues ) ) {
                        $result->setIndexedTagName( $convValues, 'c' );
                        $result->addValue( 'query', 'converted', $convValues );
-               }               
+               }
 
                // Interwiki titles
                $intrwValues = array();
@@ -424,9 +426,9 @@ class ApiQuery extends ApiBase {
                        $vals = array();
                        ApiQueryBase::addTitleInfo( $vals, $title );
                        $vals['special'] = '';
-                       if ( $title->getNamespace() == NS_SPECIAL && 
+                       if ( $title->getNamespace() == NS_SPECIAL &&
                                        !SpecialPage::exists( $title->getText() ) ) {
-                               $vals['missing'] = '';                  
+                               $vals['missing'] = '';
                        } elseif ( $title->getNamespace() == NS_MEDIA &&
                                        !wfFindFile( $title ) ) {
                                $vals['missing'] = '';
@@ -489,6 +491,7 @@ class ApiQuery extends ApiBase {
 
        /**
         * Create a generator object of the given type and return it
+        * @param $generatorName string Module name
         */
        public function newGenerator( $generatorName ) {
                // Find class that implements requested generator
@@ -510,7 +513,7 @@ class ApiQuery extends ApiBase {
        /**
         * For generator mode, execute generator, and use its output as new
         * ApiPageSet
-        * @param $generatorName string Module name
+        * @param $generator string Module name
         * @param $modules array of module objects
         */
        protected function executeGeneratorModule( $generator, $modules ) {