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

Inherits ContextSource.

Inherited by ApiAMCreateAccount, ApiBlock, ApiChangeAuthenticationData, ApiCheckToken, ApiClearHasMsg, ApiClientLogin, ApiComparePages, ApiCSPReport, ApiDelete, ApiDisabled, ApiEditPage, ApiEmailUser, ApiExpandTemplates, ApiFeedContributions, ApiFeedRecentChanges, ApiFeedWatchlist, ApiFileRevert, ApiFormatBase, ApiHelp, ApiImageRotate, ApiImport, ApiLinkAccount, ApiLogin, ApiLogout, ApiMain, ApiManageTags, ApiMergeHistory, ApiMove, ApiOpenSearch, ApiOptions, ApiPageSet, ApiParamInfo, ApiParse, ApiPatrol, ApiProtect, ApiPurge, ApiQuery, ApiQueryBase, ApiRemoveAuthenticationData, ApiResetPassword, ApiRevisionDelete, ApiRollback, ApiRsd, ApiSetNotificationTimestamp, ApiStashEdit, ApiTag, ApiTokens, ApiUnblock, ApiUndelete, ApiUpload, ApiUserrights, ApiWatch, and MockApi.

Collaboration diagram for ApiBase:

[legend]

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

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

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

	getConfig ()
	Get the Config object. More...

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

	getLanguage ()
	Get the Language object. More...

	getOutput ()
	Get the OutputPage object. More...

	getRequest ()
	Get the WebRequest object. More...

	getSkin ()
	Get the Skin object. More...

	getStats ()
	Get the Stats object. More...

	getTiming ()
	Get the Timing object. More...

	getTitle ()
	Get the Title object. More...

	getUser ()
	Get the User object. More...

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

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

	setContext (IContextSource $context)
	Set the IContextSource object. More...

Public Attributes
string	$mModulePrefix

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

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

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

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

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

Constants for ::getAllowedParams() arrays
These constants are keys in the arrays returned by ::getAllowedParams() and accepted by ::getParameterFromSettings() that define how the parameters coming in from the request are to be interpreted.
const	PARAM_DFLT = 0
	(null\|boolean\|integer\|string) Default value of the parameter. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Private Attributes
ApiMain	$mMainModule

string	$mModuleName

array null bool	$mModuleSource = false

	$mParamCache = []

	$mSlaveDB = null

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

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 ()
	Get the error formatter. More...

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

	setContinuationManager ($manager)
	Set the continuation manager. More...

	getDB ()
	Gets a default replica DB connection object. 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 ($parseLimit=true)
	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...

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

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

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

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

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

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

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

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

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

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

	validateUser ($value, $encParamName)
	Validate and normalize of parameters of type 'user'. More...

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

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

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

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

static	escapeWikiText ($v)
	A subset of wfEscapeWikiText for BC texts. More...

Warning and error reporting
static	$messageMap
	Array that maps message keys to error messages. More...

	setWarning ($warning)
	Set warning section for this module. More...

	dieUsage ($description, $errorCode, $httpRespCode=0, $extradata=null)
	Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message. More...

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

	getErrorFromStatus ($status, &$extraData=null)
	Get error (as code, string) from a Status object. More...

	dieStatus ($status)
	Throw a UsageException based on the errors in the Status object. More...

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

	dieUsageMsg ($error)
	Output the error message related to a certain array. More...

	dieUsageMsgOrDebug ($error)
	Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...

	parseMsg ($error)
	Return the error message related to a certain array. More...

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

	dieContinueUsageIf ($condition)
	Die with the $prefix. More...

	warnOrDie ($msg, $enforceLimits=false)
	Adds a warning to the output, else dies. More...

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

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

	getDescriptionMessage ()
	Return the description 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...

Deprecated
	getModuleProfileName ($db=false)

	profileIn ()

	profileOut ()

	safeProfileOut ()

	getProfileTime ()

	profileDBIn ()

	profileDBOut ()

	getProfileDBTime ()

	getResultData ()
	Get the result data array (read-only) More...

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

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

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

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

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

Definition at line 39 of file ApiBase.php.

Constructor & Destructor Documentation

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

Parameters

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

Definition at line 209 of file ApiBase.php.

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

Member Function Documentation

ApiBase::dieBlocked ( Block $block )

Throw a UsageException, 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 UsageException

Exceptions

UsageException always

Definition at line 1591 of file ApiBase.php.

References dieUsage(), ApiQueryUserInfo\getBlockInfo(), Block\getType(), and Block\TYPE_AUTO.

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

ApiBase::dieContinueUsageIf ( $condition )

protected

Die with the $prefix.

'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

UsageException

Since: 1.21

Definition at line 2229 of file ApiBase.php.

References dieUsage().

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

Referenced by ApiQueryLinks\__construct(), ApiQueryAllLinks\__construct(), ApiQueryBase\addJoinConds(), ApiQueryBase\addTables(), ApiQuerySiteinfo\appendInterwikiMap(), ApiQuerySiteinfo\execute(), ApiQueryAllUsers\execute(), ApiLogin\execute(), ApiFormatRaw\execute(), ApiFormatFeedWrapper\execute(), getContinuationManager(), ApiOpenSearch\getCustomPrinter(), getErrorFormatter(), ApiFormatRaw\getMimeType(), getParameterFromSettings(), getResult(), ApiPageSet\initFromQueryResult(), ApiFormatFeedWrapper\initPrinter(), ApiQuery\instantiateModules(), lacksSameOriginSecurity(), ApiOpenSearch\populateResult(), ApiQueryDeletedRevisions\run(), ApiQueryWatchlist\run(), ApiQueryRevisions\run(), ApiQueryRecentChanges\run(), setContinuationManager(), and ApiQueryGeneratorBase\setGeneratorMode().

