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

Inheritance diagram for ApiBase:

[legend]

Collaboration diagram for ApiBase:

[legend]

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

Old constants for ::getAllowedParams() arrays
Deprecated: since 1.35, use the equivalent ParamValidator or TypeDef constants instead.
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

Private Attributes
HookContainer	$hookContainer

ApiHookRunner	$hookRunner

API-specific constants for ::getAllowedParams() arrays
ApiMain	$mMainModule
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. More...

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

	$mReplicaDB = null
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. More...

array	$mParamCache = []
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. More...

array null false	$mModuleSource = false
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. More...

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

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

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

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

const	PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value'
	((string\|array\|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More...

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

const	ALL_DEFAULT_STRING = '*'
	(string\|array\|Message) Specify an alternative i18n documentation message for this parameter. 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	GET_VALUES_FOR_HELP = 1
	getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...

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

static array	$extensionInfo = null
	Maps extension paths to info arrays. More...

static stdClass[][]	$filterIDsCache = []
	Cache for self::filterIDs() More...

static array	$blockMsgMap
	Map of web UI block messages to corresponding API messages and codes. More...

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

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

	getHelpUrls ()
	Return links to more detailed help pages about the module. 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...

	getExamplesMessages ()
	Returns usage examples for this module. 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...

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

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

	getContinuationManager ()

	setContinuationManager (ApiContinuationManager $manager=null)

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

	getPermissionManager ()
	Obtain a PermissionManager instance that subclasses may use in their authorization checks. More...

	getHookContainer ()
	Get a HookContainer, for running extension hooks or for hook metadata. More...

	getHookRunner ()
	Get an ApiHookRunner for running core API hooks. More...

	dieIfMain (string $methodName)
	Used to avoid infinite loops - the ApiMain class should override some methods, if it doesn't and uses the default ApiBase implementation, which just calls the same method for the ApiMain instance, it'll lead to an infinite loop. More...

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

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

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

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

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

	parameterNotEmpty ( $x)
	Callback function used in requireOnlyOneParameter to check whether required parameters are set. More...

Utility methods
	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, Authority $user=null)
	Add block info to block messages in a Status. 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...

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

Warning and error reporting
	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 (Throwable $exception, array $options=[])
	Abort execution with an error derived from a throwable. 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 ( $pageIdentity, $actions, array $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...

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

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

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

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

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

	getAuthority ()

	getConfig ()

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

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

	getLanguage ()

	getOutput ()

	getRequest ()

	getSkin ()

	getStats ()

	getTiming ()

	getTitle ()

	getUser ()

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

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

	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 55 of file ApiBase.php.

Constructor & Destructor Documentation

◆ __construct()

ApiBase::__construct	(	ApiMain	$mainModule,
			$moduleName,
			$modulePrefix = `''`
	)

Stability: stable: to call

Parameters

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

Reimplemented in ApiOpenSearchFormatJson.

Definition at line 211 of file ApiBase.php.

References ContextSource\getContext(), isMain(), and ContextSource\setContext().

Member Function Documentation

◆ addBlockInfoToStatus()

ApiBase::addBlockInfoToStatus	(	StatusValue	$status,
		Authority	$user = `null`
	)

Add block info to block messages in a Status.

Since: 1.33

Access: internal: since 1.37, should become protected in the future.

Parameters

StatusValue	$status
Authority \| null	$user

Definition at line 1209 of file ApiBase.php.

References ApiMessage\create(), ContextSource\getAuthority(), StatusValue\hasMessage(), and StatusValue\replaceMessage().

Referenced by dieStatus(), and ApiQueryInfo\extractPageInfo().

◆ addDeprecation()

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 \| Message	$msg	See ApiErrorFormatter::addWarning()
string \| null	$feature	See ApiBase::logFeatureUsage()
array \| null	$data	See ApiErrorFormatter::addWarning()

Definition at line 1307 of file ApiBase.php.

References addWarning(), getHookRunner(), getMain(), logFeatureUsage(), and ContextSource\msg().

Referenced by ApiExpandTemplates\execute(), ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiTokens\execute(), ApiQueryRevisionsBase\parseParameters(), and ApiMain\setupExternalResponse().

◆ addError()

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 \| Message	$msg	See ApiErrorFormatter::addError()
string \| null	$code	See ApiErrorFormatter::addError()
array \| null	$data	See ApiErrorFormatter::addError()

Definition at line 1340 of file ApiBase.php.

References getErrorFormatter(), and getModulePath().

◆ addMessagesFromStatus()

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 1353 of file ApiBase.php.

References getErrorFormatter(), and getModulePath().

Referenced by ApiDelete\execute().

◆ addWarning()

ApiBase::addWarning	(	$msg,
		$code = `null`,
		$data = `null`
	)

Add a warning for this module.

Users should monitor this section to notice any changes in 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 \| Message	$msg	See ApiErrorFormatter::addWarning()
string \| null	$code	See ApiErrorFormatter::addWarning()
array \| null	$data	See ApiErrorFormatter::addWarning()

Definition at line 1293 of file ApiBase.php.

References getErrorFormatter(), and getModulePath().

Referenced by addDeprecation(), ApiFormatXml\addXslt(), dieWithErrorOrDebug(), ApiCheckToken\execute(), ApiComparePages\execute(), ApiExpandTemplates\execute(), ApiOptions\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiPurge\execute(), ApiQueryDisabled\execute(), ApiQueryLanguageinfo\execute(), ApiQueryTokens\execute(), ApiQueryUsers\execute(), ApiTokens\execute(), ApiPageSet\executeInternal(), ApiQueryRevisionsBase\extractDeprecatedContent(), ApiQueryInfo\extractPageInfo(), extractRequestParams(), ApiQueryRecentChanges\extractRowInfo(), ApiComparePages\getDiffRevision(), ApiMain\getVal(), ApiMain\handleException(), handleParamNormalization(), ApiQueryImageInfo\mergeThumbParams(), ApiQueryRevisionsBase\parseParameters(), ApiMain\printResult(), ApiMain\reportUnusedParams(), ApiQueryCategories\run(), ApiQueryImages\run(), ApiQueryLinks\run(), ApiQueryAllDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ checkTitleUserPermissions()

ApiBase::checkTitleUserPermissions	(		$pageIdentity,
			$actions,
		array	$options = `[]`
	)

Helper function for permission-denied errors.

Parameters

PageIdentity \| LinkTarget	$pageIdentity	deprecated passing LinkTarget since 1.36
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 of the 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 1502 of file ApiBase.php.

References Title\castFromLinkTarget(), dieStatus(), ContextSource\getAuthority(), ContextSource\getUser(), isWriteMode(), and wfDeprecatedMsg().

Referenced by ApiDelete\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiParse\execute(), ApiProtect\execute(), and ApiSetPageLanguage\execute().

◆ checkUserRightsAny()

ApiBase::checkUserRightsAny	(	$rights,
		$user = `null`
	)

Helper function for permission-denied errors.

Since: 1.29

Parameters

string \| string[]	$rights
User \| null	$user	deprecated since 1.36

Exceptions

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

Definition at line 1476 of file ApiBase.php.

References dieWithError(), ContextSource\getAuthority(), ContextSource\msg(), and wfDeprecatedMsg().

Referenced by ApiBlock\execute(), ApiChangeContentModel\execute(), ApiOptions\execute(), ApiQueryDeletedrevs\execute(), ApiRevisionDelete\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiWatch\execute(), and getWatchlistUser().

◆ dieBlocked()

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

Definition at line 1401 of file ApiBase.php.

References dieWithError(), MediaWiki\Block\Block\getType(), and MediaWiki\Block\Block\isSitewide().

Referenced by ApiUpload\checkPermissions(), ApiEditPage\execute(), ApiPurge\execute(), ApiRevisionDelete\execute(), ApiTag\execute(), ApiUndelete\execute(), and ApiUserrights\execute().

◆ dieContinueUsageIf()

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 1557 of file ApiBase.php.

References dieWithError().

◆ dieDebug()

static 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

Exceptions

MWException always

Definition at line 1569 of file ApiBase.php.

Referenced by ApiQueryLinks\__construct(), ApiQueryAllLinks\__construct(), ApiQueryBase\addJoinConds(), ApiQueryBase\addTables(), dieIfMain(), ApiFormatFeedWrapper\execute(), ApiFormatJson\execute(), ApiFormatPhp\execute(), ApiFormatRaw\execute(), ApiLogin\execute(), ApiQueryAllUsers\execute(), ApiQuerySiteinfo\execute(), ApiUpload\execute(), ApiOpenSearch\getCustomPrinter(), getFinalParamDescription(), ApiFormatRaw\getMimeType(), ApiQueryQueryPage\getSpecialPage(), ApiPageSet\initFromQueryResult(), ApiFormatFeedWrapper\initPrinter(), ApiQuery\instantiateModules(), ApiOpenSearch\populateResult(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ dieIfMain()

ApiBase::dieIfMain ( string $methodName )

private

Used to avoid infinite loops - the ApiMain class should override some methods, if it doesn't and uses the default ApiBase implementation, which just calls the same method for the ApiMain instance, it'll lead to an infinite loop.

Parameters

string $methodName used for debug messages

Definition at line 486 of file ApiBase.php.

References dieDebug(), and isMain().

Referenced by getContinuationManager(), getErrorFormatter(), getResult(), lacksSameOriginSecurity(), and setContinuationManager().

◆ dieReadOnly()

ApiBase::dieReadOnly ( )

Helper function for readonly errors.

Exceptions

ApiUsageException always

Definition at line 1460 of file ApiBase.php.

References dieWithError(), and wfReadOnlyReason().

Referenced by ApiMain\checkReadOnly(), and ApiEditPage\execute().

◆ dieStatus()

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

Definition at line 1432 of file ApiBase.php.

References addBlockInfoToStatus(), StatusValue\getErrorsByType(), StatusValue\isGood(), StatusValue\newGood(), and StatusValue\setOK().

Referenced by ApiUpload\checkPermissions(), checkTitleUserPermissions(), ApiUpload\dieRecoverableError(), ApiUpload\dieStatusWithCode(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiChangeContentModel\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiUserrights\getUrUser(), ApiUpload\performStash(), ApiUpload\performUpload(), ApiQuerySearch\run(), ApiQueryRevisions\run(), and ApiWatch\watchTitle().

◆ dieWithError()

ApiBase::dieWithError	(	$msg,
		$code = `null`,
		$data = `null`,
		$httpCode = `null`
	)

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 \| Message	$msg	See ApiErrorFormatter::addError()
string \| null	$code	See ApiErrorFormatter::addError()
array \| null	$data	See ApiErrorFormatter::addError()
int \| null	$httpCode	HTTP error code to use

Exceptions

ApiUsageException always

Definition at line 1374 of file ApiBase.php.

References ApiUsageException\newWithMessage().

◆ dieWithErrorOrDebug()

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 behaves exactly as self::dieWithError().

Since: 1.29

Parameters

string \| array \| Message	$msg
string \| null	$code
array \| null	$data
int \| null	$httpCode

Exceptions

ApiUsageException

Definition at line 1539 of file ApiBase.php.

References addWarning(), dieWithError(), and ContextSource\getConfig().

Referenced by ApiQuery\instantiateModules(), and ApiMain\setupExternalResponse().

◆ dieWithException()

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

Definition at line 1386 of file ApiBase.php.

References dieWithError(), and getErrorFormatter().

Referenced by ApiEditPage\execute(), ApiImport\execute(), ApiParse\execute(), ApiQueryStashImageInfo\execute(), ApiStashEdit\execute(), and ApiComparePages\getDiffRevision().

◆ dynamicParameterDocumentation()

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.

Reimplemented in ApiLinkAccount, ApiClientLogin, ApiChangeAuthenticationData, and ApiAMCreateAccount.

Definition at line 674 of file ApiBase.php.

◆ encodeParamName()

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

Definition at line 685 of file ApiBase.php.

Referenced by ApiContinuationManager\addContinueParam(), ApiContinuationManager\addGeneratorContinueParam(), ApiContinuationManager\addGeneratorNonContinueParam(), MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiAMCreateAccount\execute(), ApiClientLogin\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiQueryAllMessages\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLanguageinfo\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiSetNotificationTimestamp\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiPageSet\executeInternal(), extractRequestParams(), MediaWiki\Api\Validator\ApiParamValidator\getHelpInfo(), getParameterFromSettings(), MediaWiki\Api\Validator\ApiParamValidator\getParamInfo(), MediaWiki\Api\Validator\ApiParamValidator\getValue(), ApiQueryBlocks\prepareUsername(), requireAtLeastOneParameter(), requireMaxOneParameter(), requireOnlyOneParameter(), requirePostedParameters(), and MediaWiki\Api\Validator\ApiParamValidator\validateValue().

◆ errorArrayToStatus()

ApiBase::errorArrayToStatus	(	array	$errors,
		User	$user = `null`
	)

Turn an array of message keys or key+param arrays into a Status.

Since: 1.29

Parameters

array	$errors
User \| null	$user

Returns: Status

Definition at line 1180 of file ApiBase.php.

References ApiMessage\create(), ContextSource\getUser(), and StatusValue\newGood().

Referenced by ApiPatrol\execute().

◆ execute()

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

Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTokens, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRsd, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisionsBase, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLogEvents, ApiQueryLinks, ApiQueryLanguageinfo, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDisabled, ApiQueryDeletedrevs, ApiQueryContributors, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllUsers, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllCategories, ApiQuery, ApiPurge, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiPageSet, ApiOptions, ApiOpenSearchFormatJson, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiMain, ApiLogout, ApiLogin, ApiLinkAccount, ApiImport, ApiImageRotate, ApiHelp, ApiFormatXml, ApiFormatRaw, ApiFormatPhp, ApiFormatNone, ApiFormatJson, ApiFormatFeedWrapper, ApiFileRevert, ApiFeedWatchlist, ApiFeedRecentChanges, ApiFeedContributions, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDisabled, ApiDelete, ApiCSPReport, ApiComparePages, ApiClientLogin, ApiClearHasMsg, ApiCheckToken, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.

◆ extractRequestParams()

ApiBase::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.

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 707 of file ApiBase.php.

References addWarning(), encodeParamName(), getFinalParams(), getParameterFromSettings(), PARAM_TEMPLATE_VARS, and wfEscapeWikiText().

◆ filterIDs()

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 pairs of table and field to check
	(string\|int)[]	$ids IDs to filter. Strings in the array are expected to be stringified ints.

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

Definition at line 1246 of file ApiBase.php.

References getDB().

Referenced by ApiQueryBase\addWhereIDsFld(), ApiPageSet\initFromPageIds(), and ApiPageSet\initFromRevIDs().

◆ getAllowedParams()

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

Reimplemented in ApiValidatePassword, ApiUpload, ApiUndelete, ApiUnblock, ApiTokens, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisionsBase, ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLinks, ApiQueryLanguageinfo, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDisabled, ApiQueryDeletedrevs, ApiQueryDeletedRevisions, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllRevisions, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllDeletedRevisions, ApiQueryAllCategories, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiOptions, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiMain, ApiLogin, ApiLinkAccount, ApiImport, ApiHelp, ApiFormatXml, ApiFormatPhp, ApiFormatJson, ApiFormatBase, ApiFileRevert, ApiFeedRecentChanges, ApiFeedContributions, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDelete, ApiCSPReport, ApiComparePages, ApiClientLogin, ApiCheckToken, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.

Definition at line 306 of file ApiBase.php.

Referenced by getFinalParams().

◆ getConditionalRequestData()

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 426 of file ApiBase.php.

◆ getContinuationManager()

ApiBase::getContinuationManager ( )

Returns: ApiContinuationManager|null

Reimplemented in ApiMain.

Definition at line 605 of file ApiBase.php.

References dieIfMain(), and getMain().

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

◆ getCustomPrinter()

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: mixed Instance of a derived class of ApiFormatBase, or null

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

Definition at line 263 of file ApiBase.php.

◆ getDB()

ApiBase::getDB ( )

protected

Gets a default replica DB connection object.

Stability: stable: to override

Returns: IDatabase

Reimplemented in ApiQueryBase, ApiQueryAllImages, and ApiPageSet.

Definition at line 594 of file ApiBase.php.

References $mReplicaDB, DB_REPLICA, and wfGetDB().

Referenced by ApiQuery\doExport(), filterIDs(), ApiParse\formatCategoryLinks(), ApiComparePages\getRevisionById(), and ApiOpenSearch\search().

◆ getErrorFormatter()

ApiBase::getErrorFormatter ( )

Stability: stable: to override

Returns: ApiErrorFormatter

Reimplemented in ApiMain.

Definition at line 582 of file ApiBase.php.

References dieIfMain(), and getMain().

Referenced by addError(), addMessagesFromStatus(), addWarning(), dieWithException(), ApiChangeContentModel\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiProtect\execute(), ApiQueryUsers\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiValidatePassword\execute(), ApiQueryInfo\extractPageInfo(), ApiRevisionDelete\extractStatusInfo(), ApiLogin\formatMessage(), ApiUpload\handleStashException(), ApiMove\moveSubpages(), ApiUpload\performStash(), ApiTag\processIndividual(), ApiPageSet\processTitlesArray(), and ApiWatch\watchTitle().

◆ getExamplesMessages()

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

Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTokens, ApiTag, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRsd, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLogEvents, ApiQueryLinks, ApiQueryLanguageinfo, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDeletedrevs, ApiQueryDeletedRevisions, ApiQueryContributors, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllUsers, ApiQueryAllRevisions, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllDeletedRevisions, ApiQueryAllCategories, ApiQuery, ApiPurge, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiOptions, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiMain, ApiLogout, ApiLogin, ApiLinkAccount, ApiImport, ApiImageRotate, ApiHelp, ApiFormatBase, ApiFileRevert, ApiFeedWatchlist, ApiFeedRecentChanges, ApiFeedContributions, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDelete, ApiComparePages, ApiClientLogin, ApiClearHasMsg, ApiCheckToken, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.

Definition at line 279 of file ApiBase.php.

◆ getExtendedDescription()

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

Reimplemented in ApiSetPageLanguage, ApiResetPassword, ApiQueryDisabled, ApiLogin, and ApiDisabled.

Definition at line 1639 of file ApiBase.php.

Referenced by getFinalDescription().

◆ getFinalDescription()

ApiBase::getFinalDescription ( )

Get 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 ApiLinkAccount, ApiClientLogin, and ApiAMCreateAccount.

Definition at line 1669 of file ApiBase.php.

References ContextSource\getContext(), getExtendedDescription(), getHookRunner(), getModuleName(), getModulePath(), getModulePrefix(), getSummaryMessage(), and makeMessage().

◆ getFinalParamDescription()

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 1729 of file ApiBase.php.

References $path, dieDebug(), ContextSource\getContext(), getFinalParams(), getHookRunner(), getModuleFromPath(), getModuleManager(), getModuleName(), getModulePath(), getModulePrefix(), isMain(), makeMessage(), ContextSource\msg(), PARAM_DEPRECATED_VALUES, PARAM_HELP_MSG, PARAM_HELP_MSG_PER_VALUE, and PARAM_SUBMODULE_MAP.

◆ getFinalParams()

ApiBase::getFinalParams ( $flags = 0 )

Get 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 1698 of file ApiBase.php.

References getAllowedParams(), getHookRunner(), and needsToken().

Referenced by extractRequestParams(), and getFinalParamDescription().

◆ getFinalSummary()

ApiBase::getFinalSummary ( )

Get final module summary.

Since: 1.30

Stability: stable: to override

Returns: Message

Definition at line 1653 of file ApiBase.php.

References ContextSource\getContext(), getModuleName(), getModulePath(), getModulePrefix(), getSummaryMessage(), and makeMessage().

◆ getHelpFlags()

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

Definition at line 1875 of file ApiBase.php.

References isDeprecated(), isInternal(), isReadMode(), isWriteMode(), and mustBePosted().

◆ getHelpUrls()

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

Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTag, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLogEvents, ApiQueryLinks, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDeletedrevs, ApiQueryDeletedRevisions, ApiQueryContributors, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllUsers, ApiQueryAllRevisions, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllDeletedRevisions, ApiQueryAllCategories, ApiQuery, ApiPurge, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiOptions, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiLogout, ApiLogin, ApiLinkAccount, ApiImport, ApiHelp, ApiFormatBase, ApiFeedWatchlist, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDelete, ApiClientLogin, ApiClearHasMsg, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.

Definition at line 289 of file ApiBase.php.

◆ getHookContainer()

ApiBase::getHookContainer ( )

protected

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

Since: 1.35

Returns: HookContainer

Definition at line 638 of file ApiBase.php.

References $hookContainer.

Referenced by getHookRunner(), and ApiQueryBase\select().

◆ getHookRunner()

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 653 of file ApiBase.php.

References $hookRunner, and getHookContainer().

Referenced by ApiMain\__construct(), ApiQuery\__construct(), addDeprecation(), ApiQuerySiteinfo\appendGeneralInfo(), ApiQuerySiteinfo\appendStatistics(), ApiMain\checkConditionalRequestHeaders(), ApiMain\checkExecutePermissions(), ApiFormatBase\closePrinter(), ApiChangeAuthenticationData\execute(), ApiExpandTemplates\execute(), ApiLogin\execute(), ApiLogout\execute(), ApiOpenSearch\execute(), ApiOptions\execute(), ApiParse\execute(), ApiQuery\execute(), ApiRemoveAuthenticationData\execute(), ApiUndelete\execute(), ApiValidatePassword\execute(), ApiMain\executeAction(), ApiPageSet\executeInternal(), ApiQueryWatchlist\extractOutputData(), ApiQueryInfo\extractPageInfo(), ApiImport\getAllowedImportSources(), getFinalDescription(), getFinalParamDescription(), getFinalParams(), ApiQueryInfo\getLinkClasses(), ApiMain\getMaxLag(), ApiRsd\getRsdApiList(), ApiMain\handleException(), ApiMain\lacksSameOriginSecurity(), ApiQueryBase\processRow(), ApiQueryWatchlist\run(), ApiQueryBase\select(), and ApiParse\tweakParserOptions().

◆ getMain()

ApiBase::getMain ( )

Get the main module.

Returns: ApiMain

Definition at line 456 of file ApiBase.php.

References $mMainModule.

Referenced by ApiPageSet\__construct(), ApiContinuationManager\__construct(), ApiFormatBase\__construct(), ApiFormatJson\__construct(), ApiQueryBase\__construct(), addDeprecation(), ApiFormatBase\closePrinter(), ApiComparePages\execute(), ApiEditPage\execute(), ApiExpandTemplates\execute(), ApiFeedRecentChanges\execute(), ApiFeedWatchlist\execute(), ApiHelp\execute(), ApiOpenSearch\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiQuery\execute(), ApiQueryDeletedrevs\execute(), ApiUpload\execute(), ApiPageSet\executeInternal(), ApiQueryInfo\extractPageInfo(), ApiParamInfo\getAllowedParams(), ApiUpload\getChunkResult(), getContinuationManager(), ApiFeedContributions\getCustomPrinter(), ApiFeedRecentChanges\getCustomPrinter(), ApiFeedWatchlist\getCustomPrinter(), ApiHelp\getCustomPrinter(), ApiOpenSearch\getCustomPrinter(), ApiQuery\getCustomPrinter(), ApiRsd\getCustomPrinter(), getErrorFormatter(), ApiPageSet\getGenerators(), getModuleFromPath(), getParameterFromSettings(), getParent(), getResult(), ApiFeedWatchlist\getWatchlistModule(), ApiFormatBase\initPrinter(), ApiFormatRaw\initPrinter(), lacksSameOriginSecurity(), logFeatureUsage(), ApiQueryRevisionsBase\parseParameters(), requirePostedParameters(), ApiQueryRandom\run(), ApiQuerySearch\run(), ApiUpload\selectUploadModule(), setContinuationManager(), ApiFormatBase\setHttpStatus(), and ApiComparePages\setVals().

◆ getModuleFromPath()

ApiBase::getModuleFromPath ( $path )

Get a module from its module path.

Since: 1.25

Parameters

string $path

Returns: ApiBase|null

Exceptions

ApiUsageException

Definition at line 533 of file ApiBase.php.

References $path, dieWithError(), getMain(), and wfEscapeWikiText().

Referenced by ApiHelp\execute(), ApiParamInfo\execute(), and getFinalParamDescription().

◆ getModuleManager()

ApiBase::getModuleManager ( )

Get the module manager, or null if this module has no sub-modules.

Since: 1.21

Stability: stable: to override

Returns: ApiModuleManager

Reimplemented in ApiQuery, and ApiMain.

Definition at line 249 of file ApiBase.php.

Referenced by ApiFormatBase\closePrinter(), ApiParamInfo\execute(), getFinalParamDescription(), MediaWiki\Api\Validator\SubmoduleDef\getSubmoduleMap(), and ApiParamInfo\listAllSubmodules().

◆ getModuleName()

ApiBase::getModuleName ( )

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

Returns: string

Definition at line 440 of file ApiBase.php.

References $mModuleName.

◆ getModulePath()

ApiBase::getModulePath ( )

Get the path to this module.

Since: 1.25

Returns: string

Definition at line 515 of file ApiBase.php.

References getModuleName(), getParent(), and isMain().

Referenced by ApiUsageException\__construct(), addError(), addMessagesFromStatus(), addWarning(), MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiQueryAllLinks\getExamplesMessages(), ApiQueryBacklinksprop\getExamplesMessages(), ApiQueryLanguageinfo\getExamplesMessages(), ApiQueryLinks\getExamplesMessages(), ApiRemoveAuthenticationData\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiHelp\getHelp(), and MediaWiki\Api\Validator\SubmoduleDef\getSubmoduleMap().

◆ getModulePrefix()

ApiBase::getModulePrefix ( )

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

Returns: string

Definition at line 448 of file ApiBase.php.

References $mModulePrefix.

Referenced by ApiQueryBase\addPageSubItem(), ApiQueryBase\addPageSubItems(), ApiQueryImageInfo\execute(), ApiQueryStashImageInfo\execute(), ApiQueryUserInfo\getAllowedParams(), ApiQueryAllLinks\getExamplesMessages(), ApiQueryLanguageinfo\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiQueryImageInfo\mergeThumbParams(), ApiQueryRevisionsBase\parseParameters(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryExtLinksUsage\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryAllDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ getModuleSourceInfo()

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 1908 of file ApiBase.php.

References $ext, $IP, $mModuleSource, $path, ContextSource\getConfig(), SpecialVersion\getCredits(), and ExtensionRegistry\getInstance().

◆ getParameter()

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 827 of file ApiBase.php.

References extractRequestParams().

Referenced by ApiFormatRaw\__construct(), ApiMain\addRequestedFields(), ApiQuerySiteinfo\appendSkins(), ApiCSPReport\execute(), ApiFeedRecentChanges\execute(), ApiQueryLanguageinfo\execute(), ApiOpenSearch\getCustomPrinter(), ApiQuery\getCustomPrinter(), ApiCSPReport\getFlags(), ApiMain\handleCORS(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiMain\sendCacheHeaders(), and ApiMain\setCacheMode().

◆ getParameterFromSettings()

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

Definition at line 1042 of file ApiBase.php.

References encodeParamName(), getMain(), getModuleName(), and getResult().

Referenced by extractRequestParams().

◆ getParent()

ApiBase::getParent ( )

Get the parent of this module.

Stability: stable: to override

Since: 1.25

Returns: ApiBase|null

Reimplemented in ApiQueryBase.

Definition at line 475 of file ApiBase.php.

References getMain(), and isMain().

Referenced by getModulePath().

◆ getPermissionManager()

ApiBase::getPermissionManager ( )

protected

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

Since: 1.34

Returns: PermissionManager

Definition at line 628 of file ApiBase.php.

Referenced by ApiProtect\execute(), ApiQueryUsers\execute(), ApiRevisionDelete\execute(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryUserInfo\getCurrentUserInfo(), ApiTag\processIndividual(), and ApiMain\setCacheMode().

◆ getResult()

ApiBase::getResult ( )

Get the result object.

Returns: ApiResult

Reimplemented in ApiMain.

Definition at line 571 of file ApiBase.php.

References dieIfMain(), and getMain().

◆ getSummaryMessage()

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

Reimplemented in ApiQueryDisabled, and ApiDisabled.

Definition at line 1625 of file ApiBase.php.

Referenced by getFinalDescription(), and getFinalSummary().

◆ getTitleFromTitleOrPageId()

ApiBase::getTitleFromTitleOrPageId ( $params )

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

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 set of parameters, as from $this->extractRequestParams()

Returns: Title

Definition at line 1013 of file ApiBase.php.

References dieWithError(), Title\newFromID(), Title\newFromText(), requireOnlyOneParameter(), and wfEscapeWikiText().

◆ getTitleOrPageId()

ApiBase::getTitleOrPageId	(	$params,
		$load = `false`
	)

Get a WikiPage object from a title or pageid param, if possible.

Can die, if no param is set or if the title or page id is not valid.

Parameters

array	$params	User provided set of parameters, 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 976 of file ApiBase.php.

References dieWithError(), WikiPage\factory(), WikiPage\newFromID(), Title\newFromText(), requireOnlyOneParameter(), and wfEscapeWikiText().

Referenced by ApiChangeContentModel\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiParse\execute(), ApiProtect\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), and ApiQueryCategoryMembers\run().

◆ getWatchlistUser()

ApiBase::getWatchlistUser ( $params )

Gets the user for whom to get the watchlist.

Parameters

array $params

Returns: User

Definition at line 1119 of file ApiBase.php.

References checkUserRightsAny(), dieWithError(), ContextSource\getUser(), and wfEscapeWikiText().

Referenced by ApiQueryWatchlist\run(), and ApiQueryWatchlistRaw\run().

◆ getWebUITokenSalt()

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 ApiUserrights, and ApiLogout.

Definition at line 409 of file ApiBase.php.

Referenced by validateToken().

◆ handleParamNormalization()

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

Definition at line 1069 of file ApiBase.php.

References addWarning().

◆ isDeprecated()

ApiBase::isDeprecated ( )

Indicates whether this module is deprecated.

Since: 1.25

Stability: stable: to override

Returns: bool

Reimplemented in ApiTokens, ApiQueryDeletedrevs, and ApiLogin.

Definition at line 361 of file ApiBase.php.

Referenced by getHelpFlags().

◆ isInternal()

ApiBase::isInternal ( )

Indicates whether this module is "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 ApiStashEdit, and ApiCSPReport.

Definition at line 372 of file ApiBase.php.

Referenced by getHelpFlags().

◆ isMain()

ApiBase::isMain ( )

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

Returns: bool

Definition at line 465 of file ApiBase.php.

References $mMainModule.

Referenced by __construct(), dieIfMain(), getFinalParamDescription(), getModulePath(), getParent(), and MediaWiki\Api\Validator\SubmoduleDef\getSubmoduleMap().

◆ isReadMode()

ApiBase::isReadMode ( )

Indicates whether this module requires read rights.

Stability: stable: to override

Returns: bool

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

Definition at line 326 of file ApiBase.php.

Referenced by getHelpFlags().

◆ isWriteMode()

ApiBase::isWriteMode ( )

Indicates whether this module requires write mode.

This should return true for modules that may require synchronous database writes. Modules that do not need such writes should also not rely on primary database access, since only read queries are needed and each primary DB is a single point of failure. Additionally, requests that only need replica DBs can be efficiently routed to any datacenter via the Promise-Non-Write-API-Action header.

Stability: stable: to override

Returns: bool

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

Definition at line 342 of file ApiBase.php.

Referenced by checkTitleUserPermissions(), getHelpFlags(), and ApiMain\setRequestExpectations().

◆ lacksSameOriginSecurity()

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

Definition at line 502 of file ApiBase.php.

References dieIfMain(), and getMain().

Referenced by ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiQueryTokens\execute(), ApiQueryUserInfo\getCurrentUserInfo(), ApiQueryInfo\getTokenFunctions(), ApiQueryRecentChanges\getTokenFunctions(), ApiQueryRevisions\getTokenFunctions(), ApiQueryUsers\getTokenFunctions(), and ApiTokens\getTokenTypes().

◆ logFeatureUsage()

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 1579 of file ApiBase.php.

References $s, getMain(), ContextSource\getRequest(), ContextSource\getUser(), wfDebugLog(), and wfUrlencode().

Referenced by addDeprecation().

◆ makeMessage()

static 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

Parameters

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

Returns: Message|null

Definition at line 1155 of file ApiBase.php.

References ContextSource\$context, and wfMessage().

Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettingsMessage(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ modifyHelp()

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 values as for Linker::generateTOC().

Reimplemented in ApiMain.

Definition at line 1991 of file ApiBase.php.

◆ mustBePosted()

ApiBase::mustBePosted ( )

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

Stability: stable: to override

Returns: bool

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

Definition at line 351 of file ApiBase.php.

References needsToken().

Referenced by getHelpFlags().

◆ needsToken()

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 ApiWatch, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiProtect, ApiPatrol, ApiOptions, ApiMove, ApiMergeHistory, ApiManageTags, ApiLogout, ApiLinkAccount, ApiImport, ApiImageRotate, ApiFileRevert, ApiEmailUser, ApiEditPage, ApiDelete, ApiClientLogin, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.

Definition at line 395 of file ApiBase.php.

Referenced by getFinalParams(), mustBePosted(), and validateToken().

◆ parameterNotEmpty()

ApiBase::parameterNotEmpty ( $x )

private

Callback function used in requireOnlyOneParameter to check whether required parameters are set.

Parameters

mixed $x Parameter to check is not null/false

Returns: bool

Definition at line 961 of file ApiBase.php.

◆ requireAtLeastOneParameter()

ApiBase::requireAtLeastOneParameter	(	$params,
		$required
	)

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

Since: 1.23

Parameters

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

Definition at line 904 of file ApiBase.php.

References dieWithError(), encodeParamName(), and Message\listParam().

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

◆ requireMaxOneParameter()

ApiBase::requireMaxOneParameter	(	$params,
		$required
	)

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

Parameters

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

Definition at line 879 of file ApiBase.php.

References dieWithError(), encodeParamName(), and Message\listParam().

Referenced by ApiExpandTemplates\execute(), ApiImport\execute(), ApiParse\execute(), ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryUsers\execute(), ApiSetNotificationTimestamp\execute(), ApiComparePages\getDiffRevision(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().

◆ requireOnlyOneParameter()

ApiBase::requireOnlyOneParameter	(	$params,
		$required
	)

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

Parameters

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

Definition at line 844 of file ApiBase.php.

References dieWithError(), encodeParamName(), and Message\listParam().

Referenced by ApiBlock\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiQueryUserContribs\execute(), ApiResetPassword\execute(), ApiStashEdit\execute(), ApiUnblock\execute(), ApiRollback\getRbTitle(), getTitleFromTitleOrPageId(), getTitleOrPageId(), ApiUserrights\getUrUser(), and ApiUpload\selectUploadModule().

◆ requirePostedParameters()

ApiBase::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.

Since: 1.28

Parameters

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

Definition at line 931 of file ApiBase.php.

References dieWithError(), encodeParamName(), ContextSource\getConfig(), getMain(), and ContextSource\getRequest().

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

◆ setContinuationManager()

ApiBase::setContinuationManager ( ApiContinuationManager $manager = null )

Parameters

ApiContinuationManager | null $manager

Reimplemented in ApiMain.

Definition at line 615 of file ApiBase.php.

References dieIfMain(), and getMain().

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

◆ shouldCheckMaxlag()

ApiBase::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Stability: stable: to override

Returns: bool

Reimplemented in ApiHelp.

Definition at line 317 of file ApiBase.php.

◆ useTransactionalTimeLimit()

ApiBase::useTransactionalTimeLimit ( )

protected

Call wfTransactionalTimeLimit() if this request was POSTed.

Since: 1.26

Definition at line 1232 of file ApiBase.php.

References ContextSource\getRequest(), and wfTransactionalTimeLimit().

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

◆ validateToken()

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

Exceptions

MWException

Definition at line 1082 of file ApiBase.php.

References ContextSource\getCsrfTokenSet(), ContextSource\getRequest(), ApiQueryTokens\getToken(), ApiQueryTokens\getTokenTypeSalts(), ContextSource\getUser(), getWebUITokenSalt(), and needsToken().

Member Data Documentation

◆ $blockMsgMap

array ApiBase::$blockMsgMap

staticprivate

Initial value:

= [
        'blockedtext' => [ 'apierror-blocked', 'blocked' ],
        'blockedtext-partial' => [ 'apierror-blocked-partial', 'blocked' ],
        'autoblockedtext' => [ 'apierror-autoblocked', 'autoblocked' ],
        'systemblockedtext' => [ 'apierror-systemblocked', 'blocked' ],
        'blockedtext-composite' => [ 'apierror-blocked', 'blocked' ],
    ]

Map of web UI block messages to corresponding API messages and codes.

Definition at line 185 of file ApiBase.php.

◆ $extensionInfo

array ApiBase::$extensionInfo = null

staticprivate

Maps extension paths to info arrays.

Definition at line 179 of file ApiBase.php.

◆ $filterIDsCache

stdClass [][] ApiBase::$filterIDsCache = []

staticprivate

Cache for self::filterIDs()

Definition at line 182 of file ApiBase.php.

◆ $hookContainer

HookContainer ApiBase::$hookContainer

private

Definition at line 60 of file ApiBase.php.

Referenced by getHookContainer(), and ApiQueryTokens\getTokenTypeSalts().

◆ $hookRunner

ApiHookRunner ApiBase::$hookRunner

private

Definition at line 63 of file ApiBase.php.

Referenced by getHookRunner(), and ApiQueryTokens\getTokenTypeSalts().

◆ $mMainModule

ApiMain ApiBase::$mMainModule

private

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 194 of file ApiBase.php.

Referenced by getMain(), and isMain().

◆ $mModuleName

string ApiBase::$mModuleName

private

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 196 of file ApiBase.php.

Referenced by getModuleName().

◆ $mModulePrefix

string ApiBase::$mModulePrefix

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 196 of file ApiBase.php.

Referenced by getModulePrefix().

◆ $mModuleSource

array null false ApiBase::$mModuleSource = false

private

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 203 of file ApiBase.php.

Referenced by getModuleSourceInfo().

◆ $mParamCache

array ApiBase::$mParamCache = []

private

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 201 of file ApiBase.php.

◆ $mReplicaDB

ApiBase::$mReplicaDB = null

private

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 197 of file ApiBase.php.

Referenced by getDB().

◆ ALL_DEFAULT_STRING

const ApiBase::ALL_DEFAULT_STRING = '*'

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

Default is apihelp-{$path}-param-{$param}.

Since: 1.25

Definition at line 160 of file ApiBase.php.

◆ GET_VALUES_FOR_HELP

const ApiBase::GET_VALUES_FOR_HELP = 1

getAllowedParams() flag: When 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 176 of file ApiBase.php.

Referenced by ApiPageSet\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ LIMIT_BIG1

const ApiBase::LIMIT_BIG1 = 500

Fast query, standard limit.

Definition at line 163 of file ApiBase.php.

◆ LIMIT_BIG2

const ApiBase::LIMIT_BIG2 = 5000

Fast query, apihighlimits limit.

Definition at line 165 of file ApiBase.php.

◆ LIMIT_SML1

const ApiBase::LIMIT_SML1 = 50

Slow query, standard limit.

Definition at line 167 of file ApiBase.php.

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

◆ LIMIT_SML2

const ApiBase::LIMIT_SML2 = 500

Slow query, apihighlimits limit.

Definition at line 169 of file ApiBase.php.

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

◆ PARAM_ALL

const ApiBase::PARAM_ALL = ParamValidator::PARAM_ALL

Definition at line 81 of file ApiBase.php.

Referenced by ApiComparePages\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), and ApiQueryUserInfo\getAllowedParams().

◆ PARAM_ALLOW_DUPLICATES

const ApiBase::PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES

Definition at line 76 of file ApiBase.php.

Referenced by ApiUserrights\getAllowedParams(), ApiProtect\getAllowedParams(), and ApiQueryAllMessages\getAllowedParams().

◆ PARAM_DEPRECATED

const ApiBase::PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED

Definition at line 77 of file ApiBase.php.

◆ PARAM_DEPRECATED_VALUES

const ApiBase::PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES

Definition at line 84 of file ApiBase.php.

Referenced by ApiParse\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), and getFinalParamDescription().

◆ PARAM_DFLT

const ApiBase::PARAM_DFLT = ParamValidator::PARAM_DEFAULT

Definition at line 70 of file ApiBase.php.

◆ PARAM_EXTRA_NAMESPACES

const ApiBase::PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES

Definition at line 82 of file ApiBase.php.

Referenced by ApiQueryLogEvents\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), and ApiQueryRecentChanges\getAllowedParams().

◆ PARAM_HELP_MSG

const 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}.

Since: 1.25

Definition at line 105 of file ApiBase.php.

◆ PARAM_HELP_MSG_APPEND

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

Since: 1.25

Definition at line 112 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiUserrights\getAllowedParams(), ApiAMCreateAccount\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), and ApiRollback\getAllowedParams().

◆ PARAM_HELP_MSG_INFO

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

(array) Specify additional information tags for the parameter.

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 122 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_HELP_MSG_PER_VALUE

const ApiBase::PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value'

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

Any value not having a mapping will use apihelp-{$path}-paramvalue-{$param}-{$value}. Specify an empty array to use the default message key for all values.

Since: 1.25

Definition at line 138 of file ApiBase.php.

◆ PARAM_ISMULTI

const ApiBase::PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI

Definition at line 71 of file ApiBase.php.

◆ PARAM_ISMULTI_LIMIT1

const ApiBase::PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1

Definition at line 85 of file ApiBase.php.

Referenced by ApiBlock\getAllowedParams().

◆ PARAM_ISMULTI_LIMIT2

const ApiBase::PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2

Definition at line 86 of file ApiBase.php.

Referenced by ApiBlock\getAllowedParams().

◆ PARAM_MAX

const ApiBase::PARAM_MAX = IntegerDef::PARAM_MAX

Definition at line 73 of file ApiBase.php.

◆ PARAM_MAX2

const ApiBase::PARAM_MAX2 = IntegerDef::PARAM_MAX2

Definition at line 74 of file ApiBase.php.

◆ PARAM_MAX_BYTES

const ApiBase::PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES

Definition at line 87 of file ApiBase.php.

◆ PARAM_MAX_CHARS

const ApiBase::PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS

Definition at line 88 of file ApiBase.php.

◆ PARAM_MIN

const ApiBase::PARAM_MIN = IntegerDef::PARAM_MIN

Definition at line 75 of file ApiBase.php.

◆ PARAM_RANGE_ENFORCE

const ApiBase::PARAM_RANGE_ENFORCE = 'api-param-range-enforce'

(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE

Deprecated:: since 1.35

Definition at line 95 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiEditPage\getAllowedParams(), and MediaWiki\Api\Validator\ApiParamValidator\normalizeSettings().

◆ PARAM_REQUIRED

const ApiBase::PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED

◆ PARAM_SENSITIVE

const ApiBase::PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE

Definition at line 83 of file ApiBase.php.

Referenced by ApiCheckToken\getAllowedParams(), ApiLogin\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), and ApiQueryWatchlistRaw\getAllowedParams().

◆ PARAM_SUBMODULE_MAP

const ApiBase::PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP

Definition at line 79 of file ApiBase.php.

Referenced by ApiPageSet\getAllowedParams(), and getFinalParamDescription().

◆ PARAM_SUBMODULE_PARAM_PREFIX

const ApiBase::PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX

Definition at line 80 of file ApiBase.php.

Referenced by ApiPageSet\getAllowedParams().

◆ PARAM_TEMPLATE_VARS

const 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 156 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), extractRequestParams(), ApiComparePages\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_TYPE

const ApiBase::PARAM_TYPE = ParamValidator::PARAM_TYPE

Definition at line 72 of file ApiBase.php.

◆ PARAM_VALUE_LINKS

const ApiBase::PARAM_VALUE_LINKS = 'api-param-value-links'

Deprecated and unused.

Since: 1.25

Deprecated:: since 1.35

Definition at line 129 of file ApiBase.php.

Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings().

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

includes/api/ApiBase.php

Public Attributes

Private Attributes

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

◆ addBlockInfoToStatus()

◆ addDeprecation()

◆ addError()

◆ addMessagesFromStatus()

◆ addWarning()

◆ checkTitleUserPermissions()

◆ checkUserRightsAny()

◆ dieBlocked()

◆ dieContinueUsageIf()

◆ dieDebug()

◆ dieIfMain()

◆ dieReadOnly()

◆ dieStatus()

◆ dieWithError()

◆ dieWithErrorOrDebug()

◆ dieWithException()

◆ dynamicParameterDocumentation()

◆ encodeParamName()

◆ errorArrayToStatus()

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