This abstract class implements many basic API functions, and is the base of all API classes. More...

Inherits MediaWiki\Context\ContextSource.

Collaboration diagram for MediaWiki\Api\ApiBase:

[legend]

Public Attributes
const	PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
	(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

Old constants for ::getAllowedParams() arrays
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

Protected Member Functions
Data Unified metrics methods
	recordUnifiedMetrics ( $latency=0, $detailLabels=[])
	Record unified metrics for the API.

API-specific constants for ::getAllowedParams() arrays
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.

	__construct (ApiMain $mainModule, string $moduleName, string $modulePrefix='')

Methods to implement
	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.

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

	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.

	getExamplesMessages ()
	Returns usage examples for this module.

	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.

	getWebUITokenSalt (array $params)
	Fetch the salt used in the Web UI corresponding to this module.

Data access methods
	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)

	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.

Parameter handling
	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.

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

	getParameterFromSettings ( $name, $settings, $parseLimit)
	Using the settings, determine the value for the given parameter.

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

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

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

static	makeMessage ( $msg, IContextSource $context, ?array $params=null)
	Create a Message from a string or array.

static	clearCacheForTest ()
	Reset static caches of database state.

Warning and error reporting
	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.

	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.

static	dieDebug ( $method, $message)
	Internal code errors should be reported with this method.

Help message generation
	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.

	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.

Additional Inherited Members
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)

Detailed Description

This abstract class implements many basic API functions, and is the base of all API classes.

The class functions are divided into several areas of functionality:

Module parameters: Derived classes can define getAllowedParams() to specify which parameters to expect, how to parse and validate them.

Self-documentation: code to allow the API to document its own state

Stability: stable: to extend

Definition at line 60 of file ApiBase.php.

Constructor & Destructor Documentation

◆ __construct()

MediaWiki\Api\ApiBase::__construct	(	ApiMain	$mainModule,
		string	$moduleName,
		string	$modulePrefix = '' )

Stability: stable: to call

Parameters

ApiMain	$mainModule
string	$moduleName	Name of this module
string	$modulePrefix	Prefix to use for parameter names

Definition at line 286 of file ApiBase.php.

References MediaWiki\Context\ContextSource\getContext(), MediaWiki\Api\ApiBase\isMain(), and MediaWiki\Context\ContextSource\setContext().

Member Function Documentation

◆ addDeprecation()

MediaWiki\Api\ApiBase::addDeprecation	(	$msg,
		$feature,
		$data = [] )

Add a deprecation warning for this module.

A combination of $this->addWarning() and $this->logFeatureUsage()

Since: 1.29

Parameters

string \| array \| MessageSpecifier	$msg	See ApiErrorFormatter::addWarning()
string \| null	$feature	See ApiBase::logFeatureUsage()
array \| null	$data	See ApiErrorFormatter::addWarning()

Definition at line 1438 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiExpandTemplates\execute(), MediaWiki\Api\ApiLogin\execute(), and MediaWiki\Api\ApiQueryDeletedrevs\execute().

◆ addError()

MediaWiki\Api\ApiBase::addError	(	$msg,
		$code = null,
		$data = null )

Add an error for this module without aborting.

If $msg is not an ApiMessage, the message code will be derived from the message key by stripping any "apiwarn-" or "apierror-" prefix.

Note: If you want to abort processing, use self::dieWithError() instead.

Since: 1.29

Parameters

string \| array \| MessageSpecifier	$msg	See ApiErrorFormatter::addError()
string \| null	$code	See ApiErrorFormatter::addError()
array \| null	$data	See ApiErrorFormatter::addError()

Definition at line 1471 of file ApiBase.php.

◆ addMessagesFromStatus()

MediaWiki\Api\ApiBase::addMessagesFromStatus	(	StatusValue	$status,
			$types = [ 'warning', 'error' ],
		array	$filter = [] )

Add warnings and/or errors from a Status.

Note: If you want to abort processing, use self::dieStatus() instead.

Since: 1.29

Parameters

StatusValue	$status
string[]	$types	'warning' and/or 'error'
string[]	$filter	Message keys to filter out (since 1.33)

Definition at line 1484 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiUndelete\execute().

◆ addWarning()

MediaWiki\Api\ApiBase::addWarning	(	$msg,
		$code = null,
		$data = null )

Add a warning for this module.

Users should monitor this section to notice any changes in the API.

Multiple calls to this function will result in multiple warning messages.

If $msg is not an ApiMessage, the message code will be derived from the message key by stripping any "apiwarn-" or "apierror-" prefix.

Since: 1.29

Parameters

string \| array \| MessageSpecifier	$msg	See ApiErrorFormatter::addWarning()
string \| null	$code	See ApiErrorFormatter::addWarning()
array \| null	$data	See ApiErrorFormatter::addWarning()

Definition at line 1424 of file ApiBase.php.

◆ checkTitleUserPermissions()

MediaWiki\Api\ApiBase::checkTitleUserPermissions	(	PageIdentity	$pageIdentity,
			$actions,
		array	$options = [] )

Helper function for permission-denied errors.

Parameters

PageIdentity	$pageIdentity
string \| string[]	$actions
array	$options	Additional options user: (User) User to use rather than $this->getUser(). autoblock: (bool, default false) Whether to spread autoblocks.

Exceptions

ApiUsageException if the user doesn't have all the necessary rights.

Since: 1.29; 1.33 Changed the third parameter from $user to $options.; 1.36 deprecated passing LinkTarget as first parameter

Definition at line 1638 of file ApiBase.php.

References MediaWiki\Api\getAuthority(), and MediaWiki\Api\getUser().

Referenced by MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiFileRevert\execute(), MediaWiki\Api\ApiImageRotate\execute(), MediaWiki\Api\ApiProtect\execute(), and MediaWiki\Api\ApiSetPageLanguage\execute().

◆ checkUserRightsAny()

MediaWiki\Api\ApiBase::checkUserRightsAny ( $rights )

Helper function for permission-denied errors.

Since: 1.29

Parameters

string | string[] $rights

Exceptions

ApiUsageException if the user doesn't have any of the rights. The error message is based on $rights[0].

Definition at line 1615 of file ApiBase.php.

References MediaWiki\Api\getAuthority().

Referenced by MediaWiki\Api\ApiAcquireTempUserName\execute(), MediaWiki\Api\ApiBlock\execute(), MediaWiki\Api\ApiChangeContentModel\execute(), MediaWiki\Api\ApiFileRevert\execute(), MediaWiki\Api\ApiOptionsBase\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiRevisionDelete\execute(), MediaWiki\Api\ApiSetNotificationTimestamp\execute(), MediaWiki\Api\ApiSetPageLanguage\execute(), MediaWiki\Api\ApiTag\execute(), and MediaWiki\Api\ApiWatch\execute().

◆ clearCacheForTest()

static MediaWiki\Api\ApiBase::clearCacheForTest ( )

static

Reset static caches of database state.

Access: internal: For testing only

Definition at line 1365 of file ApiBase.php.

◆ dieBlocked()

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

