MediaWiki 1.17.4

[autoinstalls/mediawiki.git] / includes / api / ApiQueryLangLinks.php

diff --git a/includes/api/ApiQueryLangLinks.php b/includes/api/ApiQueryLangLinks.php
index 9330e380807040c2638275ed7214b5fc26a3af02..60e33709fe944736ceb2c2af6710225f4d2a4e78 100644 (file)
--- a/includes/api/ApiQueryLangLinks.php
+++ b/includes/api/ApiQueryLangLinks.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on May 13, 2007
- *
+/**
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on May 13, 2007
+ *
+ * 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
@@ -19,13 +18,15 @@
  *
  * 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' ) ) {
        // Eclipse helper - will be ignored in production
-       require_once ( "ApiQueryBase.php" );
+       require_once( "ApiQueryBase.php" );
 }
 
 /**
@@ -36,15 +37,16 @@ if ( !defined( 'MEDIAWIKI' ) ) {
 class ApiQueryLangLinks extends ApiQueryBase {
 
        public function __construct( $query, $moduleName ) {
-               parent :: __construct( $query, $moduleName, 'll' );
+               parent::__construct( $query, $moduleName, 'll' );
        }
 
        public function execute() {
-               if ( $this->getPageSet()->getGoodTitleCount() == 0 )
+               if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
                        return;
+               }
 
                $params = $this->extractRequestParams();
-               $this->addFields( array (
+               $this->addFields( array(
                        'll_from',
                        'll_lang',
                        'll_title'
@@ -54,27 +56,30 @@ class ApiQueryLangLinks extends ApiQueryBase {
                $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
                if ( !is_null( $params['continue'] ) ) {
                        $cont = explode( '|', $params['continue'] );
-                       if ( count( $cont ) != 2 )
-                               $this->dieUsage( "Invalid continue param. You should pass the " .
-                                       "original value returned by the previous query", "_badcontinue" );
+                       if ( count( $cont ) != 2 ) {
+                               $this->dieUsage( 'Invalid continue param. You should pass the ' .
+                                       'original value returned by the previous query', '_badcontinue' );
+                       }
                        $llfrom = intval( $cont[0] );
                        $lllang = $this->getDB()->strencode( $cont[1] );
-                       $this->addWhere( "ll_from > $llfrom OR " .
-                                       "(ll_from = $llfrom AND " .
-                                       "ll_lang >= '$lllang')" );
+                       $this->addWhere(
+                               "ll_from > $llfrom OR " .
+                               "(ll_from = $llfrom AND " .
+                               "ll_lang >= '$lllang')"
+                       );
                }
 
                // Don't order by ll_from if it's constant in the WHERE clause
-               if ( count( $this->getPageSet()->getGoodTitles() ) == 1 )
+               if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
                        $this->addOption( 'ORDER BY', 'll_lang' );
-               else
+               } else {
                        $this->addOption( 'ORDER BY', 'll_from, ll_lang' );
+               }
                $this->addOption( 'LIMIT', $params['limit'] + 1 );
                $res = $this->select( __METHOD__ );
 
                $count = 0;
-               $db = $this->getDB();
-               while ( $row = $db->fetchObject( $res ) ) {
+               foreach ( $res as $row ) {
                        if ( ++$count > $params['limit'] ) {
                                // We've reached the one extra which shows that
                                // there are additional pages to be had. Stop here...
@@ -82,15 +87,19 @@ class ApiQueryLangLinks extends ApiQueryBase {
                                break;
                        }
                        $entry = array( 'lang' => $row->ll_lang );
-                       ApiResult :: setContent( $entry, $row->ll_title );
+                       if ( $params['url'] ) {
+                               $title = Title::newFromText( "{$row->ll_lang}:{$row->ll_title}" );
+                               if ( $title ) {
+                                       $entry['url'] = $title->getFullURL();
+                               }
+                       }
+                       ApiResult::setContent( $entry, $row->ll_title );
                        $fit = $this->addPageSubItem( $row->ll_from, $entry );
-                       if ( !$fit )
-                       {
+                       if ( !$fit ) {
                                $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
                                break;
                        }
                }
-               $db->freeResult( $res );
        }
 
        public function getCacheMode( $params ) {
@@ -99,28 +108,30 @@ class ApiQueryLangLinks extends ApiQueryBase {
 
        public function getAllowedParams() {
                return array(
-                               'limit' => array(
-                                       ApiBase :: PARAM_DFLT => 10,
-                                       ApiBase :: PARAM_TYPE => 'limit',
-                                       ApiBase :: PARAM_MIN => 1,
-                                       ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
-                                       ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
-                               ),
-                               'continue' => null,
+                       'limit' => array(
+                               ApiBase::PARAM_DFLT => 10,
+                               ApiBase::PARAM_TYPE => 'limit',
+                               ApiBase::PARAM_MIN => 1,
+                               ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1,
+                               ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2
+                       ),
+                       'continue' => null,
+                       'url' => false,
                );
        }
 
-       public function getParamDescription () {
+       public function getParamDescription() {
                return array(
                        'limit' => 'How many langlinks to return',
                        'continue' => 'When more results are available, use this to continue',
+                       'url' => 'Whether to get the full URL',
                );
        }
 
        public function getDescription() {
                return 'Returns all interlanguage links from the given page(s)';
        }
-       
+
        public function getPossibleErrors() {
                return array_merge( parent::getPossibleErrors(), array(
                        array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
@@ -128,13 +139,13 @@ class ApiQueryLangLinks extends ApiQueryBase {
        }
 
        protected function getExamples() {
-               return array (
-                               "Get interlanguage links from the [[Main Page]]:",
-                               "  api.php?action=query&prop=langlinks&titles=Main%20Page&redirects",
-                       );
+               return array(
+                       'Get interlanguage links from the [[Main Page]]:',
+                       '  api.php?action=query&prop=langlinks&titles=Main%20Page&redirects=',
+               );
        }
 
        public function getVersion() {
-               return __CLASS__ . ': $Id: ApiQueryLangLinks.php 69932 2010-07-26 08:03:21Z tstarling $';
+               return __CLASS__ . ': $Id$';
        }
 }