includes/api/ApiFormatJson.php

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