MediaWiki  master
ApiBase Class Reference

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, ApiSetPageLanguage, ApiStashEdit, ApiTag, ApiTokens, ApiUnblock, ApiUndelete, ApiUpload, ApiUserrights, ApiValidatePassword, and ApiWatch.

Collaboration diagram for ApiBase:

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 ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

string $mModulePrefix
 
const ALL_DEFAULT_STRING = '*'
 
const GET_VALUES_FOR_HELP = 1
 getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...
 
const LIMIT_BIG1 = 500
 Fast query, standard limit. More...
 
const LIMIT_BIG2 = 5000
 Fast query, apihighlimits limit. More...
 
const LIMIT_SML1 = 50
 Slow query, standard limit. More...
 
const LIMIT_SML2 = 500
 Slow query, apihighlimits limit. More...
 
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...
 
const PARAM_ALL = 17
 (boolean|string) When PARAM_TYPE has a defined set of values and PARAM_ISMULTI is true, this allows for an asterisk ('*') to be passed in place of a pipe-separated list of every possible value. More...
 
const PARAM_EXTRA_NAMESPACES = 18
 (int[]) When PARAM_TYPE is 'namespace', include these as additional possible values. More...
 
const PARAM_SENSITIVE = 19
 (boolean) Is the parameter sensitive? Note 'password'-type fields are always sensitive regardless of the value of this field. More...
 
const PARAM_DEPRECATED_VALUES = 20
 (array) When PARAM_TYPE is an array, this indicates which of the values are deprecated. More...
 
const PARAM_ISMULTI_LIMIT1 = 21
 (integer) Maximum number of values, for normal users. More...
 
const PARAM_ISMULTI_LIMIT2 = 22
 (integer) Maximum number of values, for users with the apihighimits right. More...
 
const PARAM_MAX_BYTES = 23
 (integer) Maximum length of a string in bytes (in UTF-8 encoding). More...
 
const PARAM_MAX_CHARS = 24
 (integer) Maximum length of a string in characters (unicode codepoints). More...
 
const PARAM_TEMPLATE_VARS = 25
 (array) Indicate that this is a templated parameter, and specify replacements. More...
 

Private Attributes

static ApiMain $mMainModule
 
string $mModuleName
 
array null bool $mModuleSource = false
 
 $mParamCache = []
 
 $mReplicaDB = null
 

Static Private Attributes

static $blockMsgMap
 $var array Map of web UI block messages to corresponding API messages and codes More...
 
static array $extensionInfo = null
 Maps extension paths to info arrays. More...
 
