* Document a bit

[lhc/web/wiklou.git] / includes / WikiError.php

diff --git a/includes/WikiError.php b/includes/WikiError.php
index 65a6455..251c174 100644 (file)
--- a/includes/WikiError.php
+++ b/includes/WikiError.php
@@ -3,89 +3,132 @@
  * MediaWiki error classes
  * Copyright (C) 2005 Brion Vibber <brion@pobox.com>
  * http://www.mediawiki.org/
- * 
+ *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 2 of the License, or 
+ * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
- * 
+ *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  * GNU General Public License for more details.
- * 
+ *
  * You should have received a copy of the GNU General Public License along
  * with this program; if not, write to the Free Software Foundation, Inc.,
- * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  *
- * @package MediaWiki
  */
 
 /**
  * Since PHP4 doesn't have exceptions, here's some error objects
  * loosely modeled on the standard PEAR_Error model...
+ * @ingroup Exception
  */
 class WikiError {
        /**
-        * @param string $message
+        * @param $message string
         */
-       function WikiError( $message ) {
+       function __construct( $message ) {
                $this->mMessage = $message;
        }
-       
+
        /**
         * @return string Plaintext error message to display
         */
-       function toString() {
+       function getMessage() {
                return $this->mMessage;
        }
-       
+
+       /**
+        * In following PEAR_Error model this could be formatted differently,
+        * but so far it's not.
+        * @return string
+        */
+       function toString() {
+               return $this->getMessage();
+       }
+
        /**
         * Returns true if the given object is a WikiError-descended
         * error object, false otherwise.
         *
-        * @param mixed $object
+        * @param $object mixed
         * @return bool
-        * @static
         */
-       function isError( &$object ) {
-               return is_a( $object, 'WikiError' );
+       public static function isError( $object ) {
+               return $object instanceof WikiError;
        }
 }
 
 /**
  * Localized error message object
+ * @ingroup Exception
  */
 class WikiErrorMsg extends WikiError {
        /**
-        * @param string $message Wiki message name
+        * @param $message String: wiki message name
         * @param ... parameters to pass to wfMsg()
         */
        function WikiErrorMsg( $message/*, ... */ ) {
                $args = func_get_args();
                array_shift( $args );
                $this->mMessage = wfMsgReal( $message, $args, true );
+               $this->mMsgKey = $message;
+               $this->mMsgArgs = $args;
+       }
+       
+       function getMessageKey() {
+               return $this->mMsgKey;
+       }
+       
+       function getMessageArgs() {
+               return $this->mMsgArgs;
        }
 }
 
 /**
- * 
+ * Error class designed to handle errors involved with 
+ * XML parsing
+ * @ingroup Exception
  */
 class WikiXmlError extends WikiError {
        /**
-        * @param resource $parser
-        * @param string $message
+        * @param $parser resource
+        * @param $message string
+        * @param $context
+        * @param $offset Int
         */
-       function WikiXmlError( $parser, $message = '' ) {
+       function WikiXmlError( $parser, $message = 'XML parsing error', $context = null, $offset = 0 ) {
                $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 toString() {
-               return $this->mMessage . ': ' . xml_error_string( $this->mXmlError );
+
+       /** @return string */
+       function getMessage() {
+               // '$1 at line $2, col $3 (byte $4): $5',
+               return wfMsgHtml( 'xml-error-string',
+                       $this->mMessage,
+                       $this->mLine,
+                       $this->mColumn,
+                       $this->mByte . $this->mContext,
+                       xml_error_string( $this->mXmlError ) );
        }
-}
 
-?>
\ No newline at end of file
+       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 ) . '"';
+               }
+       }
+}