MediaWiki  REL1_22
Public Member Functions | Private Attributes
UsageException Class Reference
API

This exception will be thrown when dieUsage is called to stop module execution. More...

Inheritance diagram for UsageException:
Inheritance graph
[legend]
Collaboration diagram for UsageException:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 __construct ($message, $codestr, $code=0, $extradata=null)
 __toString ()
 getCodeString ()
 getMessageArray ()

Private Attributes

 $mCodestr
null array $mExtraData

Detailed Description

This exception will be thrown when dieUsage is called to stop module execution.

The exception handling code will print a help screen explaining how this API may be used.

Definition at line 1299 of file ApiMain.php.

Constructor & Destructor Documentation

UsageException::__construct ( $  message,
$  codestr,
$  code = 0,
$  extradata = null 
)
Parameters:
$messagestring
$codestrstring
$codeint
$extradataarray|null

Definition at line 1313 of file ApiMain.php.

Member Function Documentation

UsageException::__toString ( )
Returns:
string

Definition at line 1343 of file ApiMain.php.

UsageException::getCodeString ( )
Returns:
string

Definition at line 1322 of file ApiMain.php.

Referenced by ApiOptionsTest\testAnon(), ApiEditPageTest\testEditConflict(), ApiEditPageTest\testEditConflict_redirect(), ApiEditPageTest\testEditSection(), ApiOptionsTest\testNoChanges(), ApiOptionsTest\testNoOptionname(), ApiParseTest\testParseNonexistentPage(), and ApiWatchTest\testWatchRollback().

UsageException::getMessageArray ( )
Returns:
array

Definition at line 1329 of file ApiMain.php.

Referenced by ApiParseTest\testParseNonexistentPage().

Member Data Documentation

UsageException::$mCodestr [private]

Definition at line 1301 of file ApiMain.php.

null array UsageException::$mExtraData [private]

Definition at line 1305 of file ApiMain.php.

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