includes/api/ApiFormatJson.php

   1 <?php
   2
   3 /**
   4  * Created on Sep 19, 2006
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright © 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( 'ApiFormatBase.php' );
  29 }
  30
  31 /**
  32  * API JSON output formatter
  33  * @ingroup API
  34  */
  35 class ApiFormatJson extends ApiFormatBase {
  36
  37         private $mIsRaw;
  38
  39         public function __construct( $main, $format ) {
  40                 parent::__construct( $main, $format );
  41                 $this->mIsRaw = ( $format === 'rawfm' );
  42         }
  43
  44         public function getMimeType() {
  45                 $params = $this->extractRequestParams();
  46                 // callback:
  47                 if ( $params['callback'] ) {
  48                         return 'text/javascript';
  49                 }
  50                 return 'application/json';
  51         }
  52
  53         public function getNeedsRawData() {
  54                 return $this->mIsRaw;
  55         }
  56
  57         public function getWantsHelp() {
  58                 // Help is always ugly in JSON
  59                 return false;
  60         }
  61
  62         public function execute() {
  63                 $prefix = $suffix = '';
  64
  65                 $params = $this->extractRequestParams();
  66                 $callback = $params['callback'];
  67                 if ( !is_null( $callback ) ) {
  68                         $prefix = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $callback ) . '(';
  69                         $suffix = ')';
  70                 }
  71                 $this->printText(
  72                         $prefix .
  73                         FormatJson::encode( $this->getResultData(),     $this->getIsHtml() ) .
  74                         $suffix
  75                 );
  76         }
  77
  78         public function getAllowedParams() {
  79                 return array(
  80                         'callback'  => null,
  81                 );
  82         }
  83
  84         public function getParamDescription() {
  85                 return array(
  86                         'callback' => 'If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.',
  87                 );
  88         }
  89
  90         public function getDescription() {
  91                 if ( $this->mIsRaw ) {
  92                         return 'Output data with the debuging elements in JSON format' . parent::getDescription();
  93                 } else {
  94                         return 'Output data in JSON format' . parent::getDescription();
  95                 }
  96         }
  97
  98         public function getVersion() {
  99                 return __CLASS__ . ': $Id$';
 100         }
 101 }