MediaWiki
master
|
This is the main query class. More...
Public Member Functions | |
__construct (ApiMain $main, $action, ObjectFactory $objectFactory, WikiExporterFactory $wikiExporterFactory, TitleFormatter $titleFormatter, TitleFactory $titleFactory) | |
execute () | |
Query execution happens in the following steps: #1 Create a PageSet object with any pages requested by the user #2 If using a generator, execute it to get a new ApiPageSet object #3 Instantiate all requested modules. More... | |
getAllowedParams ( $flags=0) | |
getCustomPrinter () | |
getHelpUrls () | |
Return links to more detailed help pages about the module. More... | |
getModuleManager () | |
Overrides to return this instance's module manager. More... | |
getPageSet () | |
Gets the set of pages the user has requested (or generated) More... | |
isReadMode () | |
Indicates whether this module requires read rights. More... | |
![]() | |
__construct (ApiMain $mainModule, $moduleName, $modulePrefix='') | |
shouldCheckMaxlag () | |
Indicates if this module needs maxlag to be checked. More... | |
isWriteMode () | |
Indicates whether this module requires write mode. More... | |
mustBePosted () | |
Indicates whether this module must be called with a POST request. More... | |
isDeprecated () | |
Indicates whether this module is deprecated. More... | |
isInternal () | |
Indicates whether this module is considered to be "internal". More... | |
needsToken () | |
Returns the token type this module requires in order to execute. More... | |
getConditionalRequestData ( $condition) | |
Returns data for HTTP conditional request mechanisms. More... | |
getModuleName () | |
Get the name of the module being executed by this instance. More... | |
getModulePrefix () | |
Get parameter prefix (usually two letters or an empty string). More... | |
getMain () | |
Get the main module. More... | |
isMain () | |
Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. More... | |
getParent () | |
Get the parent of this module. More... | |
lacksSameOriginSecurity () | |
Returns true if the current request breaks the same-origin policy. More... | |
getModulePath () | |
Get the path to this module. More... | |
getModuleFromPath ( $path) | |
Get a module from its module path. More... | |
getResult () | |
Get the result object. More... | |
getErrorFormatter () | |
getContinuationManager () | |
setContinuationManager (ApiContinuationManager $manager=null) | |
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 the key being the name of the variable, and value - validated value from user or default. More... | |
requireOnlyOneParameter ( $params,... $required) | |
Die if 0 or more than one of a certain set of parameters is set and not false. More... | |
requireMaxOneParameter ( $params,... $required) | |
Dies if more than one parameter from a certain set of parameters are set and not false. More... | |
requireAtLeastOneParameter ( $params,... $required) | |
Die if 0 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 HTTP post body contents. More... | |
getTitleOrPageId ( $params, $load=false) | |
Attempts to load a WikiPage object from a title or pageid parameter, if possible. More... | |
getTitleFromTitleOrPageId ( $params) | |
Get a Title object from a title or pageid param, if it is possible. More... | |
handleParamNormalization ( $paramName, $value, $rawValue) | |
Handle when a parameter was Unicode-normalized. More... | |
validateToken ( $token, array $params) | |
Validate the supplied token. More... | |
getWatchlistUser ( $params) | |
Gets the user for whom to get the watchlist. More... | |
errorArrayToStatus (array $errors, Authority $performer=null) | |
Turn an array of messages into a Status. More... | |
addBlockInfoToStatus (StatusValue $status, Authority $user=null) | |
Add block info to block messages in a Status. More... | |
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=0) | |
Abort execution with an error. More... | |
dieWithException (Throwable $exception, array $options=[]) | |
Abort execution with an error derived from a throwable. More... | |
dieBlocked (Block $block) | |
Throw an ApiUsageException, which will (if uncaught) call the main module's error handler and die with an error message including block info. More... | |
dieStatus (StatusValue $status) | |
Throw an ApiUsageException based on the Status object. More... | |
dieReadOnly () | |
Helper function for readonly errors. More... | |
checkUserRightsAny ( $rights) | |
Helper function for permission-denied errors. More... | |
checkTitleUserPermissions (PageIdentity $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... | |
getFinalSummary () | |
Get the final module summary. More... | |
getFinalDescription () | |
Get the final module description, after hooks have had a chance to tweak it as needed. More... | |
getFinalParams ( $flags=0) | |
Get the 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... | |
![]() | |
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... | |
getActionName () | |
Get the action name for the current web request. More... | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. More... | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. More... | |
getLanguage () | |
getOutput () | |
getRequest () | |
getSkin () | |
getTiming () | |
getTitle () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. More... | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() More... | |
setContext (IContextSource $context) | |
Protected Member Functions | |
getExamplesMessages () | |
Returns usage examples for this module. More... | |
mergeCacheMode ( $cacheMode, $modCacheMode) | |
Update a cache mode string, applying the cache mode of a new module to it. 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... | |
getDB () | |
Gets a default replica DB connection object. More... | |
getPermissionManager () | |
Obtain a PermissionManager instance that subclasses may use in their authorization checks. More... | |
getHookContainer () | |
Get a HookContainer, for running extension hooks or for hook metadata. More... | |
getHookRunner () | |
Get an ApiHookRunner for running core API hooks. More... | |
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... | |
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... | |
parseContinueParamOrDie (string $continue, array $types) | |
Parse the 'continue' parameter in the usual format and validate the types of each part, or die with the 'badcontinue' error if the format, types, or the number of parts is wrong. More... | |
dieContinueUsageIf ( $condition) | |
Die with the 'badcontinue' error. 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 | |
![]() | |
static | makeMessage ( $msg, IContextSource $context, array $params=null) |
Create a Message from a string or array. More... | |
static | clearCacheForTest () |
Reset static caches of database state. More... | |
![]() | |
const | PARAM_RANGE_ENFORCE = 'api-param-range-enforce' |
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More... | |
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 |
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, or 'string' with PARAM_ISMULTI, this is an array mapping parameter values to help message specifiers (to be passed to ApiBase::makeMessage()) about those values. 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 this is 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 | dieDebug ( $method, $message) |
Internal code errors should be reported with this method. More... | |
This is the main query class.
It behaves similar to ApiMain: based on the parameters given, it will create a list of titles to work on (an ApiPageSet object), instantiate and execute various property/list/meta modules, and assemble all resulting data into a single ApiResult object.
In generator mode, a generator will be executed first to populate a second ApiPageSet object, and that object will be used for all subsequent modules.
Definition at line 43 of file ApiQuery.php.
ApiQuery::__construct | ( | ApiMain | $main, |
$action, | |||
ObjectFactory | $objectFactory, | ||
WikiExporterFactory | $wikiExporterFactory, | ||
TitleFormatter | $titleFormatter, | ||
TitleFactory | $titleFactory | ||
) |
ApiMain | $main | |
string | $action | |
ObjectFactory | $objectFactory | |
WikiExporterFactory | $wikiExporterFactory | |
TitleFormatter | $titleFormatter | |
TitleFactory | $titleFactory |
Definition at line 572 of file ApiQuery.php.
References ContextSource\getConfig(), and ApiBase\getHookRunner().
ApiQuery::execute | ( | ) |
Query execution happens in the following steps: #1 Create a PageSet object with any pages requested by the user #2 If using a generator, execute it to get a new ApiPageSet object #3 Instantiate all requested modules.
This way the PageSet object will know what shared data is required, and minimize DB calls. #4 Output all normalization and redirect resolution information #5 Execute all requested modules
Reimplemented from ApiBase.
Definition at line 646 of file ApiQuery.php.
References $modules, CoreParserFunctions\null\$t, ApiResult\ADD_ON_TOP, ApiBase\extractRequestParams(), ApiBase\getHookRunner(), ApiBase\getMain(), ApiBase\getResult(), mergeCacheMode(), ApiResult\NO_SIZE_CHECK, and ApiBase\setContinuationManager().
ApiQuery::getAllowedParams | ( | $flags = 0 | ) |
Definition at line 925 of file ApiQuery.php.
References XmlDumpWriter\$supportedSchemas, getPageSet(), ApiBase\PARAM_HELP_MSG, and WikiExporter\schemaVersion().
ApiQuery::getCustomPrinter | ( | ) |
Reimplemented from ApiBase.
Definition at line 624 of file ApiQuery.php.
References ApiBase\getMain(), and ApiBase\getParameter().
|
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 from ApiBase.
Definition at line 989 of file ApiQuery.php.
ApiQuery::getHelpUrls | ( | ) |
Return links to more detailed help pages about the module.
Reimplemented from ApiBase.
Definition at line 1002 of file ApiQuery.php.
ApiQuery::getModuleManager | ( | ) |
Overrides to return this instance's module manager.
Reimplemented from ApiBase.
Definition at line 609 of file ApiQuery.php.
ApiQuery::getPageSet | ( | ) |
Gets the set of pages the user has requested (or generated)
Definition at line 617 of file ApiQuery.php.
Referenced by getAllowedParams(), and isReadMode().
ApiQuery::isReadMode | ( | ) |
Indicates whether this module requires read rights.
Reimplemented from ApiBase.
Definition at line 959 of file ApiQuery.php.
References $modules, ApiBase\extractRequestParams(), getPageSet(), and ContextSource\getRequest().
|
protected |
Update a cache mode string, applying the cache mode of a new module to it.
The cache mode may increase in the level of privacy, but public modules added to private data do not decrease the level of privacy.
string | $cacheMode | |
string | $modCacheMode |
Definition at line 736 of file ApiQuery.php.
Referenced by execute().