3 * MediaWiki error classes
4 * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
5 * http://www.mediawiki.org/
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License along
18 * with this program; if not, write to the Free Software Foundation, Inc.,
19 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 * http://www.gnu.org/copyleft/gpl.html
25 * Since PHP4 doesn't have exceptions, here's some error objects
26 * loosely modeled on the standard PEAR_Error model...
31 * @param $message string
33 function __construct( $message ) {
34 $this->mMessage
= $message;
38 * @return string Plaintext error message to display
40 function getMessage() {
41 return $this->mMessage
;
45 * In following PEAR_Error model this could be formatted differently,
46 * but so far it's not.
50 return $this->getMessage();
54 * Returns true if the given object is a WikiError-descended
55 * error object, false otherwise.
57 * @param $object mixed
60 public static function isError( $object ) {
61 return $object instanceof WikiError
;
66 * Localized error message object
69 class WikiErrorMsg
extends WikiError
{
71 * @param $message String: wiki message name
72 * @param ... parameters to pass to wfMsg()
74 function WikiErrorMsg( $message/*, ... */ ) {
75 $args = func_get_args();
77 $this->mMessage
= wfMsgReal( $message, $args, true );
78 $this->mMsgKey
= $message;
79 $this->mMsgArgs
= $args;
82 function getMessageKey() {
83 return $this->mMsgKey
;
86 function getMessageArgs() {
87 return $this->mMsgArgs
;
92 * Error class designed to handle errors involved with
96 class WikiXmlError
extends WikiError
{
98 * @param $parser resource
99 * @param $message string
103 function WikiXmlError( $parser, $message = 'XML parsing error', $context = null, $offset = 0 ) {
104 $this->mXmlError
= xml_get_error_code( $parser );
105 $this->mColumn
= xml_get_current_column_number( $parser );
106 $this->mLine
= xml_get_current_line_number( $parser );
107 $this->mByte
= xml_get_current_byte_index( $parser );
108 $this->mContext
= $this->_extractContext( $context, $offset );
109 $this->mMessage
= $message;
110 xml_parser_free( $parser );
111 wfDebug( "WikiXmlError: " . $this->getMessage() . "\n" );
114 /** @return string */
115 function getMessage() {
116 // '$1 at line $2, col $3 (byte $4): $5',
117 return wfMsgHtml( 'xml-error-string',
121 $this->mByte
. $this->mContext
,
122 xml_error_string( $this->mXmlError
) );
125 function _extractContext( $context, $offset ) {
126 if( is_null( $context ) ) {
129 // Hopefully integer overflow will be handled transparently here
130 $inlineOffset = $this->mByte
- $offset;
131 return '; "' . substr( $context, $inlineOffset, 16 ) . '"';