WikiError.php

Go to the documentation of this file.

<?php
class WikiError {
    function __construct( $message ) {
        wfDeprecated( __METHOD__, '1.17' );
        $this->mMessage = $message;
    }

    function getMessage() {
        return $this->mMessage;
    }

    function toString() {
        return $this->getMessage();
    }

    public static function isError( $object ) {
        wfDeprecated( __METHOD__, '1.17' );
        if ( $object instanceof WikiError ) {
            return true;
        } elseif ( $object instanceof Status ) {
            return !$object->isOK();
        } else {
            return false;
        }
    }
}

class WikiErrorMsg extends WikiError {
    function __construct( $message/*, ... */ ) {
        wfDeprecated( __METHOD__, '1.17' );
        $args = func_get_args();
        array_shift( $args );
        $this->mMessage = wfMessage( $message )->rawParams( $args )->text();
        $this->mMsgKey = $message;
        $this->mMsgArgs = $args;
    }

    function getMessageKey() {
        return $this->mMsgKey;
    }

    function getMessageArgs() {
        return $this->mMsgArgs;
    }
}

class WikiXmlError extends WikiError {
    function __construct( $parser, $message = 'XML parsing error', $context = null, $offset = 0 ) {
        wfDeprecated( __METHOD__, '1.17' );
        $this->mXmlError = xml_get_error_code( $parser );
        $this->mColumn = xml_get_current_column_number( $parser );
        $this->mLine = xml_get_current_line_number( $parser );
        $this->mByte = xml_get_current_byte_index( $parser );
        $this->mContext = $this->_extractContext( $context, $offset );
        $this->mMessage = $message;
        xml_parser_free( $parser );
        wfDebug( "WikiXmlError: " . $this->getMessage() . "\n" );
    }

    function getMessage() {
        // '$1 at line $2, col $3 (byte $4): $5',
        return wfMessage( 'xml-error-string',
            $this->mMessage,
            $this->mLine,
            $this->mColumn,
            $this->mByte . $this->mContext,
            xml_error_string( $this->mXmlError ) )->escaped();
    }

    function _extractContext( $context, $offset ) {
        if ( is_null( $context ) ) {
            return null;
        } else {
            // Hopefully integer overflow will be handled transparently here
            $inlineOffset = $this->mByte - $offset;
            return '; "' . substr( $context, $inlineOffset, 16 ) . '"';
        }
    }
}