BlueSpice MediaWiki master
 All Classes Namespaces Files Functions Variables Groups Pages
UsageException Class Reference
Inheritance diagram for UsageException:
Collaboration diagram for UsageException:

Public Member Functions

 __construct ($message, $codestr, $code=0, $extradata=null)
 
 getCodeString ()
 
 getMessageArray ()
 
 __toString ()
 
- Public Member Functions inherited from MWException
 useOutputPage ()
 
 isLoggable ()
 
 useMessageCache ()
 
 msg ($key, $fallback)
 
 getHTML ()
 
 getText ()
 
 getPageTitle ()
 
 reportHTML ()
 
 report ()
 
- Public Member Functions inherited from Exception
 __construct ($message="", $code=0, Throwable $previous=null)
 
 getMessage ()
 
 getCode ()
 
 getFile ()
 
 getLine ()
 
 getTrace ()
 
 getPrevious ()
 
 getTraceAsString ()
 
 __toString ()
 

Additional Inherited Members

- Static Public Member Functions inherited from MWException
static isCommandLine ()
 
- Protected Attributes inherited from Exception
 $message
 
 $code
 
 $file
 
 $line
 

Detailed Description

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

Deprecated:
since 1.29, use ApiUsageException instead

Constructor & Destructor Documentation

UsageException::__construct (   $message,
  $codestr,
  $code = 0,
  $extradata = null 
)
Parameters
string$message
string$codestr
int$code
array | null$extradata

Member Function Documentation

UsageException::__toString ( )
Returns
string

Implements Throwable.

UsageException::getCodeString ( )
Returns
string
UsageException::getMessageArray ( )
Returns
array

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