MediaWiki  master
ApiBase Class Reference

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

Inheritance diagram for ApiBase:
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 ()
 Get the Config object. More...
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 Get the Language object. More...
 
 getOutput ()
 Get the OutputPage object. More...
 
 getRequest ()
 Get the WebRequest object. More...
 
 getSkin ()
 Get the Skin object. More...
 
 getStats ()
 Get the Stats object. More...
 
 getTiming ()
 Get the Timing object. More...
 
 getTitle ()
 Get the Title object. More...
 
 getUser ()
 Get the User object. More...
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ()
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 Set the IContextSource object. More...
 

Public Attributes

string $mModulePrefix
 
const GET_VALUES_FOR_HELP = 1
 getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...
 
const LIMIT_BIG1 = 500
 Fast query, standard limit. More...
 
const LIMIT_BIG2 = 5000
 Fast query, apihighlimits limit. More...
 
const LIMIT_SML1 = 50
 Slow query, standard limit. More...
 
const LIMIT_SML2 = 500
 Slow query, apihighlimits limit. More...
 
Constants for ::getAllowedParams() arrays

These constants are keys in the arrays returned by ::getAllowedParams() and accepted by ::getParameterFromSettings() that define how the parameters coming in from the request are to be interpreted.

const PARAM_DFLT = 0
 (null|boolean|integer|string) Default value of the parameter. More...
 
