4 * Created on Sep 19, 2006
6 * API for MediaWiki 1.8+
8 * Copyright © 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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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' );
32 * API JSON output formatter
35 class ApiFormatJson
extends ApiFormatBase
{
39 public function __construct( $main, $format ) {
40 parent
::__construct( $main, $format );
41 $this->mIsRaw
= ( $format === 'rawfm' );
44 public function getMimeType() {
45 $params = $this->extractRequestParams();
47 if ( $params['callback'] ) {
48 return 'text/javascript';
50 return 'application/json';
53 public function getNeedsRawData() {
57 public function getWantsHelp() {
58 // Help is always ugly in JSON
62 public function execute() {
63 $prefix = $suffix = '';
65 $params = $this->extractRequestParams();
66 $callback = $params['callback'];
67 if ( !is_null( $callback ) ) {
68 $prefix = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $callback ) . '(';
73 FormatJson
::encode( $this->getResultData(), $this->getIsHtml() ) .
78 public function getAllowedParams() {
84 public function getParamDescription() {
86 'callback' => 'If specified, wraps the output into a given function call. For safety, all user-specific data will be restricted.',
90 public function getDescription() {
91 if ( $this->mIsRaw
) {
92 return 'Output data with the debuging elements in JSON format' . parent
::getDescription();
94 return 'Output data in JSON format' . parent
::getDescription();
98 public function getVersion() {
99 return __CLASS__
. ': $Id$';