Since: 1.27

Parameters

Block $block The block used to generate the ApiUsageException

Exceptions

ApiUsageException always

Returns: never

Definition at line 1534 of file ApiBase.php.

References MediaWiki\Api\getContext(), MediaWiki\Api\getRequest(), and MediaWiki\Api\getUser().

Referenced by MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiPurge\execute(), MediaWiki\Api\ApiRevisionDelete\execute(), MediaWiki\Api\ApiTag\execute(), MediaWiki\Api\ApiUndelete\execute(), and MediaWiki\Api\ApiUserrights\execute().

◆ dieContinueUsageIf()

MediaWiki\Api\ApiBase::dieContinueUsageIf ( $condition )

protected

Die with the 'badcontinue' error.

This call is common enough to make it into the base method.

Parameters

bool $condition Will only die if this value is true

Exceptions

ApiUsageException

Since: 1.21

Definition at line 1730 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiQueryInfo\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), and MediaWiki\Api\ApiQueryRandom\run().

◆ dieDebug()

static MediaWiki\Api\ApiBase::dieDebug	(		$method,
			$message )

staticprotected

Internal code errors should be reported with this method.

Parameters

string	$method	Method or function name
string	$message	Error message

Returns: never

Definition at line 1743 of file ApiBase.php.

◆ dieReadOnly()

MediaWiki\Api\ApiBase::dieReadOnly ( )

Helper function for readonly errors.

Exceptions

ApiUsageException always

Returns: never

Definition at line 1599 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiEditPage\execute().

◆ dieStatus()

MediaWiki\Api\ApiBase::dieStatus ( StatusValue $status )

Throw an ApiUsageException based on the Status object.

Since: 1.22; 1.29 Accepts a StatusValue

Parameters

StatusValue $status

Exceptions

ApiUsageException always

Returns: never

Definition at line 1557 of file ApiBase.php.

◆ dieWithError()

MediaWiki\Api\ApiBase::dieWithError	(	$msg,
		$code = null,
		$data = null,
		$httpCode = 0 )

Abort execution with an error.

If $msg is not an ApiMessage, the message code will be derived from the message key by stripping any "apiwarn-" or "apierror-" prefix.

Since: 1.29

Parameters

string \| array \| MessageSpecifier	$msg	See ApiErrorFormatter::addError()
string \| null	$code	See ApiErrorFormatter::addError()
array \| null	$data	See ApiErrorFormatter::addError()
int	$httpCode	HTTP error code to use

Exceptions

ApiUsageException always

Returns: never

Definition at line 1506 of file ApiBase.php.

◆ dieWithErrorOrDebug()

MediaWiki\Api\ApiBase::dieWithErrorOrDebug	(	$msg,
		$code = null,
		$data = null,
		$httpCode = null )

Will only set a warning instead of failing if the global $wgDebugAPI is set to true.

Otherwise, it behaves exactly as self::dieWithError().

Since: 1.29

Parameters

string \| array \| Message	$msg	Message definition, see Message::newFromSpecifier()
string \| null	$code
array \| null	$data
int \| null	$httpCode

Exceptions

ApiUsageException

Definition at line 1673 of file ApiBase.php.

◆ dieWithException()

MediaWiki\Api\ApiBase::dieWithException	(	Throwable	$exception,
		array	$options = [] )

Abort execution with an error derived from a throwable.

Since: 1.29

Parameters

Throwable	$exception	See ApiErrorFormatter::getMessageFromException()
array	$options	See ApiErrorFormatter::getMessageFromException()

Exceptions

ApiUsageException always

Returns: never

Definition at line 1519 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiImport\execute(), MediaWiki\Api\ApiQueryStashImageInfo\execute(), and MediaWiki\Api\ApiStashEdit\execute().

◆ dynamicParameterDocumentation()

MediaWiki\Api\ApiBase::dynamicParameterDocumentation ( )

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

Stability: stable: to override

Returns: string|array|Message|null Return null if the module does not support additional dynamic parameters, otherwise return a message describing them. See Message::newFromSpecifier() for a description of allowed values.

Reimplemented in MediaWiki\Api\ApiAMCreateAccount, MediaWiki\Api\ApiChangeAuthenticationData, MediaWiki\Api\ApiClientLogin, and MediaWiki\Api\ApiLinkAccount.

Definition at line 788 of file ApiBase.php.

◆ encodeParamName()

MediaWiki\Api\ApiBase::encodeParamName ( $paramName )

This method mangles parameter name based on the prefix supplied to the constructor.

Override this method to change parameter name during runtime.

Parameters

string | string[] $paramName Parameter name

Returns: string|string[] Prefixed parameter name

Since: 1.29 accepts an array of strings

Reimplemented in MediaWiki\Api\ApiQueryGeneratorBase.

Definition at line 800 of file ApiBase.php.

◆ execute()

MediaWiki\Api\ApiBase::execute ( )

abstract

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().

◆ extractRequestParams()

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

limits will not be parsed if $parseLimit is set to false; use this when the max limit is not definitive yet, e.g. when getting revisions.

Parameters

bool | array

$options

If a boolean, uses that as the value for 'parseLimit'

parseLimit: (bool, default true) Whether to parse the 'max' value for limit types
safeMode: (bool, default false) If true, avoid throwing for parameter validation errors. Returned parameter values might be ApiUsageException instances.

Returns: array

Definition at line 822 of file ApiBase.php.

References wfEscapeWikiText().

◆ filterIDs()

MediaWiki\Api\ApiBase::filterIDs	(		$fields,
		array	$ids )

protected

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

Since: 1.33

Parameters

string[][]	$fields	Array of table and field pairs to check
	(string\|int)[]	$ids IDs to filter. Strings in the array are expected to be stringified integers.

Returns: (string|int)[] Filtered IDs.

Definition at line 1381 of file ApiBase.php.

References MediaWiki\Api\getDB().

Referenced by MediaWiki\Api\ApiQueryBase\addWhereIDsFld().

◆ getAllowedParams()

MediaWiki\Api\ApiBase::getAllowedParams ( )

protected

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

Definition at line 385 of file ApiBase.php.

◆ getConditionalRequestData()

MediaWiki\Api\ApiBase::getConditionalRequestData ( $condition )

Returns data for HTTP conditional request mechanisms.

Since: 1.26

Stability: stable: to override

Parameters

string

$condition

Condition being queried:

last-modified: Return a timestamp representing the maximum of the last-modified dates for all resources involved in the request. See RFC 7232 § 2.2 for semantics.
etag: Return an entity-tag representing the state of all resources involved in the request. Quotes must be included. See RFC 7232 § 2.3 for semantics.

Returns: string|bool|null As described above, or null if no value is available.

Definition at line 527 of file ApiBase.php.

◆ getContinuationManager()

MediaWiki\Api\ApiBase::getContinuationManager ( )

Returns: ApiContinuationManager|null

Reimplemented in MediaWiki\Api\ApiMain.

Definition at line 718 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getMain().

