fb22d04ef7378088dcf9f21e3ba407eb251a7c1c
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 * This query adds <images> subelement to all pages with the list of images embedded into those pages.
36 class ApiQueryImages
extends ApiQueryGeneratorBase
{
38 public function __construct($query, $moduleName) {
39 parent
:: __construct($query, $moduleName, 'im');
42 public function execute() {
46 public function executeGenerator($resultPageSet) {
47 $this->run($resultPageSet);
50 private function run($resultPageSet = null) {
52 if ($this->getPageSet()->getGoodTitleCount() == 0)
53 return; // nothing to do
55 $this->addFields(array (
60 $this->addTables('imagelinks');
61 $this->addWhereFld('il_from', array_keys($this->getPageSet()->getGoodTitles()));
62 $this->addOption('ORDER BY', "il_from, il_to");
65 $res = $this->select(__METHOD__
);
67 if (is_null($resultPageSet)) {
70 $lastId = 0; // database has no ID 0
71 while ($row = $db->fetchObject($res)) {
72 if ($lastId != $row->il_from
) {
74 $this->addPageSubItems($lastId, $data);
77 $lastId = $row->il_from
;
80 $title = Title
:: makeTitle(NS_IMAGE
, $row->il_to
);
81 // do not check userCanRead() -- page content is already accessible,
82 // and images are listed there.
85 ApiQueryBase
:: addTitleInfo($vals, $title, true);
90 $this->addPageSubItems($lastId, $data);
96 while ($row = $db->fetchObject($res)) {
97 $titles[] = Title
:: makeTitle(NS_IMAGE
, $row->il_to
);
99 $resultPageSet->populateFromTitles($titles);
102 $db->freeResult($res);
105 private function addPageSubItems($pageId, $data) {
106 $result = $this->getResult();
107 $result->setIndexedTagName($data, 'im');
108 $result->addValue(array ('query', 'pages', intval($pageId)),
113 protected function getDescription() {
114 return 'Returns all images contained on the given page(s)';
117 protected function getExamples() {
119 "Get a list of images used in the [[Main Page]]:",
120 " api.php?action=query&prop=images&titles=Main%20Page",
121 "Get information about all images used in the [[Main Page]]:",
122 " api.php?action=query&generator=images&titles=Main%20Page&prop=info"
126 public function getVersion() {
127 return __CLASS__
. ': $Id$';