MediaWiki
master
|
This abstract class implements many basic API functions, and is the base of all API classes. More...
Public Attributes | |
const | PARAM_RANGE_ENFORCE = 'api-param-range-enforce' |
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More... | |
Old constants for ::getAllowedParams() arrays | |
| |
const | PARAM_DFLT = ParamValidator::PARAM_DEFAULT |
const | PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI |
const | PARAM_TYPE = ParamValidator::PARAM_TYPE |
const | PARAM_MAX = IntegerDef::PARAM_MAX |
const | PARAM_MAX2 = IntegerDef::PARAM_MAX2 |
const | PARAM_MIN = IntegerDef::PARAM_MIN |
const | PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES |
const | PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED |
const | PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED |
const | PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP |
const | PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX |
const | PARAM_ALL = ParamValidator::PARAM_ALL |
const | PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES |
const | PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE |
const | PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES |
const | PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1 |
const | PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2 |
const | PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES |
const | PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS |
Protected Member Functions | |
Deprecated methods | |
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 ( $name, &$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... | |
Private Attributes | |
HookContainer | $hookContainer |
ApiHookRunner | $hookRunner |
API-specific constants for ::getAllowedParams() arrays | |
ApiMain | $mMainModule |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
string | $mModuleName |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
$mReplicaDB = null | |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
array | $mParamCache = [] |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
array null false | $mModuleSource = false |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
const | PARAM_HELP_MSG = 'api-param-help-msg' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
const | PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append' |
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter. More... | |
const | PARAM_HELP_MSG_INFO = 'api-param-help-msg-info' |
(array) Specify additional information tags for the parameter. More... | |
const | PARAM_VALUE_LINKS = 'api-param-value-links' |
Deprecated and unused. More... | |
const | PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value' |
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage(). More... | |
const | PARAM_TEMPLATE_VARS = 'param-template-vars' |
(array) Indicate that this is a templated parameter, and specify replacements. More... | |
const | ALL_DEFAULT_STRING = '*' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
const | LIMIT_BIG1 = 500 |
Fast query, standard limit. More... | |
const | LIMIT_BIG2 = 5000 |
Fast query, apihighlimits limit. More... | |
const | LIMIT_SML1 = 50 |
Slow query, standard limit. More... | |
const | LIMIT_SML2 = 500 |
Slow query, apihighlimits limit. More... | |
const | GET_VALUES_FOR_HELP = 1 |
getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More... | |
string | $mModulePrefix |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. More... | |
static array | $extensionInfo = null |
Maps extension paths to info arrays. More... | |
static stdClass[][] | $filterIDsCache = [] |
Cache for self::filterIDs() More... | |
static array | $blockMsgMap |
Map of web UI block messages to corresponding API messages and codes. More... | |
__construct (ApiMain $mainModule, $moduleName, $modulePrefix='') | |
Stable to call. 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 Stable to override. More... | |
isReadMode () | |
Indicates whether this module requires read rights Stable to override. More... | |
isWriteMode () | |
Indicates whether this module requires write mode. More... | |
mustBePosted () | |
Indicates whether this module must be called with a POST request Stable to override. 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 Stable to override. 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 () | |
Stable to override. More... | |
getContinuationManager () | |
setContinuationManager (ApiContinuationManager $manager=null) | |
getDB () | |
Gets a default replica DB connection object Stable to override. More... | |
getPermissionManager () | |
Obtain a PermissionManager instance that subclasses may use in their authorization checks. More... | |
getGroupPermissionsLookup () | |
Obtain a GroupPermissionsLookup instance that subclasses may use to access group permissions. More... | |
getHookContainer () | |
Get a HookContainer, for running extension hooks or for hook metadata. More... | |
getHookRunner () | |
Get an ApiHookRunner for running core API hooks. More... | |
Parameter handling | |
dynamicParameterDocumentation () | |
Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). More... | |
encodeParamName ( $paramName) | |
This method mangles parameter name based on the prefix supplied to the constructor. More... | |
extractRequestParams ( $options=[]) | |
Using getAllowedParams(), this function makes an array of the values provided by the user, with key being the name of the variable, and value - validated value from user or default. More... | |
requireOnlyOneParameter ( $params,... $required) | |
Die if none or more than one of a certain set of parameters is set and not false. More... | |
requireMaxOneParameter ( $params,... $required) | |
Die if more than one of a certain set of parameters is set and not false. More... | |
requireAtLeastOneParameter ( $params,... $required) | |
Die if none of a certain set of parameters is set and not false. More... | |
requirePostedParameters ( $params, $prefix='prefix') | |
Die if any of the specified parameters were found in the query part of the URL rather than the post body. More... | |
getTitleOrPageId ( $params, $load=false) | |
Get a WikiPage object from a title or pageid param, if possible. More... | |
getTitleFromTitleOrPageId ( $params) | |
Get a Title object from a title or pageid param, if possible. More... | |
handleParamNormalization ( $paramName, $value, $rawValue) | |
Handle when a parameter was Unicode-normalized. More... | |
validateToken ( $token, array $params) | |
Validate the supplied token. More... | |
getParameter ( $paramName, $parseLimit=true) | |
Get a value for the given parameter. More... | |
getParameterFromSettings ( $name, $settings, $parseLimit) | |
Using the settings determine the value for the given parameter. More... | |
parameterNotEmpty ( $x) | |
Callback function used in requireOnlyOneParameter to check whether required parameters are set. More... | |
Utility methods | |
getWatchlistUser ( $params) | |
Gets the user for whom to get the watchlist. More... | |
errorArrayToStatus (array $errors, User $user=null) | |
Turn an array of message keys or key+param arrays into a Status. More... | |
addBlockInfoToStatus (StatusValue $status, User $user=null) | |
Add block info to block messages in a Status. More... | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. More... | |
filterIDs ( $fields, array $ids) | |
Filter out-of-range values from a list of positive integer IDs. More... | |
static | makeMessage ( $msg, IContextSource $context, array $params=null) |
Create a Message from a string or array. More... | |
Warning and error reporting | |
addWarning ( $msg, $code=null, $data=null) | |
Add a warning for this module. More... | |
addDeprecation ( $msg, $feature, $data=[]) | |
Add a deprecation warning for this module. More... | |
addError ( $msg, $code=null, $data=null) | |
Add an error for this module without aborting. More... | |
addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[]) | |
Add warnings and/or errors from a Status. More... | |
dieWithError ( $msg, $code=null, $data=null, $httpCode=null) | |
Abort execution with an error. More... | |
dieWithException (Throwable $exception, array $options=[]) | |
Abort execution with an error derived from a throwable. More... | |
dieBlocked (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 ( $pageIdentity, $actions, array $options=[]) | |
Helper function for permission-denied errors. More... | |
dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null) | |
Will only set a warning instead of failing if the global $wgDebugAPI is set to true. More... | |
logFeatureUsage ( $feature) | |
Write logging information for API features to a debug log, for usage analysis. More... | |
dieContinueUsageIf ( $condition) | |
Die with the 'badcontinue' error. More... | |
static | dieDebug ( $method, $message) |
Internal code errors should be reported with this method. More... | |
Help message generation | |
getFinalSummary () | |
Get final module summary. More... | |
getFinalDescription () | |
Get final module description, after hooks have had a chance to tweak it as needed. More... | |
getFinalParams ( $flags=0) | |
Get final list of parameters, after hooks have had a chance to tweak it as needed. More... | |
getFinalParamDescription () | |
Get final parameter descriptions, after hooks have had a chance to tweak it as needed. More... | |
modifyHelp (array &$help, array $options, array &$tocData) | |
Called from ApiHelp before the pieces are joined together and returned. More... | |
getSummaryMessage () | |
Return the summary message. More... | |
getExtendedDescription () | |
Return the extended help text message. More... | |
getHelpFlags () | |
Generates the list of flags for the help screen and for action=paraminfo. More... | |
getModuleSourceInfo () | |
Returns information about the source of this module, if known. More... | |
Additional Inherited Members | |
![]() | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). More... | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. More... | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. More... | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getStats () | |
getTiming () | |
getTitle () | |
getUser () | |
Stable to override. More... | |
getWikiPage () | |
Get the WikiPage object. More... | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() More... | |
setContext (IContextSource $context) | |
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
Stable to extend
Definition at line 55 of file ApiBase.php.
ApiBase::__construct | ( | ApiMain | $mainModule, |
$moduleName, | |||
$modulePrefix = '' |
|||
) |
Stable to call.
ApiMain | $mainModule | |
string | $moduleName | Name of this module |
string | $modulePrefix | Prefix to use for parameter names |
Reimplemented in ApiWatch, ApiUpload, ApiUndelete, ApiRollback, ApiProtect, ApiEditPage, ApiDelete, ApiComparePages, and ApiOpenSearchFormatJson.
Definition at line 211 of file ApiBase.php.
References ContextSource\getContext(), isMain(), and ContextSource\setContext().
ApiBase::addBlockInfoToStatus | ( | StatusValue | $status, |
User | $user = null |
||
) |
Add block info to block messages in a Status.
StatusValue | $status | |
User | null | $user |
Definition at line 1224 of file ApiBase.php.
References ApiMessage\create(), ContextSource\getUser(), StatusValue\hasMessage(), and StatusValue\replaceMessage().
Referenced by dieStatus(), and ApiQueryInfo\extractPageInfo().
ApiBase::addDeprecation | ( | $msg, | |
$feature, | |||
$data = [] |
|||
) |
Add a deprecation warning for this module.
A combination of $this->addWarning() and $this->logFeatureUsage()
string | array | Message | $msg | See ApiErrorFormatter::addWarning() |
string | null | $feature | See ApiBase::logFeatureUsage() |
array | null | $data | See ApiErrorFormatter::addWarning() |
Definition at line 1317 of file ApiBase.php.
References addWarning(), getHookRunner(), getMain(), logFeatureUsage(), and ContextSource\msg().
Referenced by ApiExpandTemplates\execute(), ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiTokens\execute(), ApiQueryRevisionsBase\parseParameters(), and ApiMain\setupExternalResponse().
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.
string | array | Message | $msg | See ApiErrorFormatter::addError() |
string | null | $code | See ApiErrorFormatter::addError() |
array | null | $data | See ApiErrorFormatter::addError() |
Definition at line 1350 of file ApiBase.php.
References getErrorFormatter(), and getModulePath().
ApiBase::addMessagesFromStatus | ( | StatusValue | $status, |
$types = [ 'warning' , |
|||
'error'] | , | ||
array | $filter = [] |
||
) |
Add warnings and/or errors from a Status.
StatusValue | $status | |
string[] | $types | 'warning' and/or 'error' |
string[] | $filter | Message keys to filter out (since 1.33) |
Definition at line 1363 of file ApiBase.php.
References getErrorFormatter(), and getModulePath().
Referenced by ApiDelete\execute().
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.
string | array | Message | $msg | See ApiErrorFormatter::addWarning() |
string | null | $code | See ApiErrorFormatter::addWarning() |
array | null | $data | See ApiErrorFormatter::addWarning() |
Definition at line 1303 of file ApiBase.php.
References getErrorFormatter(), and getModulePath().
Referenced by addDeprecation(), ApiFormatXml\addXslt(), dieWithErrorOrDebug(), ApiCheckToken\execute(), ApiComparePages\execute(), ApiExpandTemplates\execute(), ApiOptions\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiPurge\execute(), ApiQueryDisabled\execute(), ApiQueryLanguageinfo\execute(), ApiQueryTokens\execute(), ApiQueryUsers\execute(), ApiTokens\execute(), ApiPageSet\executeInternal(), ApiQueryRevisionsBase\extractDeprecatedContent(), ApiQueryInfo\extractPageInfo(), extractRequestParams(), ApiQueryRecentChanges\extractRowInfo(), ApiComparePages\getDiffRevision(), ApiMain\getVal(), ApiMain\handleException(), handleParamNormalization(), ApiQueryImageInfo\mergeThumbParams(), parseMultiValue(), ApiQueryRevisionsBase\parseParameters(), ApiMain\printResult(), ApiMain\reportUnusedParams(), ApiQueryCategories\run(), ApiQueryImages\run(), ApiQueryLinks\run(), ApiQueryAllDeletedRevisions\run(), and ApiQueryRevisions\run().
ApiBase::checkTitleUserPermissions | ( | $pageIdentity, | |
$actions, | |||
array | $options = [] |
||
) |
Helper function for permission-denied errors.
PageIdentity | LinkTarget | $pageIdentity | deprecated passing LinkTarget since 1.36 |
string | string[] | $actions | |
array | $options | Additional options |
ApiUsageException | if the user doesn't have all of the rights. |
Definition at line 1512 of file ApiBase.php.
References Title\castFromLinkTarget(), dieStatus(), ContextSource\getAuthority(), ContextSource\getUser(), isWriteMode(), and wfDeprecatedMsg().
Referenced by ApiDelete\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiParse\execute(), ApiProtect\execute(), and ApiSetPageLanguage\execute().
ApiBase::checkUserRightsAny | ( | $rights, | |
$user = null |
|||
) |
Helper function for permission-denied errors.
string | string[] | $rights | |
User | null | $user | deprecated since 1.36 |
ApiUsageException | if the user doesn't have any of the rights. The error message is based on $rights[0]. |
Definition at line 1486 of file ApiBase.php.
References dieWithError(), ContextSource\getAuthority(), ContextSource\msg(), and wfDeprecatedMsg().
Referenced by ApiBlock\execute(), ApiChangeContentModel\execute(), ApiOptions\execute(), ApiQueryDeletedrevs\execute(), ApiRevisionDelete\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiWatch\execute(), and getWatchlistUser().
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.
AbstractBlock | $block | The block used to generate the ApiUsageException |
ApiUsageException | always |
Definition at line 1411 of file ApiBase.php.
References dieWithError(), MediaWiki\Block\AbstractBlock\getType(), and MediaWiki\Block\AbstractBlock\isSitewide().
Referenced by ApiUpload\checkPermissions(), ApiEditPage\execute(), ApiRevisionDelete\execute(), ApiTag\execute(), ApiUndelete\execute(), and ApiUserrights\execute().
|
protected |
Die with the 'badcontinue' error.
This call is common enough to make it into the base method.
bool | $condition | Will only die if this value is true |
ApiUsageException |
Definition at line 1567 of file ApiBase.php.
References dieWithError().
Referenced by ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryPagePropNames\execute(), ApiQueryPageProps\execute(), ApiQueryUserContribs\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryDuplicateFiles\run(), ApiQueryExtLinksUsage\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryLinks\run(), ApiQueryPagesWithProp\run(), ApiQueryProtectedTitles\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().
|
staticprotected |
Internal code errors should be reported with this method.
string | $method | Method or function name |
string | $message | Error message |
MWException | always |
Definition at line 1579 of file ApiBase.php.
Referenced by ApiQueryAllLinks\__construct(), ApiQueryLinks\__construct(), ApiQueryBase\addJoinConds(), ApiQueryBase\addTables(), ApiFormatFeedWrapper\execute(), ApiFormatJson\execute(), ApiFormatPhp\execute(), ApiFormatRaw\execute(), ApiLogin\execute(), ApiQueryAllUsers\execute(), ApiQuerySiteinfo\execute(), ApiUpload\execute(), getContinuationManager(), ApiOpenSearch\getCustomPrinter(), getErrorFormatter(), getFinalParamDescription(), ApiFormatRaw\getMimeType(), getResult(), ApiQueryQueryPage\getSpecialPage(), ApiPageSet\initFromQueryResult(), ApiFormatFeedWrapper\initPrinter(), ApiQuery\instantiateModules(), lacksSameOriginSecurity(), ApiOpenSearch\populateResult(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), and setContinuationManager().
ApiBase::dieReadOnly | ( | ) |
Helper function for readonly errors.
ApiUsageException | always |
Definition at line 1470 of file ApiBase.php.
References dieWithError(), and wfReadOnlyReason().
Referenced by ApiMain\checkReadOnly(), and ApiEditPage\execute().
ApiBase::dieStatus | ( | StatusValue | $status | ) |
Throw an ApiUsageException based on the Status object.
StatusValue | $status |
ApiUsageException | always |
Definition at line 1442 of file ApiBase.php.
References addBlockInfoToStatus(), StatusValue\getErrorsByType(), StatusValue\isGood(), StatusValue\newGood(), and StatusValue\setOK().
Referenced by ApiUpload\checkPermissions(), checkTitleUserPermissions(), ApiUpload\dieRecoverableError(), ApiUpload\dieStatusWithCode(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiChangeContentModel\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetPageLanguage\execute(), ApiTag\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiUserrights\getUrUser(), ApiUpload\performStash(), ApiUpload\performUpload(), ApiQuerySearch\run(), ApiQueryRevisions\run(), and ApiWatch\watchTitle().
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.
string | array | Message | $msg | See ApiErrorFormatter::addError() |
string | null | $code | See ApiErrorFormatter::addError() |
array | null | $data | See ApiErrorFormatter::addError() |
int | null | $httpCode | HTTP error code to use |
ApiUsageException | always |
Definition at line 1384 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(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiChangeContentModel\execute(), ApiClientLogin\execute(), ApiComparePages\execute(), ApiDelete\execute(), ApiDisabled\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiFeedRecentChanges\execute(), ApiFeedWatchlist\execute(), ApiFormatPhp\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiLogout\execute(), ApiManageTags\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiOpenSearchFormatJson\execute(), ApiOptions\execute(), ApiParse\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiQueryAllMessages\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryImageInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryStashImageInfo\execute(), ApiQueryUserContribs\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiQueryAllImages\executeGenerator(), ApiQueryAllPages\executeGenerator(), ApiPageSet\executeInternal(), ApiQueryRevisionsBase\extractAllSlotInfo(), ApiUpload\getChunkResult(), ApiParse\getContentParserOutput(), ApiUpload\getContextResult(), ApiComparePages\getDiffRevision(), ApiFeedRecentChanges\getFeedObject(), getModuleFromPath(), ApiParse\getPageParserOutput(), ApiParse\getParsedContent(), ApiRollback\getRbTitle(), ApiParse\getSectionContent(), getTitleFromTitleOrPageId(), getTitleOrPageId(), getWatchlistUser(), ApiQueryImageInfo\mergeThumbParams(), ApiQuery\outputGeneralPageInfo(), parseMultiValue(), ApiQueryRevisionsBase\parseParameters(), ApiQueryBase\parsePrefixedTitlePart(), ApiUpload\performUpload(), ApiQueryUserContribs\prepareQuery(), ApiQueryBlocks\prepareUsername(), requireAtLeastOneParameter(), requireMaxOneParameter(), requireOnlyOneParameter(), requirePostedParameters(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryQueryPage\run(), ApiQueryRecentChanges\run(), ApiQuerySearch\run(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiUpload\selectUploadModule(), ApiMain\setupExternalResponse(), ApiMain\setupModule(), ApiQueryBase\titlePartToKey(), ApiFileRevert\validateParameters(), and ApiUpload\verifyUpload().
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().
string | array | Message | $msg | |
string | null | $code | |
array | null | $data | |
int | null | $httpCode |
ApiUsageException |
Definition at line 1549 of file ApiBase.php.
References addWarning(), dieWithError(), and ContextSource\getConfig().
Referenced by ApiQuery\instantiateModules(), and ApiMain\setupExternalResponse().
ApiBase::dieWithException | ( | Throwable | $exception, |
array | $options = [] |
||
) |
Abort execution with an error derived from a throwable.
Throwable | $exception | See ApiErrorFormatter::getMessageFromException() |
array | $options | See ApiErrorFormatter::getMessageFromException() |
ApiUsageException | always |
Definition at line 1396 of file ApiBase.php.
References dieWithError(), and getErrorFormatter().
Referenced by ApiEditPage\execute(), ApiImport\execute(), ApiParse\execute(), ApiQueryStashImageInfo\execute(), ApiStashEdit\execute(), and ApiComparePages\getDiffRevision().
ApiBase::dynamicParameterDocumentation | ( | ) |
Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams().
Stable to override
Reimplemented in ApiLinkAccount, ApiClientLogin, ApiChangeAuthenticationData, and ApiAMCreateAccount.
Definition at line 687 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
string | string[] | $paramName | Parameter name |
Reimplemented in ApiQueryGeneratorBase.
Definition at line 698 of file ApiBase.php.
Referenced by ApiContinuationManager\addContinueParam(), ApiContinuationManager\addGeneratorContinueParam(), ApiContinuationManager\addGeneratorNonContinueParam(), MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiAMCreateAccount\execute(), ApiClientLogin\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiQueryAllMessages\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLanguageinfo\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiSetNotificationTimestamp\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiPageSet\executeInternal(), extractRequestParams(), MediaWiki\Api\Validator\ApiParamValidator\getHelpInfo(), getParameterFromSettings(), MediaWiki\Api\Validator\ApiParamValidator\getParamInfo(), MediaWiki\Api\Validator\ApiParamValidator\getValue(), ApiQueryBlocks\prepareUsername(), requireAtLeastOneParameter(), requireMaxOneParameter(), requireOnlyOneParameter(), requirePostedParameters(), and MediaWiki\Api\Validator\ApiParamValidator\validateValue().
ApiBase::errorArrayToStatus | ( | array | $errors, |
User | $user = null |
||
) |
Turn an array of message keys or key+param arrays into a Status.
array | $errors | |
User | null | $user |
Definition at line 1196 of file ApiBase.php.
References ApiMessage\create(), ContextSource\getUser(), and StatusValue\newGood().
Referenced by ApiChangeContentModel\execute(), ApiPatrol\execute(), and ApiRollback\execute().
|
abstract |
Evaluates the parameters, performs the requested query, and sets up the result.
Concrete implementations of ApiBase must override this method to provide whatever functionality their module offers. Implementations must not produce any output on their own and are not expected to handle any errors.
The execute() method will be invoked directly by ApiMain immediately before the result of the module is output. Aside from the constructor, implementations should assume that no other methods will be called externally on the module before the result is processed.
The result data should be stored in the ApiResult object available through getResult().
Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTokens, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRsd, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisionsBase, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLogEvents, ApiQueryLinks, ApiQueryLanguageinfo, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDisabled, ApiQueryDeletedrevs, ApiQueryContributors, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllUsers, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllCategories, ApiQuery, ApiPurge, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiPageSet, ApiOptions, ApiOpenSearchFormatJson, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiMain, ApiLogout, ApiLogin, ApiLinkAccount, ApiImport, ApiImageRotate, ApiHelp, ApiFormatXml, ApiFormatRaw, ApiFormatPhp, ApiFormatNone, ApiFormatJson, ApiFormatFeedWrapper, ApiFileRevert, ApiFeedWatchlist, ApiFeedRecentChanges, ApiFeedContributions, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDisabled, ApiDelete, ApiCSPReport, ApiComparePages, ApiClientLogin, ApiClearHasMsg, ApiCheckToken, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.
|
protected |
Split a multi-valued parameter string, like explode()
string | $value | |
int | $limit |
Definition at line 2018 of file ApiBase.php.
References wfDeprecated().
Referenced by parseMultiValue().
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.
bool | array | $options | If a boolean, uses that as the value for 'parseLimit'
|
Definition at line 720 of file ApiBase.php.
References addWarning(), encodeParamName(), getFinalParams(), getParameterFromSettings(), PARAM_TEMPLATE_VARS, and wfEscapeWikiText().
Referenced by ApiPageSet\__construct(), ApiAuthManagerHelper\__construct(), ApiQuerySiteinfo\appendInterwikiMap(), ApiQuerySiteinfo\appendLanguages(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeContentModel\execute(), ApiCheckToken\execute(), ApiClientLogin\execute(), ApiComparePages\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiFeedRecentChanges\execute(), ApiFeedWatchlist\execute(), ApiFileRevert\execute(), ApiFormatJson\execute(), ApiFormatPhp\execute(), ApiFormatXml\execute(), ApiHelp\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiLogin\execute(), ApiManageTags\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiOpenSearch\execute(), ApiOptions\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQuery\execute(), ApiQueryAllMessages\execute(), ApiQueryAllUsers\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryBlocks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryExternalLinks\execute(), ApiQueryFilearchive\execute(), ApiQueryFileRepoInfo\execute(), ApiQueryImageInfo\execute(), ApiQueryInfo\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryPagePropNames\execute(), ApiQueryPageProps\execute(), ApiQuerySiteinfo\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTags\execute(), ApiQueryTokens\execute(), ApiQueryUserContribs\execute(), ApiQueryUserInfo\execute(), ApiQueryUsers\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiTag\execute(), ApiTokens\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiHelp\getCustomPrinter(), ApiOpenSearch\getFormat(), ApiFormatJson\getMimeType(), getParameter(), ApiComparePages\guessModel(), ApiComparePages\guessTitle(), ApiQuery\isReadMode(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategories\run(), ApiQueryCategoryMembers\run(), ApiQueryDuplicateFiles\run(), ApiQueryExtLinksUsage\run(), ApiQueryImages\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryLinks\run(), ApiQueryPagesWithProp\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryQueryPage\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQuerySearch\run(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiQueryRandom\runQuery(), and ApiMain\setupExecuteAction().
|
protected |
Filter out-of-range values from a list of positive integer IDs.
string[][] | $fields | Array of pairs of table and field to check |
(string|int)[] | $ids IDs to filter. Strings in the array are expected to be stringified ints. |
Definition at line 1256 of file ApiBase.php.
References getDB().
Referenced by ApiQueryBase\addWhereIDsFld(), ApiPageSet\initFromPageIds(), and ApiPageSet\initFromRevIDs().
|
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.
Stable to override
Reimplemented in ApiValidatePassword, ApiUpload, ApiUndelete, ApiUnblock, ApiTokens, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisionsBase, ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLinks, ApiQueryLanguageinfo, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDisabled, ApiQueryDeletedrevs, ApiQueryDeletedRevisions, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllRevisions, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllDeletedRevisions, ApiQueryAllCategories, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiOptions, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiMain, ApiLogin, ApiLinkAccount, ApiImport, ApiHelp, ApiFormatXml, ApiFormatPhp, ApiFormatJson, ApiFormatBase, ApiFileRevert, ApiFeedRecentChanges, ApiFeedContributions, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDelete, ApiCSPReport, ApiComparePages, ApiClientLogin, ApiCheckToken, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.
Definition at line 306 of file ApiBase.php.
Referenced by getFinalParams().
ApiBase::getConditionalRequestData | ( | $condition | ) |
Returns data for HTTP conditional request mechanisms.
string | $condition | Condition being queried:
|
Definition at line 426 of file ApiBase.php.
ApiBase::getContinuationManager | ( | ) |
Reimplemented in ApiMain.
Definition at line 601 of file ApiBase.php.
References dieDebug(), getMain(), and isMain().
Referenced by ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryAllRevisions\run(), ApiQueryBase\setContinueEnumParameter(), and ApiQueryGeneratorBase\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.
Reimplemented in ApiRsd, ApiQuery, ApiOpenSearch, ApiHelp, ApiFeedWatchlist, ApiFeedRecentChanges, and ApiFeedContributions.
Definition at line 263 of file ApiBase.php.
|
protected |
Gets a default replica DB connection object Stable to override.
Reimplemented in ApiQueryBase, ApiQueryAllImages, and ApiPageSet.
Definition at line 590 of file ApiBase.php.
References $mReplicaDB, DB_REPLICA, and wfGetDB().
Referenced by ApiQuery\doExport(), filterIDs(), ApiParse\formatCategoryLinks(), ApiComparePages\getRevisionById(), and ApiOpenSearch\search().
ApiBase::getErrorFormatter | ( | ) |
Stable to override.
Reimplemented in ApiMain.
Definition at line 575 of file ApiBase.php.
References dieDebug(), getMain(), and isMain().
Referenced by addError(), addMessagesFromStatus(), addWarning(), dieWithException(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiManageTags\execute(), ApiMove\execute(), ApiQueryUsers\execute(), ApiValidatePassword\execute(), ApiQueryInfo\extractPageInfo(), ApiRevisionDelete\extractStatusInfo(), ApiLogin\formatMessage(), ApiUpload\handleStashException(), ApiMove\moveSubpages(), ApiUpload\performStash(), ApiTag\processIndividual(), ApiPageSet\processTitlesArray(), and ApiWatch\watchTitle().
|
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.
Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTokens, ApiTag, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRsd, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLogEvents, ApiQueryLinks, ApiQueryLanguageinfo, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDeletedrevs, ApiQueryDeletedRevisions, ApiQueryContributors, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllUsers, ApiQueryAllRevisions, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllDeletedRevisions, ApiQueryAllCategories, ApiQuery, ApiPurge, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiOptions, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiMain, ApiLogout, ApiLogin, ApiLinkAccount, ApiImport, ApiImageRotate, ApiHelp, ApiFormatBase, ApiFileRevert, ApiFeedWatchlist, ApiFeedRecentChanges, ApiFeedContributions, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDelete, ApiComparePages, ApiClientLogin, ApiClearHasMsg, ApiCheckToken, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.
Definition at line 279 of file ApiBase.php.
|
protected |
Return the extended help text message.
This is additional text to display at the top of the help section, below the summary.
Reimplemented in ApiSetPageLanguage, ApiResetPassword, ApiQueryDisabled, ApiLogin, and ApiDisabled.
Definition at line 1649 of file ApiBase.php.
Referenced by getFinalDescription().
ApiBase::getFinalDescription | ( | ) |
Get final module description, after hooks have had a chance to tweak it as needed.
Reimplemented in ApiLinkAccount, ApiClientLogin, and ApiAMCreateAccount.
Definition at line 1679 of file ApiBase.php.
References ContextSource\getContext(), getExtendedDescription(), getHookRunner(), getModuleName(), getModulePath(), getModulePrefix(), getSummaryMessage(), and makeMessage().
ApiBase::getFinalParamDescription | ( | ) |
Get final parameter descriptions, after hooks have had a chance to tweak it as needed.
Definition at line 1739 of file ApiBase.php.
References $path, dieDebug(), ContextSource\getContext(), getFinalParams(), getHookRunner(), getModuleFromPath(), getModuleManager(), getModuleName(), getModulePath(), getModulePrefix(), isMain(), makeMessage(), ContextSource\msg(), PARAM_DEPRECATED_VALUES, PARAM_HELP_MSG, PARAM_HELP_MSG_PER_VALUE, and PARAM_SUBMODULE_MAP.
ApiBase::getFinalParams | ( | $flags = 0 | ) |
Get final list of parameters, after hooks have had a chance to tweak it as needed.
int | $flags | Zero or more flags like GET_VALUES_FOR_HELP |
Definition at line 1708 of file ApiBase.php.
References getAllowedParams(), getHookRunner(), and needsToken().
Referenced by extractRequestParams(), and getFinalParamDescription().
ApiBase::getFinalSummary | ( | ) |
Get final module summary.
Definition at line 1663 of file ApiBase.php.
References ContextSource\getContext(), getModuleName(), getModulePath(), getModulePrefix(), getSummaryMessage(), and makeMessage().
|
protected |
Obtain a GroupPermissionsLookup instance that subclasses may use to access group permissions.
Definition at line 641 of file ApiBase.php.
Referenced by ApiQueryAllUsers\execute(), ApiQueryContributors\execute(), ApiMain\modifyHelp(), and ApiQueryAllImages\run().
|
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
Reimplemented in ApiQueryGeneratorBase.
Definition at line 1885 of file ApiBase.php.
References isDeprecated(), isInternal(), isReadMode(), isWriteMode(), and mustBePosted().
ApiBase::getHelpUrls | ( | ) |
Return links to more detailed help pages about the module.
Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTag, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiQueryWatchlistRaw, ApiQueryWatchlist, ApiQueryUsers, ApiQueryUserInfo, ApiQueryUserContribs, ApiQueryTokens, ApiQueryTags, ApiQueryStashImageInfo, ApiQuerySiteinfo, ApiQuerySearch, ApiQueryRevisions, ApiQueryRecentChanges, ApiQueryRandom, ApiQueryQueryPage, ApiQueryProtectedTitles, ApiQueryPrefixSearch, ApiQueryPagesWithProp, ApiQueryPageProps, ApiQueryPagePropNames, ApiQueryMyStashedFiles, ApiQueryLogEvents, ApiQueryLinks, ApiQueryLangLinks, ApiQueryLangBacklinks, ApiQueryIWLinks, ApiQueryIWBacklinks, ApiQueryInfo, ApiQueryImages, ApiQueryImageInfo, ApiQueryFileRepoInfo, ApiQueryFilearchive, ApiQueryExtLinksUsage, ApiQueryExternalLinks, ApiQueryDuplicateFiles, ApiQueryDeletedrevs, ApiQueryDeletedRevisions, ApiQueryContributors, ApiQueryCategoryMembers, ApiQueryCategoryInfo, ApiQueryCategories, ApiQueryBlocks, ApiQueryBacklinksprop, ApiQueryBacklinks, ApiQueryAuthManagerInfo, ApiQueryAllUsers, ApiQueryAllRevisions, ApiQueryAllPages, ApiQueryAllMessages, ApiQueryAllLinks, ApiQueryAllImages, ApiQueryAllDeletedRevisions, ApiQueryAllCategories, ApiQuery, ApiPurge, ApiProtect, ApiPatrol, ApiParse, ApiParamInfo, ApiOptions, ApiOpenSearch, ApiMove, ApiMergeHistory, ApiManageTags, ApiLogout, ApiLogin, ApiLinkAccount, ApiImport, ApiHelp, ApiFormatBase, ApiFeedWatchlist, ApiExpandTemplates, ApiEmailUser, ApiEditPage, ApiDelete, ApiClientLogin, ApiClearHasMsg, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.
Definition at line 289 of file ApiBase.php.
|
protected |
Get a HookContainer, for running extension hooks or for hook metadata.
Definition at line 651 of file ApiBase.php.
References $hookContainer.
Referenced by getHookRunner().
|
protected |
Get an ApiHookRunner for running core API hooks.
Definition at line 666 of file ApiBase.php.
References $hookRunner, and getHookContainer().
Referenced by ApiMain\__construct(), ApiQuery\__construct(), addDeprecation(), ApiQuerySiteinfo\appendGeneralInfo(), ApiQuerySiteinfo\appendStatistics(), ApiMain\checkConditionalRequestHeaders(), ApiMain\checkExecutePermissions(), ApiFormatBase\closePrinter(), ApiChangeAuthenticationData\execute(), ApiExpandTemplates\execute(), ApiLogin\execute(), ApiLogout\execute(), ApiOpenSearch\execute(), ApiOptions\execute(), ApiParse\execute(), ApiQuery\execute(), ApiRemoveAuthenticationData\execute(), ApiUndelete\execute(), ApiValidatePassword\execute(), ApiMain\executeAction(), ApiPageSet\executeInternal(), ApiQueryWatchlist\extractOutputData(), ApiQueryInfo\extractPageInfo(), ApiFeedContributions\feedItem(), ApiImport\getAllowedImportSources(), getFinalDescription(), getFinalParamDescription(), getFinalParams(), ApiQueryInfo\getLinkClasses(), ApiMain\getMaxLag(), ApiRsd\getRsdApiList(), ApiMain\handleException(), ApiMain\lacksSameOriginSecurity(), ApiQueryBase\processRow(), ApiQueryWatchlist\run(), ApiQueryBase\select(), and ApiParse\tweakParserOptions().
ApiBase::getMain | ( | ) |
Get the main module.
Definition at line 456 of file ApiBase.php.
References $mMainModule.
Referenced by ApiPageSet\__construct(), ApiContinuationManager\__construct(), ApiFormatBase\__construct(), ApiFormatJson\__construct(), ApiQueryBase\__construct(), addDeprecation(), ApiFormatBase\closePrinter(), ApiComparePages\execute(), ApiEditPage\execute(), ApiExpandTemplates\execute(), ApiFeedRecentChanges\execute(), ApiFeedWatchlist\execute(), ApiHelp\execute(), ApiOpenSearch\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiQuery\execute(), ApiQueryDeletedrevs\execute(), ApiUpload\execute(), ApiPageSet\executeInternal(), ApiQueryInfo\extractPageInfo(), ApiParamInfo\getAllowedParams(), ApiUpload\getChunkResult(), getContinuationManager(), ApiQueryUserInfo\getCurrentUserInfo(), ApiFeedContributions\getCustomPrinter(), ApiFeedRecentChanges\getCustomPrinter(), ApiFeedWatchlist\getCustomPrinter(), ApiHelp\getCustomPrinter(), ApiOpenSearch\getCustomPrinter(), ApiQuery\getCustomPrinter(), ApiRsd\getCustomPrinter(), getErrorFormatter(), ApiPageSet\getGenerators(), getModuleFromPath(), getParameterFromSettings(), getParent(), getResult(), ApiFeedWatchlist\getWatchlistModule(), ApiFormatBase\initPrinter(), ApiFormatRaw\initPrinter(), lacksSameOriginSecurity(), logFeatureUsage(), ApiQueryRevisionsBase\parseParameters(), requirePostedParameters(), ApiQueryRandom\run(), ApiQuerySearch\run(), ApiUpload\selectUploadModule(), setContinuationManager(), ApiFormatBase\setHttpStatus(), ApiComparePages\setVals(), validateLimit(), and validateTimestamp().
ApiBase::getModuleFromPath | ( | $path | ) |
Get a module from its module path.
string | $path |
ApiUsageException |
Definition at line 523 of file ApiBase.php.
References $path, dieWithError(), getMain(), and wfEscapeWikiText().
Referenced by ApiHelp\execute(), ApiParamInfo\execute(), and getFinalParamDescription().
ApiBase::getModuleManager | ( | ) |
Get the module manager, or null if this module has no sub-modules.
Reimplemented in ApiQuery, and ApiMain.
Definition at line 249 of file ApiBase.php.
Referenced by ApiFormatBase\closePrinter(), ApiParamInfo\execute(), getFinalParamDescription(), MediaWiki\Api\Validator\SubmoduleDef\getSubmoduleMap(), and ApiParamInfo\listAllSubmodules().
ApiBase::getModuleName | ( | ) |
Get the name of the module being executed by this instance.
Definition at line 440 of file ApiBase.php.
References $mModuleName.
Referenced by ApiPageSet\__construct(), ApiContinuationManager\addContinueParam(), ApiContinuationManager\addGeneratorContinueParam(), ApiContinuationManager\addGeneratorNonContinueParam(), ApiQuerySearch\addInterwikiResults(), ApiQueryBase\addPageSubItem(), ApiQueryBase\addPageSubItems(), ApiBlock\execute(), ApiChangeContentModel\execute(), ApiCheckToken\execute(), ApiClearHasMsg\execute(), ApiComparePages\execute(), ApiCSPReport\execute(), ApiDelete\execute(), ApiDisabled\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFileRevert\execute(), ApiHelp\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiManageTags\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiOptions\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQueryAllMessages\execute(), ApiQueryAllUsers\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryDisabled\execute(), ApiQueryFilearchive\execute(), ApiQueryLanguageinfo\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryPagePropNames\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTags\execute(), ApiQueryTokens\execute(), ApiQueryUserContribs\execute(), ApiQueryUserInfo\execute(), ApiQueryUsers\execute(), ApiRemoveAuthenticationData\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiTag\execute(), ApiTokens\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiQueryBacklinksprop\getAllowedParams(), ApiFormatBase\getExamplesMessages(), ApiQueryAllLinks\getExamplesMessages(), ApiQueryBacklinksprop\getExamplesMessages(), ApiQueryLanguageinfo\getExamplesMessages(), ApiQueryLinks\getExamplesMessages(), ApiRemoveAuthenticationData\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiQueryAllLinks\getHelpUrls(), ApiQueryBacklinksprop\getHelpUrls(), getModulePath(), getParameterFromSettings(), ApiAuthManagerHelper\logAuthenticationResult(), ApiQueryRevisionsBase\parseParameters(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryPagesWithProp\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryQueryPage\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQuerySearch\run(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryRandom\runQuery(), and ApiUpload\selectUploadModule().
ApiBase::getModulePath | ( | ) |
Get the path to this module.
Definition at line 505 of file ApiBase.php.
References getModuleName(), getParent(), and isMain().
Referenced by ApiUsageException\__construct(), addError(), addMessagesFromStatus(), addWarning(), MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiQueryAllLinks\getExamplesMessages(), ApiQueryBacklinksprop\getExamplesMessages(), ApiQueryLanguageinfo\getExamplesMessages(), ApiQueryLinks\getExamplesMessages(), ApiRemoveAuthenticationData\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiHelp\getHelp(), and MediaWiki\Api\Validator\SubmoduleDef\getSubmoduleMap().
ApiBase::getModulePrefix | ( | ) |
Get parameter prefix (usually two letters or an empty string).
Definition at line 448 of file ApiBase.php.
References $mModulePrefix.
Referenced by ApiQueryBase\addPageSubItem(), ApiQueryBase\addPageSubItems(), ApiQueryImageInfo\execute(), ApiQueryStashImageInfo\execute(), ApiQueryUserInfo\getAllowedParams(), ApiQueryAllLinks\getExamplesMessages(), ApiQueryLanguageinfo\getExamplesMessages(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiQueryImageInfo\mergeThumbParams(), ApiQueryRevisionsBase\parseParameters(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryExtLinksUsage\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryRevisions\run(), and validateTimestamp().
|
protected |
Returns information about the source of this module, if known.
Returned array is an array with the following keys:
Definition at line 1918 of file ApiBase.php.
References $ext, $IP, $mModuleSource, $path, ContextSource\getConfig(), SpecialVersion\getCredits(), and ExtensionRegistry\getInstance().
|
protected |
Get a value for the given parameter.
string | $paramName | Parameter name |
bool | $parseLimit | See extractRequestParams() |
Definition at line 840 of file ApiBase.php.
References extractRequestParams().
Referenced by ApiFormatRaw\__construct(), ApiMain\addRequestedFields(), ApiQuerySiteinfo\appendSkins(), ApiCSPReport\execute(), ApiFeedRecentChanges\execute(), ApiQueryLanguageinfo\execute(), ApiOpenSearch\getCustomPrinter(), ApiQuery\getCustomPrinter(), ApiCSPReport\getFlags(), ApiMain\handleCORS(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), ApiQueryRevisions\run(), ApiMain\sendCacheHeaders(), and ApiMain\setCacheMode().
|
protected |
Using the settings determine the value for the given parameter.
string | $name | Parameter name |
array | mixed | $settings | Default value or an array of settings using PARAM_* constants. |
bool | $parseLimit | Whether to parse and validate 'limit' parameters |
Reimplemented in ApiFormatBase.
Definition at line 1055 of file ApiBase.php.
References encodeParamName(), getMain(), getModuleName(), and getResult().
Referenced by extractRequestParams().
ApiBase::getParent | ( | ) |
Get the parent of this module Stable to override.
Reimplemented in ApiQueryBase.
Definition at line 475 of file ApiBase.php.
References getMain(), and isMain().
Referenced by getModulePath().
|
protected |
Obtain a PermissionManager instance that subclasses may use in their authorization checks.
Definition at line 630 of file ApiBase.php.
Referenced by ApiQueryUsers\execute(), ApiRevisionDelete\execute(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryUserInfo\getCurrentUserInfo(), ApiTag\processIndividual(), and ApiMain\setCacheMode().
ApiBase::getResult | ( | ) |
Get the result object.
Reimplemented in ApiMain.
Definition at line 561 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\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(), ApiAMCreateAccount\execute(), ApiBlock\execute(), ApiChangeAuthenticationData\execute(), ApiChangeContentModel\execute(), ApiCheckToken\execute(), ApiClearHasMsg\execute(), ApiClientLogin\execute(), ApiComparePages\execute(), ApiCSPReport\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiEmailUser\execute(), ApiExpandTemplates\execute(), ApiFeedContributions\execute(), ApiFeedRecentChanges\execute(), ApiFeedWatchlist\execute(), ApiFileRevert\execute(), ApiFormatFeedWrapper\execute(), ApiFormatJson\execute(), ApiFormatPhp\execute(), ApiFormatRaw\execute(), ApiFormatXml\execute(), ApiHelp\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiLinkAccount\execute(), ApiLogin\execute(), ApiManageTags\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiOpenSearchFormatJson\execute(), ApiOptions\execute(), ApiParamInfo\execute(), ApiParse\execute(), ApiPatrol\execute(), ApiProtect\execute(), ApiPurge\execute(), ApiQuery\execute(), ApiQueryAllMessages\execute(), ApiQueryAllUsers\execute(), ApiQueryAuthManagerInfo\execute(), ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryDeletedrevs\execute(), ApiQueryFilearchive\execute(), ApiQueryFileRepoInfo\execute(), ApiQueryImageInfo\execute(), ApiQueryInfo\execute(), ApiQueryLanguageinfo\execute(), ApiQueryLogEvents\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryPagePropNames\execute(), ApiQueryPageProps\execute(), ApiQueryStashImageInfo\execute(), ApiQueryTags\execute(), ApiQueryTokens\execute(), ApiQueryUserContribs\execute(), ApiQueryUserInfo\execute(), ApiQueryUsers\execute(), ApiRemoveAuthenticationData\execute(), ApiResetPassword\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiRsd\execute(), ApiSetNotificationTimestamp\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), ApiTag\execute(), ApiTokens\execute(), ApiUnblock\execute(), ApiUndelete\execute(), ApiUpload\execute(), ApiUserrights\execute(), ApiValidatePassword\execute(), ApiWatch\execute(), ApiFormatRaw\getFilename(), ApiFormatRaw\getMimeType(), getParameterFromSettings(), ApiFormatFeedWrapper\initPrinter(), ApiFormatRaw\initPrinter(), ApiQuery\outputGeneralPageInfo(), ApiQueryRevisionsBase\parseParameters(), ApiOpenSearch\populateResult(), ApiQueryAllCategories\run(), ApiQueryAllImages\run(), ApiQueryAllLinks\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryPagesWithProp\run(), ApiQueryPrefixSearch\run(), ApiQueryProtectedTitles\run(), ApiQueryQueryPage\run(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQuerySearch\run(), ApiQueryWatchlist\run(), ApiQueryWatchlistRaw\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryRandom\runQuery(), and ApiUpload\selectUploadModule().
|
protected |
Return the summary message.
This is a one-line description of the module, suitable for display in a list of modules.
Reimplemented in ApiQueryDisabled, and ApiDisabled.
Definition at line 1635 of file ApiBase.php.
Referenced by getFinalDescription(), and getFinalSummary().
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.
array | $params | User provided set of parameters, as from $this->extractRequestParams() |
Definition at line 1026 of file ApiBase.php.
References dieWithError(), Title\newFromID(), Title\newFromText(), requireOnlyOneParameter(), and wfEscapeWikiText().
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.
array | $params | User provided set of parameters, as from $this->extractRequestParams() |
string | false | $load | Whether load the object's state from the database:
|
Definition at line 989 of file ApiBase.php.
References dieWithError(), WikiPage\factory(), WikiPage\newFromID(), Title\newFromText(), requireOnlyOneParameter(), and wfEscapeWikiText().
Referenced by ApiChangeContentModel\execute(), ApiDelete\execute(), ApiEditPage\execute(), ApiParse\execute(), ApiProtect\execute(), ApiSetPageLanguage\execute(), ApiStashEdit\execute(), and ApiQueryCategoryMembers\run().
ApiBase::getWatchlistUser | ( | $params | ) |
Gets the user for whom to get the watchlist.
array | $params |
Definition at line 1136 of file ApiBase.php.
References checkUserRightsAny(), dieWithError(), ContextSource\getUser(), User\newFromName(), and wfEscapeWikiText().
Referenced by ApiQueryWatchlist\run(), and ApiQueryWatchlistRaw\run().
|
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.
array | $params | All supplied parameters for the module Stable to override |
Reimplemented in ApiUserrights, and ApiLogout.
Definition at line 409 of file ApiBase.php.
Referenced by validateToken().
ApiBase::handleParamNormalization | ( | $paramName, | |
$value, | |||
$rawValue | |||
) |
Handle when a parameter was Unicode-normalized.
Reimplemented in ApiPageSet.
Definition at line 1082 of file ApiBase.php.
References addWarning().
ApiBase::isDeprecated | ( | ) |
Indicates whether this module is deprecated.
Reimplemented in ApiTokens, ApiQueryDeletedrevs, and ApiLogin.
Definition at line 361 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.
Reimplemented in ApiStashEdit, and ApiCSPReport.
Definition at line 372 of file ApiBase.php.
Referenced by getHelpFlags().
ApiBase::isMain | ( | ) |
Returns true if this module is the main module ($this === $this->mMainModule), false otherwise.
Definition at line 465 of file ApiBase.php.
References $mMainModule.
Referenced by __construct(), getContinuationManager(), getErrorFormatter(), getFinalParamDescription(), getModulePath(), getParent(), getResult(), MediaWiki\Api\Validator\SubmoduleDef\getSubmoduleMap(), lacksSameOriginSecurity(), and setContinuationManager().
ApiBase::isReadMode | ( | ) |
Indicates whether this module requires read rights Stable to override.
Reimplemented in ApiRsd, ApiQueryTokens, ApiQueryAuthManagerInfo, ApiQuery, ApiParamInfo, ApiMain, ApiLogout, ApiLogin, ApiLinkAccount, ApiHelp, ApiDisabled, ApiCSPReport, ApiClientLogin, and ApiAMCreateAccount.
Definition at line 326 of file ApiBase.php.
Referenced by getHelpFlags().
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.
Stable to override
Reimplemented in ApiWatch, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiPurge, ApiProtect, ApiPatrol, ApiOptions, ApiMove, ApiMergeHistory, ApiManageTags, ApiLinkAccount, ApiImport, ApiImageRotate, ApiFileRevert, ApiEmailUser, ApiEditPage, ApiDelete, ApiClearHasMsg, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.
Definition at line 342 of file ApiBase.php.
Referenced by checkTitleUserPermissions(), getHelpFlags(), and ApiMain\setRequestExpectations().
ApiBase::lacksSameOriginSecurity | ( | ) |
Returns true if the current request breaks the same-origin policy.
For example, json with callbacks.
https://en.wikipedia.org/wiki/Same-origin_policy
Reimplemented in ApiMain.
Definition at line 489 of file ApiBase.php.
References dieDebug(), getMain(), and isMain().
Referenced by ApiLogin\execute(), ApiQueryDeletedrevs\execute(), ApiQueryTokens\execute(), ApiQueryUserInfo\getCurrentUserInfo(), ApiQueryInfo\getTokenFunctions(), ApiQueryRecentChanges\getTokenFunctions(), ApiQueryRevisions\getTokenFunctions(), ApiQueryUsers\getTokenFunctions(), and ApiTokens\getTokenTypes().
ApiBase::logFeatureUsage | ( | $feature | ) |
Write logging information for API features to a debug log, for usage analysis.
string | $feature | Feature being used. |
Definition at line 1589 of file ApiBase.php.
References $s, getMain(), ContextSource\getRequest(), ContextSource\getUser(), wfDebugLog(), and wfUrlencode().
Referenced by addDeprecation().
|
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.
string | array | Message | $msg | |
IContextSource | $context | |
array | null | $params |
Definition at line 1171 of file ApiBase.php.
References ContextSource\$context, and wfMessage().
Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettingsMessage(), ApiAMCreateAccount\getFinalDescription(), getFinalDescription(), ApiClientLogin\getFinalDescription(), ApiLinkAccount\getFinalDescription(), getFinalParamDescription(), getFinalSummary(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().
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.
Stable to override
string[] | &$help | Array of help data |
array | $options | Options passed to ApiHelp::getHelp |
array | &$tocData | If a TOC is being generated, this array has keys as anchors in the page and values as for Linker::generateTOC(). |
Reimplemented in ApiMain.
Definition at line 2001 of file ApiBase.php.
ApiBase::mustBePosted | ( | ) |
Indicates whether this module must be called with a POST request Stable to override.
Reimplemented in ApiWatch, ApiValidatePassword, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRollback, ApiRevisionDelete, ApiPurge, ApiProtect, ApiPatrol, ApiOptions, ApiMove, ApiMergeHistory, ApiManageTags, ApiLogout, ApiLogin, ApiImport, ApiImageRotate, ApiFileRevert, ApiEmailUser, ApiEditPage, ApiDelete, ApiCSPReport, ApiClearHasMsg, ApiChangeContentModel, and ApiBlock.
Definition at line 351 of file ApiBase.php.
References needsToken().
Referenced by getHelpFlags().
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.
Stable to override
Reimplemented in ApiWatch, ApiUserrights, ApiUpload, ApiUndelete, ApiUnblock, ApiTag, ApiStashEdit, ApiSetPageLanguage, ApiSetNotificationTimestamp, ApiRollback, ApiRevisionDelete, ApiResetPassword, ApiRemoveAuthenticationData, ApiProtect, ApiPatrol, ApiOptions, ApiMove, ApiMergeHistory, ApiManageTags, ApiLogout, ApiLinkAccount, ApiImport, ApiImageRotate, ApiFileRevert, ApiEmailUser, ApiEditPage, ApiDelete, ApiClientLogin, ApiChangeContentModel, ApiChangeAuthenticationData, ApiBlock, and ApiAMCreateAccount.
Definition at line 395 of file ApiBase.php.
Referenced by getFinalParams(), mustBePosted(), and validateToken().
|
private |
Callback function used in requireOnlyOneParameter to check whether required parameters are set.
mixed | $x | Parameter to check is not null/false |
Definition at line 974 of file ApiBase.php.
|
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.
string | $valueName | The name of the parameter (for error reporting) |
mixed | $value | The value being parsed |
bool | $allowMultiple | Can $value contain more than one value separated by '|'? |
string[] | null | $allowedValues | An array of values to check against. If null, all values are accepted. |
string | null | $allSpecifier | String to use to specify all allowed values, or null if this behavior should not be allowed |
int | null | $limit1 | Maximum number of values, for normal users. |
int | null | $limit2 | Maximum number of values, for users with the apihighlimits right. |
Definition at line 2041 of file ApiBase.php.
References addWarning(), dieWithError(), explodeMultiValue(), LIMIT_SML1, LIMIT_SML2, Message\listParam(), wfDeprecated(), and wfEscapeWikiText().
ApiBase::requireAtLeastOneParameter | ( | $params, | |
$required | |||
) |
Die if none of a certain set of parameters is set and not false.
array | $params | User provided set of parameters, as from $this->extractRequestParams() |
string | ...$required Names of parameters of which at least one must be set |
Definition at line 917 of file ApiBase.php.
References dieWithError(), encodeParamName(), and Message\listParam().
Referenced by ApiAMCreateAccount\execute(), ApiClientLogin\execute(), ApiComparePages\execute(), ApiEditPage\execute(), ApiLinkAccount\execute(), ApiQueryStashImageInfo\execute(), and ApiTag\execute().
ApiBase::requireMaxOneParameter | ( | $params, | |
$required | |||
) |
Die if more than one of a certain set of parameters is set and not false.
array | $params | User provided set of parameters, as from $this->extractRequestParams() |
string | ...$required Names of parameters of which at most one must be set |
Definition at line 892 of file ApiBase.php.
References dieWithError(), encodeParamName(), and Message\listParam().
Referenced by ApiExpandTemplates\execute(), ApiImport\execute(), ApiParse\execute(), ApiQueryAllUsers\execute(), ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryIWLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryLogEvents\execute(), ApiQueryUsers\execute(), ApiSetNotificationTimestamp\execute(), ApiComparePages\getDiffRevision(), ApiQueryRandom\run(), ApiQueryRecentChanges\run(), ApiQueryWatchlist\run(), ApiQueryAllRevisions\run(), ApiQueryDeletedRevisions\run(), and ApiQueryRevisions\run().
ApiBase::requireOnlyOneParameter | ( | $params, | |
$required | |||
) |
Die if none or more than one of a certain set of parameters is set and not false.
array | $params | User provided set of parameters, as from $this->extractRequestParams() |
string | ...$required Names of parameters of which exactly one must be set |
Definition at line 857 of file ApiBase.php.
References dieWithError(), encodeParamName(), and Message\listParam().
Referenced by ApiBlock\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiPatrol\execute(), ApiQueryUserContribs\execute(), ApiResetPassword\execute(), ApiStashEdit\execute(), ApiUnblock\execute(), ApiRollback\getRbTitle(), getTitleFromTitleOrPageId(), getTitleOrPageId(), ApiUserrights\getUrUser(), and ApiUpload\selectUploadModule().
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.
string[] | $params | Parameters to check |
string | $prefix | Set to 'noprefix' to skip calling $this->encodeParamName() |
Definition at line 944 of file ApiBase.php.
References dieWithError(), encodeParamName(), ContextSource\getConfig(), getMain(), and ContextSource\getRequest().
Referenced by ApiLogin\execute(), and ApiValidatePassword\execute().
ApiBase::setContinuationManager | ( | ApiContinuationManager | $manager = null | ) |
ApiContinuationManager | null | $manager |
Reimplemented in ApiMain.
Definition at line 614 of file ApiBase.php.
References dieDebug(), getMain(), and isMain().
Referenced by ApiImageRotate\execute(), ApiPurge\execute(), ApiQuery\execute(), ApiSetNotificationTimestamp\execute(), and ApiWatch\execute().
ApiBase::shouldCheckMaxlag | ( | ) |
Indicates if this module needs maxlag to be checked Stable to override.
Reimplemented in ApiHelp.
Definition at line 317 of file ApiBase.php.
|
protected |
Call wfTransactionalTimeLimit() if this request was POSTed.
Definition at line 1242 of file ApiBase.php.
References ContextSource\getRequest(), and wfTransactionalTimeLimit().
Referenced by ApiDelete\execute(), ApiEditPage\execute(), ApiFileRevert\execute(), ApiImageRotate\execute(), ApiImport\execute(), ApiMergeHistory\execute(), ApiMove\execute(), ApiRevisionDelete\execute(), ApiRollback\execute(), ApiSetPageLanguage\execute(), and ApiUndelete\execute().
|
protected |
Validate the value against the minimum and user/bot maximum limits.
Prints usage info on failure.
string | $name | Parameter name, unprefixed |
int | &$value | Parameter value |
int | null | $min | Minimum value |
int | null | $max | Maximum value for users |
int | null | $botMax | Maximum value for sysops/bots |
bool | $enforceLimits | Whether to enforce (die) if value is outside limits |
Definition at line 2125 of file ApiBase.php.
References getMain(), and wfDeprecated().
|
protected |
Validate and normalize parameters of type 'timestamp'.
string | $value | Parameter value |
string | $encParamName | Parameter name |
Definition at line 2147 of file ApiBase.php.
References getMain(), getModulePrefix(), and wfDeprecated().
|
final |
Validate the supplied token.
string | $token | Supplied token |
array | $params | All supplied parameters for the module |
MWException |
Definition at line 1095 of file ApiBase.php.
References ContextSource\getRequest(), ApiQueryTokens\getToken(), ApiQueryTokens\getTokenTypeSalts(), ContextSource\getUser(), getWebUITokenSalt(), and needsToken().
|
staticprivate |
Map of web UI block messages to corresponding API messages and codes.
Definition at line 185 of file ApiBase.php.
|
staticprivate |
Maps extension paths to info arrays.
Definition at line 179 of file ApiBase.php.
|
staticprivate |
Cache for self::filterIDs()
Definition at line 182 of file ApiBase.php.
|
private |
Definition at line 60 of file ApiBase.php.
Referenced by getHookContainer(), and ApiQueryTokens\getTokenTypeSalts().
|
private |
Definition at line 63 of file ApiBase.php.
Referenced by getHookRunner(), and ApiQueryTokens\getTokenTypeSalts().
|
private |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 194 of file ApiBase.php.
|
private |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 196 of file ApiBase.php.
Referenced by getModuleName().
string ApiBase::$mModulePrefix |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 196 of file ApiBase.php.
Referenced by getModulePrefix().
|
private |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 203 of file ApiBase.php.
Referenced by getModuleSourceInfo().
|
private |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 201 of file ApiBase.php.
|
private |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 197 of file ApiBase.php.
Referenced by getDB().
const ApiBase::ALL_DEFAULT_STRING = '*' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 160 of file ApiBase.php.
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
Definition at line 176 of file ApiBase.php.
Referenced by ApiPageSet\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().
const ApiBase::LIMIT_BIG1 = 500 |
Fast query, standard limit.
Definition at line 163 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiQueryDeletedrevs\execute(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryRevisionsBase\parseParameters(), and ApiQueryBacklinks\run().
const ApiBase::LIMIT_BIG2 = 5000 |
Fast query, apihighlimits limit.
Definition at line 165 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiQueryDeletedrevs\execute(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiQueryRevisionsBase\parseParameters(), and ApiQueryBacklinks\run().
const ApiBase::LIMIT_SML1 = 50 |
Slow query, standard limit.
Definition at line 167 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\__construct(), ApiQueryDeletedrevs\execute(), ApiQueryInfo\extractPageInfo(), parseMultiValue(), and ApiQueryRevisionsBase\parseParameters().
const ApiBase::LIMIT_SML2 = 500 |
Slow query, apihighlimits limit.
Definition at line 169 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\__construct(), ApiQueryDeletedrevs\execute(), ApiQueryInfo\extractPageInfo(), parseMultiValue(), and ApiQueryRevisionsBase\parseParameters().
const ApiBase::PARAM_ALL = ParamValidator::PARAM_ALL |
Definition at line 81 of file ApiBase.php.
Referenced by ApiComparePages\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), and ApiQueryUserInfo\getAllowedParams().
const ApiBase::PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES |
Definition at line 76 of file ApiBase.php.
Referenced by ApiUserrights\getAllowedParams(), ApiProtect\getAllowedParams(), and ApiQueryAllMessages\getAllowedParams().
const ApiBase::PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED |
Definition at line 77 of file ApiBase.php.
Referenced by ApiUserrights\getAllowedParams(), ApiBlock\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiDelete\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiOpenSearch\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiParse\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiUnblock\getAllowedParams(), ApiUpload\getAllowedParams(), and ApiHelp\getHelpInternal().
const ApiBase::PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES |
Definition at line 84 of file ApiBase.php.
Referenced by ApiParse\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), and getFinalParamDescription().
const ApiBase::PARAM_DFLT = ParamValidator::PARAM_DEFAULT |
Definition at line 70 of file ApiBase.php.
Referenced by buildCommonApiParams(), buildProfileApiParam(), ApiFeedWatchlist\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiCSPReport\getAllowedParams(), ApiDelete\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiFileRevert\getAllowedParams(), ApiFormatBase\getAllowedParams(), ApiFormatJson\getAllowedParams(), ApiFormatPhp\getAllowedParams(), ApiFormatXml\getAllowedParams(), ApiHelp\getAllowedParams(), ApiMain\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiOpenSearch\getAllowedParams(), ApiOptions\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiParse\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryTokens\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiStashEdit\getAllowedParams(), ApiTag\getAllowedParams(), ApiTokens\getAllowedParams(), ApiUpload\getAllowedParams(), ApiOpenSearch\getFormat(), ApiFormatBase\getParameterFromSettings(), and ApiAuthManagerHelper\getStandardParams().
const ApiBase::PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES |
Definition at line 82 of file ApiBase.php.
Referenced by ApiQueryLogEvents\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), and ApiQueryRecentChanges\getAllowedParams().
const ApiBase::PARAM_HELP_MSG = 'api-param-help-msg' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter.
Default is apihelp-{$path}-param-{$param}.
Definition at line 105 of file ApiBase.php.
Referenced by buildCommonApiParams(), buildProfileApiParam(), MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiFeedWatchlist\getAllowedParams(), ApiImageRotate\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiPurge\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiSetNotificationTimestamp\getAllowedParams(), ApiWatch\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiFormatBase\getAllowedParams(), ApiFormatJson\getAllowedParams(), ApiFormatPhp\getAllowedParams(), ApiFormatXml\getAllowedParams(), ApiLogin\getAllowedParams(), ApiParse\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryInfo\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPageProps\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), getFinalParamDescription(), and ApiAuthManagerHelper\getStandardParams().
const ApiBase::PARAM_HELP_MSG_APPEND = 'api-param-help-msg-append' |
((string|array|Message)[]) Specify additional i18n messages to append to the normal message for this parameter.
Definition at line 112 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiUserrights\getAllowedParams(), ApiAMCreateAccount\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), and ApiRollback\getAllowedParams().
const ApiBase::PARAM_HELP_MSG_INFO = 'api-param-help-msg-info' |
(array) Specify additional information tags for the parameter.
Value is an array of arrays, with the first member being the 'tag' for the info and the remaining members being the values. In the help, this is formatted using apihelp-{$path}-paraminfo-{$tag}, which is passed $1 = count, $2 = comma-joined list of values, $3 = module prefix.
Definition at line 122 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().
const ApiBase::PARAM_HELP_MSG_PER_VALUE = 'api-param-help-msg-per-value' |
((string|array|Message)[]) When PARAM_TYPE is an array, this is an array mapping those values to $msg for ApiBase::makeMessage().
Any value not having a mapping will use apihelp-{$path}-paramvalue-{$param}-{$value}. Specify an empty array to use the default message key for all values.
Definition at line 138 of file ApiBase.php.
Referenced by buildProfileApiParam(), MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiParse\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), and getFinalParamDescription().
const ApiBase::PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI |
Definition at line 71 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiImageRotate\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiBlock\getAllowedParams(), ApiChangeContentModel\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiDelete\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiHelp\getAllowedParams(), ApiImport\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiMove\getAllowedParams(), ApiOptions\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiParse\getAllowedParams(), ApiPatrol\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPageProps\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryTokens\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiRollback\getAllowedParams(), ApiSetPageLanguage\getAllowedParams(), ApiTag\getAllowedParams(), ApiTokens\getAllowedParams(), ApiUnblock\getAllowedParams(), ApiUndelete\getAllowedParams(), ApiUpload\getAllowedParams(), and ApiAuthManagerHelper\getStandardParams().
const ApiBase::PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1 |
Definition at line 85 of file ApiBase.php.
Referenced by ApiBlock\getAllowedParams().
const ApiBase::PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2 |
Definition at line 86 of file ApiBase.php.
Referenced by ApiBlock\getAllowedParams().
const ApiBase::PARAM_MAX = IntegerDef::PARAM_MAX |
Definition at line 73 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), and ApiUpload\getAllowedParams().
const ApiBase::PARAM_MAX2 = IntegerDef::PARAM_MAX2 |
Definition at line 74 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), and ApiQueryWatchlistRaw\getAllowedParams().
const ApiBase::PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES |
Definition at line 87 of file ApiBase.php.
const ApiBase::PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS |
Definition at line 88 of file ApiBase.php.
const ApiBase::PARAM_MIN = IntegerDef::PARAM_MIN |
Definition at line 75 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiFeedWatchlist\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), and ApiUpload\getAllowedParams().
const ApiBase::PARAM_RANGE_ENFORCE = 'api-param-range-enforce' |
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE
Definition at line 95 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), ApiEditPage\getAllowedParams(), and MediaWiki\Api\Validator\ApiParamValidator\normalizeSettings().
const ApiBase::PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED |
Definition at line 78 of file ApiBase.php.
Referenced by buildCommonApiParams(), ApiImageRotate\getAllowedParams(), ApiChangeContentModel\getAllowedParams(), ApiCheckToken\getAllowedParams(), ApiCSPReport\getAllowedParams(), ApiEmailUser\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiFileRevert\getAllowedParams(), ApiLogin\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiMove\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiRollback\getAllowedParams(), ApiSetPageLanguage\getAllowedParams(), ApiStashEdit\getAllowedParams(), ApiUndelete\getAllowedParams(), ApiValidatePassword\getAllowedParams(), and ApiAuthManagerHelper\getStandardParams().
const ApiBase::PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE |
Definition at line 83 of file ApiBase.php.
Referenced by ApiCheckToken\getAllowedParams(), ApiLogin\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), and ApiQueryWatchlistRaw\getAllowedParams().
const ApiBase::PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP |
Definition at line 79 of file ApiBase.php.
Referenced by ApiPageSet\getAllowedParams(), and getFinalParamDescription().
const ApiBase::PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX |
Definition at line 80 of file ApiBase.php.
Referenced by ApiPageSet\getAllowedParams().
const ApiBase::PARAM_TEMPLATE_VARS = 'param-template-vars' |
(array) Indicate that this is a templated parameter, and specify replacements.
Keys are the placeholders in the parameter name and values are the names of (unprefixed) parameters from which the replacement values are taken.
For example, a parameter "foo-{ns}-{title}" could be defined with PARAM_TEMPLATE_VARS => [ 'ns' => 'namespaces', 'title' => 'titles' ]. Then a query for namespaces=0|1&titles=X|Y would support parameters foo-0-X, foo-0-Y, foo-1-X, and foo-1-Y.
All placeholders must be present in the parameter's name. Each target parameter must have PARAM_ISMULTI true. If a target is itself a templated parameter, its PARAM_TEMPLATE_VARS must be a subset of the referring parameter's, mapping the same placeholders to the same targets. A parameter cannot target itself.
Definition at line 156 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings(), extractRequestParams(), ApiComparePages\getAllowedParams(), ApiHelp\getHelpInternal(), and ApiParamInfo\getModuleInfo().
const ApiBase::PARAM_TYPE = ParamValidator::PARAM_TYPE |
Definition at line 72 of file ApiBase.php.
Referenced by buildCommonApiParams(), buildProfileApiParam(), ApiFeedWatchlist\getAllowedParams(), ApiImageRotate\getAllowedParams(), ApiPageSet\getAllowedParams(), ApiQuery\getAllowedParams(), ApiQueryAllUsers\getAllowedParams(), ApiQueryContributors\getAllowedParams(), ApiQueryLogEvents\getAllowedParams(), ApiSetNotificationTimestamp\getAllowedParams(), ApiUserrights\getAllowedParams(), ApiBlock\getAllowedParams(), ApiChangeContentModel\getAllowedParams(), ApiCheckToken\getAllowedParams(), ApiComparePages\getAllowedParams(), ApiCSPReport\getAllowedParams(), ApiDelete\getAllowedParams(), ApiEditPage\getAllowedParams(), ApiEmailUser\getAllowedParams(), ApiExpandTemplates\getAllowedParams(), ApiFeedContributions\getAllowedParams(), ApiFeedRecentChanges\getAllowedParams(), ApiFileRevert\getAllowedParams(), ApiFormatJson\getAllowedParams(), ApiFormatPhp\getAllowedParams(), ApiImport\getAllowedParams(), ApiLogin\getAllowedParams(), ApiMain\getAllowedParams(), ApiManageTags\getAllowedParams(), ApiMergeHistory\getAllowedParams(), ApiMove\getAllowedParams(), ApiOpenSearch\getAllowedParams(), ApiOptions\getAllowedParams(), ApiParamInfo\getAllowedParams(), ApiParse\getAllowedParams(), ApiPatrol\getAllowedParams(), ApiProtect\getAllowedParams(), ApiQueryAllCategories\getAllowedParams(), ApiQueryAllDeletedRevisions\getAllowedParams(), ApiQueryAllImages\getAllowedParams(), ApiQueryAllLinks\getAllowedParams(), ApiQueryAllMessages\getAllowedParams(), ApiQueryAllPages\getAllowedParams(), ApiQueryAllRevisions\getAllowedParams(), ApiQueryAuthManagerInfo\getAllowedParams(), ApiQueryBacklinks\getAllowedParams(), ApiQueryBacklinksprop\getAllowedParams(), ApiQueryBlocks\getAllowedParams(), ApiQueryCategories\getAllowedParams(), ApiQueryCategoryMembers\getAllowedParams(), ApiQueryDeletedRevisions\getAllowedParams(), ApiQueryDeletedrevs\getAllowedParams(), ApiQueryDuplicateFiles\getAllowedParams(), ApiQueryExternalLinks\getAllowedParams(), ApiQueryExtLinksUsage\getAllowedParams(), ApiQueryFilearchive\getAllowedParams(), ApiQueryFileRepoInfo\getAllowedParams(), ApiQueryImageInfo\getAllowedParams(), ApiQueryImages\getAllowedParams(), ApiQueryInfo\getAllowedParams(), ApiQueryIWBacklinks\getAllowedParams(), ApiQueryIWLinks\getAllowedParams(), ApiQueryLangBacklinks\getAllowedParams(), ApiQueryLangLinks\getAllowedParams(), ApiQueryLinks\getAllowedParams(), ApiQueryMyStashedFiles\getAllowedParams(), ApiQueryPagePropNames\getAllowedParams(), ApiQueryPagesWithProp\getAllowedParams(), ApiQueryProtectedTitles\getAllowedParams(), ApiQueryQueryPage\getAllowedParams(), ApiQueryRandom\getAllowedParams(), ApiQueryRecentChanges\getAllowedParams(), ApiQueryRevisions\getAllowedParams(), ApiQueryRevisionsBase\getAllowedParams(), ApiQuerySearch\getAllowedParams(), ApiQuerySiteinfo\getAllowedParams(), ApiQueryStashImageInfo\getAllowedParams(), ApiQueryTags\getAllowedParams(), ApiQueryTokens\getAllowedParams(), ApiQueryUserContribs\getAllowedParams(), ApiQueryUserInfo\getAllowedParams(), ApiQueryUsers\getAllowedParams(), ApiQueryWatchlist\getAllowedParams(), ApiQueryWatchlistRaw\getAllowedParams(), ApiResetPassword\getAllowedParams(), ApiRevisionDelete\getAllowedParams(), ApiRollback\getAllowedParams(), ApiSetPageLanguage\getAllowedParams(), ApiStashEdit\getAllowedParams(), ApiTag\getAllowedParams(), ApiTokens\getAllowedParams(), ApiUnblock\getAllowedParams(), ApiUndelete\getAllowedParams(), ApiUpload\getAllowedParams(), ApiValidatePassword\getAllowedParams(), ApiOpenSearch\getFormat(), ApiHelp\getHelpInternal(), and ApiAuthManagerHelper\getStandardParams().
const ApiBase::PARAM_VALUE_LINKS = 'api-param-value-links' |
Deprecated and unused.
Definition at line 129 of file ApiBase.php.
Referenced by MediaWiki\Api\Validator\ApiParamValidator\checkSettings().