Referenced by MediaWiki\Api\ApiQueryRandom\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), MediaWiki\Api\ApiQueryBase\setContinueEnumParameter(), and MediaWiki\Api\ApiQueryGeneratorBase\setContinueEnumParameter().

◆ getCustomPrinter()

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

A value of null means the default format will be used.

Note: Do not use this just because you don't want to support non-json formats. This should be used only when there is a fundamental requirement for a specific format.

Stability: stable: to override

Returns: ApiFormatBase|null An instance of a class derived from ApiFormatBase, or null

Reimplemented in MediaWiki\Api\ApiFeedContributions, MediaWiki\Api\ApiFeedRecentChanges, MediaWiki\Api\ApiFeedWatchlist, MediaWiki\Api\ApiHelp, MediaWiki\Api\ApiOpenSearch, MediaWiki\Api\ApiQuery, and MediaWiki\Api\ApiRsd.

Definition at line 341 of file ApiBase.php.

◆ getDB()

MediaWiki\Api\ApiBase::getDB ( )

protected

Gets a default replica DB connection object.

Stability: stable: to override

Returns: IReadableDatabase

Reimplemented in MediaWiki\Api\ApiPageSet, MediaWiki\Api\ApiQueryAllImages, and MediaWiki\Api\ApiQueryBase.

Definition at line 705 of file ApiBase.php.

References MediaWiki\MediaWikiServices\getInstance().

◆ getErrorFormatter()

MediaWiki\Api\ApiBase::getErrorFormatter ( )

Stability: stable: to override

Returns: ApiErrorFormatter

Reimplemented in MediaWiki\Api\ApiMain.

Definition at line 692 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getMain().

◆ getExamplesMessages()

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

Definition at line 357 of file ApiBase.php.

◆ getExtendedDescription()

MediaWiki\Api\ApiBase::getExtendedDescription ( )

protected

Return the extended help text message.

This is additional text to display at the top of the help section, below the summary.

Since: 1.30

Stability: stable: to override

Returns: string|array|Message Message definition, see Message::newFromSpecifier(). When returning an array, the definition may also specify fallback keys.

Reimplemented in MediaWiki\Api\ApiDisabled, MediaWiki\Api\ApiLogin, MediaWiki\Api\ApiQueryDisabled, MediaWiki\Api\ApiResetPassword, and MediaWiki\Api\ApiSetPageLanguage.

Definition at line 1824 of file ApiBase.php.

◆ getFinalDescription()

MediaWiki\Api\ApiBase::getFinalDescription ( )

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

Since: 1.25, returns Message[] rather than string[]

Returns: Message[]

Reimplemented in MediaWiki\Api\ApiAMCreateAccount, MediaWiki\Api\ApiClientLogin, and MediaWiki\Api\ApiLinkAccount.

Definition at line 1854 of file ApiBase.php.

◆ getFinalParamDescription()

MediaWiki\Api\ApiBase::getFinalParamDescription ( )

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

Since: 1.25, returns array of Message[] rather than array of string[]

Returns: array Keys are parameter names, values are arrays of Message objects

Definition at line 1921 of file ApiBase.php.

References $path, and MediaWiki\Api\getContext().

◆ getFinalParams()

MediaWiki\Api\ApiBase::getFinalParams ( $flags = 0 )

Get the final list of parameters, after hooks have had a chance to tweak it as needed.

Parameters

int $flags Zero or more flags like GET_VALUES_FOR_HELP

Returns: array

Since: 1.21 $flags param added

Definition at line 1890 of file ApiBase.php.

◆ getFinalSummary()

MediaWiki\Api\ApiBase::getFinalSummary ( )

Get the final module summary.

Since: 1.30

Stability: stable: to override

Returns: Message

Definition at line 1838 of file ApiBase.php.

◆ getHelpFlags()

MediaWiki\Api\ApiBase::getHelpFlags ( )

protected

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

Corresponding messages: api-help-flag-deprecated, api-help-flag-internal, api-help-flag-readrights, api-help-flag-writerights, api-help-flag-mustbeposted

Returns: string[]

Reimplemented in MediaWiki\Api\ApiQueryGeneratorBase.

Definition at line 2054 of file ApiBase.php.

◆ getHelpUrls()

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

Definition at line 368 of file ApiBase.php.

◆ getHookContainer()

MediaWiki\Api\ApiBase::getHookContainer ( )

protected

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

Since: 1.35

Returns: HookContainer

Definition at line 751 of file ApiBase.php.

References MediaWiki\MediaWikiServices\getInstance().

Referenced by MediaWiki\Api\ApiQueryRecentChanges\run(), and MediaWiki\Api\ApiQueryBase\select().

◆ getHookRunner()

MediaWiki\Api\ApiBase::getHookRunner ( )

protected

Get an ApiHookRunner for running core API hooks.

Access: internal: This is for use by core only. Hook interfaces may be removed without notice.

Since: 1.35

Returns: ApiHookRunner

Definition at line 766 of file ApiBase.php.

◆ getMain()

MediaWiki\Api\ApiBase::getMain ( )

Get the main module.

Returns: ApiMain

Definition at line 560 of file ApiBase.php.

◆ getModuleFromPath()

MediaWiki\Api\ApiBase::getModuleFromPath ( $path )

Get a module from its module path.

Since: 1.25

Parameters

string $path

Returns: ApiBase|null

Exceptions

ApiUsageException

Definition at line 641 of file ApiBase.php.

References $path, MediaWiki\Api\ApiBase\dieWithError(), MediaWiki\Api\ApiBase\getMain(), and wfEscapeWikiText().

Referenced by MediaWiki\Api\ApiHelp\execute(), and MediaWiki\Api\ApiParamInfo\execute().

◆ getModuleManager()

MediaWiki\Api\ApiBase::getModuleManager ( )

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

Since: 1.21

Stability: stable: to override

Returns: ApiModuleManager|null

Reimplemented in MediaWiki\Api\ApiMain, and MediaWiki\Api\ApiQuery.

Definition at line 325 of file ApiBase.php.

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

◆ getModuleName()

MediaWiki\Api\ApiBase::getModuleName ( )

Get the name of the module being executed by this instance.

Returns: string

Definition at line 542 of file ApiBase.php.

◆ getModulePath()

MediaWiki\Api\ApiBase::getModulePath ( )

Get the path to this module.

Since: 1.25

Returns: string

Definition at line 621 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getModuleName(), MediaWiki\Api\ApiBase\getParent(), and MediaWiki\Api\ApiBase\isMain().

Referenced by MediaWiki\Api\ApiUsageException\__construct(), MediaWiki\Api\ApiQueryBacklinksprop\getExamplesMessages(), MediaWiki\Api\ApiQueryLanguageinfo\getExamplesMessages(), MediaWiki\Api\ApiQueryLinks\getExamplesMessages(), MediaWiki\Api\ApiRemoveAuthenticationData\getExamplesMessages(), MediaWiki\Api\ApiAMCreateAccount\getFinalDescription(), MediaWiki\Api\ApiClientLogin\getFinalDescription(), MediaWiki\Api\ApiLinkAccount\getFinalDescription(), and MediaWiki\Api\ApiHelp\getHelp().

