This is the abstract base class for API formatters. More...

Inheritance diagram for ApiFormatBase:

[legend]

Collaboration diagram for ApiFormatBase:

[legend]

Public Member Functions
	__construct (ApiMain $main, $format)
	If $format ends with 'fm', pretty-print the output in HTML. More...

	canPrintErrors ()
	Whether this formatter can handle printing API errors. More...

	closePrinter ()
	Finish printing and output buffered data. More...

	disable ()
	Disable the formatter. More...

	forceDefaultParams ()
	Ignore request parameters, force a default. More...

	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. More...

	getBuffer ()
	Get the contents of the buffer. More...

	getFilename ()
	Return a filename for this module's output. More...

	getFormat ()
	Get the internal format name. More...

	getHelpUrls ()
	Return links to more detailed help pages about the module. More...

	getIsHtml ()
	Returns true when the HTML pretty-printer should be used. More...

	getMimeType ()
	Overriding class returns the MIME type that should be sent to the client. More...

	initPrinter ( $unused=false)
	Initialize the printer function and prepare the output headers. More...

	isDisabled ()
	Whether the printer is disabled. More...

	printText ( $text)
	Append text to the output buffer. More...

	setHttpStatus ( $code)
	Set the HTTP status code to be used for the response. More...

Public Member Functions inherited from ApiBase
	__construct (ApiMain $mainModule, $moduleName, $modulePrefix='')

	execute ()
	Evaluates the parameters, performs the requested query, and sets up the result. More...

	getModuleManager ()
	Get the module manager, or null if this module has no sub-modules. More...

	getCustomPrinter ()
	If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More...

	shouldCheckMaxlag ()
	Indicates if this module needs maxlag to be checked. More...

	isReadMode ()
	Indicates whether this module requires read rights. More...

	isWriteMode ()
	Indicates whether this module requires write mode. More...

	mustBePosted ()
	Indicates whether this module must be called with a POST request. More...

	isDeprecated ()
	Indicates whether this module is deprecated. More...

	isInternal ()
	Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More...

	needsToken ()
	Returns the token type this module requires in order to execute. More...

	getConditionalRequestData ( $condition)
	Returns data for HTTP conditional request mechanisms. More...

	getModuleName ()
	Get the name of the module being executed by this instance. More...

	getModulePrefix ()
	Get parameter prefix (usually two letters or an empty string). More...

	getMain ()
	Get the main module. More...

	isMain ()
	Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More...

	getParent ()
	Get the parent of this module. More...

	lacksSameOriginSecurity ()
	Returns true if the current request breaks the same-origin policy. More...

	getModulePath ()
	Get the path to this module. More...

	getModuleFromPath ( $path)
	Get a module from its module path. More...

	getResult ()
	Get the result object. More...

	getErrorFormatter ()
	Get the error formatter. More...

	getContinuationManager ()
	Get the continuation manager. More...

	setContinuationManager (ApiContinuationManager $manager=null)
	Set the continuation manager. More...

	dynamicParameterDocumentation ()
	Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More...

	encodeParamName ( $paramName)
	This method mangles parameter name based on the prefix supplied to the constructor. More...

	extractRequestParams ( $options=[])
	Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More...

	requireOnlyOneParameter ( $params, $required)
	Die if none or more than one of a certain set of parameters is set and not false. More...

	requireMaxOneParameter ( $params, $required)
	Die if more than one of a certain set of parameters is set and not false. More...

	requireAtLeastOneParameter ( $params, $required)
	Die if none of a certain set of parameters is set and not false. More...

	requirePostedParameters ( $params, $prefix='prefix')
	Die if any of the specified parameters were found in the query part of the URL rather than the post body. More...

	getTitleOrPageId ( $params, $load=false)
	Get a WikiPage object from a title or pageid param, if possible. More...

	getTitleFromTitleOrPageId ( $params)
	Get a Title object from a title or pageid param, if possible. More...

	validateToken ( $token, array $params)
	Validate the supplied token. More...

	getWatchlistUser ( $params)
	Gets the user for whom to get the watchlist. More...

	errorArrayToStatus (array $errors, User $user=null)
	Turn an array of message keys or key+param arrays into a Status. More...

	addBlockInfoToStatus (StatusValue $status, User $user=null)
	Add block info to block messages in a Status. More...

	addWarning ( $msg, $code=null, $data=null)
	Add a warning for this module. More...

	addDeprecation ( $msg, $feature, $data=[])
	Add a deprecation warning for this module. More...

	addError ( $msg, $code=null, $data=null)
	Add an error for this module without aborting. More...

	addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[])
	Add warnings and/or errors from a Status. More...

	dieWithError ( $msg, $code=null, $data=null, $httpCode=null)
	Abort execution with an error. More...

	dieWithException ( $exception, array $options=[])
	Abort execution with an error derived from an exception. More...

	dieBlocked (Block $block)
	Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More...

	dieStatus (StatusValue $status)
	Throw an ApiUsageException based on the Status object. More...

	dieReadOnly ()
	Helper function for readonly errors. More...

	checkUserRightsAny ( $rights, $user=null)
	Helper function for permission-denied errors. More...

	checkTitleUserPermissions (Title $title, $actions, $options=[])
	Helper function for permission-denied errors. More...

	dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...

	logFeatureUsage ( $feature)
	Write logging information for API features to a debug log, for usage analysis. More...

	getFinalSummary ()
	Get final module summary. More...

	getFinalDescription ()
	Get final module description, after hooks have had a chance to tweak it as needed. More...

	getFinalParams ( $flags=0)
	Get final list of parameters, after hooks have had a chance to tweak it as needed. More...

	getFinalParamDescription ()
	Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More...

	modifyHelp (array &$help, array $options, array &$tocData)
	Called from ApiHelp before the pieces are joined together and returned. More...

