4 * Created on May 13, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 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 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, 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 )
46 $params = $this->extractRequestParams();
47 $this->addFields( array (
53 $this->addTables( 'langlinks' );
54 $this->addWhereFld( 'll_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
55 if ( !is_null( $params['continue'] ) ) {
56 $cont = explode( '|', $params['continue'] );
57 if ( count( $cont ) != 2 )
58 $this->dieUsage( "Invalid continue param. You should pass the " .
59 "original value returned by the previous query", "_badcontinue" );
60 $llfrom = intval( $cont[0] );
61 $lllang = $this->getDB()->strencode( $cont[1] );
62 $this->addWhere( "ll_from > $llfrom OR " .
63 "(ll_from = $llfrom AND " .
64 "ll_lang >= '$lllang')" );
67 // Don't order by ll_from if it's constant in the WHERE clause
68 if ( count( $this->getPageSet()->getGoodTitles() ) == 1 )
69 $this->addOption( 'ORDER BY', 'll_lang' );
71 $this->addOption( 'ORDER BY', 'll_from, ll_lang' );
72 $this->addOption( 'LIMIT', $params['limit'] +
1 );
73 $res = $this->select( __METHOD__
);
77 while ( $row = $db->fetchObject( $res ) ) {
78 if ( ++
$count > $params['limit'] ) {
79 // We've reached the one extra which shows that
80 // there are additional pages to be had. Stop here...
81 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
84 $entry = array( 'lang' => $row->ll_lang
);
85 ApiResult
:: setContent( $entry, $row->ll_title
);
86 $fit = $this->addPageSubItem( $row->ll_from
, $entry );
89 $this->setContinueEnumParameter( 'continue', "{$row->ll_from}|{$row->ll_lang}" );
93 $db->freeResult( $res );
96 public function getAllowedParams() {
99 ApiBase
:: PARAM_DFLT
=> 10,
100 ApiBase
:: PARAM_TYPE
=> 'limit',
101 ApiBase
:: PARAM_MIN
=> 1,
102 ApiBase
:: PARAM_MAX
=> ApiBase
:: LIMIT_BIG1
,
103 ApiBase
:: PARAM_MAX2
=> ApiBase
:: LIMIT_BIG2
109 public function getParamDescription () {
111 'limit' => 'How many langlinks to return',
112 'continue' => 'When more results are available, use this to continue',
116 public function getDescription() {
117 return 'Returns all interlanguage links from the given page(s)';
120 public function getPossibleErrors() {
121 return array_merge( parent
::getPossibleErrors(), array(
122 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
126 protected function getExamples() {
128 "Get interlanguage links from the [[Main Page]]:",
129 " api.php?action=query&prop=langlinks&titles=Main%20Page&redirects",
133 public function getVersion() {
134 return __CLASS__
. ': $Id$';