UsageException Class Reference

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

Inheritance diagram for UsageException:

Collaboration diagram for UsageException:

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

---

Constructor & Destructor Documentation

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

Parameters:

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

Definition at line 1286 of file ApiMain.php.

---

Member Function Documentation

UsageException::__toString

(

)

Returns:

string

Definition at line 1316 of file ApiMain.php.

UsageException::getCodeString

(

)

Returns:

string

Definition at line 1295 of file ApiMain.php.

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

UsageException::getMessageArray

(

)

Returns:

array

Definition at line 1302 of file ApiMain.php.

Referenced by ApiParseTest\testParseNonexistentPage().

---

Member Data Documentation

UsageException::$mCodestr [private]

Definition at line 1274 of file ApiMain.php.

null array UsageException::$mExtraData [private]

Definition at line 1278 of file ApiMain.php.

---

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

• includes/api/ApiMain.php