const PARAM_ISMULTI = 1
 (boolean) Accept multiple pipe-separated values for this parameter (e.g. More...
 
const PARAM_TYPE = 2
 (string|string[]) Either an array of allowed value strings, or a string type as described below. More...
 
const PARAM_MAX = 3
 (integer) Max value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More...
 
const PARAM_MAX2 = 4
 (integer) Max value allowed for the parameter for users with the apihighlimits right, for PARAM_TYPE 'limit'. More...
 
const PARAM_MIN = 5
 (integer) Lowest value allowed for the parameter, for PARAM_TYPE 'integer' and 'limit'. More...
 
const PARAM_ALLOW_DUPLICATES = 6
 (boolean) Allow the same value to be set more than once when PARAM_ISMULTI is true? More...
 
const PARAM_DEPRECATED = 7
 (boolean) Is the parameter deprecated (will show a warning)? More...
 
const PARAM_REQUIRED = 8
 (boolean) Is the parameter required? More...
 
const PARAM_RANGE_ENFORCE = 9
 (boolean) For PARAM_TYPE 'integer', enforce PARAM_MIN and PARAM_MAX? More...
 
const PARAM_HELP_MSG = 10
 (string|array|Message) Specify an alternative i18n documentation message for this parameter. More...
 
const PARAM_HELP_MSG_APPEND = 11
 ((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More...
 
const PARAM_HELP_MSG_INFO = 12
 (array) Specify additional information tags for the parameter. More...
 
const PARAM_VALUE_LINKS = 13
 (string[]) When PARAM_TYPE is an array, this may be an array mapping those values to page titles which will be linked in the help. More...
 
const PARAM_HELP_MSG_PER_VALUE = 14
 ((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More...
 
const PARAM_SUBMODULE_MAP = 15
 (string[]) When PARAM_TYPE is 'submodule', map parameter values to submodule paths. More...
 
const PARAM_SUBMODULE_PARAM_PREFIX = 16
 (string) When PARAM_TYPE is 'submodule', used to indicate the 'g' prefix added by ApiQueryGeneratorBase (and similar if anything else ever does that). More...
 

Private Attributes

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

Static Private Attributes

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

Methods to implement

 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result. More...
 
 getModuleManager ()
 Get the module manager, or null if this module has no sub-modules. More...
 
 getCustomPrinter ()
 If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More...
 
 getHelpUrls ()
 Return links to more detailed help pages about the module. More...
 
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked. More...
 
 isReadMode ()
 Indicates whether this module requires read rights. More...
 
 isWriteMode ()
 Indicates whether this module requires write mode. More...
 
 mustBePosted ()
 Indicates whether this module must be called with a POST request. More...
 
 isDeprecated ()
 Indicates whether this module is deprecated. More...
 
 isInternal ()
 Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More...
 
 needsToken ()
 Returns the token type this module requires in order to execute. More...
 
 getConditionalRequestData ($condition)
 Returns data for HTTP conditional request mechanisms. More...
 
 getExamplesMessages ()
 Returns usage examples for this module. More...
 
 getAllowedParams ()
 Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed. More...
 
 getWebUITokenSalt (array $params)
 Fetch the salt used in the Web UI corresponding to this module. More...
 

Data access methods

 getModuleName ()
 Get the name of the module being executed by this instance. More...
 
 getModulePrefix ()
 Get parameter prefix (usually two letters or an empty string). More...
 
 getMain ()
 Get the main module. More...
 
 isMain ()
 Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More...
 
 getParent ()
 Get the parent of this module. More...
 
 lacksSameOriginSecurity ()
 Returns true if the current request breaks the same-origin policy. More...
 
 getModulePath ()
 Get the path to this module. More...
 
 getModuleFromPath ($path)
 Get a module from its module path. More...
 
 getResult ()
 Get the result object. More...
 
 getErrorFormatter ()
 Get the error formatter. More...
 
 getContinuationManager ()
 Get the continuation manager. More...
 
 setContinuationManager ($manager)
 Set the continuation manager. More...
 
 getDB ()
 Gets a default slave database connection object. More...
 

Parameter handling

 dynamicParameterDocumentation ()
 Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More...
 
 encodeParamName ($paramName)
 This method mangles parameter name based on the prefix supplied to the constructor. More...
 
 extractRequestParams ($parseLimit=true)
 Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More...
 
 requireOnlyOneParameter ($params, $required)
 Die if none or more than one of a certain set of parameters is set and not false. More...
 
 requireMaxOneParameter ($params, $required)
 Die if more than one of a certain set of parameters is set and not false. More...
 
 requireAtLeastOneParameter ($params, $required)
 Die if none of a certain set of parameters is set and not false. More...
 
 getTitleOrPageId ($params, $load=false)
 Get a WikiPage object from a title or pageid param, if possible. More...
 
 validateToken ($token, array $params)
 Validate the supplied token. More...
 
 getParameter ($paramName, $parseLimit=true)
 Get a value for the given parameter. More...
 
 getWatchlistValue ($watchlist, $titleObj, $userOption=null)
 Return true if we're to watch the page, false if not, null if no change. More...
 
 getParameterFromSettings ($paramName, $paramSettings, $parseLimit)
 Using the settings determine the value for the given parameter. More...
 
 parseMultiValue ($valueName, $value, $allowMultiple, $allowedValues)
 Return an array of values that were given in a 'a|b|c' notation, after it optionally validates them against the list allowed values. More...
 
 validateLimit ($paramName, &$value, $min, $max, $botMax=null, $enforceLimits=false)
 Validate the value against the minimum and user/bot maximum limits. More...
 
 validateTimestamp ($value, $encParamName)
 Validate and normalize of parameters of type 'timestamp'. More...
 
 parameterNotEmpty ($x)
 Callback function used in requireOnlyOneParameter to check whether required parameters are set. More...
 
 validateUser ($value, $encParamName)
 Validate and normalize of parameters of type 'user'. More...
 

Utility methods

 getWatchlistUser ($params)
 Gets the user for whom to get the watchlist. More...
 
 setWatch ($watch, $titleObj, $userOption=null)
 Set a watch (or unwatch) based the based on a watchlist parameter. More...
 
static truncateArray (&$arr, $limit)
 Truncate an array to a certain length. More...
 
static makeMessage ($msg, IContextSource $context, array $params=null)
 Create a Message from a string or array. More...
 
static escapeWikiText ($v)
 A subset of wfEscapeWikiText for BC texts. More...
 

Warning and error reporting

static $messageMap
 Array that maps message keys to error messages. More...
 
 setWarning ($warning)
 Set warning section for this module. More...
 
 dieUsage ($description, $errorCode, $httpRespCode=0, $extradata=null)
 Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message. More...
 
 dieBlocked (Block $block)
 Throw a UsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More...
 
 getErrorFromStatus ($status, &$extraData=null)
 Get error (as code, string) from a Status object. More...
 
 dieStatus ($status)
 Throw a UsageException based on the errors in the Status object. More...
 
static dieReadOnly ()
 Helper function for readonly errors. More...
 
 dieUsageMsg ($error)
 Output the error message related to a certain array. More...
 
 dieUsageMsgOrDebug ($error)
 Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More...
 
 parseMsg ($error)
 Return the error message related to a certain array. More...
 
 dieContinueUsageIf ($condition)
 Die with the $prefix. More...
 
 logFeatureUsage ($feature)
 Write logging information for API features to a debug log, for usage analysis. More...
 
 warnOrDie ($msg, $enforceLimits=false)
 Adds a warning to the output, else dies. More...
 
static dieDebug ($method, $message)
 Internal code errors should be reported with this method. More...
 

Help message generation

 getFinalDescription ()
 Get final module description, after hooks have had a chance to tweak it as needed. More...
 
 getFinalParams ($flags=0)
 Get final list of parameters, after hooks have had a chance to tweak it as needed. More...
 
 getFinalParamDescription ()
 Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More...
 
 modifyHelp (array &$help, array $options, array &$tocData)
 Called from ApiHelp before the pieces are joined together and returned. More...
 
 getDescriptionMessage ()
 Return the description message. More...
 
 getHelpFlags ()
 Generates the list of flags for the help screen and for action=paraminfo. More...
 
 getModuleSourceInfo ()
 Returns information about the source of this module, if known. More...
 

Deprecated

 makeHelpMsg ()
 Generates help message for this module, or false if there is no description. More...
 
 makeHelpMsgParameters ()
 Generates the parameter descriptions for this module, to be displayed in the module's help. More...
 
 getModuleProfileName ($db=false)
 
 profileIn ()
 
 profileOut ()
 
 safeProfileOut ()
 
 getProfileTime ()
 
 profileDBIn ()
 
 profileDBOut ()
 
 getProfileDBTime ()
 
 getResultData ()
 Get the result data array (read-only) More...
 
 getDescription ()
 Returns the description string for this module. More...
 
 getParamDescription ()
 Returns an array of parameter descriptions. More...
 
 getExamples ()
 Returns usage examples for this module. More...
 
 makeHelpArrayToString ($prefix, $title, $input)
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
 indentExampleText ($item)
 

Detailed Description

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

The class functions are divided into several areas of functionality:

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

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

Definition at line 39 of file ApiBase.php.

Constructor & Destructor Documentation

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

Definition at line 209 of file ApiBase.php.

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

Member Function Documentation

ApiBase::dieBlocked ( Block  $block)

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

Since
1.27
Parameters
Block$blockThe block used to generate the UsageException
Exceptions
UsageExceptionalways

Definition at line 1492 of file ApiBase.php.

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

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

static ApiBase::dieReadOnly ( )

Helper function for readonly errors.

Exceptions
UsageExceptionalways

Definition at line 2082 of file ApiBase.php.

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

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

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

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

Parameters
string$descriptionOne-line human-readable description of the error condition, e.g., "The API requires a valid action parameter"
string$errorCodeBrief, arbitrary, stable string to allow easy automated identification of the error, e.g., 'unknown_action'
int$httpRespCodeHTTP response code
array | null$extradataData to add to the "<error>" element; array in ApiResult format
Exceptions
UsageExceptionalways

Definition at line 1475 of file ApiBase.php.

References encodeParamName().

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

ApiBase::dieUsageMsg (   $error)

Output the error message related to a certain array.

Parameters
array | string$errorElement of a getUserPermissionsErrors()-style array
Exceptions
UsageExceptionalways

Definition at line 2093 of file ApiBase.php.

References dieUsage(), and parseMsg().

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

ApiBase::dieUsageMsgOrDebug (   $error)

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

Otherwise behaves exactly as dieUsageMsg().

Parameters
array | string$errorElement of a getUserPermissionsErrors()-style array
Exceptions
UsageException
Since
1.21

Definition at line 2111 of file ApiBase.php.

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

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

ApiBase::dynamicParameterDocumentation ( )

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

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

Definition at line 649 of file ApiBase.php.

ApiBase::encodeParamName (   $paramName)

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

Override this method to change parameter name during runtime

Parameters
string$paramNameParameter name
Returns
string Prefixed parameter name

Definition at line 659 of file ApiBase.php.

Referenced by ApiContinuationManager\addContinueParam(), ApiContinuationManager\addGeneratorContinueParam(), dieUsage(), ApiQueryLogEvents\execute(), getParameterFromSettings(), makeHelpMsgParameters(), and validateLimit().

static ApiBase::escapeWikiText (   $v)
staticprivate

A subset of wfEscapeWikiText for BC texts.

Since
1.25
Parameters
string | array$v
Returns
string|array

Definition at line 1388 of file ApiBase.php.

ApiBase::execute ( )
abstract

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

Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.

The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.

The result data should be stored in the ApiResult object available through getResult().

ApiBase::extractRequestParams (   $parseLimit = true)

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

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

Parameters
bool$parseLimitTrue by default
Returns
array

Definition at line 672 of file ApiBase.php.

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

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

ApiBase::getAllowedParams ( )
protected

Returns an array of allowed parameters (parameter name) => (default value) or (parameter name) => (array with PARAM_* constants as keys) Don't call this function directly: use getFinalParams() to allow hooks to modify parameters as needed.

Some derived classes may choose to handle an integer $flags parameter in the overriding methods. Callers of this method can pass zero or more OR-ed flags like GET_VALUES_FOR_HELP.

Returns
array

Definition at line 338 of file ApiBase.php.

Referenced by getFinalParams().

ApiBase::getConditionalRequestData (   $condition)

Returns data for HTTP conditional request mechanisms.

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

ApiBase::getContinuationManager ( )

Get the continuation manager.

Returns
ApiContinuationManager|null

Definition at line 611 of file ApiBase.php.

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

Referenced by ApiQueryGeneratorBase\setContinueEnumParameter(), and ApiQueryBase\setContinueEnumParameter().

ApiBase::getCustomPrinter ( )

If the module may only be used with a certain format module, it should override this method to return an instance of that formatter.

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

Note
Do not use this just because you don't want to support non-json formats. This should be used only when there is a fundamental requirement for a specific format.
Returns
mixed Instance of a derived class of ApiFormatBase, or null

Definition at line 260 of file ApiBase.php.

ApiBase::getDB ( )
protected

Gets a default slave database connection object.

Returns
DatabaseBase

Definition at line 599 of file ApiBase.php.

References $mSlaveDB, DB_SLAVE, and wfGetDB().

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

ApiBase::getDescription ( )
protected

Returns the description string for this module.

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

Deprecated:
since 1.25
Returns
Message|string|array

Definition at line 2536 of file ApiBase.php.

Referenced by getFinalDescription().

ApiBase::getDescriptionMessage ( )
protected

Return the description message.

Returns
string|array|Message

Definition at line 2210 of file ApiBase.php.

Referenced by getFinalDescription().

ApiBase::getErrorFormatter ( )

Get the error formatter.

Returns
ApiErrorFormatter

Definition at line 585 of file ApiBase.php.

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

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

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

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

Since
1.23
Parameters
Status$status
array | null&$extraDataSet if extra data from IApiMessage is available (since 1.27)
Returns
array Array of code and error string
Exceptions
MWException

Definition at line 1520 of file ApiBase.php.

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

Referenced by dieStatus(), ApiMove\execute(), and ApiWatch\watchTitle().

ApiBase::getExamples ( )
protected

Returns usage examples for this module.

Return value as an array is either:

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

Definition at line 2572 of file ApiBase.php.

Referenced by getExamplesMessages(), and makeHelpMsg().

ApiBase::getExamplesMessages ( )
protected

Returns usage examples for this module.

Return value has query strings as keys, with values being either strings (message key), arrays (message key + parameter), or Message objects.

Do not call this base class implementation when overriding this method.

Since
1.25
Returns
array

Definition at line 275 of file ApiBase.php.

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

ApiBase::getFinalDescription ( )

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

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

Definition at line 2221 of file ApiBase.php.

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

Referenced by makeHelpMsg().

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

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

Referenced by makeHelpMsgParameters().

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

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

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

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

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

ApiBase::getHelpUrls ( )

Return links to more detailed help pages about the module.

Since
1.25, returning boolean false is deprecated
Returns
string|array

Definition at line 322 of file ApiBase.php.

Referenced by makeHelpMsg().

ApiBase::getModuleFromPath (   $path)

Get a module from its module path.

Since
1.25
Parameters
string$path
Returns
ApiBase|null
Exceptions
UsageException

Definition at line 533 of file ApiBase.php.

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

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

ApiBase::getModuleManager ( )

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

Since
1.21
Returns
ApiModuleManager

Definition at line 247 of file ApiBase.php.

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

ApiBase::getModuleName ( )

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

Returns
string

Definition at line 457 of file ApiBase.php.

References $mModuleName.

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

ApiBase::getModuleProfileName (   $db = false)
Deprecated:
since 1.25, always returns empty string
Parameters
IDatabase | bool$db
Returns
string

Definition at line 2850 of file ApiBase.php.

References wfDeprecated().

ApiBase::getModuleSourceInfo ( )
protected

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

Returned array is an array with the following keys:

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

Definition at line 2430 of file ApiBase.php.

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

ApiBase::getParamDescription ( )
protected

Returns an array of parameter descriptions.

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

Deprecated:
since 1.25
Returns
array|bool False on no parameter descriptions

Definition at line 2552 of file ApiBase.php.

Referenced by getFinalParamDescription().

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$parseLimitParse limit?
Returns
mixed Parameter value

Definition at line 873 of file ApiBase.php.

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

Referenced by extractRequestParams(), and getParameter().

ApiBase::getParent ( )

Get the parent of this module.

Since
1.25
Returns
ApiBase|null

Definition at line 491 of file ApiBase.php.

References getMain(), and isMain().

Referenced by getModulePath().

ApiBase::getProfileDBTime ( )
Deprecated:
since 1.25, always returns 0
Returns
float

Definition at line 2905 of file ApiBase.php.

References wfDeprecated().

ApiBase::getProfileTime ( )
Deprecated:
since 1.25, always returns 0
Returns
float

Definition at line 2882 of file ApiBase.php.

References wfDeprecated().

ApiBase::getResult ( )

Get the result object.

Returns
ApiResult

Definition at line 571 of file ApiBase.php.

References dieDebug(), 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\appendMagicWords(), ApiQuerySiteinfo\appendNamespaceAliases(), ApiQuerySiteinfo\appendNamespaces(), ApiQuerySiteinfo\appendProtocols(), ApiQuerySiteinfo\appendRestrictions(), ApiQuerySiteinfo\appendRightsInfo(), ApiQuerySiteinfo\appendSkins(), ApiQuerySiteinfo\appendSpecialPageAliases(), ApiQuerySiteinfo\appendStatistics(), ApiQuerySiteinfo\appendSubscribedHooks(), ApiQuerySiteinfo\appendUserGroups(), ApiQuerySiteinfo\appendVariables(), ApiFormatRaw\closePrinter(), ApiComparePages\execute(), ApiManageTags\execute(), ApiTag\execute(), ApiProtect\execute(), ApiClearHasMsg\execute(), ApiCheckToken\execute(), ApiCreateAccount\execute(), ApiUndelete\execute(), ApiEmailUser\execute(), ApiTokens\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiQueryStashImageInfo\execute(), ApiImport\execute(), ApiRevisionDelete\execute(), ApiRsd\execute(), ApiQueryMyStashedFiles\execute(), ApiWatch\execute(), ApiPatrol\execute(), ApiUpload\execute(), ApiExpandTemplates\execute(), ApiQueryTokens\execute(), ApiHelp\execute(), ApiSetNotificationTimestamp\execute(), ApiOptions\execute(), ApiFormatPhp\execute(), ApiEditPage\execute(), ApiQueryAllMessages\execute(), ApiQueryTags\execute(), ApiQueryBlocks\execute(), ApiUnblock\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiPurge\execute(), ApiQueryDeletedrevs\execute(), ApiQueryPageProps\execute(), ApiQueryFilearchive\execute(), ApiFileRevert\execute(), ApiDelete\execute(), ApiBlock\execute(), ApiFeedContributions\execute(), ApiRollback\execute(), ApiQueryPagePropNames\execute(), ApiQueryUserInfo\execute(), ApiQueryContributions\execute(), ApiQueryFileRepoInfo\execute(), ApiQueryLogEvents\execute(), ApiFeedRecentChanges\execute(), ApiStashEdit\execute(), ApiQueryImageInfo\execute(), ApiFormatXml\execute(), ApiQueryContributors\execute(), ApiQueryAllUsers\execute(), ApiLogin\execute(), ApiUserrights\execute(), ApiImageRotate\execute(), ApiFeedWatchlist\execute(), ApiFormatJson\execute(), ApiFormatRaw\execute(), ApiFormatFeedWrapper\execute(), ApiQueryUsers\execute(), ApiQuery\execute(), ApiQueryInfo\execute(), ApiOpenSearchFormatJson\execute(), ApiFormatRaw\getMimeType(), getParameterFromSettings(), getResultData(), ApiFormatRaw\initPrinter(), ApiFormatFeedWrapper\initPrinter(), ApiQuery\outputGeneralPageInfo(), ApiQueryRevisionsBase\parseParameters(), ApiOpenSearch\populateResult(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryPrefixSearch\run(), ApiQueryLangBacklinks\run(), ApiQueryIWBacklinks\run(), ApiQueryProtectedTitles\run(), ApiQueryWatchlistRaw\run(), ApiQueryExtLinksUsage\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryWatchlist\run(), ApiQueryQueryPage\run(), ApiQuerySearch\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryRandom\runQuery(), and ApiUpload\selectUploadModule().

ApiBase::getResultData ( )

Get the result data array (read-only)

Deprecated:
since 1.25, use $this->getResult() methods instead
Returns
array

Definition at line 2915 of file ApiBase.php.

References getResult(), and wfDeprecated().

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

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

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

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

Parameters
array$params
bool | string$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 slave database
  • 'fromdbmaster': load from the master database
Returns
WikiPage

Definition at line 794 of file ApiBase.php.

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

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

ApiBase::getWatchlistUser (   $params)

Gets the user for whom to get the watchlist.

Parameters
array$params
Returns
User

Definition at line 1355 of file ApiBase.php.

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

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

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

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

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

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

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

ApiBase::getWebUITokenSalt ( array  $params)
protected

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

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

Since
1.24
Parameters
array$paramsAll supplied parameters for the module
Returns
string|array|null

Definition at line 426 of file ApiBase.php.

Referenced by validateToken().

ApiBase::indentExampleText (   $item)
private
Deprecated:
since 1.25
Parameters
string$item
Returns
string

Definition at line 2651 of file ApiBase.php.

ApiBase::isDeprecated ( )

Indicates whether this module is deprecated.

Since
1.25
Returns
bool

Definition at line 381 of file ApiBase.php.

Referenced by getHelpFlags().

ApiBase::isInternal ( )

Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable.

Since
1.25
Returns
bool

Definition at line 391 of file ApiBase.php.

Referenced by getHelpFlags().

ApiBase::isMain ( )

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

Returns
bool

Definition at line 482 of file ApiBase.php.

References $mMainModule.

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

ApiBase::isReadMode ( )

Indicates whether this module requires read rights.

Returns
bool

Definition at line 356 of file ApiBase.php.

Referenced by getHelpFlags(), and makeHelpMsg().

ApiBase::isWriteMode ( )

Indicates whether this module requires write mode.

Returns
bool

Definition at line 364 of file ApiBase.php.

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

ApiBase::logFeatureUsage (   $feature)
protected

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

Parameters
string$featureFeature being used.

Definition at line 2188 of file ApiBase.php.

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

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

ApiBase::makeHelpArrayToString (   $prefix,
  $title,
  $input 
)
protected
Deprecated:
since 1.25
Parameters
string$prefixText to split output items
string$titleWhat is being output
string | array$input
Returns
string

Definition at line 2662 of file ApiBase.php.

References $title, and wfDeprecated().

Referenced by makeHelpMsg().

ApiBase::makeHelpMsg ( )

Generates help message for this module, or false if there is no description.

Deprecated:
since 1.25
Returns
string|bool

Definition at line 2581 of file ApiBase.php.

References as, getExamples(), getFinalDescription(), getHelpUrls(), isReadMode(), isWriteMode(), makeHelpArrayToString(), makeHelpMsgParameters(), mustBePosted(), and wfDeprecated().

ApiBase::makeHelpMsgParameters ( )

Generates the parameter descriptions for this module, to be displayed in the module's help.

Deprecated:
since 1.25
Returns
string|bool

Definition at line 2691 of file ApiBase.php.

References $params, $s, $t, $type, as, encodeParamName(), GET_VALUES_FOR_HELP, getFinalParamDescription(), getFinalParams(), getModuleManager(), MWNamespace\getValidNamespaces(), PARAM_DFLT, PARAM_TYPE, and wfDeprecated().

Referenced by makeHelpMsg().

static ApiBase::makeMessage (   $msg,
IContextSource  $context,
array  $params = null 
)
static

Create a Message from a string or array.

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

Since
1.25
Parameters
string | array | Message$msg
IContextSource$context
array$params
Returns
Message|null

Definition at line 1412 of file ApiBase.php.

References $params, and wfMessage().

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

ApiBase::modifyHelp ( array $help,
array  $options,
array $tocData 
)

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

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

Parameters
string[]&$help Array of help data
array$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 2517 of file ApiBase.php.

ApiBase::mustBePosted ( )

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

Returns
bool

Definition at line 372 of file ApiBase.php.

References needsToken().

Referenced by getHelpFlags(), and makeHelpMsg().

ApiBase::needsToken ( )

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

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

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

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

Returns
string|false

Definition at line 413 of file ApiBase.php.

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

ApiBase::parameterNotEmpty (   $x)
private

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

Parameters
object$xParameter to check is not null/false
Returns
bool

Definition at line 779 of file ApiBase.php.

ApiBase::parseMsg (   $error)

Return the error message related to a certain array.

Parameters
array$errorElement of a getUserPermissionsErrors()-style array
Returns
array('code' => code, 'info' => info)

Definition at line 2143 of file ApiBase.php.

References $key, array(), and wfMsgReplaceArgs().

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

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

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

Parameters
string$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.
Returns
string|string[] (allowMultiple ? an_array_of_values : a_single_value)

Definition at line 1122 of file ApiBase.php.

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

Referenced by getParameterFromSettings().

ApiBase::profileDBIn ( )
Deprecated:
since 1.25

Definition at line 2890 of file ApiBase.php.

References wfDeprecated().

ApiBase::profileDBOut ( )
Deprecated:
since 1.25

Definition at line 2897 of file ApiBase.php.

References wfDeprecated().

ApiBase::profileIn ( )
Deprecated:
since 1.25

Definition at line 2858 of file ApiBase.php.

ApiBase::profileOut ( )
Deprecated:
since 1.25

Definition at line 2866 of file ApiBase.php.

ApiBase::requireAtLeastOneParameter (   $params,
  $required 
)

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

Since
1.23
Parameters
array$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 757 of file ApiBase.php.

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

Referenced by ApiTag\execute().

ApiBase::requireMaxOneParameter (   $params,
  $required 
)

Die if 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 at most one must be set

Definition at line 734 of file ApiBase.php.

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

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

ApiBase::requireOnlyOneParameter (   $params,
  $required 
)

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

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

Definition at line 708 of file ApiBase.php.

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

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

ApiBase::safeProfileOut ( )
Deprecated:
since 1.25

Definition at line 2874 of file ApiBase.php.

References wfDeprecated().

ApiBase::setContinuationManager (   $manager)

Set the continuation manager.

Parameters
ApiContinuationManager|null

Definition at line 625 of file ApiBase.php.

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

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

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$userOptionThe user option to consider when $watch=preferences

Definition at line 1324 of file ApiBase.php.

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

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

ApiBase::shouldCheckMaxlag ( )

Indicates if this module needs maxlag to be checked.

Returns
bool

Definition at line 348 of file ApiBase.php.

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

Truncate an array to a certain length.

Parameters
array$arrArray to truncate
int$limitMaximum length
Returns
bool True if the array was truncated, false otherwise

Definition at line 1339 of file ApiBase.php.

References $limit.

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$botMaxMaximum value for sysops/bots
bool$enforceLimitsWhether to enforce (die) if value is outside limits

Definition at line 1186 of file ApiBase.php.

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

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

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

Validate and normalize of parameters of type 'timestamp'.

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

Definition at line 1225 of file ApiBase.php.

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

Referenced by getParameterFromSettings().

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

Validate the supplied token.

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

Definition at line 1264 of file ApiBase.php.

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

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

Validate and normalize of parameters of type 'user'.

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

Definition at line 1299 of file ApiBase.php.

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

Referenced by getParameterFromSettings().

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

Adds a warning to the output, else dies.

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

Definition at line 1455 of file ApiBase.php.

References dieUsage(), and setWarning().

Referenced by validateLimit().

Member Data Documentation

array ApiBase::$extensionInfo = null
staticprivate

Maps extension paths to info arrays.

Definition at line 193 of file ApiBase.php.

ApiBase::$messageMap
static
Initial value:
= [
'unknownerror' => [ 'code' => 'unknownerror'

Array that maps message keys to error messages.

$1 and friends are replaced.

Definition at line 1574 of file ApiBase.php.

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

ApiMain ApiBase::$mMainModule
private

Definition at line 196 of file ApiBase.php.

Referenced by getMain(), and isMain().

string ApiBase::$mModuleName
private

Definition at line 198 of file ApiBase.php.

Referenced by getModuleName().

string ApiBase::$mModulePrefix

Definition at line 198 of file ApiBase.php.

Referenced by getModulePrefix().

array null bool ApiBase::$mModuleSource = false
private

Definition at line 202 of file ApiBase.php.

Referenced by getModuleSourceInfo().

ApiBase::$mParamCache = []
private

Definition at line 200 of file ApiBase.php.

ApiBase::$mSlaveDB = null
private

Definition at line 199 of file ApiBase.php.

Referenced by getDB().

const ApiBase::GET_VALUES_FOR_HELP = 1

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

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

Since
1.21

Definition at line 190 of file ApiBase.php.

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

const ApiBase::LIMIT_BIG1 = 500

Fast query, standard limit.

Definition at line 177 of file ApiBase.php.

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

const ApiBase::LIMIT_BIG2 = 5000

Fast query, apihighlimits limit.

Definition at line 179 of file ApiBase.php.

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

const ApiBase::LIMIT_SML1 = 50
const ApiBase::LIMIT_SML2 = 500

Slow query, apihighlimits limit.

Definition at line 183 of file ApiBase.php.

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

const ApiBase::PARAM_ALLOW_DUPLICATES = 6

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

Definition at line 103 of file ApiBase.php.

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

const ApiBase::PARAM_DFLT = 0

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

Definition at line 50 of file ApiBase.php.

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

const ApiBase::PARAM_HELP_MSG = 10

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

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

Since
1.25

Definition at line 125 of file ApiBase.php.

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

const ApiBase::PARAM_HELP_MSG_INFO = 12

(array) Specify additional information tags for the parameter.

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

Since
1.25

Definition at line 142 of file ApiBase.php.

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

const ApiBase::PARAM_HELP_MSG_PER_VALUE = 14

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

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

Since
1.25

Definition at line 157 of file ApiBase.php.

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

const ApiBase::PARAM_ISMULTI = 1

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

titles)?

Definition at line 53 of file ApiBase.php.

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

const ApiBase::PARAM_MAX = 3

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

Definition at line 91 of file ApiBase.php.

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

const ApiBase::PARAM_MAX2 = 4

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

Definition at line 97 of file ApiBase.php.

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

const ApiBase::PARAM_MIN = 5

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

Definition at line 100 of file ApiBase.php.

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

const ApiBase::PARAM_RANGE_ENFORCE = 9

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

Since
1.17

Definition at line 118 of file ApiBase.php.

Referenced by ApiParamInfo\getModuleInfo().

const ApiBase::PARAM_SUBMODULE_MAP = 15

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

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

Since
1.26

Definition at line 165 of file ApiBase.php.

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

const ApiBase::PARAM_SUBMODULE_PARAM_PREFIX = 16

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

Since
1.26

Definition at line 172 of file ApiBase.php.

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

const ApiBase::PARAM_TYPE = 2

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

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

Supported string types are:

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

Definition at line 88 of file ApiBase.php.

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

const ApiBase::PARAM_VALUE_LINKS = 13

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

Since
1.25

Definition at line 149 of file ApiBase.php.

Referenced by ApiHelp\getHelpInternal().


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