4 * Created on Sep 19, 2006
6 * API for MediaWiki 1.8+
8 * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
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.
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.
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
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ('ApiFormatBase.php');
34 class ApiFormatJson
extends ApiFormatBase
{
38 public function __construct($main, $format) {
39 parent
:: __construct($main, $format);
40 $this->mIsRaw
= ($format === 'rawfm');
43 public function getMimeType() {
44 $params = $this->extractRequestParams();
46 if( $params['callback']){
47 return 'text/javascript';
49 //check for text content request
50 if( isset( $params['ctypetext']) && $params['ctypetext']) {
53 return 'application/json';
56 public function getNeedsRawData() {
60 public function getWantsHelp() {
61 // Help is always ugly in JSON
65 public function execute() {
66 $prefix = $suffix = "";
68 $params = $this->extractRequestParams();
69 $callback = $params['callback'];
70 if(!is_null($callback)) {
71 $prefix = preg_replace("/[^][.\\'\\\"_A-Za-z0-9]/", "", $callback ) . "(";
75 // Some versions of PHP have a broken json_encode, see PHP bug
76 // 46944. Test encoding an affected character (U+20000) to
78 $this->printText( $prefix . $this->getJsonEncode($this->getResultData(), $this->getIsHtml() ) . $suffix);
81 * static to support static calls to json output (instead of json_encode function)
82 * @param array $results the results array to output as a json string
83 * @parm isHTML if the output is html
85 public static function getJsonEncode($value, $isHtml=false){
86 if (!function_exists('json_encode') ||
$isHtml ||
strtolower(json_encode("\xf0\xa0\x80\x80")) != '\ud840\udc00') {
87 $json = new Services_JSON();
88 return $json->encode($value, $isHtml) ;
90 return json_encode($value);
94 public function getAllowedParams() {
101 public function getParamDescription() {
103 'callback' => 'If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.',
104 'ctypetext'=> 'Used to set the content type of the json result to plain-text (useful for evaling iframe uploads)',
108 public function getDescription() {
110 return 'Output data with the debuging elements in JSON format' . parent
:: getDescription();
112 return 'Output data in JSON format' . parent
:: getDescription();
115 public function getVersion() {
116 return __CLASS__
. ': $Id$';