◆ getModulePrefix()

MediaWiki\Api\ApiBase::getModulePrefix ( )

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

Returns: string

Definition at line 551 of file ApiBase.php.

◆ getModuleSourceInfo()

MediaWiki\Api\ApiBase::getModuleSourceInfo ( )

protected

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

Returned array is an array with the following keys:

path: Install path
name: Extension name, or "MediaWiki" for core
namemsg: (optional) i18n message key for a display name
license-name: (optional) Name of license

Returns: array|null

Definition at line 2087 of file ApiBase.php.

References $path.

◆ getParameter()

MediaWiki\Api\ApiBase::getParameter	(		$paramName,
			$parseLimit = true )

protected

Get a value for the given parameter.

Parameters

string	$paramName	Parameter name
bool	$parseLimit	See extractRequestParams()

Returns: mixed Parameter value

Definition at line 943 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiFormatRaw\__construct(), MediaWiki\Api\ApiCSPReport\execute(), MediaWiki\Api\ApiFeedRecentChanges\execute(), MediaWiki\Api\ApiQueryLanguageinfo\execute(), MediaWiki\Api\ApiQuery\getCustomPrinter(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), MediaWiki\Api\ApiQueryDeletedRevisions\run(), and MediaWiki\Api\ApiQueryRevisions\run().

◆ getParameterFromSettings()

MediaWiki\Api\ApiBase::getParameterFromSettings	(	$name,
		$settings,
		$parseLimit )

protected

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

Reimplemented in MediaWiki\Api\ApiFormatBase.

Definition at line 1216 of file ApiBase.php.

◆ getParent()

MediaWiki\Api\ApiBase::getParent ( )

Get the parent of this module.

Stability: stable: to override

Since: 1.25

Returns: ApiBase|null

Reimplemented in MediaWiki\Api\ApiQueryBase.

Definition at line 581 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getMain(), and MediaWiki\Api\ApiBase\isMain().

Referenced by MediaWiki\Api\ApiBase\getModulePath().

◆ getPermissionManager()

MediaWiki\Api\ApiBase::getPermissionManager ( )

protected

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

Since: 1.34

Returns: PermissionManager

Definition at line 741 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiProtect\execute(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiRevisionDelete\execute(), MediaWiki\Api\ApiQueryAllUsers\getAllowedParams(), and MediaWiki\Api\ApiQueryContributors\getAllowedParams().

◆ getResult()

MediaWiki\Api\ApiBase::getResult ( )

Get the result object.

Returns: ApiResult

Reimplemented in MediaWiki\Api\ApiMain.

Definition at line 681 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getMain().

◆ getSummaryMessage()

MediaWiki\Api\ApiBase::getSummaryMessage ( )

protected

Return the summary message.

This is a one-line description of the module, suitable for display in a list of modules.

Since: 1.30

Stability: stable: to override

Returns: string|array|Message Message definition, see Message::newFromSpecifier()

Reimplemented in MediaWiki\Api\ApiDisabled, MediaWiki\Api\ApiQueryContributors, and MediaWiki\Api\ApiQueryDisabled.

Definition at line 1809 of file ApiBase.php.

◆ getTitleFromTitleOrPageId()

MediaWiki\Api\ApiBase::getTitleFromTitleOrPageId ( $params )

Get a Title object from a title or pageid param, if it is possible.

It can die if no param is set or if the title or page ID is not valid.

Since: 1.29

Parameters

array $params User provided parameter set, as from $this->extractRequestParams()

Returns: Title

Definition at line 1184 of file ApiBase.php.

References wfEscapeWikiText().

◆ getTitleOrPageId()

MediaWiki\Api\ApiBase::getTitleOrPageId	(		$params,
			$load = false )

Attempts to load a WikiPage object from a title or pageid parameter, if possible.

It can die if no param is set or if the title or page ID is not valid.

Parameters

array	$params	User provided parameter set, as from $this->extractRequestParams()
string \| false	$load	Whether load the object's state from the database: false: don't load (if the pageid is given, it will still be loaded) 'fromdb': load from a replica DB 'fromdbmaster': load from the primary database

Returns: WikiPage

Definition at line 1146 of file ApiBase.php.

References MediaWiki\MediaWikiServices\getInstance(), and wfEscapeWikiText().

Referenced by MediaWiki\Api\ApiChangeContentModel\execute(), MediaWiki\Api\ApiDelete\execute(), MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiProtect\execute(), MediaWiki\Api\ApiSetPageLanguage\execute(), and MediaWiki\Api\ApiStashEdit\execute().

◆ getWatchlistUser()

MediaWiki\Api\ApiBase::getWatchlistUser ( $params )

Gets the user for whom to get the watchlist.

Parameters

array $params

Returns: User

Definition at line 1292 of file ApiBase.php.

References MediaWiki\MediaWikiServices\getInstance(), MediaWiki\Api\getUser(), and wfEscapeWikiText().

◆ getWebUITokenSalt()

MediaWiki\Api\ApiBase::getWebUITokenSalt ( array $params )

protected

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

Only override this if the Web UI uses a token with a non-constant salt.

Since: 1.24

Parameters

array $params All supplied parameters for the module

Stability: stable: to override

Returns: string|array|null

Reimplemented in MediaWiki\Api\ApiLogout, and MediaWiki\Api\ApiUserrights.

Definition at line 510 of file ApiBase.php.

◆ handleParamNormalization()

MediaWiki\Api\ApiBase::handleParamNormalization	(	$paramName,
		$value,
		$rawValue )

Handle when a parameter was Unicode-normalized.

Since: 1.28; 1.35 $paramName is prefixed

Access: internal: For overriding by subclasses and use by ApiParamValidatorCallbacks only.

Parameters

string	$paramName	Prefixed parameter name
string	$value	Input that will be used.
string	$rawValue	Input before normalization.

Reimplemented in MediaWiki\Api\ApiPageSet.

Definition at line 1244 of file ApiBase.php.

◆ isDeprecated()

MediaWiki\Api\ApiBase::isDeprecated ( )

Indicates whether this module is deprecated.

Since: 1.25

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Api\ApiLogin, and MediaWiki\Api\ApiQueryDeletedrevs.

Definition at line 460 of file ApiBase.php.

◆ isInternal()

MediaWiki\Api\ApiBase::isInternal ( )

Indicates whether this module is considered to be "internal".

Internal API modules are not (yet) intended for 3rd party use and may be unstable.

Since: 1.25

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Api\ApiCSPReport, and MediaWiki\Api\ApiStashEdit.

Definition at line 473 of file ApiBase.php.

◆ isMain()

MediaWiki\Api\ApiBase::isMain ( )

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

Returns: bool

Definition at line 570 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiBase\__construct(), MediaWiki\Api\ApiBase\getModulePath(), and MediaWiki\Api\ApiBase\getParent().

◆ isReadMode()

MediaWiki\Api\ApiBase::isReadMode ( )

Indicates whether this module requires read rights.

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Api\ApiAMCreateAccount, MediaWiki\Api\ApiClientLogin, MediaWiki\Api\ApiCSPReport, MediaWiki\Api\ApiDisabled, MediaWiki\Api\ApiHelp, MediaWiki\Api\ApiLinkAccount, MediaWiki\Api\ApiLogin, MediaWiki\Api\ApiLogout, MediaWiki\Api\ApiMain, MediaWiki\Api\ApiParamInfo, MediaWiki\Api\ApiQuery, MediaWiki\Api\ApiQueryAuthManagerInfo, MediaWiki\Api\ApiQueryTokens, and MediaWiki\Api\ApiRsd.

Definition at line 407 of file ApiBase.php.

◆ isWriteMode()

MediaWiki\Api\ApiBase::isWriteMode ( )

Indicates whether this module requires write access to the wiki.

API modules must override this method to return true if the operation they will perform is not "safe" per RFC 7231 section 4.2.1. A module's operation is "safe" if it is essentially read-only, i.e. the client does not request nor expect any state change that would be observable in the responses to future requests.

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

Modules that do not require POST requests should only perform "safe" operations. Note that some modules might require POST requests because they need to support large input parameters and not because they perform non-"safe" operations.

The information provided by this method is used to perform authorization checks. It can also be used to enforce proper routing of supposedly "safe" POST requests to the closest datacenter via the Promise-Non-Write-API-Action header.

See also: mustBePosted(); needsToken()

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Api\ApiAcquireTempUserName, MediaWiki\Api\ApiAMCreateAccount, MediaWiki\Api\ApiBlock, MediaWiki\Api\ApiChangeAuthenticationData, MediaWiki\Api\ApiChangeContentModel, MediaWiki\Api\ApiClearHasMsg, MediaWiki\Api\ApiClientLogin, MediaWiki\Api\ApiDelete, MediaWiki\Api\ApiEditPage, MediaWiki\Api\ApiEmailUser, MediaWiki\Api\ApiFileRevert, MediaWiki\Api\ApiImageRotate, MediaWiki\Api\ApiImport, MediaWiki\Api\ApiLinkAccount, MediaWiki\Api\ApiLogin, MediaWiki\Api\ApiLogout, MediaWiki\Api\ApiManageTags, MediaWiki\Api\ApiMergeHistory, MediaWiki\Api\ApiMove, MediaWiki\Api\ApiOptionsBase, MediaWiki\Api\ApiPatrol, MediaWiki\Api\ApiProtect, MediaWiki\Api\ApiPurge, MediaWiki\Api\ApiQuery, MediaWiki\Api\ApiRemoveAuthenticationData, MediaWiki\Api\ApiResetPassword, MediaWiki\Api\ApiRevisionDelete, MediaWiki\Api\ApiRollback, MediaWiki\Api\ApiSetNotificationTimestamp, MediaWiki\Api\ApiSetPageLanguage, MediaWiki\Api\ApiStashEdit, MediaWiki\Api\ApiTag, MediaWiki\Api\ApiUnblock, MediaWiki\Api\ApiUndelete, MediaWiki\Api\ApiUpload, MediaWiki\Api\ApiUserrights, and MediaWiki\Api\ApiWatch.

Definition at line 436 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiMain\setRequestExpectations().

◆ lacksSameOriginSecurity()

MediaWiki\Api\ApiBase::lacksSameOriginSecurity ( )

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

For example, json with callbacks.

https://en.wikipedia.org/wiki/Same-origin_policy

Since: 1.25

Returns: bool

Reimplemented in MediaWiki\Api\ApiMain.

Definition at line 608 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getMain().

Referenced by MediaWiki\Api\ApiLogin\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), and MediaWiki\Api\ApiQueryTokens\execute().