static ApiBase::dieReadOnly ( )

Helper function for readonly errors.

Exceptions

UsageException always

Definition at line 2181 of file ApiBase.php.

References dieUsage(), parseMsg(), and wfReadOnlyReason().

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

ApiBase::dieStatus ( $status )

Throw a UsageException based on the errors in the Status object.

Since: 1.22

Parameters

Status $status

Exceptions

UsageException always

Definition at line 1663 of file ApiBase.php.

References $code, $status, dieUsage(), getErrorFromStatus(), and list.

Referenced by ApiManageTags\execute(), ApiProtect\execute(), ApiUndelete\execute(), ApiMove\execute(), ApiMergeHistory\execute(), ApiImport\execute(), ApiChangeAuthenticationData\execute(), ApiPatrol\execute(), ApiEditPage\execute(), ApiUnblock\execute(), ApiDelete\execute(), ApiRollback\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), getParameterFromSettings(), ApiUserrights\getUrUser(), ApiUpload\performStash(), ApiUpload\performUpload(), and ApiWatch\watchTitle().

ApiBase::dieUsage	(	$description,
		$errorCode,
		$httpRespCode = `0`,
		$extradata = `null`
	)

Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message.

Parameters

string	$description	One-line human-readable description of the error condition, e.g., "The API requires a valid action parameter"
string	$errorCode	Brief, arbitrary, stable string to allow easy automated identification of the error, e.g., 'unknown_action'
int	$httpRespCode	HTTP response code
array \| null	$extradata	Data to add to the "<error>" element; array in ApiResult format

Exceptions

UsageException always

Definition at line 1574 of file ApiBase.php.

References encodeParamName().

Referenced by ApiQuerySiteinfo\appendDbReplLagInfo(), ApiMain\checkAsserts(), ApiMain\checkBotReadOnly(), ApiMain\checkExecutePermissions(), ApiMain\checkMaxLag(), ApiQueryImageInfo\checkParameterNormalise(), ApiParse\checkReadPermissions(), ApiUpload\checkVerification(), ApiMain\createPrinterByName(), dieBlocked(), dieContinueUsageIf(), dieReadOnly(), ApiUpload\dieRecoverableError(), dieStatus(), ApiUpload\dieStatusWithCode(), dieUsageMsg(), ApiCSPReport\error(), ApiComparePages\execute(), ApiManageTags\execute(), ApiTag\execute(), ApiQueryStashImageInfo\execute(), ApiRevisionDelete\execute(), ApiQueryMyStashedFiles\execute(), ApiWatch\execute(), ApiUpload\execute(), ApiChangeAuthenticationData\execute(), ApiPatrol\execute(), ApiExpandTemplates\execute(), ApiFormatPhp\execute(), ApiLogout\execute(), ApiSetNotificationTimestamp\execute(), ApiOptions\execute(), ApiEditPage\execute(), ApiUnblock\execute(), ApiQueryAllMessages\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiDisabled\execute(), ApiQueryFilearchive\execute(), ApiBlock\execute(), ApiFeedContributions\execute(), ApiRollback\execute(), ApiQueryLogEvents\execute(), ApiQueryContributions\execute(), ApiFeedRecentChanges\execute(), ApiParse\execute(), ApiRemoveAuthenticationData\execute(), ApiQueryAllUsers\execute(), ApiStashEdit\execute(), ApiLinkAccount\execute(), ApiAMCreateAccount\execute(), ApiClientLogin\execute(), ApiFeedWatchlist\execute(), ApiResetPassword\execute(), ApiFormatJson\execute(), ApiOpenSearchFormatJson\execute(), ApiQueryAllPages\executeGenerator(), ApiQueryAllImages\executeGenerator(), ApiPageSet\executeInternal(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiUpload\getChunkResult(), getModuleFromPath(), getParameterFromSettings(), ApiParse\getParsedContent(), ApiParse\getSectionContent(), getTitleOrPageId(), getWatchlistUser(), ApiQueryImageInfo\mergeThumbParams(), ApiQuery\outputGeneralPageInfo(), parseMultiValue(), ApiQueryRevisionsBase\parseParameters(), ApiUpload\performUpload(), ApiQueryContributions\prepareQuery(), ApiQueryBase\prepareUrlQuerySearchString(), ApiQueryBlocks\prepareUsername(), requireAtLeastOneParameter(), requireMaxOneParameter(), requireOnlyOneParameter(), requirePostedParameters(), ApiComparePages\revisionOrTitleOrId(), ApiQueryDeletedRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQuerySearch\run(), ApiQueryWatchlist\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), ApiQueryRevisions\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), ApiUpload\selectUploadModule(), ApiMain\setupExecuteAction(), ApiMain\setupModule(), validateTimestamp(), validateUser(), and warnOrDie().

ApiBase::dieUsageMsg ( $error )

Output the error message related to a certain array.

Parameters

array | string | MessageSpecifier $error Element of a getUserPermissionsErrors()-style array

Exceptions

UsageException always

Definition at line 2192 of file ApiBase.php.

References dieUsage(), and parseMsg().

