includes/api/ApiQueryExternalLinks.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 <FirstnameLastname@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  * @addtogroup API
  33  */
  34 class ApiQueryExternalLinks extends ApiQueryBase {
  35
  36         public function __construct($query, $moduleName) {
  37                 parent :: __construct($query, $moduleName, 'el');
  38         }
  39
  40         public function execute() {
  41
  42                 $this->addFields(array (
  43                         'el_from',
  44                         'el_to'
  45                 ));
  46
  47                 $this->addTables('externallinks');
  48                 $this->addWhereFld('el_from', array_keys($this->getPageSet()->getGoodTitles()));
  49
  50                 $db = $this->getDB();
  51                 $res = $this->select(__METHOD__);
  52
  53                 $data = array();
  54                 $lastId = 0;    // database has no ID 0
  55                 while ($row = $db->fetchObject($res)) {
  56                         if ($lastId != $row->el_from) {
  57                                 if($lastId != 0) {
  58                                         $this->addPageSubItems($lastId, $data);
  59                                         $data = array();
  60                                 }
  61                                 $lastId = $row->el_from;
  62                         }
  63
  64                         $entry = array();
  65                         ApiResult :: setContent($entry, $row->el_to);
  66                         $data[] = $entry;
  67                 }
  68
  69                 if($lastId != 0) {
  70                         $this->addPageSubItems($lastId, $data);
  71                 }
  72
  73                 $db->freeResult($res);
  74         }
  75
  76         private function addPageSubItems($pageId, $data) {
  77                 $result = $this->getResult();
  78                 $result->setIndexedTagName($data, 'el');
  79                 $result->addValue(array ('query', 'pages', intval($pageId)),
  80                         'extlinks',
  81                         $data);
  82         }
  83
  84         protected function getDescription() {
  85                 return 'Returns all external urls (not interwikies) from the given page(s)';
  86         }
  87
  88         protected function getExamples() {
  89                 return array (
  90                                 "Get a list of external links on the [[Main Page]]:",
  91                                 "  api.php?action=query&prop=extlinks&titles=Main%20Page",
  92                         );
  93         }
  94
  95         public function getVersion() {
  96                 return __CLASS__ . ': $Id$';
  97         }
  98 }
  99 ?>