ApiFormatRaw.php

Go to the documentation of this file.

<?php
class ApiFormatRaw extends ApiFormatBase {

    private $errorFallback;
    private $mFailWithHTTPError = false;

    public function __construct( ApiMain $main, ApiFormatBase $errorFallback = null ) {
        parent::__construct( $main, 'raw' );
        if ( $errorFallback === null ) {
            $this->errorFallback = $main->createPrinterByName( $main->getParameter( 'format' ) );
        } else {
            $this->errorFallback = $errorFallback;
        }
    }

    public function getMimeType() {
        $data = $this->getResult()->getResultData();

        if ( isset( $data['error'] ) ) {
            return $this->errorFallback->getMimeType();
        }

        if ( !isset( $data['mime'] ) ) {
            ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
        }

        return $data['mime'];
    }

    public function initPrinter( $unused = false ) {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['error'] ) ) {
            $this->errorFallback->initPrinter( $unused );
            if ( $this->mFailWithHTTPError ) {
                $this->getMain()->getRequest()->response()->statusHeader( 400 );
            }
        } else {
            parent::initPrinter( $unused );
        }
    }

    public function closePrinter() {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['error'] ) ) {
            $this->errorFallback->closePrinter();
        } else {
            parent::closePrinter();
        }
    }

    public function execute() {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['error'] ) ) {
            $this->errorFallback->execute();
            return;
        }

        if ( !isset( $data['text'] ) ) {
            ApiBase::dieDebug( __METHOD__, 'No text given for raw formatter' );
        }
        $this->printText( $data['text'] );
    }

    public function setFailWithHTTPError( $fail ) {
        $this->mFailWithHTTPError = $fail;
    }
}