ApiUsageException.php

Go to the documentation of this file.

<?php
class UsageException extends MWException {
 
    private $mCodestr;
 
    private $mExtraData;
 
    public function __construct( $message, $codestr, $code = 0, $extradata = null ) {
        parent::__construct( $message, $code );
        $this->mCodestr = $codestr;
        $this->mExtraData = $extradata;
 
        // This should never happen, so throw an exception about it that will
        // hopefully get logged with a backtrace (T138585)
        if ( !is_string( $codestr ) || $codestr === '' ) {
            throw new InvalidArgumentException( 'Invalid $codestr, was ' .
                ( $codestr === '' ? 'empty string' : gettype( $codestr ) )
            );
        }
    }
 
    public function getCodeString() {
        return $this->mCodestr;
    }
 
    public function getMessageArray() {
        $result = [
            'code' => $this->mCodestr,
            'info' => $this->getMessage()
        ];
        if ( is_array( $this->mExtraData ) ) {
            $result = array_merge( $result, $this->mExtraData );
        }
 
        return $result;
    }
 
    public function __toString() {
        return "{$this->getCodeString()}: {$this->getMessage()}";
    }
}
 
class ApiUsageException extends UsageException implements ILocalizedException {
 
    protected $modulePath;
    protected $status;
 
    public function __construct(
        ApiBase $module = null, StatusValue $status, $httpCode = 0
    ) {
        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() ),
            $enMsg->getApiCode(),
            $httpCode,
            $enMsg->getApiData()
        );
    }
 
    public static function newWithMessage(
        ApiBase $module = null, $msg, $code = null, $data = null, $httpCode = 0
    ) {
        return new static(
            $module,
            StatusValue::newFatal( ApiMessage::create( $msg, $code, $data ) ),
            $httpCode
        );
    }
 
    private function getApiMessage() {
        $errors = $this->status->getErrorsByType( 'error' );
        if ( !$errors ) {
            $errors = $this->status->getErrors();
        }
        if ( !$errors ) {
            $msg = new ApiMessage( 'apierror-unknownerror-nocode', 'unknownerror' );
        } else {
            $msg = ApiMessage::create( $errors[0] );
        }
        return $msg;
    }
 
    public function getModulePath() {
        return $this->modulePath;
    }
 
    public function getStatusValue() {
        return $this->status;
    }
 
    public function getCodeString() {
        return $this->getApiMessage()->getApiCode();
    }
 
    public function getMessageArray() {
        $enMsg = clone $this->getApiMessage();
        $enMsg->inLanguage( 'en' )->useDatabase( false );
 
        return [
            'code' => $enMsg->getApiCode(),
            'info' => ApiErrorFormatter::stripMarkup( $enMsg->text() ),
        ] + $enMsg->getApiData();
    }
 
    public function getMessageObject() {
        return $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()}";
    }
 
}