includes/api/ApiQueryLangLinks.php

   1 <?php
   2
   3 /*
   4  * Created on May 13, 2007
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
   9  *
  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.
  14  *
  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.
  19  *
  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
  24  */
  25
  26 if (!defined('MEDIAWIKI')) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ("ApiQueryBase.php");
  29 }
  30
  31 /**
  32  * A query module to list all langlinks (links to correspanding foreign language pages).
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryLangLinks extends ApiQueryBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'll');
  40         }
  41
  42         public function execute() {
  43                 $this->addFields(array (
  44                         'll_from',
  45                         'll_lang',
  46                         'll_title'
  47                 ));
  48
  49                 $this->addTables('langlinks');
  50                 $this->addWhereFld('ll_from', array_keys($this->getPageSet()->getGoodTitles()));
  51                 $this->addOption('ORDER BY', "ll_from, ll_lang");
  52                 $res = $this->select(__METHOD__);
  53
  54                 $data = array();
  55                 $lastId = 0;    // database has no ID 0
  56                 $db = $this->getDB();
  57                 while ($row = $db->fetchObject($res)) {
  58
  59                         if ($lastId != $row->ll_from) {
  60                                 if($lastId != 0) {
  61                                         $this->addPageSubItems($lastId, $data);
  62                                         $data = array();
  63                                 }
  64                                 $lastId = $row->ll_from;
  65                         }
  66
  67                         $entry = array('lang'=>$row->ll_lang);
  68                         ApiResult :: setContent($entry, $row->ll_title);
  69                         $data[] = $entry;
  70                 }
  71
  72                 if($lastId != 0) {
  73                         $this->addPageSubItems($lastId, $data);
  74                 }
  75
  76                 $db->freeResult($res);
  77         }
  78
  79         protected function getDescription() {
  80                 return 'Returns all interlanguage links from the given page(s)';
  81         }
  82
  83         protected function getExamples() {
  84                 return array (
  85                                 "Get interlanguage links from the [[Main Page]]:",
  86                                 "  api.php?action=query&prop=langlinks&titles=Main%20Page&redirects",
  87                         );
  88         }
  89
  90         public function getVersion() {
  91                 return __CLASS__ . ': $Id$';
  92         }
  93 }
  94