includes/api/ApiQueryInfo.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 25, 2006
   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 ApiQueryInfo extends ApiQueryBase {
  35
  36         public function __construct($query, $moduleName) {
  37                 parent :: __construct($query, $moduleName);
  38         }
  39
  40         public function requestExtraData() {
  41                 $pageSet = $this->getPageSet();
  42                 $pageSet->requestField('page_is_redirect');
  43                 $pageSet->requestField('page_is_new');
  44                 $pageSet->requestField('page_counter');
  45                 $pageSet->requestField('page_touched');
  46                 $pageSet->requestField('page_latest');
  47                 $pageSet->requestField('page_len');
  48         }
  49
  50         public function execute() {
  51
  52                 $pageSet = $this->getPageSet();
  53                 $titles = $pageSet->getGoodTitles();
  54                 $result = $this->getResult();
  55
  56                 $pageIsRedir = $pageSet->getCustomField('page_is_redirect');
  57                 $pageIsNew = $pageSet->getCustomField('page_is_new');
  58                 $pageCounter = $pageSet->getCustomField('page_counter');
  59                 $pageTouched = $pageSet->getCustomField('page_touched');
  60                 $pageLatest = $pageSet->getCustomField('page_latest');
  61                 $pageLength = $pageSet->getCustomField('page_len');
  62
  63                 foreach ( $titles as $pageid => $unused ) {
  64                         $pageInfo = array (
  65                                 'touched' => wfTimestamp(TS_ISO_8601, $pageTouched[$pageid]),
  66                                 'lastrevid' => intval($pageLatest[$pageid]),
  67                                 'counter' => intval($pageCounter[$pageid]),
  68                                 'length' => intval($pageLength[$pageid]),
  69                         );
  70
  71                         if ($pageIsRedir[$pageid])
  72                                 $pageInfo['redirect'] = '';
  73
  74                         if ($pageIsNew[$pageid])
  75                                 $pageInfo['new'] = '';
  76
  77                         $result->addValue(array (
  78                                 'query',
  79                                 'pages'
  80                         ), $pageid, $pageInfo);
  81                 }
  82         }
  83
  84         protected function getDescription() {
  85                 return 'Get basic page information such as namespace, title, last touched date, ...';
  86         }
  87
  88         protected function getExamples() {
  89                 return array (
  90                         'api.php?action=query&prop=info&titles=Main%20Page'
  91                 );
  92         }
  93
  94         public function getVersion() {
  95                 return __CLASS__ . ': $Id$';
  96         }
  97 }
  98 ?>