4 * Created on May 13, 2007
6 * API for MediaWiki 1.8+
8 * Copyright © 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( "ApiQueryBase.php" );
32 * A query module to list all langlinks (links to correspanding foreign language pages).
36 class ApiQueryLangLinks
extends ApiQueryBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'll' );
42 public function execute() {
43 if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
47 $params = $this->extractRequestParams();
48 $this->addFields( array(
54 $this->addTables( 'langlinks' );
55 $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
56 if ( !is_null( $params['continue'] ) ) {
57 $cont = explode( '|', $params['continue'] );
58 if ( count( $cont ) != 2 ) {
59 $this->dieUsage( 'Invalid continue param. You should pass the ' .
60 'original value returned by the previous query', '_badcontinue' );
62 $llfrom = intval( $cont[0] );
63 $lllang = $this->getDB()->strencode( $cont[1] );
65 "ll_from > $llfrom OR " .
66 "(ll_from = $llfrom AND " .
67 "ll_lang >= '$lllang')"
71 // Don't order by ll_from if it's constant in the WHERE clause
72 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) {
73 $this->addOption( 'ORDER BY', 'll_lang' );
75 $this->addOption( 'ORDER BY', 'll_from, ll_lang' );
77 $this->addOption( 'LIMIT', $params['limit'] +
1 );
78 $res = $this->select( __METHOD__
);
81 foreach ( $res as $row ) {
82 if ( ++
$count > $params['limit'] ) {
83 // We've reached the one extra which shows that
84 // there are additional pages to be had. Stop here...
85 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
88 $entry = array( 'lang' => $row->ll_lang
);
89 ApiResult
::setContent( $entry, $row->ll_title
);
90 $fit = $this->addPageSubItem( $row->ll_from
, $entry );
92 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
98 public function getCacheMode( $params ) {
102 public function getAllowedParams() {
105 ApiBase
::PARAM_DFLT
=> 10,
106 ApiBase
::PARAM_TYPE
=> 'limit',
107 ApiBase
::PARAM_MIN
=> 1,
108 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
109 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
115 public function getParamDescription() {
117 'limit' => 'How many langlinks to return',
118 'continue' => 'When more results are available, use this to continue',
122 public function getDescription() {
123 return 'Returns all interlanguage links from the given page(s)';
126 public function getPossibleErrors() {
127 return array_merge( parent
::getPossibleErrors(), array(
128 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
132 protected function getExamples() {
134 'Get interlanguage links from the [[Main Page]]:',
135 ' api.php?action=query&prop=langlinks&titles=Main%20Page&redirects',
139 public function getVersion() {
140 return __CLASS__
. ': $Id$';