includes/api/ApiFormatJson.php

   1 <?php
   2
   3
   4 /*
   5  * Created on Sep 19, 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 ('ApiFormatBase.php');
  30 }
  31
  32 class ApiFormatJson extends ApiFormatBase {
  33
  34         private $mIsRaw;
  35
  36         public function __construct($main, $format) {
  37                 parent :: __construct($main, $format);
  38                 $this->mIsRaw = ($format === 'rawfm');
  39         }
  40
  41         public function getMimeType() {
  42                 return 'application/json';
  43         }
  44
  45         public function getNeedsRawData() {
  46                 return $this->mIsRaw;
  47         }
  48
  49         public function execute() {
  50                 if (!function_exists('json_encode') || $this->getIsHtml()) {
  51                         $json = new Services_JSON();
  52                         $this->printText($json->encode($this->getResultData(), $this->getIsHtml()));
  53                 } else {
  54                         $this->printText(json_encode($this->getResultData()));
  55                 }
  56         }
  57
  58         protected function getDescription() {
  59                 if ($this->mIsRaw)
  60                         return 'Output data with the debuging elements in JSON format' . parent :: getDescription();
  61                 else
  62                         return 'Output data in JSON format' . parent :: getDescription();
  63         }
  64
  65         public function getVersion() {
  66                 return __CLASS__ . ': $Id$';
  67         }
  68 }
  69 ?>