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 return 'application/json';
47 public function getNeedsRawData() {
51 public function execute() {
52 $prefix = $suffix = "";
54 $params = $this->extractRequestParams();
55 $callback = $params['callback'];
56 if(!is_null($callback)) {
57 $prefix = preg_replace("/[^][.\\'\\\"_A-Za-z0-9]/", "", $callback ) . "(";
61 // Some versions of PHP have a broken json_encode, see PHP bug
62 // 46944. Test encoding an affected character (U+20000) to
64 if (!function_exists('json_encode') ||
$this->getIsHtml() ||
strtolower(json_encode("\xf0\xa0\x80\x80")) != '\ud840\udc00') {
65 $json = new Services_JSON();
66 $this->printText($prefix . $json->encode($this->getResultData(), $this->getIsHtml()) . $suffix);
68 $this->printText($prefix . json_encode($this->getResultData()) . $suffix);
72 public function getAllowedParams() {
78 public function getParamDescription() {
80 'callback' => 'If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.',
84 public function getDescription() {
86 return 'Output data with the debuging elements in JSON format' . parent
:: getDescription();
88 return 'Output data in JSON format' . parent
:: getDescription();
91 public function getVersion() {
92 return __CLASS__
. ': $Id$';