Referenced by ApiMain\checkExecutePermissions(), ApiFileRevert\checkPermissions(), ApiUpload\checkPermissions(), dieUsageMsgOrDebug(), ApiProtect\execute(), ApiUndelete\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiEmailUser\execute(), ApiRevisionDelete\execute(), ApiImport\execute(), ApiWatch\execute(), ApiExpandTemplates\execute(), ApiPatrol\execute(), ApiUpload\execute(), ApiOptions\execute(), ApiEditPage\execute(), ApiUnblock\execute(), ApiQueryAllMessages\execute(), ApiQueryBlocks\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiBlock\execute(), ApiDelete\execute(), ApiRollback\execute(), ApiParse\execute(), ApiUpload\getContextResult(), ApiFeedRecentChanges\getFeedObject(), getParameterFromSettings(), ApiRollback\getRbTitle(), ApiRollback\getRbUser(), getTitleOrPageId(), ApiQueryRevisionsBase\parseParameters(), ApiQueryBase\prefixedTitlePartToKey(), ApiQueryContributions\prepareQuery(), ApiComparePages\revisionOrTitleOrId(), ApiQueryLangBacklinks\run(), ApiQueryIWBacklinks\run(), ApiQueryCategories\run(), ApiQueryWatchlistRaw\run(), ApiQueryQueryPage\run(), ApiQueryWatchlist\run(), ApiQueryBacklinksprop\run(), ApiQueryRecentChanges\run(), ApiUpload\selectUploadModule(), ApiMain\setupModule(), ApiQueryBase\titlePartToKey(), and ApiFileRevert\validateParameters().

ApiBase::dieUsageMsgOrDebug ( $error )

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

Otherwise behaves exactly as dieUsageMsg().

Parameters

array | string | MessageSpecifier $error Element of a getUserPermissionsErrors()-style array

Exceptions

UsageException

Since: 1.21

Definition at line 2210 of file ApiBase.php.

References dieUsageMsg(), ContextSource\getConfig(), parseMsg(), and setWarning().

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

ApiBase::dynamicParameterDocumentation ( )

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

Returns: string|array|Message|null Return null if the module does not support additional dynamic parameters, otherwise return a message describing them.

Definition at line 655 of file ApiBase.php.

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 $paramName Parameter name

Returns: string Prefixed parameter name

Definition at line 665 of file ApiBase.php.

Referenced by ApiContinuationManager\addContinueParam(), ApiContinuationManager\addGeneratorContinueParam(), ApiContinuationManager\addGeneratorNonContinueParam(), dieUsage(), ApiQueryLogEvents\execute(), ApiLinkAccount\execute(), ApiAMCreateAccount\execute(), ApiClientLogin\execute(), getParameterFromSettings(), handleParamNormalization(), requirePostedParameters(), and validateLimit().

static ApiBase::escapeWikiText ( $v )

staticprivate

A subset of wfEscapeWikiText for BC texts.

Since: 1.25

Parameters

string | array $v

Returns: string|array

Definition at line 1487 of file ApiBase.php.

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

ApiBase::explodeMultiValue	(	$value,
		$limit
	)

protected

Split a multi-valued parameter string, like explode()

Since: 1.28

Parameters

string	$value
int	$limit

Returns: string[]

Definition at line 1196 of file ApiBase.php.

References $limit, and $value.

Referenced by ApiPageSet\handleParamNormalization(), and parseMultiValue().

ApiBase::extractRequestParams ( $parseLimit = true )

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 $parseLimit True by default

Returns: array

Definition at line 678 of file ApiBase.php.

References $params, as, getFinalParams(), and getParameterFromSettings().

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.

Returns: array

Definition at line 338 of file ApiBase.php.

Referenced by getFinalParams().

ApiBase::getConditionalRequestData ( $condition )

Returns data for HTTP conditional request mechanisms.

Since: 1.26

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

ApiBase::getContinuationManager ( )

Get the continuation manager.

Returns: ApiContinuationManager|null

Definition at line 617 of file ApiBase.php.

References dieDebug(), getMain(), and isMain().

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

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.

Returns: mixed Instance of a derived class of ApiFormatBase, or null

Definition at line 260 of file ApiBase.php.

ApiBase::getDB ( )

protected

Gets a default replica DB connection object.

Returns: Database

Definition at line 605 of file ApiBase.php.

References $mSlaveDB, DB_REPLICA, and wfGetDB().

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

ApiBase::getDescription ( )

protected

Returns the description string for this module.

Ignored if an i18n message exists for "apihelp-{$this->getModulePath()}-description".

Deprecated:

since 1.25

Returns: Message|string|array

Definition at line 2643 of file ApiBase.php.

Referenced by getFinalDescription().

ApiBase::getDescriptionMessage ( )

protected

Return the description message.

Returns: string|array|Message

Definition at line 2315 of file ApiBase.php.

Referenced by getFinalDescription().

ApiBase::getErrorFormatter ( )

Get the error formatter.

Returns: ApiErrorFormatter

Definition at line 591 of file ApiBase.php.

References dieDebug(), getMain(), and isMain().

Referenced by ApiManageTags\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiQueryUsers\execute(), ApiTag\processIndividual(), and setWarning().

ApiBase::getErrorFromStatus	(		$status,
		&	$extraData = `null`
	)

Get error (as code, string) from a Status object.

Since: 1.23

Parameters

Status	$status
array \| null	&$extraData	Set if extra data from IApiMessage is available (since 1.27)

Returns: array Array of code and error string

Exceptions

MWException

Definition at line 1619 of file ApiBase.php.

References $code, $messageMap, $status, and wfMessage().

Referenced by dieStatus(), ApiUpload\dieStatusWithCode(), ApiMove\execute(), ApiCSPReport\getReport(), ApiUpload\performStash(), and ApiWatch\watchTitle().

ApiBase::getExamples ( )

protected

Returns usage examples for this module.

Return value as an array is either:

numeric keys with partial URLs ("api.php?" plus a query string) as values
sequential numeric keys with even-numbered keys being display-text and odd-numbered keys being partial urls
partial URLs as keys with display-text (string or array-to-be-joined) as values Return value as a string is the same as an array with a numeric key and that value, and boolean false means "no examples".

Deprecated:

