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

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

List of all members.

Public Member Functions

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

Private Attributes

 $mCodestr
 $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 1064 of file ApiMain.php.

Constructor & Destructor Documentation

UsageException::__construct ( $  message,
$  codestr,
$  code = 0,
$  extradata = null 
)

Definition at line 1069 of file ApiMain.php.

Member Function Documentation

UsageException::__toString ( )
Returns:
string

Definition at line 1099 of file ApiMain.php.

UsageException::getCodeString ( )
Returns:
string

Definition at line 1078 of file ApiMain.php.

Referenced by ApiWatchTest\testWatchRollback().

Here is the caller graph for this function:

UsageException::getMessageArray ( )
Returns:
array

Definition at line 1085 of file ApiMain.php.

References $result.

Member Data Documentation

UsageException::$mCodestr [private]

Definition at line 1066 of file ApiMain.php.

UsageException::$mExtraData [private]

Definition at line 1067 of file ApiMain.php.

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