ApiFormatJson.php

Go to the documentation of this file.

<?php
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 );
            # Prepend a comment to try to avoid attacks against content
            # sniffers, such as bug 68187.
            $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();
    }
}