includes/api/ApiQueryInfo.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 25, 2006
   6  *
   7  * API for MediaWiki 1.8+
   8  *
   9  * Copyright (C) 2006 Yuri Astrakhan <FirstnameLastname@gmail.com>
  10  *
  11  * This program is free software; you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation; either version 2 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License along
  22  * with this program; if not, write to the Free Software Foundation, Inc.,
  23  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  24  * http://www.gnu.org/copyleft/gpl.html
  25  */
  26
  27 if (!defined('MEDIAWIKI')) {
  28         // Eclipse helper - will be ignored in production
  29         require_once ('ApiQueryBase.php');
  30 }
  31
  32 class ApiQueryInfo extends ApiQueryBase {
  33
  34         public function __construct($query, $moduleName) {
  35                 parent :: __construct($query, $moduleName);
  36         }
  37
  38         public function requestExtraData() {
  39                 $pageSet = $this->getPageSet();
  40                 $pageSet->requestField('page_is_redirect');
  41                 $pageSet->requestField('page_touched');
  42                 $pageSet->requestField('page_latest');
  43         }
  44
  45         public function execute() {
  46
  47                 $pageSet = $this->getPageSet();
  48                 $titles = $pageSet->getGoodTitles();
  49                 $result = & $this->getResult();
  50
  51                 $pageIsRedir = $pageSet->getCustomField('page_is_redirect');
  52                 $pageTouched = $pageSet->getCustomField('page_touched');
  53                 $pageLatest = $pageSet->getCustomField('page_latest');
  54
  55                 foreach ($titles as $pageid => $title) {
  56                         $pageInfo = array ('touched' => $pageTouched[$pageid], 'lastrevid' => $pageLatest[$pageid]);
  57
  58                         if ($pageIsRedir[$pageid])
  59                                 $pageInfo['redirect'] = '';
  60
  61                         $result->addValue(array (
  62                                 'query',
  63                                 'pages'
  64                         ), $pageid, $pageInfo);
  65                 }
  66         }
  67
  68         protected function getDescription() {
  69                 return 'Get basic page information such as namespace, title, last touched date, ...';
  70         }
  71
  72         protected function getExamples() {
  73                 return array (
  74                         'api.php?action=query&prop=info&titles=Main%20Page'
  75                 );
  76         }
  77
  78         public function getVersion() {
  79                 return __CLASS__ . ': $Id$';
  80         }
  81 }
  82 ?>