Bug 27341 - Add drto param to list=deletedrevs

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

diff --git a/includes/api/ApiQueryBacklinks.php b/includes/api/ApiQueryBacklinks.php
index 6d22160..6335f6c 100644 (file)
--- a/includes/api/ApiQueryBacklinks.php
+++ b/includes/api/ApiQueryBacklinks.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Oct 16, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Oct 16, 2006
+ *
+ * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
  *
  * 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
@@ -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' ) ) {
@@ -38,9 +39,24 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiQueryBacklinks extends ApiQueryGeneratorBase {
 
-       private $params, $rootTitle, $contID, $redirID, $redirect;
+       /**
+        * @var Title
+        */
+       private $rootTitle;
+
+       private $params, $contID, $redirID, $redirect;
        private $bl_ns, $bl_from, $bl_table, $bl_code, $bl_title, $bl_sort, $bl_fields, $hasNS;
-       private $pageMap, $resultArr;
+
+       /**
+        * Maps ns and title to pageid
+        *
+        * @var array
+        */
+       private $pageMap = array();
+       private $resultArr;
+
+       private $redirTitles = array();
+       private $continueStr = null;
 
        // output element name, database column field prefix, database table
        private $backlinksSettings = array(
@@ -62,13 +78,15 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
        );
 
        public function __construct( $query, $moduleName ) {
-               extract( $this->backlinksSettings[$moduleName] );
+               $settings = $this->backlinksSettings[$moduleName];
+               $prefix = $settings['prefix'];
+               $code = $settings['code'];
                $this->resultArr = array();
 
                parent::__construct( $query, $moduleName, $code );
                $this->bl_ns = $prefix . '_namespace';
                $this->bl_from = $prefix . '_from';
-               $this->bl_table = $linktbl;
+               $this->bl_table = $settings['linktbl'];
                $this->bl_code = $code;
 
                $this->hasNS = $moduleName !== 'imageusage';
@@ -100,6 +118,10 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
                $this->run( $resultPageSet );
        }
 
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return void
+        */
        private function prepareFirstQuery( $resultPageSet = null ) {
                /* SELECT page_id, page_title, page_namespace, page_is_redirect
                 * FROM pagelinks, page WHERE pl_from=page_id
@@ -138,6 +160,10 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
                $this->addOption( 'STRAIGHT_JOIN' );
        }
 
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return void
+        */
        private function prepareSecondQuery( $resultPageSet = null ) {
                /* SELECT page_id, page_title, page_namespace, page_is_redirect, pl_title, pl_namespace
                   FROM pagelinks, page WHERE pl_from=page_id
@@ -196,6 +222,10 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
                $this->addOption( 'USE INDEX', array( 'page' => 'PRIMARY' ) );
        }
 
+       /**
+        * @param $resultPageSet ApiPageSet
+        * @return void
+        */
        private function run( $resultPageSet = null ) {
                $this->params = $this->extractRequestParams( false );
                $this->redirect = isset( $this->params['redirect'] ) && $this->params['redirect'];
@@ -212,9 +242,7 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
                $res = $this->select( __METHOD__ . '::firstQuery' );
 
                $count = 0;
-               $this->pageMap = array(); // Maps ns and title to pageid
-               $this->continueStr = null;
-               $this->redirTitles = array();
+
                foreach ( $res as $row ) {
                        if ( ++ $count > $this->params['limit'] ) {
                                // We've reached the one extra which shows that there are additional pages to be had. Stop here...
@@ -404,7 +432,7 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
                $retval = array(
                        'title' => array(
                                ApiBase::PARAM_TYPE => 'string',
-                               ApiBase::PARAM_REQUIRED => 1
+                               ApiBase::PARAM_REQUIRED => true
                        ),
                        'continue' => null,
                        'namespace' => array(
@@ -469,7 +497,6 @@ class ApiQueryBacklinks extends ApiQueryGeneratorBase {
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'invalidtitle', 'title' ),
-                       array( 'missingparam', 'title' ),
                        array( 'code' => 'bad_image_title', 'info' => "The title for {$this->getModuleName()} query must be an image" ),
                        array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
                ) );