WikiError Class Reference
[Exception]

MediaWiki error classes Copyright (C) 2005 Brion Vibber <brion@pobox.com> http://www.mediawiki.org/. More...

Inherited by WikiErrorMsg, and WikiXmlError.

List of all members.

Public Member Functions

 __construct ($message)
 getMessage ()
 toString ()
 In following PEAR_Error model this could be formatted differently, but so far it's not.

Static Public Member Functions

static isError ($object)
 Returns true if the given object is a WikiError-descended error object, false otherwise.


Detailed Description

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 (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., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html Since PHP4 doesn't have exceptions, here's some error objects loosely modeled on the standard PEAR_Error model...

Definition at line 29 of file WikiError.php.


Constructor & Destructor Documentation

WikiError::__construct ( message  ) 

Parameters:
$message string

Definition at line 33 of file WikiError.php.


Member Function Documentation

WikiError::getMessage (  ) 

Returns:
string Plaintext error message to display

Reimplemented in WikiXmlError.

Definition at line 40 of file WikiError.php.

Referenced by toString().

static WikiError::isError ( object  )  [static]

Returns true if the given object is a WikiError-descended error object, false otherwise.

Parameters:
$object mixed
Returns:
bool

Definition at line 60 of file WikiError.php.

Referenced by LoginForm::addNewAccount(), LoginForm::addNewAccountMailPassword(), SpecialImport::doImport(), EmailUserForm::doSubmit(), TextPassDumper::dump(), ApiImport::execute(), LoginForm::mailPassword(), PreferencesForm::savePreferences(), UserMailer::send(), and EmailConfirmation::showRequestForm().

WikiError::toString (  ) 

In following PEAR_Error model this could be formatted differently, but so far it's not.

Returns:
string

Definition at line 49 of file WikiError.php.

References getMessage().


The documentation for this class was generated from the following file:

Generated on Sat Sep 5 02:08:50 2009 for MediaWiki by  doxygen 1.5.9