static stdClass [][] $filterIDsCache = []
 Cache for self::filterIDs() 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 (ApiContinuationManager $manager=null)
 Set the continuation manager. More...
 
 getDB ()
 Gets a default replica DB connection object. More...
 
 getPermissionManager ()
 Obtain a PermissionManager instance that subclasses may use in their authorization checks. 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...
 
 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, $allSpecifier=null, $limit1=null, $limit2=null)
 Return an array of values that were given in a 'a|b|c' notation, after it optionally validates them against the list allowed values. More...
 
 validateLimit ( $paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
 Validate the value against the minimum and user/bot maximum limits. More...
 
 validateTimestamp ( $value, $encParamName)
 Validate and normalize parameters of type 'timestamp'. More...
 
 parameterNotEmpty ( $x)
 Callback function used in requireOnlyOneParameter to check whether required parameters are set. More...
 
 validateUser ( $value, $encParamName)
 Validate and normalize parameters of type 'user'. 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, User $user=null)
 Add block info to block messages in a Status. More...
 
 setWatch ( $watch, $titleObj, $userOption=null)
 Set a watch (or unwatch) based the based on a watchlist parameter. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
 filterIDs ( $fields, array $ids)
 Filter out-of-range values from a list of positive integer IDs. More...
 
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 ( $exception, array $options=[])
 Abort execution with an error derived from an exception. More...
 
 dieBlocked (AbstractBlock $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 (LinkTarget $linkTarget, $actions, $options=[])
 Helper function for permission-denied errors. More...
 
 dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null)
 Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...
 
 logFeatureUsage ( $feature)
 Write logging information for API features to a debug log, for usage analysis. More...
 
 dieContinueUsageIf ( $condition)
 Die with the 'badcontinue' error. More...
 
 warnOrDie (ApiMessage $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

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

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

Constructor & Destructor Documentation

◆ __construct()

ApiBase::__construct ( ApiMain  $mainModule,
  $moduleName,
  $modulePrefix = '' 
)
Parameters
ApiMain$mainModule
string$moduleNameName of this module
string$modulePrefixPrefix to use for parameter names

Definition at line 303 of file ApiBase.php.

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

Member Function Documentation

◆ addBlockInfoToStatus()

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

Add block info to block messages in a Status.

Since
1.33
Parameters
StatusValue$status
User | null$user

Definition at line 1850 of file ApiBase.php.

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

Referenced by dieStatus().

◆ addDeprecation()

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

◆ 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$msgSee ApiErrorFormatter::addError()
string | null$codeSee ApiErrorFormatter::addError()
array | null$dataSee ApiErrorFormatter::addError()

Definition at line 1977 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 1990 of file ApiBase.php.

References $filter, 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$msgSee ApiErrorFormatter::addWarning()
string | null$codeSee ApiErrorFormatter::addWarning()
array | null$dataSee ApiErrorFormatter::addWarning()

Definition at line 1930 of file ApiBase.php.

References getErrorFormatter(), and getModulePath().

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

◆ checkTitleUserPermissions()

ApiBase::checkTitleUserPermissions ( LinkTarget  $linkTarget,
  $actions,
  $options = [] 
)

Helper function for permission-denied errors.

Parameters
LinkTarget$linkTarget
string|string[]$actions
array$optionsAdditional options
  • user: (User) User to use rather than $this->getUser()
  • autoblock: (bool, default false) Whether to spread autoblocks For compatibility, passing a User object is treated as the value for the 'user' option.
Exceptions
ApiUsageExceptionif the user doesn't have all of the rights.
Since
1.29
1.33 Changed the third parameter from $user to $options.

Definition at line 2152 of file ApiBase.php.

References dieStatus(), errorArrayToStatus(), getPermissionManager(), ContextSource\getUser(), and wfDeprecated().

Referenced by ApiProtect\execute(), ApiImageRotate\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiDelete\execute(), ApiParse\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
Exceptions
ApiUsageExceptionif the user doesn't have any of the rights. The error message is based on $rights[0].

Definition at line 2126 of file ApiBase.php.

References dieWithError(), getPermissionManager(), ContextSource\getUser(), and ContextSource\msg().

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

◆ dieBlocked()

ApiBase::dieBlocked ( AbstractBlock  $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
AbstractBlock$blockThe block used to generate the ApiUsageException
Exceptions
ApiUsageExceptionalways

Definition at line 2051 of file ApiBase.php.

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

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

◆ dieContinueUsageIf()

◆ dieDebug()

◆ dieReadOnly()

ApiBase::dieReadOnly ( )

Helper function for readonly errors.

Exceptions
ApiUsageExceptionalways

Definition at line 2110 of file ApiBase.php.

References dieWithError(), and wfReadOnlyReason().

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

◆ dieStatus()

◆ 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$msgSee ApiErrorFormatter::addError()
string | null$codeSee ApiErrorFormatter::addError()
array | null$dataSee ApiErrorFormatter::addError()
int | null$httpCodeHTTP error code to use
Exceptions
ApiUsageExceptionalways

Definition at line 2011 of file ApiBase.php.

References ApiUsageException\newWithMessage().

Referenced by ApiQuerySiteinfo\appendDbReplLagInfo(), ApiMain\checkAsserts(), ApiMain\checkBotReadOnly(), ApiMain\checkExecutePermissions(), ApiMain\checkMaxLag(), ApiQueryImageInfo\checkParameterNormalise(), ApiUpload\checkPermissions(), checkUserRightsAny(), ApiUpload\checkVerification(), ApiMain\createPrinterByName(), dieBlocked(), dieContinueUsageIf(), dieReadOnly(), dieWithErrorOrDebug(), dieWithException(), ApiCSPReport\error(), ApiValidatePassword\execute(), ApiProtect\execute(), ApiManageTags\execute(), ApiUndelete\execute(), ApiMergeHistory\execute(), ApiEmailUser\execute(), ApiImport\execute(), ApiMove\execute(), ApiWatch\execute(), ApiUpload\execute(), ApiLogout\execute(), ApiQueryExternalLinks\execute(), ApiQueryStashImageInfo\execute(), ApiRevisionDelete\execute(), ApiExpandTemplates\execute(), ApiQueryMyStashedFiles\execute(), ApiDisabled\execute(), ApiQueryAllMessages\execute(), ApiFormatPhp\execute(), ApiQueryLangLinks\execute(), ApiChangeAuthenticationData\execute(), ApiOpenSearchFormatJson\execute(), ApiSetNotificationTimestamp\execute(), ApiPatrol\execute(), ApiEditPage\execute(), ApiQueryBlocks\execute(), ApiQueryIWLinks\execute(), ApiDelete\execute(), ApiUnblock\execute(), ApiOptions\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiBlock\execute(), ApiParse\execute(), ApiFeedRecentChanges\execute(), ApiStashEdit\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiRemoveAuthenticationData\execute(), ApiSetPageLanguage\execute(), ApiComparePages\execute(), ApiFeedContributions\execute(), ApiUserrights\execute(), ApiFeedWatchlist\execute(), ApiAMCreateAccount\execute(), ApiLinkAccount\execute(), ApiClientLogin\execute(), ApiResetPassword\execute(), ApiQueryAllPages\executeGenerator(), ApiQueryAllImages\executeGenerator(), ApiPageSet\executeInternal(), ApiQueryRevisionsBase\extractAllSlotInfo(), ApiUpload\getChunkResult(), ApiUpload\getContextResult(), ApiComparePages\getDiffRevision(), ApiFeedRecentChanges\getFeedObject(), getModuleFromPath(), getParameterFromSettings(), ApiParse\getParsedContent(), ApiRollback\getRbTitle(), ApiRollback\getRbUser(), ApiParse\getSectionContent(), getTitleFromTitleOrPageId(), getTitleOrPageId(), getWatchlistUser(), ApiQueryImageInfo\mergeThumbParams(), ApiQuery\outputGeneralPageInfo(), parseMultiValue(), ApiQueryRevisionsBase\parseParameters(), ApiUpload\performUpload(), ApiQueryBase\prefixedTitlePartToKey(), ApiQueryUserContribs\prepareQuery(), ApiQueryBlocks\prepareUsername(), requireAtLeastOneParameter(), requireMaxOneParameter(), requireOnlyOneParameter(), requirePostedParameters(), ApiQueryDeletedRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryExtLinksUsage\run(), ApiQueryCategories\run(), ApiQueryWatchlistRaw\run(), ApiQuerySearch\run(), ApiQueryCategoryMembers\run(), ApiQueryWatchlist\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), ApiQueryQueryPage\run(), ApiQueryRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\run(), ApiUpload\selectUploadModule(), ApiMain\setupExternalResponse(), ApiMain\setupModule(), ApiQueryBase\titlePartToKey(), ApiFileRevert\validateParameters(), validateTimestamp(), validateUser(), and warnOrDie().

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

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

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

◆ dieWithException()

ApiBase::dieWithException (   $exception,
array  $options = [] 
)

Abort execution with an error derived from an exception.

Since
1.29
Parameters
Exception | Throwable$exceptionSee ApiErrorFormatter::getMessageFromException()
array$optionsSee ApiErrorFormatter::getMessageFromException()
Exceptions
ApiUsageExceptionalways

Definition at line 2023 of file ApiBase.php.

References dieWithError(), and getErrorFormatter().

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

◆ dynamicParameterDocumentation()

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

◆ encodeParamName()

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

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

Referenced by checkTitleUserPermissions(), ApiImageRotate\execute(), ApiPatrol\execute(), ApiRollback\execute(), ApiUnblock\execute(), ApiBlock\execute(), and ApiQueryInfo\extractPageInfo().

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

Referenced by __construct().

◆ explodeMultiValue()

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

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

◆ 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$optionsIf 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 761 of file ApiBase.php.

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

Referenced by ApiAuthManagerHelper\__construct(), ApiPageSet\__construct(), ApiQuerySiteinfo\appendInterwikiMap(), ApiQuerySiteinfo\appendLanguages(), ApiValidatePassword\execute(), ApiProtect\execute(), ApiManageTags\execute(), ApiUndelete\execute(), ApiImageRotate\execute(), ApiTokens\execute(), ApiEmailUser\execute(), ApiMergeHistory\execute(), ApiImport\execute(), ApiCheckToken\execute(), ApiWatch\execute(), ApiMove\execute(), ApiUpload\execute(), ApiPurge\execute(), ApiHelp\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTags\execute(), ApiQueryTokens\execute(), ApiExpandTemplates\execute(), ApiRevisionDelete\execute(), ApiQueryExternalLinks\execute(), ApiQueryMyStashedFiles\execute(), ApiParamInfo\execute(), ApiQuerySiteinfo\execute(), ApiTag\execute(), ApiQueryCategoryInfo\execute(), ApiFileRevert\execute(), ApiQueryLangLinks\execute(), ApiQueryPageProps\execute(), ApiPatrol\execute(), ApiFormatPhp\execute(), ApiEditPage\execute(), ApiQueryAllMessages\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryIWLinks\execute(), ApiDelete\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryBlocks\execute(), ApiOptions\execute(), ApiRollback\execute(), ApiUnblock\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryPagePropNames\execute(), ApiBlock\execute(), ApiFormatXml\execute(), ApiQueryFileRepoInfo\execute(), ApiParse\execute(), ApiQueryAllUsers\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiStashEdit\execute(), ApiFeedRecentChanges\execute(), ApiQueryUserInfo\execute(), ApiRemoveAuthenticationData\execute(), ApiSetPageLanguage\execute(), ApiComparePages\execute(), ApiQueryContributors\execute(), ApiUserrights\execute(), ApiFeedContributions\execute(), ApiFeedWatchlist\execute(), ApiAMCreateAccount\execute(), ApiLinkAccount\execute(), ApiClientLogin\execute(), ApiResetPassword\execute(), ApiFormatJson\execute(), ApiLogin\execute(), ApiOpenSearch\execute(), ApiQueryUsers\execute(), ApiQuery\execute(), ApiQueryInfo\execute(), ApiHelp\getCustomPrinter(), ApiOpenSearch\getFormat(), ApiFormatJson\getMimeType(), getParameter(), ApiComparePages\guessModel(), ApiComparePages\guessTitle(), ApiQuery\isReadMode(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryImages\run(), ApiQueryProtectedTitles\run(), ApiQueryPrefixSearch\run(), ApiQueryExtLinksUsage\run(), ApiQueryLangBacklinks\run(), ApiQueryIWBacklinks\run(), ApiQueryCategories\run(), ApiQueryDuplicateFiles\run(), ApiQueryWatchlistRaw\run(), ApiQuerySearch\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryWatchlist\run(), ApiQueryLinks\run(), ApiQueryAllImages\run(), ApiQueryQueryPage\run(), ApiQueryRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryAllLinks\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\run(), ApiQueryRandom\runQuery(), and ApiMain\setupExecuteAction().

◆ filterIDs()

ApiBase::filterIDs (   $fields,
array  $ids 
)
protected

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

Since
1.33
Parameters
array$fieldsArray 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 1882 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.

Returns
array

Definition at line 394 of file ApiBase.php.

Referenced by getFinalParams().

◆ getConditionalRequestData()

ApiBase::getConditionalRequestData (   $condition)

Returns data for HTTP conditional request mechanisms.

Since
1.26
Parameters
string$conditionCondition 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 505 of file ApiBase.php.

◆ getContinuationManager()

ApiBase::getContinuationManager ( )

Get the continuation manager.

Returns
ApiContinuationManager|null

Definition at line 680 of file ApiBase.php.

References getMain(), and isMain().

Referenced by ApiQueryAllRevisions\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryGeneratorBase\setContinueEnumParameter(), and ApiQueryBase\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.
Returns
mixed Instance of a derived class of ApiFormatBase, or null

Definition at line 354 of file ApiBase.php.

◆ getDB()

ApiBase::getDB ( )
protected

Gets a default replica DB connection object.

Returns
IDatabase

Definition at line 668 of file ApiBase.php.

References $mReplicaDB, DB_REPLICA, and wfGetDB().

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

◆ getErrorFormatter()

◆ 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 369 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
Returns
string|array|Message

Definition at line 2285 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[]

Definition at line 2314 of file ApiBase.php.

References ContextSource\getContext(), getExtendedDescription(), getModuleName(), getModulePath(), getModulePrefix(), getSummaryMessage(), and Hooks\run().

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

References $path, ContextSource\getContext(), getFinalParams(), getModuleFromPath(), getModuleManager(), getModuleName(), getModulePath(), getModulePrefix(), isMain(), ContextSource\msg(), Hooks\run(), and Message\setContext().

◆ getFinalParams()

ApiBase::getFinalParams (   $flags = 0)

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

Parameters
int$flagsZero or more flags like GET_VALUES_FOR_HELP
Returns
array|bool False on no parameters
Since
1.21 $flags param added

Definition at line 2343 of file ApiBase.php.

References getAllowedParams(), needsToken(), and Hooks\run().

Referenced by extractRequestParams(), and getFinalParamDescription().

◆ getFinalSummary()

ApiBase::getFinalSummary ( )

Get final module summary.

Since
1.30
Returns
Message

Definition at line 2298 of file ApiBase.php.

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

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

Definition at line 2511 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
Returns
string|array

Definition at line 378 of file ApiBase.php.

◆ getMain()

ApiBase::getMain ( )

Get the main module.

Returns
ApiMain

Definition at line 536 of file ApiBase.php.

References $mMainModule.

Referenced by ApiFormatJson\__construct(), ApiQueryBase\__construct(), ApiFormatBase\__construct(), ApiContinuationManager\__construct(), ApiPageSet\__construct(), addDeprecation(), ApiFormatBase\closePrinter(), ApiUpload\execute(), ApiHelp\execute(), ApiExpandTemplates\execute(), ApiParamInfo\execute(), ApiEditPage\execute(), ApiQueryDeletedrevs\execute(), ApiParse\execute(), ApiFeedRecentChanges\execute(), ApiComparePages\execute(), ApiFeedWatchlist\execute(), ApiOpenSearch\execute(), ApiQuery\execute(), ApiPageSet\executeInternal(), ApiQueryInfo\extractPageInfo(), ApiParamInfo\getAllowedParams(), ApiUpload\getChunkResult(), getContinuationManager(), ApiQueryUserInfo\getCurrentUserInfo(), ApiFeedRecentChanges\getCustomPrinter(), ApiFeedWatchlist\getCustomPrinter(), ApiFeedContributions\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(), ApiQuerySearch\run(), ApiQueryRandom\run(), ApiQueryBacklinks\run(), ApiUpload\selectUploadModule(), setContinuationManager(), ApiFormatBase\setHttpStatus(), ApiComparePages\setVals(), and validateLimit().

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

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

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

◆ getModuleManager()

ApiBase::getModuleManager ( )

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

Since
1.21
Returns
ApiModuleManager

Definition at line 341 of file ApiBase.php.

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

◆ getModuleName()

ApiBase::getModuleName ( )

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

Returns
string

Definition at line 520 of file ApiBase.php.

References $mModuleName.

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

◆ getModulePath()

◆ getModulePrefix()

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

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

◆ getParameter()

◆ getParameterFromSettings()

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

Using the settings determine the value for the given parameter.

Parameters
string$paramNameParameter name
array | mixed$paramSettingsDefault value or an array of settings using PARAM_* constants.
bool$parseLimitWhether to parse and validate 'limit' parameters
Returns
mixed Parameter value

Definition at line 1140 of file ApiBase.php.

References $type, addDeprecation(), ChangeTags\canAddTagsAccompanyingChange(), dieStatus(), dieWithError(), encodeParamName(), getMain(), getModuleManager(), getModuleName(), getResult(), handleParamNormalization(), parseMultiValue(), validateLimit(), validateTimestamp(), and validateUser().

Referenced by extractRequestParams().

◆ getParent()

ApiBase::getParent ( )

Get the parent of this module.

Since
1.25
Returns
ApiBase|null

Definition at line 554 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 710 of file ApiBase.php.

Referenced by ApiMain\canApiHighLimits(), ApiMain\checkAsserts(), ApiMain\checkExecutePermissions(), checkTitleUserPermissions(), checkUserRightsAny(), ApiQuery\doExport(), ApiManageTags\execute(), ApiUndelete\execute(), ApiImport\execute(), ApiMove\execute(), ApiRevisionDelete\execute(), ApiQueryBlocks\execute(), ApiUnblock\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiBlock\execute(), ApiQueryAllUsers\execute(), ApiQueryLogEvents\execute(), ApiQueryContributors\execute(), ApiUserrights\execute(), ApiResetPassword\execute(), ApiQueryUsers\execute(), ApiQueryInfo\extractPageInfo(), ApiFeedContributions\feedItem(), ApiQueryContributors\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryInfo\getBlockToken(), ApiQueryUserInfo\getCurrentUserInfo(), ApiQueryInfo\getDeleteToken(), ApiQueryInfo\getEditToken(), ApiQueryInfo\getImportToken(), ApiQueryInfo\getMoveToken(), ApiQueryInfo\getProtectToken(), ApiComparePages\getRevisionById(), ApiQueryRevisions\getRollbackToken(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryInfo\getWatchedInfo(), ApiQueryInfo\getWatcherInfo(), ApiPageSet\initFromRevIDs(), ApiMain\modifyHelp(), ApiMove\movePage(), ApiQueryUserContribs\prepareQuery(), ApiTag\processIndividual(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllImages\run(), ApiQueryRevisions\run(), ApiQueryRecentChanges\run(), ApiQueryBase\showHiddenUsersAddBlockInfo(), and ApiQueryBase\userCanSeeRevDel().

◆ getResult()

ApiBase::getResult ( )

Get the result object.

Returns
ApiResult

Definition at line 640 of file ApiBase.php.

References getMain(), and isMain().

Referenced by ApiQueryBase\addPageSubItem(), ApiQueryBase\addPageSubItems(), ApiQuerySiteinfo\appendDbReplLagInfo(), ApiQuerySiteinfo\appendDefaultOptions(), ApiQuerySiteinfo\appendExtensions(), ApiQuerySiteinfo\appendExtensionTags(), ApiQuerySiteinfo\appendFileExtensions(), ApiQuerySiteinfo\appendFunctionHooks(), ApiQuerySiteinfo\appendGeneralInfo(), ApiQuerySiteinfo\appendInstalledLibraries(), ApiQuerySiteinfo\appendInterwikiMap(), ApiQuerySiteinfo\appendLanguages(), ApiQuerySiteinfo\appendLanguageVariants(), ApiQuerySiteinfo\appendMagicWords(), ApiQuerySiteinfo\appendNamespaceAliases(), ApiQuerySiteinfo\appendNamespaces(), ApiQuerySiteinfo\appendProtocols(), ApiQuerySiteinfo\appendRestrictions(), ApiQuerySiteinfo\appendRightsInfo(), ApiQuerySiteinfo\appendSkins(), ApiQuerySiteinfo\appendSpecialPageAliases(), ApiQuerySiteinfo\appendStatistics(), ApiQuerySiteinfo\appendSubscribedHooks(), ApiQuerySiteinfo\appendUploadDialog(), ApiQuerySiteinfo\appendUserGroups(), ApiQuerySiteinfo\appendVariables(), ApiFormatRaw\closePrinter(), ApiFormatBase\closePrinter(), ApiValidatePassword\execute(), ApiProtect\execute(), ApiManageTags\execute(), ApiUndelete\execute(), ApiClearHasMsg\execute(), ApiMergeHistory\execute(), ApiEmailUser\execute(), ApiImageRotate\execute(), ApiTokens\execute(), ApiImport\execute(), ApiWatch\execute(), ApiMove\execute(), ApiCheckToken\execute(), ApiUpload\execute(), ApiRsd\execute(), ApiPurge\execute(), ApiHelp\execute(), ApiExpandTemplates\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTags\execute(), ApiQueryTokens\execute(), ApiRevisionDelete\execute(), ApiQueryMyStashedFiles\execute(), ApiParamInfo\execute(), ApiTag\execute(), ApiChangeAuthenticationData\execute(), ApiFileRevert\execute(), ApiQueryPageProps\execute(), ApiOpenSearchFormatJson\execute(), ApiEditPage\execute(), ApiPatrol\execute(), ApiFormatPhp\execute(), ApiQueryAllMessages\execute(), ApiSetNotificationTimestamp\execute(), ApiQueryAuthManagerInfo\execute(), ApiDelete\execute(), ApiQueryBlocks\execute(), ApiOptions\execute(), ApiRollback\execute(), ApiUnblock\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryPagePropNames\execute(), ApiBlock\execute(), ApiCSPReport\execute(), ApiFormatXml\execute(), ApiQueryFileRepoInfo\execute(), ApiParse\execute(), ApiQueryAllUsers\execute(), ApiQueryImageInfo\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiFeedRecentChanges\execute(), ApiStashEdit\execute(), ApiRemoveAuthenticationData\execute(), ApiSetPageLanguage\execute(), ApiQueryUserInfo\execute(), ApiComparePages\execute(), ApiQueryContributors\execute(), ApiUserrights\execute(), ApiFeedContributions\execute(), ApiFeedWatchlist\execute(), ApiLinkAccount\execute(), ApiAMCreateAccount\execute(), ApiClientLogin\execute(), ApiResetPassword\execute(), ApiFormatJson\execute(), ApiQueryLanguageinfo\execute(), ApiLogin\execute(), ApiFormatRaw\execute(), ApiQueryUsers\execute(), ApiFormatFeedWrapper\execute(), ApiQuery\execute(), ApiQueryInfo\execute(), ApiFormatRaw\getFilename(), ApiFormatRaw\getMimeType(), getParameterFromSettings(), ApiFormatRaw\initPrinter(), ApiFormatFeedWrapper\initPrinter(), ApiQuery\outputGeneralPageInfo(), ApiQueryRevisionsBase\parseParameters(), ApiOpenSearch\populateResult(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryPrefixSearch\run(), ApiQueryExtLinksUsage\run(), ApiQueryLangBacklinks\run(), ApiQueryIWBacklinks\run(), ApiQueryWatchlistRaw\run(), ApiQuerySearch\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryWatchlist\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryAllImages\run(), ApiQueryQueryPage\run(), ApiQueryAllLinks\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\run(), ApiQueryRandom\runQuery(), and ApiUpload\selectUploadModule().

◆ 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
Returns
string|array|Message

Definition at line 2272 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$paramsUser provided set of parameters, as from $this->extractRequestParams()
Returns
Title

Definition at line 1071 of file ApiBase.php.

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

Referenced by ApiQueryBacklinks\run().

◆ 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$paramsUser provided set of parameters, as from $this->extractRequestParams()
bool | string$loadWhether 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 1034 of file ApiBase.php.

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

Referenced by ApiProtect\execute(), ApiEditPage\execute(), ApiDelete\execute(), ApiParse\execute(), ApiStashEdit\execute(), ApiSetPageLanguage\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 1762 of file ApiBase.php.

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

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

◆ getWatchlistValue()

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$watchlistValid values: 'watch', 'unwatch', 'preferences', 'nochange'
Title$titleObjThe page under consideration
string | null$userOptionThe 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 1099 of file ApiBase.php.

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

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

◆ 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$paramsAll supplied parameters for the module
Returns
string|array|null

Definition at line 489 of file ApiBase.php.

Referenced by validateToken().

◆ handleParamNormalization()

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

Handle when a parameter was Unicode-normalized.

Since
1.28
Parameters
string$paramNameUnprefixed parameter name
string$valueInput that will be used.
string$rawValueInput before normalization.

Definition at line 1457 of file ApiBase.php.

References addWarning(), and encodeParamName().

Referenced by getParameterFromSettings().

◆ isDeprecated()

ApiBase::isDeprecated ( )

Indicates whether this module is deprecated.

Since
1.25
Returns
bool

Definition at line 444 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
Returns
bool

Definition at line 454 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 545 of file ApiBase.php.

References $mMainModule.

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

◆ isReadMode()

ApiBase::isReadMode ( )

Indicates whether this module requires read rights.

Returns
bool

Definition at line 412 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 master database access, since only read queries are needed and each master 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.

Returns
bool

Definition at line 427 of file ApiBase.php.

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

◆ lacksSameOriginSecurity()

ApiBase::lacksSameOriginSecurity ( )

◆ 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$featureFeature being used.

Definition at line 2226 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 1797 of file ApiBase.php.

References wfMessage().

Referenced by ApiAMCreateAccount\getFinalDescription(), ApiLinkAccount\getFinalDescription(), ApiClientLogin\getFinalDescription(), 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.

Parameters
string[]&$help Array of help data
array$optionsOptions passed to ApiHelp::getHelp
array&$tocDataIf a TOC is being generated, this array has keys as anchors in the page and values as for Linker::generateTOC().

Definition at line 2633 of file ApiBase.php.

◆ mustBePosted()

ApiBase::mustBePosted ( )

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

Returns
bool

Definition at line 435 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.

Returns
string|false

Definition at line 476 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
object$xParameter to check is not null/false
Returns
bool

Definition at line 1019 of file ApiBase.php.

◆ parseMultiValue()

ApiBase::parseMultiValue (   $valueName,
  $value,
  $allowMultiple,
  $allowedValues,
  $allSpecifier = null,
  $limit1 = null,
  $limit2 = null 
)
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$valueNameThe name of the parameter (for error reporting)
mixed$valueThe value being parsed
bool$allowMultipleCan $value contain more than one value separated by '|'?
string[]|null$allowedValues An array of values to check against. If null, all values are accepted.
string | null$allSpecifierString to use to specify all allowed values, or null if this behavior should not be allowed
int | null$limit1Maximum number of values, for normal users.
int | null$limit2Maximum number of values, for users with the apihighlimits right.
Returns
string|string[] (allowMultiple ? an_array_of_values : a_single_value)

Definition at line 1497 of file ApiBase.php.

References addWarning(), dieWithError(), explodeMultiValue(), Message\listParam(), and wfEscapeWikiText().

Referenced by getParameterFromSettings().

◆ requireAtLeastOneParameter()

ApiBase::requireAtLeastOneParameter (   $params,
  $required 
)

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

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

Definition at line 959 of file ApiBase.php.

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

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

◆ requireMaxOneParameter()

ApiBase::requireMaxOneParameter (   $params,
  $required 
)

◆ 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$paramsUser provided set of parameters, as from $this->extractRequestParams()
string$required,...Names of parameters of which exactly one must be set

Definition at line 893 of file ApiBase.php.

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

Referenced by ApiMergeHistory\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiUnblock\execute(), ApiBlock\execute(), ApiStashEdit\execute(), ApiQueryUserContribs\execute(), ApiResetPassword\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$prefixSet to 'noprefix' to skip calling $this->encodeParamName()

Definition at line 989 of file ApiBase.php.

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

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

◆ setContinuationManager()

ApiBase::setContinuationManager ( ApiContinuationManager  $manager = null)

Set the continuation manager.

Parameters
ApiContinuationManager | null$manager

Definition at line 694 of file ApiBase.php.

References getMain(), and isMain().

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

◆ setWatch()

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

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

Parameters
string$watchValid values: 'watch', 'unwatch', 'preferences', 'nochange'
Title$titleObjThe article's title to change
string | null$userOptionThe user option to consider when $watch=preferences

Definition at line 1747 of file ApiBase.php.

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

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

◆ shouldCheckMaxlag()

ApiBase::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns
bool

Definition at line 404 of file ApiBase.php.

◆ useTransactionalTimeLimit()

◆ validateLimit()

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$paramNameParameter name
int&$valueParameter value
int | null$minMinimum value
int | null$maxMaximum value for users
int | null$botMaxMaximum value for sysops/bots
bool$enforceLimitsWhether to enforce (die) if value is outside limits

Definition at line 1578 of file ApiBase.php.

References ApiMessage\create(), encodeParamName(), getMain(), and warnOrDie().

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

◆ validateTimestamp()

ApiBase::validateTimestamp (   $value,
  $encParamName 
)
protected

Validate and normalize parameters of type 'timestamp'.

Parameters
string$valueParameter value
string$encParamNameParameter name
Returns
string Validated and normalized parameter

Definition at line 1631 of file ApiBase.php.

References addDeprecation(), dieWithError(), wfEscapeWikiText(), and wfTimestamp().

Referenced by getParameterFromSettings().

◆ validateToken()

ApiBase::validateToken (   $token,
array  $params 
)
final

Validate the supplied token.

Since
1.24
Parameters
string$tokenSupplied token
array$paramsAll supplied parameters for the module
Returns
bool
Exceptions
MWException

Definition at line 1668 of file ApiBase.php.

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

◆ validateUser()

ApiBase::validateUser (   $value,
  $encParamName 
)
private

Validate and normalize parameters of type 'user'.

Parameters
string$valueParameter value
string$encParamNameParameter name
Returns
string Validated and normalized parameter

Definition at line 1703 of file ApiBase.php.

References dieWithError(), User\getCanonicalName(), ExternalUserNames\isExternal(), IP\isIPAddress(), User\newFromName(), RE_IP_BYTE, IP\sanitizeIP(), and wfEscapeWikiText().

Referenced by getParameterFromSettings().

◆ warnOrDie()

ApiBase::warnOrDie ( ApiMessage  $msg,
  $enforceLimits = false 
)
private

Adds a warning to the output, else dies.

Parameters
ApiMessage$msgMessage to show as a warning, or error message if dying
bool$enforceLimitsWhether this is an enforce (die)

Definition at line 2035 of file ApiBase.php.

References addWarning(), and dieWithError().

Referenced by validateLimit().

Member Data Documentation

◆ $blockMsgMap

ApiBase::$blockMsgMap
staticprivate
Initial value:
= [
'blockedtext' => [ 'apierror-blocked', 'blocked' ]

$var array Map of web UI block messages to corresponding API messages and codes

Definition at line 281 of file ApiBase.php.

◆ $extensionInfo

array ApiBase::$extensionInfo = null
staticprivate

Maps extension paths to info arrays.

Definition at line 275 of file ApiBase.php.

◆ $filterIDsCache

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

Cache for self::filterIDs()

Definition at line 278 of file ApiBase.php.

◆ $mMainModule

ApiMain ApiBase::$mMainModule
private

Definition at line 286 of file ApiBase.php.

Referenced by getMain(), and isMain().

◆ $mModuleName

string ApiBase::$mModuleName
private

Definition at line 292 of file ApiBase.php.

Referenced by getModuleName().

◆ $mModulePrefix

string ApiBase::$mModulePrefix

Definition at line 292 of file ApiBase.php.

Referenced by getModulePrefix().

◆ $mModuleSource

array null bool ApiBase::$mModuleSource = false
private

Definition at line 296 of file ApiBase.php.

Referenced by getModuleSourceInfo().

◆ $mParamCache

ApiBase::$mParamCache = []
private

Definition at line 294 of file ApiBase.php.

◆ $mReplicaDB

ApiBase::$mReplicaDB = null
private

Definition at line 293 of file ApiBase.php.

Referenced by getDB().

◆ ALL_DEFAULT_STRING

const ApiBase::ALL_DEFAULT_STRING = '*'

Definition at line 256 of file ApiBase.php.

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

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

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

◆ LIMIT_BIG1

const ApiBase::LIMIT_BIG1 = 500

Fast query, standard limit.

Definition at line 259 of file ApiBase.php.

Referenced by buildCommonApiParams(), ApiQueryDeletedrevs\execute(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\parseParameters(), and ApiQueryBacklinks\run().

◆ LIMIT_BIG2

const ApiBase::LIMIT_BIG2 = 5000

Fast query, apihighlimits limit.

Definition at line 261 of file ApiBase.php.

Referenced by buildCommonApiParams(), ApiQueryDeletedrevs\execute(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\parseParameters(), and ApiQueryBacklinks\run().

◆ LIMIT_SML1

const ApiBase::LIMIT_SML1 = 50

◆ LIMIT_SML2

const ApiBase::LIMIT_SML2 = 500

Slow query, apihighlimits limit.

Definition at line 265 of file ApiBase.php.

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

◆ PARAM_ALL

const ApiBase::PARAM_ALL = 17

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

If a string is set, it will be used in place of the asterisk.

Since
1.29

Definition at line 187 of file ApiBase.php.

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

◆ PARAM_ALLOW_DUPLICATES

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

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

◆ PARAM_DEPRECATED

◆ PARAM_DEPRECATED_VALUES

const ApiBase::PARAM_DEPRECATED_VALUES = 20

(array) When PARAM_TYPE is an array, this indicates which of the values are deprecated.

Keys are the deprecated parameter values, values define the warning message to emit: either boolean true (to use a default message) or a $msg for ApiBase::makeMessage().

Since
1.30

Definition at line 209 of file ApiBase.php.

Referenced by ApiQueryUserInfo\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiParse\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_DFLT

const ApiBase::PARAM_DFLT = 0

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

Definition at line 55 of file ApiBase.php.

Referenced by buildCommonApiParams(), buildProfileApiParam(), ApiFormatPhp\getAllowedParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiTokens\getAllowedParams(), ApiQueryTokens\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiUndelete\getAllowedParams(), ApiFileRevert\getAllowedParams(), ApiRollback\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiFormatJson\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiStashEdit\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiTag\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiDelete\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiOptions\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiMove\getAllowedParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiCSPReport\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryDeletedRevisions\getAllowedParams(), ApiOpenSearch\getAllowedParams(), ApiFormatXml\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiFormatBase\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiParse\getAllowedParams(), ApiUpload\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiHelp\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiMain\getAllowedParams(), ApiOpenSearch\getFormat(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiAuthManagerHelper\getStandardParams().

◆ PARAM_EXTRA_NAMESPACES

const ApiBase::PARAM_EXTRA_NAMESPACES = 18

(int[]) When PARAM_TYPE is 'namespace', include these as additional possible values.

Since
1.29

Definition at line 193 of file ApiBase.php.

Referenced by ApiQueryLinks\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_HELP_MSG

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

Referenced by buildCommonApiParams(), buildProfileApiParam(), ApiFormatPhp\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryCategoryInfo\getAllowedParams(), ApiQueryPageProps\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiFormatJson\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiPurge\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiWatch\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiImageRotate\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiSetNotificationTimestamp\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiLogin\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryDeletedRevisions\getAllowedParams(), ApiFormatXml\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiFormatBase\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiParse\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiPageSet\getAllowedParams(), and ApiAuthManagerHelper\getStandardParams().

◆ PARAM_HELP_MSG_APPEND

◆ PARAM_HELP_MSG_INFO

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

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

◆ PARAM_HELP_MSG_PER_VALUE

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}. Specify an empty array to use the default message key for all values.

Since
1.25

Definition at line 164 of file ApiBase.php.

Referenced by buildProfileApiParam(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiParse\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), and ApiQueryInfo\getAllowedParams().

◆ PARAM_ISMULTI

const ApiBase::PARAM_ISMULTI = 1

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

titles)?

Definition at line 58 of file ApiBase.php.

Referenced by buildCommonApiParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiPatrol\getAllowedParams(), ApiTokens\getAllowedParams(), ApiQueryPageProps\getAllowedParams(), ApiQueryTokens\getAllowedParams(), ApiUndelete\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiUnblock\getAllowedParams(), ApiRollback\getAllowedParams(), ApiSetPageLanguage\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiImport\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiImageRotate\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiTag\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiBlock\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiDelete\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiOptions\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiMove\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiParse\getAllowedParams(), ApiUpload\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiHelp\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiAuthManagerHelper\getStandardParams().

◆ PARAM_ISMULTI_LIMIT1

const ApiBase::PARAM_ISMULTI_LIMIT1 = 21

(integer) Maximum number of values, for normal users.

Must be used with PARAM_ISMULTI.

Since
1.30

Definition at line 215 of file ApiBase.php.

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

◆ PARAM_ISMULTI_LIMIT2

const ApiBase::PARAM_ISMULTI_LIMIT2 = 22

(integer) Maximum number of values, for users with the apihighimits right.

Must be used with PARAM_ISMULTI.

Since
1.30

Definition at line 222 of file ApiBase.php.

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

◆ PARAM_MAX

const ApiBase::PARAM_MAX = 3

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

Definition at line 97 of file ApiBase.php.

Referenced by buildCommonApiParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiUpload\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_MAX2

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

Referenced by buildCommonApiParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_MAX_BYTES

const ApiBase::PARAM_MAX_BYTES = 23

(integer) Maximum length of a string in bytes (in UTF-8 encoding).

Since
1.31

Definition at line 228 of file ApiBase.php.

◆ PARAM_MAX_CHARS

const ApiBase::PARAM_MAX_CHARS = 24

(integer) Maximum length of a string in characters (unicode codepoints).

Since
1.31

Definition at line 234 of file ApiBase.php.

◆ PARAM_MIN

const ApiBase::PARAM_MIN = 5

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

Definition at line 106 of file ApiBase.php.

Referenced by buildCommonApiParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiUpload\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().

◆ PARAM_RANGE_ENFORCE

const ApiBase::PARAM_RANGE_ENFORCE = 9

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

Since
1.17

Definition at line 124 of file ApiBase.php.

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

◆ PARAM_REQUIRED

◆ PARAM_SENSITIVE

const ApiBase::PARAM_SENSITIVE = 19

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

Since
1.29

Definition at line 200 of file ApiBase.php.

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

◆ PARAM_SUBMODULE_MAP

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

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

◆ PARAM_SUBMODULE_PARAM_PREFIX

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

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

◆ PARAM_TEMPLATE_VARS

const ApiBase::PARAM_TEMPLATE_VARS = 25

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

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

◆ PARAM_TYPE

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. Forces PARAM_ALL = true to support easily specifying all namespaces.
  • 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 94 of file ApiBase.php.

Referenced by buildCommonApiParams(), buildProfileApiParam(), ApiValidatePassword\getAllowedParams(), ApiCheckToken\getAllowedParams(), ApiFormatPhp\getAllowedParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiEmailUser\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiPatrol\getAllowedParams(), ApiTokens\getAllowedParams(), ApiQueryAuthManagerInfo\getAllowedParams(), ApiResetPassword\getAllowedParams(), ApiQueryTokens\getAllowedParams(), ApiMergeHistory\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiUndelete\getAllowedParams(), ApiFileRevert\getAllowedParams(), ApiUnblock\getAllowedParams(), ApiRollback\getAllowedParams(), ApiSetPageLanguage\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiFormatJson\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiImport\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiWatch\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiStashEdit\getAllowedParams(), ApiImageRotate\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiTag\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiBlock\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiDelete\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiOptions\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), ApiSetNotificationTimestamp\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiMove\getAllowedParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiLogin\getAllowedParams(), ApiCSPReport\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryDeletedRevisions\getAllowedParams(), ApiOpenSearch\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiParse\getAllowedParams(), ApiUpload\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiMain\getAllowedParams(), ApiOpenSearch\getFormat(), ApiHelp\getHelpInternal(), ApiParamInfo\getModuleInfo(), and ApiAuthManagerHelper\getStandardParams().

◆ PARAM_VALUE_LINKS

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

Referenced by ApiHelp\getHelpInternal().


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