since 1.25, use getExamplesMessages() instead

Returns: bool|string|array

Definition at line 2679 of file ApiBase.php.

Referenced by 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

Returns: array

Definition at line 275 of file ApiBase.php.

References $ret, as, getExamples(), and ContextSource\msg().

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[]

Definition at line 2326 of file ApiBase.php.

References ContextSource\getContext(), getDescription(), getDescriptionMessage(), getModuleName(), getModulePath(), getModulePrefix(), makeMessage(), ContextSource\msg(), Hooks\run(), and string.

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

References $line, $name, $params, $path, $value, as, GET_VALUES_FOR_HELP, ContextSource\getContext(), getFinalParams(), getModuleName(), getModulePath(), getModulePrefix(), getParamDescription(), makeMessage(), ContextSource\msg(), PARAM_HELP_MSG, PARAM_HELP_MSG_APPEND, PARAM_HELP_MSG_PER_VALUE, PARAM_TYPE, Hooks\run(), and Message\setContext().

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|bool False on no parameters

Since: 1.21 $flags param added

Definition at line 2359 of file ApiBase.php.

References $flags, $params, getAllowedParams(), needsToken(), PARAM_HELP_MSG, PARAM_REQUIRED, PARAM_TYPE, and Hooks\run().

Referenced by extractRequestParams(), getFinalParamDescription(), and getParameter().

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[]

Definition at line 2502 of file ApiBase.php.

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

ApiBase::getHelpUrls ( )

Return links to more detailed help pages about the module.

Since: 1.25, returning boolean false is deprecated

Returns: string|array

Definition at line 322 of file ApiBase.php.

ApiBase::getMain ( )

Get the main module.

Returns: ApiMain

Definition at line 473 of file ApiBase.php.

References $mMainModule.

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

ApiBase::getModuleFromPath ( $path )

Get a module from its module path.

Since: 1.25

Parameters

string $path

Returns: ApiBase|null

Exceptions

UsageException

Definition at line 539 of file ApiBase.php.

References $count, $path, dieUsage(), and getMain().

Referenced by ApiHelp\execute(), ApiParamInfo\execute(), and ApiDocumentationTest\testDocumentationExists().

ApiBase::getModuleManager ( )

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

Since: 1.21

Returns: ApiModuleManager

Definition at line 247 of file ApiBase.php.

Referenced by ApiParamInfo\execute(), getParameterFromSettings(), and ApiParamInfo\listAllSubmodules().

ApiBase::getModuleName ( )

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

Returns: string

Definition at line 457 of file ApiBase.php.

References $mModuleName.

Referenced by ApiPageSet\__construct(), ApiContinuationManager\addContinueParam(), ApiContinuationManager\addGeneratorContinueParam(), ApiContinuationManager\addGeneratorNonContinueParam(), ApiQueryBase\addPageSubItem(), ApiQueryBase\addPageSubItems(), ApiTag\execute(), ApiManageTags\execute(), ApiComparePages\execute(), ApiProtect\execute(), ApiClearHasMsg\execute(), ApiCheckToken\execute(), ApiUndelete\execute(), ApiEmailUser\execute(), ApiTokens\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiQueryStashImageInfo\execute(), ApiRevisionDelete\execute(), ApiImport\execute(), ApiWatch\execute(), ApiQueryMyStashedFiles\execute(), ApiPatrol\execute(), ApiQueryTokens\execute(), ApiExpandTemplates\execute(), ApiHelp\execute(), ApiUpload\execute(), ApiEditPage\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryAuthManagerInfo\execute(), ApiOptions\execute(), ApiQueryTags\execute(), ApiQueryAllMessages\execute(), ApiUnblock\execute(), ApiQueryBlocks\execute(), ApiParamInfo\execute(), ApiPurge\execute(), ApiQueryDeletedrevs\execute(), ApiFileRevert\execute(), ApiQueryFilearchive\execute(), ApiDelete\execute(), ApiBlock\execute(), ApiCSPReport\execute(), ApiRollback\execute(), ApiQueryPagePropNames\execute(), ApiQueryLogEvents\execute(), ApiQueryContributions\execute(), ApiParse\execute(), ApiQueryUserInfo\execute(), ApiRemoveAuthenticationData\execute(), ApiQueryAllUsers\execute(), ApiStashEdit\execute(), ApiImageRotate\execute(), ApiUserrights\execute(), ApiQueryUsers\execute(), ApiQueryBacklinksprop\getAllowedParams(), ApiRemoveAuthenticationData\getExamplesMessages(), ApiQueryLinks\getExamplesMessages(), ApiQueryAllLinks\getExamplesMessages(), ApiFormatBase\getExamplesMessages(), ApiQueryBacklinksprop\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), ApiLinkAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), getFinalDescription(), getFinalParamDescription(), ApiQueryAllLinks\getHelpUrls(), ApiQueryBacklinksprop\getHelpUrls(), getModulePath(), getParameterFromSettings(), ApiAuthManagerHelper\logAuthenticationResult(), ApiQueryRevisionsBase\parseParameters(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryExtLinksUsage\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllCategories\run(), ApiQuerySearch\run(), ApiQueryPagesWithProp\run(), ApiQueryQueryPage\run(), ApiQueryWatchlist\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), ApiQueryBacklinksprop\run(), ApiQueryAllLinks\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryRandom\runQuery(), ApiUpload\selectUploadModule(), and setWarning().

ApiBase::getModulePath ( )

Get the path to this module.

Since: 1.25

Returns: string

Definition at line 521 of file ApiBase.php.

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

