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)
 getCodeString ()
 getMessageArray ()
 __toString ()

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 907 of file ApiMain.php.


Constructor & Destructor Documentation

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

Definition at line 912 of file ApiMain.php.

References $code.


Member Function Documentation

UsageException::__toString (  ) 

Definition at line 929 of file ApiMain.php.

UsageException::getCodeString (  ) 

Definition at line 917 of file ApiMain.php.

UsageException::getMessageArray (  ) 

Definition at line 920 of file ApiMain.php.

References $result.


Member Data Documentation

UsageException::$mCodestr [private]

Definition at line 909 of file ApiMain.php.

UsageException::$mExtraData [private]

Definition at line 910 of file ApiMain.php.


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

Generated on Sat Apr 30 22:57:51 2011 for MediaWiki by  doxygen 1.5.9