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

Inherits MediaWiki\Api\ApiBase.

Inherited by MediaWiki\Api\ApiFormatFeedWrapper, MediaWiki\Api\ApiFormatJson, MediaWiki\Api\ApiFormatNone, MediaWiki\Api\ApiFormatPhp, MediaWiki\Api\ApiFormatRaw, and MediaWiki\Api\ApiFormatXml.

Collaboration diagram for MediaWiki\Api\ApiFormatBase:

[legend]

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

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

	closePrinter ()
	Finish printing and output buffered data.

	disable ()
	Disable the formatter.

	forceDefaultParams ()
	Ignore request parameters, force a default.

	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.

	getBuffer ()
	Get the contents of the buffer.

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

	getFormat ()
	Get the internal format name.

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

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

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

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

	isDisabled ()
	Whether the printer is disabled.

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

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

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

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

	getModuleManager ()
	Get the module manager, or null if this module has no submodules.

	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.

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

	isReadMode ()
	Indicates whether this module requires read rights.

	isWriteMode ()
	Indicates whether this module requires write access to the wiki.

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

	isDeprecated ()
	Indicates whether this module is deprecated.

	isInternal ()
	Indicates whether this module is considered to be "internal".

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

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

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

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

	getMain ()
	Get the main module.

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

	getParent ()
	Get the parent of this module.

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

	getModulePath ()
	Get the path to this module.

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

	getResult ()
	Get the result object.

	getErrorFormatter ()

	getContinuationManager ()

	setContinuationManager (?ApiContinuationManager $manager=null)

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

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

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

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

	requireMaxOneParameter ( $params,... $required)
	Dies if more than one parameter from a certain set of parameters are set and not false.

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

	requireNoConflictingParameters ( $params, $trigger, $conflicts)
	Die with an "invalid param mix" error if the parameters contain the trigger parameter and any of the conflicting parameters.

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

	getTitleOrPageId ( $params, $load=false)
	Attempts to load a WikiPage object from a title or pageid parameter, if possible.

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

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

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

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

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

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

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

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

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

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

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

	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.

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

	dieReadOnly ()
	Helper function for readonly errors.

	checkUserRightsAny ( $rights)
	Helper function for permission-denied errors.

	checkTitleUserPermissions (PageIdentity $pageIdentity, $actions, array $options=[])
	Helper function for permission-denied errors.

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

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

	getFinalSummary ()
	Get the final module summary.

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

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

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

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

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

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

	getActionName ()
	Get the action name for the current web request.

	getAuthority ()

	getConfig ()

	getContext ()
	Get the base IContextSource object.

	getCsrfTokenSet ()
	Get a repository to obtain and match CSRF tokens.

	getLanguage ()

	getLanguageCode ()

	getOutput ()

	getRequest ()

	getSkin ()

	getTiming ()

	getTitle ()

	getUser ()

	getWikiPage ()
	Get the WikiPage object.

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

	setContext (IContextSource $context)

Protected Member Functions

getExamplesMessages ()

Returns usage examples for this module.

getIsWrappedHtml ()

Returns true when the special-wrapped mode is enabled.

getParameterFromSettings ( $paramName, $paramSettings, $parseLimit)

Overridden to honor $this->forceDefaultParams(), if applicable Using the settings, determine the value for the given parameter.

Parameters

string	$name	Parameter name
array \| mixed	$settings	Default value or an array of settings using PARAM_* constants.
bool	$parseLimit	Whether to parse and validate 'limit' parameters

Returns: mixed Parameter value

.

Protected Member Functions inherited from MediaWiki\Api\ApiBase

getWebUITokenSalt (array $params)

Fetch the salt used in the Web UI corresponding to this module.

getDB ()

Gets a default replica DB connection object.

getPermissionManager ()

Obtain a PermissionManager instance that subclasses may use in their authorization checks.

getHookContainer ()

Get a HookContainer, for running extension hooks or for hook metadata.

getHookRunner ()

Get an ApiHookRunner for running core API hooks.

getParameter ( $paramName, $parseLimit=true)

Get a value for the given parameter.

useTransactionalTimeLimit ()

Call wfTransactionalTimeLimit() if this request was POSTed.

filterIDs ( $fields, array $ids)

Filter out-of-range values from a list of positive integer IDs.

parseContinueParamOrDie (string $continue, array $types)

Parse the 'continue' parameter in the usual format and validate the types of each part, or die with the 'badcontinue' error if the format, types, or the number of parts is wrong.

dieContinueUsageIf ( $condition)

Die with the 'badcontinue' error.

getSummaryMessage ()

Return the summary message.

getExtendedDescription ()

Return the extended help text message.

getHelpFlags ()

Generates the list of flags for the help screen and for action=paraminfo.

getModuleSourceInfo ()

Returns information about the source of this module, if known.

Protected Attributes
bool	$mForceDefaultParams = false

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

