ApiUsageException.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Api;
 
use InvalidArgumentException;
use MediaWiki\Exception\ILocalizedException;
use MediaWiki\Exception\MWException;
use MediaWiki\Status\Status;
use StatusValue;
use Stringable;
use Throwable;
use Wikimedia\Message\MessageSpecifier;
 
class ApiUsageException extends MWException implements Stringable, ILocalizedException {
 
    protected $modulePath;
    protected $status;
 
    public function __construct(
        ?ApiBase $module, StatusValue $status, $httpCode = 0, ?Throwable $previous = null
    ) {
        if ( $status->isOK() ) {
            throw new InvalidArgumentException( __METHOD__ . ' requires a fatal Status' );
        }
 
        $this->modulePath = $module ? $module->getModulePath() : null;
        $this->status = $status;
 
        // Bug T46111: Messages in the log files should be in English and not
        // customized by the local wiki.
        $enMsg = clone $this->getApiMessage();
        $enMsg->inLanguage( 'en' )->useDatabase( false );
        parent::__construct( ApiErrorFormatter::stripMarkup( $enMsg->text() ), $httpCode, $previous );
    }
 
    public static function newWithMessage(
        ?ApiBase $module, $msg, $code = null, $data = null, $httpCode = 0, ?Throwable $previous = null
    ) {
        return new static(
            $module,
            StatusValue::newFatal( ApiMessage::create( $msg, $code, $data ) ),
            $httpCode,
            $previous
        );
    }
 
    private function getApiMessage() {
        // Return the first error message, if any; or the first warning message, if any; or a generic message
        foreach ( $this->status->getMessages( 'error' ) as $msg ) {
            // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
            return ApiMessage::create( $msg );
        }
        foreach ( $this->status->getMessages( 'warning' ) as $msg ) {
            // @phan-suppress-next-line PhanTypeMismatchReturnSuperType
            return ApiMessage::create( $msg );
        }
        return new ApiMessage( 'apierror-unknownerror-nocode', 'unknownerror' );
    }
 
    public function getModulePath() {
        return $this->modulePath;
    }
 
    public function getStatusValue() {
        return $this->status;
    }
 
    public function getMessageObject() {
        return Status::wrap( $this->status )->getMessage();
    }
 
    public function __toString() {
        $enMsg = clone $this->getApiMessage();
        $enMsg->inLanguage( 'en' )->useDatabase( false );
        $text = ApiErrorFormatter::stripMarkup( $enMsg->text() );
 
        return get_class( $this ) . ": {$enMsg->getApiCode()}: {$text} "
            . "in {$this->getFile()}:{$this->getLine()}\n"
            . "Stack trace:\n{$this->getTraceAsString()}"
            . ( $this->getPrevious() ? "\n\nNext {$this->getPrevious()}" : "" );
    }
 
}
 
class_alias( ApiUsageException::class, 'ApiUsageException' );