23632a4ecd
Which type is used depends on the ApiModuleManager responsible for the API module. There are two managers, one in ApiMain and one in ApiQuery. Both contain a list of API modules they instantiate. Both use $this as the first parameter in the constructors of the individual modules. There is no other regular way to instantiate the modules, so we know the type must either be ApiMain or ApiQuery. The lists don't intersect. I would have prefered the naming scheme $mainModule for ApiMain modules and $queryModule for ApiQuery modules but since this doesn't add much I left the shorter variable names untouched. Change-Id: Ie6bf19150f1c9b619655a06a8e051412665e54db
98 lines
2.6 KiB
PHP
98 lines
2.6 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on Sep 19, 2006
|
|
*
|
|
* Copyright © 2006 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
/**
|
|
* API JSON output formatter
|
|
* @ingroup API
|
|
*/
|
|
class ApiFormatJson extends ApiFormatBase {
|
|
|
|
private $mIsRaw;
|
|
|
|
public function __construct( ApiMain $main, $format ) {
|
|
parent::__construct( $main, $format );
|
|
$this->mIsRaw = ( $format === 'rawfm' );
|
|
}
|
|
|
|
public function getMimeType() {
|
|
$params = $this->extractRequestParams();
|
|
// callback:
|
|
if ( $params['callback'] ) {
|
|
return 'text/javascript';
|
|
}
|
|
|
|
return 'application/json';
|
|
}
|
|
|
|
public function getNeedsRawData() {
|
|
return $this->mIsRaw;
|
|
}
|
|
|
|
public function getWantsHelp() {
|
|
// Help is always ugly in JSON
|
|
return false;
|
|
}
|
|
|
|
public function execute() {
|
|
$params = $this->extractRequestParams();
|
|
$json = FormatJson::encode(
|
|
$this->getResultData(),
|
|
$this->getIsHtml(),
|
|
$params['utf8'] ? FormatJson::ALL_OK : FormatJson::XMLMETA_OK
|
|
);
|
|
$callback = $params['callback'];
|
|
if ( $callback !== null ) {
|
|
$callback = preg_replace( "/[^][.\\'\\\"_A-Za-z0-9]/", '', $callback );
|
|
$this->printText( "$callback($json)" );
|
|
} else {
|
|
$this->printText( $json );
|
|
}
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'callback' => null,
|
|
'utf8' => false,
|
|
);
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
return array(
|
|
'callback' => 'If specified, wraps the output into a given function ' .
|
|
'call. For safety, all user-specific data will be restricted.',
|
|
'utf8' => 'If specified, encodes most (but not all) non-ASCII ' .
|
|
'characters as UTF-8 instead of replacing them with hexadecimal escape sequences.',
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
if ( $this->mIsRaw ) {
|
|
return 'Output data with the debugging elements in JSON format' . parent::getDescription();
|
|
}
|
|
|
|
return 'Output data in JSON format' . parent::getDescription();
|
|
}
|
|
}
|