◆ logFeatureUsage()

MediaWiki\Api\ApiBase::logFeatureUsage ( $feature )

Write logging information for API features to a debug log, for usage analysis.

Note: Consider using $this->addDeprecation() instead to both warn and log.

Parameters

string $feature Feature being used.

Definition at line 1754 of file ApiBase.php.

References MediaWiki\Api\getRequest(), MediaWiki\Api\getUser(), wfDebugLog(), and wfUrlencode().

Referenced by MediaWiki\Api\ApiValidatePassword\execute().

◆ makeMessage()

static MediaWiki\Api\ApiBase::makeMessage	(		$msg,
		IContextSource	$context,
		?array	$params = null )

static

Create a Message from a string or array.

A string is used as a message key. An array has the message key as the first value and message parameters as subsequent values.

Since: 1.25

Deprecated: since 1.43, use ApiBase::msg()

Parameters

string \| array \| Message	$msg
IContextSource	$context
array \| null	$params

Returns: Message|null

Definition at line 1330 of file ApiBase.php.

References wfDeprecated(), and wfMessage().

◆ modifyHelp()

MediaWiki\Api\ApiBase::modifyHelp	(	array &	$help,
		array	$options,
		array &	$tocData )

Called from ApiHelp before the pieces are joined together and returned.

This exists mainly for ApiMain to add the Permissions and Credits sections. Other modules probably don't need it.

Stability: stable: to override

Parameters

string[]	&$help	Array of help data
array	$options	Options passed to ApiHelp::getHelp
array	&$tocData	If a TOC is being generated, this array has keys as anchors in the page and SectionMetadata values.

Reimplemented in MediaWiki\Api\ApiMain.

Definition at line 2168 of file ApiBase.php.

◆ mustBePosted()

MediaWiki\Api\ApiBase::mustBePosted ( )

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

Implementations of this method must always return the same value, regardless of the parameters passed to the constructor or system state.

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Api\ApiAcquireTempUserName, MediaWiki\Api\ApiBlock, MediaWiki\Api\ApiChangeContentModel, MediaWiki\Api\ApiClearHasMsg, MediaWiki\Api\ApiCSPReport, MediaWiki\Api\ApiDelete, MediaWiki\Api\ApiEditPage, MediaWiki\Api\ApiEmailUser, MediaWiki\Api\ApiFileRevert, MediaWiki\Api\ApiImageRotate, MediaWiki\Api\ApiImport, MediaWiki\Api\ApiLogin, MediaWiki\Api\ApiLogout, MediaWiki\Api\ApiManageTags, MediaWiki\Api\ApiMergeHistory, MediaWiki\Api\ApiMove, MediaWiki\Api\ApiOptionsBase, MediaWiki\Api\ApiPatrol, MediaWiki\Api\ApiProtect, MediaWiki\Api\ApiPurge, MediaWiki\Api\ApiRevisionDelete, MediaWiki\Api\ApiRollback, MediaWiki\Api\ApiSetNotificationTimestamp, MediaWiki\Api\ApiSetPageLanguage, MediaWiki\Api\ApiStashEdit, MediaWiki\Api\ApiTag, MediaWiki\Api\ApiUnblock, MediaWiki\Api\ApiUndelete, MediaWiki\Api\ApiUpload, MediaWiki\Api\ApiUserrights, MediaWiki\Api\ApiValidatePassword, and MediaWiki\Api\ApiWatch.