Public Member Functions inherited from ContextSource
	canUseWikiPage ()
	Check whether a WikiPage object can be get with getWikiPage(). More...

	exportSession ()
	Export the resolved user IP, HTTP headers, user ID, and session ID. More...

	getConfig ()

	getContext ()
	Get the base IContextSource object. More...

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object. More...

	msg ( $key)
	Get a Message object with context set Parameters are the same as wfMessage() More...

	setContext (IContextSource $context)

Public Attributes
	$mDisabled = false

	$mFormat

Public Attributes inherited from ApiBase
string	$mModulePrefix

const	ALL_DEFAULT_STRING = '*'

const	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...

const	LIMIT_BIG1 = 500
	Fast query, standard limit. More...

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit. More...

const	LIMIT_SML1 = 50
	Slow query, standard limit. More...

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit. More...

const	PARAM_DFLT = 0
	(null\|boolean\|integer\|string) Default value of the parameter. More...

const	PARAM_ISMULTI = 1
	(boolean) Accept multiple pipe-separated values for this parameter (e.g. More...

const	PARAM_TYPE = 2
	(string\|string[]) Either an array of allowed value strings, or a string type as described below. More...

const	PARAM_MAX = 3
	(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More...

const	PARAM_MAX2 = 4
	(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'. More...

const	PARAM_MIN = 5
	(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More...

const	PARAM_ALLOW_DUPLICATES = 6
	(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? More...

const	PARAM_DEPRECATED = 7
	(boolean) Is the parameter deprecated (will show a warning)? More...

const	PARAM_REQUIRED = 8
	(boolean) Is the parameter required? More...

const	PARAM_RANGE_ENFORCE = 9
	(boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX? More...

const	PARAM_HELP_MSG = 10
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. More...

const	PARAM_HELP_MSG_APPEND = 11
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More...

const	PARAM_HELP_MSG_INFO = 12
	(array) Specify additional information tags for the parameter. More...

const	PARAM_VALUE_LINKS = 13
	(string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help. More...

const	PARAM_HELP_MSG_PER_VALUE = 14
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More...

const	PARAM_SUBMODULE_MAP = 15
	(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths. More...

const	PARAM_SUBMODULE_PARAM_PREFIX = 16
	(string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that). More...

const	PARAM_ALL = 17
	(boolean\|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value. More...

const	PARAM_EXTRA_NAMESPACES = 18
	(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values. More...

const	PARAM_SENSITIVE = 19
	(boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field. More...

const	PARAM_DEPRECATED_VALUES = 20
	(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated. More...

const	PARAM_ISMULTI_LIMIT1 = 21
	(integer) Maximum number of values, for normal users. More...

const	PARAM_ISMULTI_LIMIT2 = 22
	(integer) Maximum number of values, for users with the apihighimits right. More...

const	PARAM_MAX_BYTES = 23
	(integer) Maximum length of a string in bytes (in UTF-8 encoding). More...

const	PARAM_MAX_CHARS = 24
	(integer) Maximum length of a string in characters (unicode codepoints). More...

const	PARAM_TEMPLATE_VARS = 25
	(array) Indicate that this is a templated parameter, and specify replacements. More...

Protected Member Functions
	getExamplesMessages ()
	Returns usage examples for this module. More...

	getIsWrappedHtml ()
	Returns true when the special wrapped mode is enabled. More...

	getParameterFromSettings ( $paramName, $paramSettings, $parseLimit)
	Overridden to honor $this->forceDefaultParams(), if applicable @inheritDoc. More...

Protected Member Functions inherited from ApiBase
	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module. More...

	getDB ()
	Gets a default replica DB connection object. More...

	getParameter ( $paramName, $parseLimit=true)
	Get a value for the given parameter. More...

	getWatchlistValue ( $watchlist, $titleObj, $userOption=null)
	Return true if we're to watch the page, false if not, null if no change. More...

	handleParamNormalization ( $paramName, $value, $rawValue)
	Handle when a parameter was Unicode-normalized. More...

	explodeMultiValue ( $value, $limit)
	Split a multi-valued parameter string, like explode() More...

	parseMultiValue ( $valueName, $value, $allowMultiple, $allowedValues, $allSpecifier=null, $limit1=null, $limit2=null)
	Return an array of values that were given in a 'a\|b\|c' notation, after it optionally validates them against the list allowed values. More...

	validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
	Validate the value against the minimum and user/bot maximum limits. More...

	validateTimestamp ( $value, $encParamName)
	Validate and normalize parameters of type 'timestamp'. More...

	setWatch ( $watch, $titleObj, $userOption=null)
	Set a watch (or unwatch) based the based on a watchlist parameter. More...

	useTransactionalTimeLimit ()
	Call wfTransactionalTimeLimit() if this request was POSTed. More...

	filterIDs ( $fields, array $ids)
	Filter out-of-range values from a list of positive integer IDs. More...

	dieContinueUsageIf ( $condition)
	Die with the 'badcontinue' error. More...

	getSummaryMessage ()
	Return the summary message. More...

	getExtendedDescription ()
	Return the extended help text message. More...

	getHelpFlags ()
	Generates the list of flags for the help screen and for action=paraminfo. More...

	getModuleSourceInfo ()
	Returns information about the source of this module, if known. More...

	getDescription ()
	Returns the description string for this module. More...

	getParamDescription ()
	Returns an array of parameter descriptions. More...

	getExamples ()
	Returns usage examples for this module. More...

	getDescriptionMessage ()
	Return the description message. More...

Protected Attributes
	$mForceDefaultParams = false

Private Attributes
	$mBuffer

	$mHttpStatus = false

	$mIsHtml

	$mIsWrappedHtml = false

Additional Inherited Members
Static Public Member Functions inherited from ApiBase
static	makeMessage ( $msg, IContextSource $context, array $params=null)
	Create a Message from a string or array. More...

static	truncateArray (&$arr, $limit)
	Truncate an array to a certain length. More...

Static Protected Member Functions inherited from ApiBase
static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method. More...

Detailed Description

This is the abstract base class for API formatters.

Definition at line 28 of file ApiFormatBase.php.

Constructor & Destructor Documentation

◆ __construct()

ApiFormatBase::__construct	(	ApiMain	$main,
			$format
	)

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

Parameters

ApiMain	$main
string	$format	Format name

Reimplemented in ApiFormatJson.

Definition at line 40 of file ApiFormatBase.php.

References ApiBase\getMain().

Member Function Documentation

◆ canPrintErrors()

ApiFormatBase::canPrintErrors ( )

Whether this formatter can handle printing API errors.

If this returns false, then on API errors the default printer will be instantiated.

Since: 1.23

Returns: bool

Reimplemented in ApiFormatFeedWrapper.

Definition at line 135 of file ApiFormatBase.php.

◆ closePrinter()

ApiFormatBase::closePrinter ( )

Finish printing and output buffered data.

Reimplemented in ApiFormatRaw.

Definition at line 236 of file ApiFormatBase.php.

References ContextSource\$context, $header, $out, $time, FormatJson\ALL_OK, FormatJson\encode(), ApiHelp\fixHelpLinks(), getBuffer(), SkinFactory\getDefaultInstance(), getFormat(), getIsHtml(), getIsWrappedHtml(), ApiBase\getMain(), HttpStatus\getMessage(), getMimeType(), ContextSource\getRequest(), ApiBase\getResult(), SpecialPage\getTitleFor(), MessageLocalizer\msg(), ContextSource\msg(), and Hooks\run().

◆ disable()

ApiFormatBase::disable ( )

Disable the formatter.

This causes calls to initPrinter() and closePrinter() to be ignored.

Definition at line 115 of file ApiFormatBase.php.

◆ forceDefaultParams()

ApiFormatBase::forceDefaultParams ( )

Ignore request parameters, force a default.

Used as a fallback if errors are being thrown.

Since: 1.26

Definition at line 145 of file ApiFormatBase.php.

◆ getAllowedParams()

ApiFormatBase::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

Reimplemented from ApiBase.

Reimplemented in ApiFormatJson, and ApiFormatPhp.

Definition at line 357 of file ApiFormatBase.php.

References $ret, getIsHtml(), ApiBase\PARAM_DFLT, and ApiBase\PARAM_HELP_MSG.

◆ getBuffer()

ApiFormatBase::getBuffer ( )

Get the contents of the buffer.

Returns: string

Definition at line 353 of file ApiFormatBase.php.

References $mBuffer.

Referenced by closePrinter().

◆ getExamplesMessages()

ApiFormatBase::getExamplesMessages ( )

protected

Returns usage examples for this module.

Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.

Do not call this base class implementation when overriding this method.

Since: 1.25

Returns: array

Reimplemented from ApiBase.

Definition at line 369 of file ApiFormatBase.php.

References getFormat(), and ApiBase\getModuleName().

◆ getFilename()

ApiFormatBase::getFilename ( )

Return a filename for this module's output.

Note: If $this->getIsWrappedHtml() || $this->getIsHtml(), you'll very likely want to fall back to this class's version.

Since: 1.27

Returns: string Generally this should be "api-result.$ext"

Reimplemented in ApiFormatRaw.

Definition at line 70 of file ApiFormatBase.php.

References $ext, MediaWiki\MediaWikiServices\getInstance(), getIsHtml(), getIsWrappedHtml(), and getMimeType().

Referenced by initPrinter().

◆ getFormat()

ApiFormatBase::getFormat ( )

Get the internal format name.

Returns: string

Definition at line 87 of file ApiFormatBase.php.

References $mFormat.

Referenced by closePrinter(), and getExamplesMessages().

◆ getHelpUrls()

ApiFormatBase::getHelpUrls ( )

Return links to more detailed help pages about the module.

Since: 1.25, returning boolean false is deprecated

Returns: string|array

Reimplemented from ApiBase.

Definition at line 376 of file ApiFormatBase.php.

◆ getIsHtml()

ApiFormatBase::getIsHtml ( )

Returns true when the HTML pretty-printer should be used.

The default implementation assumes that formats ending with 'fm' should be formatted in HTML.

Returns: bool

Definition at line 97 of file ApiFormatBase.php.

References $mIsHtml.

Referenced by closePrinter(), ApiFormatJson\execute(), getAllowedParams(), ApiFormatRaw\getFilename(), getFilename(), initPrinter(), and setHttpStatus().

◆ getIsWrappedHtml()

ApiFormatBase::getIsWrappedHtml ( )

protected

Returns true when the special wrapped mode is enabled.

Since: 1.27

Returns: bool

Definition at line 106 of file ApiFormatBase.php.

References $mIsWrappedHtml.

Referenced by closePrinter(), ApiFormatRaw\getFilename(), getFilename(), and initPrinter().

◆ getMimeType()

ApiFormatBase::getMimeType ( )

abstract

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

When getIsHtml() returns true, the return value here is used for syntax highlighting but the client sees text/html.

Returns: string

Reimplemented in ApiFormatFeedWrapper, ApiFormatJson, ApiFormatRaw, ApiFormatNone, and ApiFormatPhp.

Referenced by closePrinter(), getFilename(), and initPrinter().

◆ getParameterFromSettings()

ApiFormatBase::getParameterFromSettings	(	$paramName,
		$paramSettings,
		$parseLimit
	)

protected

Overridden to honor $this->forceDefaultParams(), if applicable @inheritDoc.

Since: 1.26

Reimplemented from ApiBase.

Definition at line 154 of file ApiFormatBase.php.

References ApiBase\PARAM_DFLT.

◆ initPrinter()

ApiFormatBase::initPrinter ( $unused = false )

Initialize the printer function and prepare the output headers.

Parameters

bool $unused Always false since 1.25

Reimplemented in ApiFormatFeedWrapper, and ApiFormatRaw.

Definition at line 187 of file ApiFormatBase.php.

References $header, $value, ContextSource\getConfig(), getFilename(), getIsHtml(), getIsWrappedHtml(), ApiBase\getMain(), and getMimeType().

Referenced by ApiMain\printResult().

◆ isDisabled()

ApiFormatBase::isDisabled ( )

Whether the printer is disabled.

Returns: bool

Definition at line 123 of file ApiFormatBase.php.

References $mDisabled.

Referenced by ApiFormatFeedWrapper\initPrinter().

◆ printText()

ApiFormatBase::printText ( $text )

Append text to the output buffer.

Parameters

string $text

Definition at line 345 of file ApiFormatBase.php.

Referenced by ApiFormatPhp\execute(), ApiFormatJson\execute(), ApiFormatRaw\execute(), and ApiFormatFeedWrapper\execute().

◆ setHttpStatus()

ApiFormatBase::setHttpStatus ( $code )

Set the HTTP status code to be used for the response.

Since: 1.29

Parameters

int $code

Definition at line 171 of file ApiFormatBase.php.

References $code, getIsHtml(), and ApiBase\getMain().

Member Data Documentation

◆ $mBuffer

ApiFormatBase::$mBuffer

private

Definition at line 30 of file ApiFormatBase.php.

Referenced by getBuffer().

◆ $mDisabled

ApiFormatBase::$mDisabled = false

Definition at line 30 of file ApiFormatBase.php.

Referenced by isDisabled().

◆ $mForceDefaultParams

ApiFormatBase::$mForceDefaultParams = false

protected

Definition at line 33 of file ApiFormatBase.php.

◆ $mFormat

ApiFormatBase::$mFormat

Definition at line 29 of file ApiFormatBase.php.

Referenced by getFormat().

◆ $mHttpStatus

ApiFormatBase::$mHttpStatus = false

private

Definition at line 32 of file ApiFormatBase.php.

◆ $mIsHtml

ApiFormatBase::$mIsHtml

private

Definition at line 29 of file ApiFormatBase.php.

Referenced by getIsHtml().

◆ $mIsWrappedHtml

ApiFormatBase::$mIsWrappedHtml = false

private

Definition at line 31 of file ApiFormatBase.php.

Referenced by getIsWrappedHtml().

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

includes/api/ApiFormatBase.php

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ canPrintErrors()

◆ closePrinter()

◆ disable()

◆ forceDefaultParams()

◆ getAllowedParams()

◆ getBuffer()

◆ getExamplesMessages()

◆ getFilename()

◆ getFormat()

◆ getHelpUrls()

◆ getIsHtml()

◆ getIsWrappedHtml()

◆ getMimeType()

◆ getParameterFromSettings()

◆ initPrinter()

◆ isDisabled()

◆ printText()

◆ setHttpStatus()

Member Data Documentation

◆ $mBuffer

◆ $mDisabled

◆ $mForceDefaultParams

◆ $mFormat

◆ $mHttpStatus

◆ $mIsHtml

◆ $mIsWrappedHtml