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                 if ( $this->getPageSet()->getGoodTitleCount() == 0 )
  44                         return;
  45
  46                 $this->addFields(array (
  47                         'll_from',
  48                         'll_lang',
  49                         'll_title'
  50                 ));
  51
  52                 $this->addTables('langlinks');
  53                 $this->addWhereFld('ll_from', array_keys($this->getPageSet()->getGoodTitles()));
  54                 $this->addOption('ORDER BY', "ll_from, ll_lang");
  55                 $res = $this->select(__METHOD__);
  56
  57                 $data = array();
  58                 $lastId = 0;    // database has no ID 0
  59                 $db = $this->getDB();
  60                 while ($row = $db->fetchObject($res)) {
  61
  62                         if ($lastId != $row->ll_from) {
  63                                 if($lastId != 0) {
  64                                         $this->addPageSubItems($lastId, $data);
  65                                         $data = array();
  66                                 }
  67                                 $lastId = $row->ll_from;
  68                         }
  69
  70                         $entry = array('lang'=>$row->ll_lang);
  71                         ApiResult :: setContent($entry, $row->ll_title);
  72                         $data[] = $entry;
  73                 }
  74
  75                 if($lastId != 0) {
  76                         $this->addPageSubItems($lastId, $data);
  77                 }
  78
  79                 $db->freeResult($res);
  80         }
  81
  82         public function getDescription() {
  83                 return 'Returns all interlanguage links from the given page(s)';
  84         }
  85
  86         protected function getExamples() {
  87                 return array (
  88                                 "Get interlanguage links from the [[Main Page]]:",
  89                                 "  api.php?action=query&prop=langlinks&titles=Main%20Page&redirects",
  90                         );
  91         }
  92
  93         public function getVersion() {
  94                 return __CLASS__ . ': $Id$';
  95         }
  96 }
  97