Definition at line 449 of file ApiBase.php.

References MediaWiki\Api\ApiBase\needsToken().

◆ needsToken()

MediaWiki\Api\ApiBase::needsToken ( )

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

Modules are strongly encouraged to use the core 'csrf' type unless they have specialized security needs. If the token type is not one of the core types, you must use the ApiQueryTokensRegisterTypes hook to register it.

Returning a non-falsey value here will force the addition of an appropriate 'token' parameter in self::getFinalParams(). Also, self::mustBePosted() must return true when tokens are used.

In previous versions of MediaWiki, true was a valid return value. Returning true will generate errors indicating that the API module needs updating.

Stability: stable: to override

Returns: string|false

Reimplemented in MediaWiki\Api\ApiAMCreateAccount, MediaWiki\Api\ApiBlock, MediaWiki\Api\ApiChangeAuthenticationData, MediaWiki\Api\ApiChangeContentModel, MediaWiki\Api\ApiClientLogin, MediaWiki\Api\ApiDelete, MediaWiki\Api\ApiEditPage, MediaWiki\Api\ApiEmailUser, MediaWiki\Api\ApiFileRevert, MediaWiki\Api\ApiImageRotate, MediaWiki\Api\ApiImport, MediaWiki\Api\ApiLinkAccount, MediaWiki\Api\ApiLogout, MediaWiki\Api\ApiManageTags, MediaWiki\Api\ApiMergeHistory, MediaWiki\Api\ApiMove, MediaWiki\Api\ApiOptionsBase, MediaWiki\Api\ApiPatrol, MediaWiki\Api\ApiProtect, MediaWiki\Api\ApiRemoveAuthenticationData, MediaWiki\Api\ApiResetPassword, MediaWiki\Api\ApiRevisionDelete, MediaWiki\Api\ApiRollback, MediaWiki\Api\ApiSetNotificationTimestamp, MediaWiki\Api\ApiSetPageLanguage, MediaWiki\Api\ApiStashEdit, MediaWiki\Api\ApiTag, MediaWiki\Api\ApiUnblock, MediaWiki\Api\ApiUndelete, MediaWiki\Api\ApiUpload, MediaWiki\Api\ApiUserrights, and MediaWiki\Api\ApiWatch.

Definition at line 496 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiBase\mustBePosted().

◆ parseContinueParamOrDie()

MediaWiki\Api\ApiBase::parseContinueParamOrDie	(	string	$continue,
		array	$types )

protected

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.

Parameters

string	$continue	Value of 'continue' parameter obtained from extractRequestParams()
string[]	$types	Types of the expected parts in order, 'string', 'int' or 'timestamp'

Returns: mixed[] Array containing strings, integers or timestamps

Exceptions

ApiUsageException

Since: 1.40

Definition at line 1691 of file ApiBase.php.

References MediaWiki\Api\getDB().

◆ recordUnifiedMetrics()

MediaWiki\Api\ApiBase::recordUnifiedMetrics	(		$latency = 0,
			$detailLabels = [] )

protected

Record unified metrics for the API.

Parameters

float	$latency	Optional value for process runtime, in microseconds, for metrics
array	$detailLabels	Additional or override labels for the metrics

Definition at line 2183 of file ApiBase.php.

References $path, and MediaWiki\Api\getRequest().

◆ requireAtLeastOneParameter()

MediaWiki\Api\ApiBase::requireAtLeastOneParameter	(		$params,
			$required )

Die if 0 of a certain set of parameters is set and not false.

Since: 1.23

Parameters

array	$params	User provided parameters set, as from $this->extractRequestParams()
	string	...$required Names of parameters of which at least one must be set

Definition at line 1024 of file ApiBase.php.

References MediaWiki\Message\Message\listParam().

Referenced by MediaWiki\Api\ApiAMCreateAccount\execute(), MediaWiki\Api\ApiClientLogin\execute(), MediaWiki\Api\ApiComparePages\execute(), MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiLinkAccount\execute(), MediaWiki\Api\ApiQueryStashImageInfo\execute(), and MediaWiki\Api\ApiTag\execute().

◆ requireMaxOneParameter()

MediaWiki\Api\ApiBase::requireMaxOneParameter	(		$params,
			$required )

Dies if more than one parameter from a certain set of parameters are set and not false.

Parameters

array	$params	User provided parameters set, as from $this->extractRequestParams()
	string	...$required Parameter names that cannot have more than one set

Definition at line 997 of file ApiBase.php.

References MediaWiki\Message\Message\listParam().

◆ requireNoConflictingParameters()

MediaWiki\Api\ApiBase::requireNoConflictingParameters	(	$params,
		$trigger,
		$conflicts )

Die with an "invalid param mix" error if the parameters contain the trigger parameter and any of the conflicting parameters.

Since: 1.44

Parameters

array	$params	User provided parameters set, as from $this->extractRequestParams()
string	$trigger	The name of the trigger parameter
string \| string[]	$conflicts	The conflicting parameter or a list of conflicting parameters

Definition at line 1055 of file ApiBase.php.

References MediaWiki\Message\Message\listParam().

Referenced by MediaWiki\Api\ApiBlock\execute().

◆ requireOnlyOneParameter()

MediaWiki\Api\ApiBase::requireOnlyOneParameter	(		$params,
			$required )

Die if 0 or more than one of a certain set of parameters is set and not false.

Parameters

array	$params	User provided parameter set, as from $this->extractRequestParams()
	string	...$required Names of parameters of which exactly one must be set

Definition at line 960 of file ApiBase.php.

References MediaWiki\Message\Message\listParam().

Referenced by MediaWiki\Api\ApiBlock\execute(), MediaWiki\Api\ApiMergeHistory\execute(), MediaWiki\Api\ApiMove\execute(), MediaWiki\Api\ApiPatrol\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), MediaWiki\Api\ApiStashEdit\execute(), and MediaWiki\Api\ApiUnblock\execute().

◆ requirePostedParameters()

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

Since: 1.28

Parameters

string[]	$params	Parameters to check
string	$prefix	Set to 'noprefix' to skip calling $this->encodeParamName()

Definition at line 1086 of file ApiBase.php.

References MediaWiki\MainConfigNames\DebugAPI, MediaWiki\Api\getRequest(), and wfDeprecatedMsg().

Referenced by MediaWiki\Api\ApiLogin\execute(), and MediaWiki\Api\ApiValidatePassword\execute().

◆ setContinuationManager()

MediaWiki\Api\ApiBase::setContinuationManager ( ?ApiContinuationManager $manager = null )

Parameters

ApiContinuationManager | null $manager

Reimplemented in MediaWiki\Api\ApiMain.

Definition at line 728 of file ApiBase.php.

References MediaWiki\Api\ApiBase\getMain().

Referenced by MediaWiki\Api\ApiImageRotate\execute(), MediaWiki\Api\ApiPurge\execute(), MediaWiki\Api\ApiQuery\execute(), MediaWiki\Api\ApiSetNotificationTimestamp\execute(), and MediaWiki\Api\ApiWatch\execute().