static	clearCacheForTest ()
	Reset static caches of database state.

Public Attributes inherited from MediaWiki\Api\ApiBase
const	PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
	(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

const	PARAM_DFLT = ParamValidator::PARAM_DEFAULT

const	PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI

const	PARAM_TYPE = ParamValidator::PARAM_TYPE

const	PARAM_MAX = IntegerDef::PARAM_MAX

const	PARAM_MAX2 = IntegerDef::PARAM_MAX2

const	PARAM_MIN = IntegerDef::PARAM_MIN

const	PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES

const	PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED

const	PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED

const	PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP

const	PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX

const	PARAM_ALL = ParamValidator::PARAM_ALL

const	PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES

const	PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE

const	PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES

const	PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1

const	PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2

const	PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES

const	PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS

const	PARAM_HELP_MSG = 'api-param-help-msg'
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

const	PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append'
	((string\|array\|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.

const	PARAM_HELP_MSG_INFO = 'api-param-help-msg-info'
	(array) Specify additional information tags for the parameter.

const	PARAM_VALUE_LINKS = 'api-param-value-links'
	Deprecated and unused.

const	PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value'
	((string\|array\|Message)[]) When PARAM_TYPE is an array, or 'string' with PARAM_ISMULTI, this is an array mapping parameter values to help messages.

const	PARAM_TEMPLATE_VARS = 'param-template-vars'
	(array) Indicate that this is a templated parameter, and specify replacements.

const	ALL_DEFAULT_STRING = '*'
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter.

const	LIMIT_BIG1 = 500
	Fast query, standard limit.

const	LIMIT_BIG2 = 5000
	Fast query, apihighlimits limit.

const	LIMIT_SML1 = 50
	Slow query, standard limit.

const	LIMIT_SML2 = 500
	Slow query, apihighlimits limit.

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

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

Detailed Description

This is the abstract base class for API formatters.

Definition at line 40 of file ApiFormatBase.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Api\ApiFormatBase::__construct	(	ApiMain	$main,
		string	$format )

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

Parameters

ApiMain	$main
string	$format	Format name

Reimplemented in MediaWiki\Api\ApiFormatJson, and MediaWiki\Api\ApiFormatXmlRsd.

Definition at line 58 of file ApiFormatBase.php.

References MediaWiki\Api\ApiBase\getMain().

Member Function Documentation

◆ canPrintErrors()

MediaWiki\Api\ApiFormatBase::canPrintErrors ( )

Whether this formatter can handle printing API errors.

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

Since: 1.23

Returns: bool

Reimplemented in MediaWiki\Api\ApiFormatFeedWrapper.

Definition at line 158 of file ApiFormatBase.php.

◆ closePrinter()

MediaWiki\Api\ApiFormatBase::closePrinter ( )

Finish printing and output buffered data.

Reimplemented in MediaWiki\Api\ApiFormatRaw.

Definition at line 265 of file ApiFormatBase.php.

◆ disable()

MediaWiki\Api\ApiFormatBase::disable ( )

Disable the formatter.

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

Definition at line 138 of file ApiFormatBase.php.

◆ forceDefaultParams()

MediaWiki\Api\ApiFormatBase::forceDefaultParams ( )

Ignore request parameters, force a default.

Used as a fallback if errors are being thrown.

Since: 1.26

Definition at line 169 of file ApiFormatBase.php.

◆ getAllowedParams()

MediaWiki\Api\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.

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Api\ApiBase.

Reimplemented in MediaWiki\Api\ApiFormatJson, MediaWiki\Api\ApiFormatPhp, and MediaWiki\Api\ApiFormatXml.

Definition at line 378 of file ApiFormatBase.php.

References MediaWiki\Api\ApiFormatBase\getIsHtml(), and MediaWiki\Api\ApiBase\PARAM_HELP_MSG.

◆ getBuffer()

MediaWiki\Api\ApiFormatBase::getBuffer ( )

Get the contents of the buffer.

Returns: string

Definition at line 374 of file ApiFormatBase.php.

Referenced by MediaWiki\Api\ApiFormatBase\closePrinter().

◆ getExamplesMessages()

MediaWiki\Api\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

Stability: stable: to override

Returns: array

Reimplemented from MediaWiki\Api\ApiBase.

Definition at line 389 of file ApiFormatBase.php.

References MediaWiki\Api\ApiFormatBase\getFormat(), and MediaWiki\Api\ApiBase\getModuleName().

◆ getFilename()

MediaWiki\Api\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 MediaWiki\Api\ApiFormatRaw.

Definition at line 89 of file ApiFormatBase.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Api\ApiFormatBase\getIsHtml(), MediaWiki\Api\ApiFormatBase\getIsWrappedHtml(), and MediaWiki\Api\ApiFormatBase\getMimeType().

Referenced by MediaWiki\Api\ApiFormatBase\initPrinter().

◆ getFormat()

MediaWiki\Api\ApiFormatBase::getFormat ( )

Get the internal format name.

Returns: string

Definition at line 109 of file ApiFormatBase.php.

Referenced by MediaWiki\Api\ApiFormatBase\closePrinter(), and MediaWiki\Api\ApiFormatBase\getExamplesMessages().

◆ getHelpUrls()

MediaWiki\Api\ApiFormatBase::getHelpUrls ( )

Return links to more detailed help pages about the module.

Since: 1.25, returning boolean false is deprecated

Stability: stable: to override

Returns: string|array

Reimplemented from MediaWiki\Api\ApiBase.

Definition at line 396 of file ApiFormatBase.php.

◆ getIsHtml()

MediaWiki\Api\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 119 of file ApiFormatBase.php.

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

◆ getIsWrappedHtml()

MediaWiki\Api\ApiFormatBase::getIsWrappedHtml ( )

protected

Returns true when the special-wrapped mode is enabled.

Since: 1.27

Returns: bool

Definition at line 129 of file ApiFormatBase.php.

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

◆ getMimeType()

MediaWiki\Api\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|null

Reimplemented in MediaWiki\Api\ApiFormatFeedWrapper, MediaWiki\Api\ApiFormatJson, MediaWiki\Api\ApiFormatNone, MediaWiki\Api\ApiFormatPhp, MediaWiki\Api\ApiFormatRaw, MediaWiki\Api\ApiFormatXml, and MediaWiki\Api\ApiFormatXmlRsd.

Referenced by MediaWiki\Api\ApiFormatBase\closePrinter(), MediaWiki\Api\ApiFormatBase\getFilename(), and MediaWiki\Api\ApiFormatBase\initPrinter().

◆ getParameterFromSettings()

MediaWiki\Api\ApiFormatBase::getParameterFromSettings	(	$paramName,
		$paramSettings,
		$parseLimit )

protected

Overridden to honor $this->forceDefaultParams(), if applicable Using the settings, determine the value for the given parameter.

Parameters

string	$name	Parameter name
array \| mixed	$settings	Default value or an array of settings using PARAM_* constants.
bool	$parseLimit	Whether to parse and validate 'limit' parameters

Returns: mixed Parameter value

.

Since: 1.26

Reimplemented from MediaWiki\Api\ApiBase.

Definition at line 178 of file ApiFormatBase.php.

◆ initPrinter()

MediaWiki\Api\ApiFormatBase::initPrinter ( $unused = false )

Initialize the printer function and prepare the output headers.

Parameters

bool $unused Always false since 1.25

Reimplemented in MediaWiki\Api\ApiFormatFeedWrapper, and MediaWiki\Api\ApiFormatRaw.

Definition at line 211 of file ApiFormatBase.php.

References $header, MediaWiki\MainConfigNames\ApiFrameOptions, MediaWiki\Context\ContextSource\getConfig(), MediaWiki\Api\ApiFormatBase\getFilename(), MediaWiki\Api\ApiFormatBase\getIsHtml(), MediaWiki\Api\ApiFormatBase\getIsWrappedHtml(), MediaWiki\Api\ApiBase\getMain(), and MediaWiki\Api\ApiFormatBase\getMimeType().

◆ isDisabled()

MediaWiki\Api\ApiFormatBase::isDisabled ( )

Whether the printer is disabled.

Returns: bool

Definition at line 147 of file ApiFormatBase.php.

Referenced by MediaWiki\Api\ApiFormatFeedWrapper\initPrinter().

◆ printText()

MediaWiki\Api\ApiFormatBase::printText ( $text )

Append text to the output buffer.

Parameters

string $text

Definition at line 365 of file ApiFormatBase.php.

Referenced by MediaWiki\Api\ApiFormatXml\addXslt(), MediaWiki\Api\ApiFormatFeedWrapper\execute(), MediaWiki\Api\ApiFormatJson\execute(), MediaWiki\Api\ApiFormatPhp\execute(), MediaWiki\Api\ApiFormatRaw\execute(), and MediaWiki\Api\ApiFormatXml\execute().

◆ setHttpStatus()

MediaWiki\Api\ApiFormatBase::setHttpStatus ( $code )

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

Since: 1.29

Parameters

int $code

Definition at line 195 of file ApiFormatBase.php.

References MediaWiki\Api\ApiFormatBase\getIsHtml(), and MediaWiki\Api\ApiBase\getMain().

Member Data Documentation

◆ $mForceDefaultParams

bool MediaWiki\Api\ApiFormatBase::$mForceDefaultParams = false

protected

Definition at line 50 of file ApiFormatBase.php.

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

includes/api/ApiFormatBase.php

Public Member Functions

Protected Member Functions

Protected 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

◆ $mForceDefaultParams