ApiFormatJson Class Reference

API JSON output formatter. More...

Inheritance diagram for ApiFormatJson:

Collaboration diagram for ApiFormatJson:

List of all members.

Public Member Functions
	__construct ($main, $format)
	Constructor If $format ends with 'fm', pretty-print the output in HTML.
	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result.
	getAllowedParams ()
	Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.
	getDescription ()
	Returns the description string for this module.
	getMimeType ()
	Overriding class returns the mime type that should be sent to the client.
	getNeedsRawData ()
	Whether this formatter needs raw data such as _element tags.
	getParamDescription ()
	Returns an array of parameter descriptions.
	getWantsHelp ()
	Whether this formatter can format the help message in a nice way.
Private Attributes
	$mIsRaw

---

Detailed Description

API JSON output formatter.

Definition at line 31 of file ApiFormatJson.php.

---

Constructor & Destructor Documentation

ApiFormatJson::__construct	(	$	main,
		$	format
	)

Constructor If $format ends with 'fm', pretty-print the output in HTML.

Parameters:

	$main	ApiMain
string	$format	Format name

Reimplemented from ApiFormatBase.

Definition at line 35 of file ApiFormatJson.php.

---

Member Function Documentation

ApiFormatJson::execute

(

)

Evaluates the parameters, performs the requested query, and sets up the result.

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

Reimplemented from ApiBase.

Definition at line 58 of file ApiFormatJson.php.

References $params, FormatJson\ALL_OK, FormatJson\encode(), ApiBase\extractRequestParams(), ApiFormatBase\getIsHtml(), ApiBase\getResultData(), ApiFormatBase\printText(), and FormatJson\XMLMETA_OK.

ApiFormatJson::getAllowedParams

(

)

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns:

array|bool

Reimplemented from ApiBase.

Definition at line 76 of file ApiFormatJson.php.

References array().

ApiFormatJson::getDescription

(

)

Returns the description string for this module.

Returns:

mixed string or array of strings

Reimplemented from ApiFormatBase.

Reimplemented in ApiFormatYaml.

Definition at line 90 of file ApiFormatJson.php.

ApiFormatJson::getMimeType

(

)

Overriding class returns the mime type that should be sent to the client.

This method is not called if getIsHtml() returns true.

Returns:

string

Reimplemented from ApiFormatBase.

Reimplemented in ApiFormatYaml.

Definition at line 40 of file ApiFormatJson.php.

References $params, and ApiBase\extractRequestParams().

ApiFormatJson::getNeedsRawData

(

)

Whether this formatter needs raw data such as _element tags.

Returns:

bool

Reimplemented from ApiFormatBase.

Definition at line 49 of file ApiFormatJson.php.

ApiFormatJson::getParamDescription

(

)

Returns an array of parameter descriptions.

Don't call this function directly: use getFinalParamDescription() to allow hooks to modify descriptions as needed.

Returns:

array|bool False on no parameter descriptions

Reimplemented from ApiBase.

Definition at line 83 of file ApiFormatJson.php.

References array().

ApiFormatJson::getWantsHelp

(

)

Whether this formatter can format the help message in a nice way.

By default, this returns the same as getIsHtml(). When action=help is set explicitly, the help will always be shown

Returns:

bool

Reimplemented from ApiFormatBase.

Definition at line 53 of file ApiFormatJson.php.

---

Member Data Documentation

ApiFormatJson::$mIsRaw [private]

Definition at line 33 of file ApiFormatJson.php.

---

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

• includes/api/ApiFormatJson.php