◆ shouldCheckMaxlag()

MediaWiki\Api\ApiBase::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Stability: stable: to override

Returns: bool

Reimplemented in MediaWiki\Api\ApiHelp, and MediaWiki\Api\ApiQueryCodexIcons.

Definition at line 397 of file ApiBase.php.

◆ useTransactionalTimeLimit()

MediaWiki\Api\ApiBase::useTransactionalTimeLimit ( )

protected

Call wfTransactionalTimeLimit() if this request was POSTed.

Since: 1.26

Definition at line 1354 of file ApiBase.php.

References MediaWiki\Api\getRequest(), and wfTransactionalTimeLimit().

Referenced by MediaWiki\Api\ApiDelete\execute(), MediaWiki\Api\ApiEditPage\execute(), MediaWiki\Api\ApiFileRevert\execute(), MediaWiki\Api\ApiImageRotate\execute(), MediaWiki\Api\ApiImport\execute(), MediaWiki\Api\ApiMergeHistory\execute(), MediaWiki\Api\ApiMove\execute(), MediaWiki\Api\ApiRevisionDelete\execute(), MediaWiki\Api\ApiRollback\execute(), MediaWiki\Api\ApiSetPageLanguage\execute(), MediaWiki\Api\ApiUndelete\execute(), and MediaWiki\Api\ApiUpload\execute().

◆ validateToken()

MediaWiki\Api\ApiBase::validateToken	(		$token,
		array	$params )

final

Validate the supplied token.

Since: 1.24

Parameters

string	$token	Supplied token
array	$params	All supplied parameters for the module

Returns: bool

Definition at line 1256 of file ApiBase.php.

References MediaWiki\Api\getRequest(), MediaWiki\Api\ApiQueryTokens\getToken(), MediaWiki\Api\ApiQueryTokens\getTokenTypeSalts(), and MediaWiki\Api\getUser().

Member Data Documentation

◆ ALL_DEFAULT_STRING

const MediaWiki\Api\ApiBase::ALL_DEFAULT_STRING = '*'

(string|array|Message) Specify an alternative i18n documentation message for this parameter.

Default is apihelp-{$path}-param-{$param}. See Message::newFromSpecifier() for a description of allowed values.

Since: 1.25

Definition at line 228 of file ApiBase.php.

◆ GET_VALUES_FOR_HELP

const MediaWiki\Api\ApiBase::GET_VALUES_FOR_HELP = 1

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

E.g. get the list of generators for ApiSandBox extension

Since: 1.21

Definition at line 244 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiQueryAllUsers\getAllowedParams(), MediaWiki\Api\ApiQueryContributors\getAllowedParams(), MediaWiki\Api\ApiQueryLogEvents\getAllowedParams(), and MediaWiki\Api\ApiUserrights\getAllowedParams().

◆ LIMIT_BIG1

const MediaWiki\Api\ApiBase::LIMIT_BIG1 = 500

Fast query, standard limit.

Definition at line 231 of file ApiBase.php.

◆ LIMIT_BIG2

const MediaWiki\Api\ApiBase::LIMIT_BIG2 = 5000

Fast query, apihighlimits limit.

Definition at line 233 of file ApiBase.php.

◆ LIMIT_SML1

const MediaWiki\Api\ApiBase::LIMIT_SML1 = 50

Slow query, standard limit.