Referenced by ApiRemoveAuthenticationData\getExamplesMessages(), ApiQueryLinks\getExamplesMessages(), ApiQueryAllLinks\getExamplesMessages(), ApiQueryBacklinksprop\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), ApiLinkAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), getFinalDescription(), getFinalParamDescription(), ApiHelp\getHelp(), and ApiDocumentationTest\provideDocumentationExists().

ApiBase::getModulePrefix ( )

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

Returns: string

Definition at line 465 of file ApiBase.php.

References $mModulePrefix.

Referenced by ApiQueryBase\addPageSubItem(), ApiQueryBase\addPageSubItems(), ApiQueryStashImageInfo\execute(), ApiWatch\execute(), ApiQueryDeletedrevs\execute(), ApiQueryUserInfo\getCurrentUserInfo(), ApiQueryAllLinks\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), ApiLinkAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), getFinalDescription(), getFinalParamDescription(), ApiQueryImageInfo\mergeThumbParams(), ApiQueryRevisionsBase\parseParameters(), requireAtLeastOneParameter(), requireMaxOneParameter(), requireOnlyOneParameter(), ApiQueryAllDeletedRevisions\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryExtLinksUsage\run(), ApiQueryAllImages\run(), and ApiQueryAllLinks\run().

ApiBase::getModuleProfileName ( $db = false )

Deprecated:

since 1.25, always returns empty string

Parameters

IDatabase | bool $db

Returns: string

Definition at line 2688 of file ApiBase.php.

References wfDeprecated().

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

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

ApiBase::getParamDescription ( )

protected

Returns an array of parameter descriptions.

For each parameter, ignored if an i18n message exists for the parameter. By default that message is "apihelp-{$this->getModulePath()}-param-{$param}", but it may be overridden using ApiBase::PARAM_HELP_MSG in the data returned by self::getFinalParams().

Deprecated:

since 1.25

Returns: array|bool False on no parameter descriptions

Definition at line 2659 of file ApiBase.php.

Referenced by getFinalParamDescription().

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

References getFinalParams(), and getParameterFromSettings().

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

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

protected

Using the settings determine the value for the given parameter.

Parameters

string	$paramName	Parameter name
array \| mixed	$paramSettings	Default value or an array of settings using PARAM_* constants.
bool	$parseLimit	Parse limit?

Returns: mixed Parameter value

Definition at line 912 of file ApiBase.php.

References $name, $request, $type, $value, as, ChangeTags\canAddTagsAccompanyingChange(), dieDebug(), dieStatus(), dieUsage(), dieUsageMsg(), encodeParamName(), getMain(), getModuleManager(), getModuleName(), getResult(), MWNamespace\getValidNamespaces(), handleParamNormalization(), logFeatureUsage(), parseMultiValue(), setWarning(), validateLimit(), validateTimestamp(), and validateUser().

Referenced by extractRequestParams(), and getParameter().

ApiBase::getParent ( )

Get the parent of this module.

Since: 1.25

Returns: ApiBase|null

Definition at line 491 of file ApiBase.php.

References getMain(), and isMain().

Referenced by getModulePath().

ApiBase::getProfileDBTime ( )

Deprecated:

since 1.25, always returns 0

Returns: float

Definition at line 2743 of file ApiBase.php.

References wfDeprecated().

ApiBase::getProfileTime ( )

Deprecated:

since 1.25, always returns 0

Returns: float

Definition at line 2720 of file ApiBase.php.

References wfDeprecated().

ApiBase::getResult ( )

Get the result object.

Returns: ApiResult

Definition at line 577 of file ApiBase.php.

References dieDebug(), getMain(), and isMain().

ApiBase::getResultData ( )

Get the result data array (read-only)

Deprecated:

since 1.25, use $this->getResult() methods instead

Returns: array

Definition at line 2753 of file ApiBase.php.

References getResult(), and wfDeprecated().

Referenced by ApiFormatPhp\execute(), and ApiOpenSearchFormatJson\execute().

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
bool \| string	$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 master database

Returns: WikiPage

Definition at line 833 of file ApiBase.php.

References $params, dieUsage(), dieUsageMsg(), WikiPage\factory(), WikiPage\newFromID(), Title\newFromText(), and requireOnlyOneParameter().

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

ApiBase::getWatchlistUser ( $params )

Gets the user for whom to get the watchlist.

Parameters

array $params

Returns: User

Definition at line 1454 of file ApiBase.php.

References $params, $user, dieUsage(), ContextSource\getUser(), and User\newFromName().

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

ApiBase::getWatchlistValue	(	$watchlist,
		$titleObj,
		$userOption = `null`
	)

protected

Return true if we're to watch the page, false if not, null if no change.

Parameters

string	$watchlist	Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
Title	$titleObj	The page under consideration
string	$userOption	The user option to consider when $watchlist=preferences. If not set will use watchdefault always and watchcreations if $titleObj doesn't exist.

Returns: bool

Definition at line 870 of file ApiBase.php.

References ContextSource\getUser(), and User\IGNORE_USER_RIGHTS.

Referenced by ApiEditPage\execute(), ApiUpload\performUpload(), and setWatch().

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

Returns: string|array|null

Definition at line 426 of file ApiBase.php.

Referenced by validateToken().

ApiBase::handleParamNormalization	(	$paramName,
		$value,
		$rawValue
	)

protected

Handle when a parameter was Unicode-normalized.

Since: 1.28

Parameters

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

Definition at line 1180 of file ApiBase.php.

References encodeParamName(), and setWarning().

Referenced by getParameterFromSettings().

ApiBase::isDeprecated ( )

Indicates whether this module is deprecated.

Since: 1.25

Returns: bool

Definition at line 381 of file ApiBase.php.

Referenced by getHelpFlags().

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

Returns: bool

Definition at line 391 of file ApiBase.php.

Referenced by getHelpFlags().

