ApiFormatRaw.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
class ApiFormatRaw extends ApiFormatBase {
 
    private $errorFallback;
    private $mFailWithHTTPError = false;
 
    public function __construct( ApiMain $main, ?ApiFormatBase $errorFallback = null ) {
        parent::__construct( $main, 'raw' );
        $this->errorFallback = $errorFallback ??
            $main->createPrinterByName( $main->getParameter( 'format' ) );
    }
 
    public function getMimeType() {
        $data = $this->getResult()->getResultData();
 
        if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
            return $this->errorFallback->getMimeType();
        }
 
        if ( !isset( $data['mime'] ) ) {
            ApiBase::dieDebug( __METHOD__, 'No MIME type set for raw formatter' );
        }
 
        return $data['mime'];
    }
 
    public function getFilename() {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['error'] ) ) {
            return $this->errorFallback->getFilename();
        } elseif ( !isset( $data['filename'] ) || $this->getIsWrappedHtml() || $this->getIsHtml() ) {
            return parent::getFilename();
        } else {
            return $data['filename'];
        }
    }
 
    public function initPrinter( $unused = false ) {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
            $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'] ) || isset( $data['errors'] ) ) {
            $this->errorFallback->closePrinter();
        } else {
            parent::closePrinter();
        }
    }
 
    public function execute() {
        $data = $this->getResult()->getResultData();
        if ( isset( $data['error'] ) || isset( $data['errors'] ) ) {
            $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;
    }
}
 
class_alias( ApiFormatRaw::class, 'ApiFormatRaw' );