Definition at line 235 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\__construct(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryDeletedrevs\getAllowedParams(), and MediaWiki\Api\ApiQueryRevisionsBase\parseParameters().

◆ LIMIT_SML2

const MediaWiki\Api\ApiBase::LIMIT_SML2 = 500

Slow query, apihighlimits limit.

Definition at line 237 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\__construct(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryDeletedrevs\getAllowedParams(), and MediaWiki\Api\ApiQueryRevisionsBase\parseParameters().

◆ PARAM_ALL

const MediaWiki\Api\ApiBase::PARAM_ALL = ParamValidator::PARAM_ALL

Deprecated: since 1.35, use ParamValidator::PARAM_ALL instead

Definition at line 120 of file ApiBase.php.

◆ PARAM_ALLOW_DUPLICATES

const MediaWiki\Api\ApiBase::PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES

Deprecated: since 1.35, use ParamValidator::PARAM_ALLOW_DUPLICATES instead

Definition at line 100 of file ApiBase.php.

◆ PARAM_DEPRECATED

const MediaWiki\Api\ApiBase::PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED

Deprecated: since 1.35, use ParamValidator::PARAM_DEPRECATED instead

Definition at line 104 of file ApiBase.php.

◆ PARAM_DEPRECATED_VALUES

const MediaWiki\Api\ApiBase::PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES

Deprecated: since 1.35, use EnumDef::PARAM_DEPRECATED_VALUES instead

Definition at line 132 of file ApiBase.php.

◆ PARAM_DFLT

const MediaWiki\Api\ApiBase::PARAM_DFLT = ParamValidator::PARAM_DEFAULT

Deprecated: since 1.35, use ParamValidator::PARAM_DEFAULT instead

Definition at line 76 of file ApiBase.php.

◆ PARAM_EXTRA_NAMESPACES

const MediaWiki\Api\ApiBase::PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES

Deprecated: since 1.35, use NamespaceDef::PARAM_EXTRA_NAMESPACES instead

Definition at line 124 of file ApiBase.php.

◆ PARAM_HELP_MSG

const MediaWiki\Api\ApiBase::PARAM_HELP_MSG = 'api-param-help-msg'

(string|array|Message) Specify an alternative i18n documentation message for this parameter.

Default is apihelp-{$path}-param-{$param}. See Message::newFromSpecifier() for a description of allowed values.

Since: 1.25

Definition at line 166 of file ApiBase.php.

◆ PARAM_HELP_MSG_APPEND

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

See Message::newFromSpecifier() for a description of allowed values.

Since: 1.25

Definition at line 174 of file ApiBase.php.

◆ PARAM_HELP_MSG_INFO

const MediaWiki\Api\ApiBase::PARAM_HELP_MSG_INFO = 'api-param-help-msg-info'

(array) Specify additional information tags for the parameter.

The value is an array of arrays, with the first member being the 'tag' for the info and the remaining members being the values. In the help, this is formatted using apihelp-{$path}-paraminfo-{$tag}, which is passed $1 = count, $2 = comma-joined list of values, $3 = module prefix.

Since: 1.25

Definition at line 184 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiQueryAllDeletedRevisions\getAllowedParams(), MediaWiki\Api\ApiQueryDeletedrevs\getAllowedParams(), MediaWiki\Api\ApiQueryInfo\getAllowedParams(), and MediaWiki\Api\ApiQueryRevisions\getAllowedParams().

◆ PARAM_HELP_MSG_PER_VALUE

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

See Message::newFromSpecifier() for a description of allowed values.

When PARAM_TYPE is an array, any value not having a mapping will use the apihelp-{$path}-paramvalue-{$param}-{$value} message. (This means you can use an empty array to use the default message key for all values.)

Since: 1.25

Note: Use with PARAM_TYPE = 'string' is allowed since 1.40.

Definition at line 206 of file ApiBase.php.

◆ PARAM_ISMULTI

const MediaWiki\Api\ApiBase::PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI

Deprecated: since 1.35, use ParamValidator::PARAM_ISMULTI instead

Definition at line 80 of file ApiBase.php.

◆ PARAM_ISMULTI_LIMIT1

const MediaWiki\Api\ApiBase::PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1

Deprecated: since 1.35, use ParamValidator::PARAM_ISMULTI_LIMIT1 instead

Definition at line 136 of file ApiBase.php.

◆ PARAM_ISMULTI_LIMIT2

const MediaWiki\Api\ApiBase::PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2

Deprecated: since 1.35, use ParamValidator::PARAM_ISMULTI_LIMIT2 instead

Definition at line 140 of file ApiBase.php.

◆ PARAM_MAX

const MediaWiki\Api\ApiBase::PARAM_MAX = IntegerDef::PARAM_MAX

Deprecated: since 1.35, use IntegerDef::PARAM_MAX instead

Definition at line 88 of file ApiBase.php.

◆ PARAM_MAX2

const MediaWiki\Api\ApiBase::PARAM_MAX2 = IntegerDef::PARAM_MAX2

Deprecated: since 1.35, use IntegerDef::PARAM_MAX2 instead

Definition at line 92 of file ApiBase.php.

◆ PARAM_MAX_BYTES

const MediaWiki\Api\ApiBase::PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES

Deprecated: since 1.35, use StringDef::PARAM_MAX_BYTES instead

Definition at line 144 of file ApiBase.php.

◆ PARAM_MAX_CHARS

const MediaWiki\Api\ApiBase::PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS

Deprecated: since 1.35, use StringDef::PARAM_MAX_CHARS instead

Definition at line 148 of file ApiBase.php.

◆ PARAM_MIN

const MediaWiki\Api\ApiBase::PARAM_MIN = IntegerDef::PARAM_MIN

Deprecated: since 1.35, use IntegerDef::PARAM_MIN instead

Definition at line 96 of file ApiBase.php.

◆ PARAM_RANGE_ENFORCE

const MediaWiki\Api\ApiBase::PARAM_RANGE_ENFORCE = 'api-param-range-enforce'

(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

Deprecated: since 1.35

Definition at line 155 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiEditPage\getAllowedParams().

◆ PARAM_REQUIRED

const MediaWiki\Api\ApiBase::PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED

Deprecated: since 1.35, use ParamValidator::PARAM_REQUIRED instead

Definition at line 108 of file ApiBase.php.

◆ PARAM_SENSITIVE

const MediaWiki\Api\ApiBase::PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE

Deprecated: since 1.35, use ParamValidator::PARAM_SENSITIVE instead

Definition at line 128 of file ApiBase.php.

◆ PARAM_SUBMODULE_MAP

const MediaWiki\Api\ApiBase::PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP

Deprecated: since 1.35, use SubmoduleDef::PARAM_SUBMODULE_MAP instead

Definition at line 112 of file ApiBase.php.

◆ PARAM_SUBMODULE_PARAM_PREFIX

const MediaWiki\Api\ApiBase::PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX

Deprecated: since 1.35, use SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX instead

Definition at line 116 of file ApiBase.php.

◆ PARAM_TEMPLATE_VARS

const MediaWiki\Api\ApiBase::PARAM_TEMPLATE_VARS = 'param-template-vars'

(array) Indicate that this is a templated parameter, and specify replacements.

Keys are the placeholders in the parameter name and values are the names of (unprefixed) parameters from which the replacement values are taken.

For example, a parameter "foo-{ns}-{title}" could be defined with PARAM_TEMPLATE_VARS => [ 'ns' => 'namespaces', 'title' => 'titles' ]. Then a query for namespaces=0|1&titles=X|Y would support parameters foo-0-X, foo-0-Y, foo-1-X, and foo-1-Y.

All placeholders must be present in the parameter's name. Each target parameter must have PARAM_ISMULTI true. If a target is itself a templated parameter, its PARAM_TEMPLATE_VARS must be a subset of the referring parameter's, mapping the same placeholders to the same targets. A parameter cannot target itself.

Since: 1.32

Definition at line 224 of file ApiBase.php.

Referenced by MediaWiki\Api\ApiComparePages\getAllowedParams().

◆ PARAM_TYPE

const MediaWiki\Api\ApiBase::PARAM_TYPE = ParamValidator::PARAM_TYPE

Deprecated: since 1.35, use ParamValidator::PARAM_TYPE instead

Definition at line 84 of file ApiBase.php.

◆ PARAM_VALUE_LINKS

const MediaWiki\Api\ApiBase::PARAM_VALUE_LINKS = 'api-param-value-links'

Deprecated and unused.

Since: 1.25

Deprecated: since 1.35

Definition at line 191 of file ApiBase.php.

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

includes/Api/ApiBase.php

Public Attributes

Protected Member Functions

API-specific constants for ::getAllowedParams() arrays

Methods to implement

Data access methods

Parameter handling

Utility methods

Warning and error reporting

Help message generation

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ addDeprecation()

◆ addError()

◆ addMessagesFromStatus()

◆ addWarning()

◆ checkTitleUserPermissions()

◆ checkUserRightsAny()

◆ clearCacheForTest()

◆ dieBlocked()

◆ dieContinueUsageIf()

◆ dieDebug()

◆ dieReadOnly()

◆ dieStatus()

◆ dieWithError()

◆ dieWithErrorOrDebug()

◆ dieWithException()

◆ dynamicParameterDocumentation()

◆ encodeParamName()

◆ execute()

◆ extractRequestParams()

◆ filterIDs()

◆ getAllowedParams()

◆ getConditionalRequestData()

◆ getContinuationManager()

◆ getCustomPrinter()

◆ getDB()

◆ getErrorFormatter()

◆ getExamplesMessages()

◆ getExtendedDescription()

◆ getFinalDescription()

◆ getFinalParamDescription()

◆ getFinalParams()

◆ getFinalSummary()

◆ getHelpFlags()

◆ getHelpUrls()

◆ getHookContainer()

◆ getHookRunner()

◆ getMain()

◆ getModuleFromPath()

◆ getModuleManager()

◆ getModuleName()

◆ getModulePath()

◆ getModulePrefix()

◆ getModuleSourceInfo()

◆ getParameter()

◆ getParameterFromSettings()

◆ getParent()

◆ getPermissionManager()

◆ getResult()

◆ getSummaryMessage()

◆ getTitleFromTitleOrPageId()

◆ getTitleOrPageId()

◆ getWatchlistUser()

◆ getWebUITokenSalt()

◆ handleParamNormalization()

◆ isDeprecated()

◆ isInternal()

◆ isMain()

◆ isReadMode()

◆ isWriteMode()

◆ lacksSameOriginSecurity()

◆ logFeatureUsage()

◆ makeMessage()

◆ modifyHelp()

◆ mustBePosted()

◆ needsToken()

◆ parseContinueParamOrDie()