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

Inheritance diagram for UsageException:

Collaboration diagram for UsageException:

Public Member Functions
	__construct ( $message, $codestr, $code=0, $extradata=null)

	__toString ()

	getCodeString ()

	getMessageArray ()

Public Member Functions inherited from MWException
	getHTML ()
	If $wgShowExceptionDetails is true, return a HTML message with a backtrace to the error, otherwise show a message to ask to set it to true to show that information. More...

	getLogId ()
	Get a the ID for this error. More...

	getLogMessage ()
	Return the requested URL and point to file and line number from which the exception occurred. More...

	getPageTitle ()
	Return the title of the page when reporting this error in a HTTP response. More...

	getText ()
	Get the text to display when reporting the error on the command line. More...

	isLoggable ()
	Whether to log this exception in the exception debug log. More...

	msg ( $key, $fallback)
	Get a message from i18n. More...

	report ()
	Output a report about the exception and takes care of formatting. More...

	reportHTML ()
	Output the exception report using HTML. More...

	runHooks ( $name, $args=array())
	Run hook to allow extensions to modify the text of the exception. More...

	useMessageCache ()
	Can the extension use the Message class/wfMessage to get i18n-ed messages? More...

	useOutputPage ()
	Should the exception use $wgOut to output the error? More...

Private Attributes
	$mCodestr

null array	$mExtraData

Additional Inherited Members
Static Public Member Functions inherited from MWException
static	isCommandLine ()
	Check whether we are in command line mode or not to report the exception in the correct format. More...

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

Constructor & Destructor Documentation

◆ __construct()

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

Parameters

$message	string
$codestr	string
$code	int
$extradata	array\|null

Definition at line 1420 of file ApiMain.php.

Member Function Documentation

◆ __toString()

UsageException::__toString ( )

Returns: string

Definition at line 1451 of file ApiMain.php.

◆ getCodeString()

UsageException::getCodeString ( )

Returns: string

Definition at line 1429 of file ApiMain.php.

References $mCodestr.

Referenced by ApiEditPageTest\testEditConflict(), ApiEditPageTest\testEditConflict_redirect(), ApiParseTest\testParseNonexistentPage(), and ApiWatchTest\testWatchRollback().

◆ getMessageArray()

UsageException::getMessageArray ( )

Returns: array

Definition at line 1436 of file ApiMain.php.

References array().

Referenced by ApiParseTest\testParseNonexistentPage().

Member Data Documentation

◆ $mCodestr

UsageException::$mCodestr

private

Definition at line 1408 of file ApiMain.php.

Referenced by getCodeString().

◆ $mExtraData

null array UsageException::$mExtraData

private

Definition at line 1412 of file ApiMain.php.

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

includes/api/ApiMain.php

Public Member Functions

Private Attributes

Additional Inherited Members