ApiBase::isMain ( )

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

Returns: bool

Definition at line 482 of file ApiBase.php.

References $mMainModule.

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

ApiBase::isReadMode ( )

Indicates whether this module requires read rights.

Returns: bool

Definition at line 356 of file ApiBase.php.

Referenced by getHelpFlags().

ApiBase::isWriteMode ( )

Indicates whether this module requires write mode.

Returns: bool

Definition at line 364 of file ApiBase.php.

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

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

Definition at line 505 of file ApiBase.php.

References dieDebug(), getMain(), and isMain().

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

ApiBase::logFeatureUsage ( $feature )

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

Parameters

string $feature Feature being used.

Definition at line 2293 of file ApiBase.php.

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

Referenced by ApiTokens\execute(), ApiExpandTemplates\execute(), ApiQueryDeletedrevs\execute(), ApiPurge\execute(), ApiParse\execute(), ApiLogin\execute(), getParameterFromSettings(), parseMultiValue(), ApiQuerySearch\run(), ApiMain\setupExternalResponse(), and validateTimestamp().

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	$params

Returns: Message|null

Definition at line 1511 of file ApiBase.php.

References $params, and wfMessage().

Referenced by ApiDocumentationTest\checkMessage(), ApiAMCreateAccount\getFinalDescription(), ApiLinkAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), getFinalDescription(), getFinalParamDescription(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

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.

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

Definition at line 2624 of file ApiBase.php.

ApiBase::mustBePosted ( )

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

Returns: bool

Definition at line 372 of file ApiBase.php.

References needsToken().

Referenced by getHelpFlags().

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.

Returns: string|false

Definition at line 413 of file ApiBase.php.

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

ApiBase::parameterNotEmpty ( $x )

private

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

Parameters

object $x Parameter to check is not null/false

Returns: bool

Definition at line 818 of file ApiBase.php.

ApiBase::parseMsg ( $error )

Return the error message related to a certain array.

Parameters

array | string | MessageSpecifier $error Element of a getUserPermissionsErrors()-style array

Returns: [ 'code' => code, 'info' => info ]

Definition at line 2242 of file ApiBase.php.

References $params, Message\newFromSpecifier(), wfDebug(), wfGetAllCallers(), and wfMsgReplaceArgs().

Referenced by ApiMain\checkBotReadOnly(), ApiImageRotate\checkPermissions(), ApiUpload\checkVerification(), dieReadOnly(), ApiUpload\dieRecoverableError(), dieUsageMsg(), dieUsageMsgOrDebug(), ApiUnblock\execute(), ApiPurge\execute(), ApiBlock\execute(), ApiMove\moveSubpages(), and ApiTag\processIndividual().

ApiBase::parseMultiValue	(	$valueName,
		$value,
		$allowMultiple,
		$allowedValues
	)

protected

Return an array of values that were given in a 'a|b|c' notation, after it optionally validates them against the list allowed values.

Parameters

string	$valueName	The name of the parameter (for error reporting)
mixed	$value	The value being parsed
bool	$allowMultiple	Can $value contain more than one value separated by '\|'?
	string[]\|null	$allowedValues An array of values to check against. If null, all values are accepted.

Returns: string|string[] (allowMultiple ? an_array_of_values : a_single_value)

Definition at line 1220 of file ApiBase.php.

References $s, $value, dieUsage(), explodeMultiValue(), logFeatureUsage(), and setWarning().

Referenced by getParameterFromSettings().

ApiBase::profileDBIn ( )

Deprecated:: since 1.25

Definition at line 2728 of file ApiBase.php.

References wfDeprecated().

ApiBase::profileDBOut ( )

Deprecated:: since 1.25

Definition at line 2735 of file ApiBase.php.

References wfDeprecated().

ApiBase::profileIn ( )

Deprecated:: since 1.25

Definition at line 2696 of file ApiBase.php.

ApiBase::profileOut ( )

Deprecated:: since 1.25

Definition at line 2704 of file ApiBase.php.

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

References $params, dieUsage(), and getModulePrefix().

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

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

References $params, dieUsage(), and getModulePrefix().

Referenced by ApiImport\execute(), ApiExpandTemplates\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryBlocks\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryContributors\execute(), ApiQueryAllRevisions\run(), and ApiQueryRandom\run().

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

References $params, dieUsage(), and getModulePrefix().

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

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

References $params, as, dieUsage(), encodeParamName(), ContextSource\getConfig(), getMain(), and ContextSource\getRequest().

Referenced by ApiLogin\execute().

ApiBase::safeProfileOut ( )

Deprecated:: since 1.25

Definition at line 2712 of file ApiBase.php.

References wfDeprecated().

ApiBase::setContinuationManager ( $manager )

Set the continuation manager.

Parameters

ApiContinuationManager|null

Definition at line 631 of file ApiBase.php.

References dieDebug(), getMain(), and isMain().

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

ApiBase::setWarning ( $warning )

Set warning section for this module.

Users should monitor this section to notice any changes in API. Multiple calls to this function will result in the warning messages being separated by newlines

Parameters

string $warning Warning message

Definition at line 1543 of file ApiBase.php.

References getErrorFormatter(), and getModuleName().

Referenced by ApiFormatXml\addXslt(), dieUsageMsgOrDebug(), ApiTokens\execute(), ApiQueryTokens\execute(), ApiExpandTemplates\execute(), ApiOptions\execute(), ApiParamInfo\execute(), ApiPurge\execute(), ApiQueryDeletedrevs\execute(), ApiQueryDisabled\execute(), ApiParse\execute(), ApiLogin\execute(), ApiQueryUsers\execute(), ApiPageSet\executeInternal(), ApiQueryInfo\extractPageInfo(), ApiQueryRevisionsBase\extractRevisionInfo(), ApiQueryRecentChanges\extractRowInfo(), ApiQueryUserInfo\getCurrentUserInfo(), getParameterFromSettings(), ApiMain\getVal(), ApiMain\handleException(), handleParamNormalization(), ApiQueryImageInfo\mergeThumbParams(), parseMultiValue(), ApiQueryRevisionsBase\parseParameters(), ApiMain\printResult(), ApiMain\reportUnusedParams(), ApiQueryAllDeletedRevisions\run(), ApiQueryImages\run(), ApiQueryCategories\run(), ApiQuerySearch\run(), ApiQueryLinks\run(), ApiQueryRevisions\run(), ApiMain\setupExternalResponse(), validateTimestamp(), and warnOrDie().

ApiBase::setWatch	(	$watch,
		$titleObj,
		$userOption = `null`
	)

protected

Set a watch (or unwatch) based the based on a watchlist parameter.

Parameters

string	$watch	Valid values: 'watch', 'unwatch', 'preferences', 'nochange'
Title	$titleObj	The article's title to change
string	$userOption	The user option to consider when $watch=preferences

Definition at line 1423 of file ApiBase.php.

References $value, WatchAction\doWatchOrUnwatch(), ContextSource\getUser(), and getWatchlistValue().

Referenced by ApiProtect\execute(), ApiUndelete\execute(), ApiMove\execute(), ApiDelete\execute(), and ApiRollback\execute().

ApiBase::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns: bool

Definition at line 348 of file ApiBase.php.

static ApiBase::truncateArray	(	&	$arr,
			$limit
	)

static

Truncate an array to a certain length.

Parameters

array	$arr	Array to truncate
int	$limit	Maximum length

Returns: bool True if the array was truncated, false otherwise

Definition at line 1438 of file ApiBase.php.

References $limit.

ApiBase::useTransactionalTimeLimit ( )

protected

Call wfTransactionalTimeLimit() if this request was POSTed.

Since: 1.26

Definition at line 2762 of file ApiBase.php.

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

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

ApiBase::validateLimit	(		$paramName,
		&	$value,
			$min,
			$max,
			$botMax = `null`,
			$enforceLimits = `false`
	)

protected

Validate the value against the minimum and user/bot maximum limits.

Prints usage info on failure.

Parameters

string	$paramName	Parameter name
int	$value	Parameter value
int \| null	$min	Minimum value
int \| null	$max	Maximum value for users
int	$botMax	Maximum value for sysops/bots
bool	$enforceLimits	Whether to enforce (die) if value is outside limits

Definition at line 1285 of file ApiBase.php.

References $value, encodeParamName(), getMain(), and warnOrDie().

Referenced by ApiQueryDeletedrevs\execute(), getParameterFromSettings(), and ApiQueryRevisionsBase\parseParameters().

ApiBase::validateTimestamp	(	$value,
		$encParamName
	)

protected

Validate and normalize of parameters of type 'timestamp'.

Parameters

string	$value	Parameter value
string	$encParamName	Parameter name

Returns: string Validated and normalized parameter

Definition at line 1324 of file ApiBase.php.

References $value, dieUsage(), logFeatureUsage(), setWarning(), TS_MW, TS_UNIX, and wfTimestamp().

Referenced by getParameterFromSettings().

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

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

ApiBase::validateUser	(	$value,
		$encParamName
	)

private

Validate and normalize of parameters of type 'user'.

Parameters

string	$value	Parameter value
string	$encParamName	Parameter name

Returns: string Validated and normalized parameter

Definition at line 1398 of file ApiBase.php.

References $title, $value, dieUsage(), Title\makeTitleSafe(), and NS_USER.

Referenced by getParameterFromSettings().

ApiBase::warnOrDie	(	$msg,
		$enforceLimits = `false`
	)

private

Adds a warning to the output, else dies.

Parameters

string	$msg	Message to show as a warning, or error message if dying
bool	$enforceLimits	Whether this is an enforce (die)

Definition at line 1554 of file ApiBase.php.

References dieUsage(), and setWarning().

Referenced by validateLimit().

Member Data Documentation

array ApiBase::$extensionInfo = null

staticprivate

Maps extension paths to info arrays.

Definition at line 193 of file ApiBase.php.

ApiBase::$messageMap

static

Initial value:

= [
        
        'unknownerror' => [ 'code' => 'unknownerror'

Array that maps message keys to error messages.

$1 and friends are replaced.

Definition at line 1673 of file ApiBase.php.

Referenced by ApiErrorFormatter_BackCompat\addWarningOrError(), ApiRollback\execute(), and getErrorFromStatus().

ApiMain ApiBase::$mMainModule

private

Definition at line 196 of file ApiBase.php.

Referenced by getMain(), and isMain().

string ApiBase::$mModuleName

private

Definition at line 198 of file ApiBase.php.

Referenced by getModuleName().

string ApiBase::$mModulePrefix

Definition at line 198 of file ApiBase.php.

Referenced by getModulePrefix().

array null bool ApiBase::$mModuleSource = false

private

Definition at line 202 of file ApiBase.php.

Referenced by getModuleSourceInfo().

ApiBase::$mParamCache = []

private

Definition at line 200 of file ApiBase.php.

ApiBase::$mSlaveDB = null

private

Definition at line 199 of file ApiBase.php.

Referenced by getDB().

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

Referenced by ApiQueryLogEvents\getAllowedParams(), ApiPageSet\getAllowedParams(), getFinalParamDescription(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiDocumentationTest\testDocumentationExists().

const ApiBase::LIMIT_BIG1 = 500

Fast query, standard limit.

Definition at line 177 of file ApiBase.php.

const ApiBase::LIMIT_BIG2 = 5000

Fast query, apihighlimits limit.

Definition at line 179 of file ApiBase.php.

const ApiBase::LIMIT_SML1 = 50

Slow query, standard limit.

Definition at line 181 of file ApiBase.php.

Referenced by ApiQueryDeletedrevs\execute(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiQueryRevisionsBase\parseParameters().

const ApiBase::LIMIT_SML2 = 500

Slow query, apihighlimits limit.

Definition at line 183 of file ApiBase.php.

Referenced by ApiQueryDeletedrevs\execute(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiQueryRevisionsBase\parseParameters().

const ApiBase::PARAM_ALLOW_DUPLICATES = 6

(boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true?

Definition at line 103 of file ApiBase.php.

Referenced by ApiProtect\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), and ApiParamInfo\getModuleInfo().

const ApiBase::PARAM_DEPRECATED = 7

(boolean) Is the parameter deprecated (will show a warning)?

Definition at line 106 of file ApiBase.php.

const ApiBase::PARAM_DFLT = 0

(null|boolean|integer|string) Default value of the parameter.

Definition at line 50 of file ApiBase.php.

const ApiBase::PARAM_HELP_MSG = 10

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

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

Since: 1.25

Definition at line 125 of file ApiBase.php.

const ApiBase::PARAM_HELP_MSG_APPEND = 11

((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.

Since: 1.25

Definition at line 132 of file ApiBase.php.

Referenced by ApiUserrights\getAllowedParams(), ApiAMCreateAccount\getAllowedParams(), ApiRollback\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiEditPage\getAllowedParams(), getFinalParamDescription(), and ApiDocumentationTest\testDocumentationExists().

const ApiBase::PARAM_HELP_MSG_INFO = 12

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

Referenced by ApiQueryRevisions\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiDocumentationTest\testDocumentationExists().

const ApiBase::PARAM_HELP_MSG_PER_VALUE = 14

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

Any value not having a mapping will use apihelp-{$path}-paramvalue-{$param}-{$value}.

Since: 1.25

Definition at line 157 of file ApiBase.php.

const ApiBase::PARAM_ISMULTI = 1

(boolean) Accept multiple pipe-separated values for this parameter (e.g.

titles)?

Definition at line 53 of file ApiBase.php.

const ApiBase::PARAM_MAX = 3

(integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.

Definition at line 91 of file ApiBase.php.

const ApiBase::PARAM_MAX2 = 4

(integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'.

Definition at line 97 of file ApiBase.php.

const ApiBase::PARAM_MIN = 5

(integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'.

Definition at line 100 of file ApiBase.php.

const ApiBase::PARAM_RANGE_ENFORCE = 9

(boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX?

Since: 1.17

Definition at line 118 of file ApiBase.php.

Referenced by ApiParamInfo\getModuleInfo().

const ApiBase::PARAM_REQUIRED = 8

(boolean) Is the parameter required?

Since: 1.17

Definition at line 112 of file ApiBase.php.

const ApiBase::PARAM_SUBMODULE_MAP = 15

(string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths.

Default is to use all modules in $this->getModuleManager() in the group matching the parameter name.

Since: 1.26

Definition at line 165 of file ApiBase.php.

Referenced by ApiPageSet\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

const ApiBase::PARAM_SUBMODULE_PARAM_PREFIX = 16

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

Since: 1.26

Definition at line 172 of file ApiBase.php.

Referenced by ApiPageSet\getAllowedParams(), and ApiParamInfo\getModuleInfo().

const ApiBase::PARAM_TYPE = 2

(string|string[]) Either an array of allowed value strings, or a string type as described below.

If not specified, will be determined from the type of PARAM_DFLT.

Supported string types are:

boolean: A boolean parameter, returned as false if the parameter is omitted and true if present (even with a falsey value, i.e. it works like HTML checkboxes). PARAM_DFLT must be boolean false, if specified. Cannot be used with PARAM_ISMULTI.
integer: An integer value. See also PARAM_MIN, PARAM_MAX, and PARAM_RANGE_ENFORCE.
limit: An integer or the string 'max'. Default lower limit is 0 (but see PARAM_MIN), and requires that PARAM_MAX and PARAM_MAX2 be specified. Cannot be used with PARAM_ISMULTI.
namespace: An integer representing a MediaWiki namespace.
NULL: Any string.
password: Any non-empty string. Input value is private or sensitive. <input type="password"> would be an appropriate HTML form field.
string: Any non-empty string, not expected to be very long or contain newlines. <input type="text"> would be an appropriate HTML form field.
submodule: The name of a submodule of this module, see PARAM_SUBMODULE_MAP.
tags: A string naming an existing, explicitly-defined tag. Should usually be used with PARAM_ISMULTI.
text: Any non-empty string, expected to be very long or contain newlines. <textarea> would be an appropriate HTML form field.
timestamp: A timestamp in any format recognized by MWTimestamp, or the string 'now' representing the current timestamp. Will be returned in TS_MW format.
user: A MediaWiki username or IP. Will be returned normalized but not canonicalized.
upload: An uploaded file. Will be returned as a WebRequestUpload object. Cannot be used with PARAM_ISMULTI.

Definition at line 88 of file ApiBase.php.

const ApiBase::PARAM_VALUE_LINKS = 13

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

Since: 1.25

Definition at line 149 of file ApiBase.php.

Referenced by ApiHelp\getHelpInternal().

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

includes/api/ApiBase.php

Public Member Functions

Public Attributes

Private Attributes

Static Private Attributes

Methods to implement

Data access methods

Parameter handling

Utility methods

Warning and error reporting

Help message generation

Deprecated

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation