includes/api/ApiQueryImages.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  * This query adds <images> subelement to all pages with the list of images embedded into those pages.
  33  *
  34  * @addtogroup API
  35  */
  36 class ApiQueryImages extends ApiQueryGeneratorBase {
  37
  38         public function __construct($query, $moduleName) {
  39                 parent :: __construct($query, $moduleName, 'im');
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator($resultPageSet) {
  47                 $this->run($resultPageSet);
  48         }
  49
  50         private function run($resultPageSet = null) {
  51
  52                 if ($this->getPageSet()->getGoodTitleCount() == 0)
  53                         return; // nothing to do
  54
  55                 $this->addFields(array (
  56                         'il_from',
  57                         'il_to'
  58                 ));
  59
  60                 $this->addTables('imagelinks');
  61                 $this->addWhereFld('il_from', array_keys($this->getPageSet()->getGoodTitles()));
  62                 $this->addOption('ORDER BY', "il_from, il_to");
  63
  64                 $db = $this->getDB();
  65                 $res = $this->select(__METHOD__);
  66
  67                 if (is_null($resultPageSet)) {
  68
  69                         $data = array();
  70                         $lastId = 0;    // database has no ID 0
  71                         while ($row = $db->fetchObject($res)) {
  72                                 if ($lastId != $row->il_from) {
  73                                         if($lastId != 0) {
  74                                                 $this->addPageSubItems($lastId, $data);
  75                                                 $data = array();
  76                                         }
  77                                         $lastId = $row->il_from;
  78                                 }
  79
  80                                 $vals = array();
  81                                 ApiQueryBase :: addTitleInfo($vals, Title :: makeTitle(NS_IMAGE, $row->il_to));
  82                                 $data[] = $vals;
  83                         }
  84
  85                         if($lastId != 0) {
  86                                 $this->addPageSubItems($lastId, $data);
  87                         }
  88
  89                 } else {
  90
  91                         $titles = array();
  92                         while ($row = $db->fetchObject($res)) {
  93                                 $titles[] = Title :: makeTitle(NS_IMAGE, $row->il_to);
  94                         }
  95                         $resultPageSet->populateFromTitles($titles);
  96                 }
  97
  98                 $db->freeResult($res);
  99         }
 100
 101         protected function getDescription() {
 102                 return 'Returns all images contained on the given page(s)';
 103         }
 104
 105         protected function getExamples() {
 106                 return array (
 107                                 "Get a list of images used in the [[Main Page]]:",
 108                                 "  api.php?action=query&prop=images&titles=Main%20Page",
 109                                 "Get information about all images used in the [[Main Page]]:",
 110                                 "  api.php?action=query&generator=images&titles=Main%20Page&prop=info"
 111                         );
 112         }
 113
 114         public function getVersion() {
 115                 return __CLASS__ . ': $Id$';
 116         }
 117 }
 118