MediaWiki master
|
This is a base class for all Query modules. More...
Inherits MediaWiki\Api\ApiBase.
Inherited by MediaWiki\Api\ApiQueryAllMessages, MediaWiki\Api\ApiQueryAllUsers, MediaWiki\Api\ApiQueryAuthManagerInfo, MediaWiki\Api\ApiQueryBlocks, MediaWiki\Api\ApiQueryCategoryInfo, MediaWiki\Api\ApiQueryContributors, MediaWiki\Api\ApiQueryDeletedrevs, MediaWiki\Api\ApiQueryDisabled, MediaWiki\Api\ApiQueryExternalLinks, MediaWiki\Api\ApiQueryFileRepoInfo, MediaWiki\Api\ApiQueryFilearchive, MediaWiki\Api\ApiQueryGeneratorBase, MediaWiki\Api\ApiQueryIWLinks, MediaWiki\Api\ApiQueryImageInfo, MediaWiki\Api\ApiQueryInfo, MediaWiki\Api\ApiQueryLangLinks, MediaWiki\Api\ApiQueryLanguageinfo, MediaWiki\Api\ApiQueryLogEvents, MediaWiki\Api\ApiQueryMyStashedFiles, MediaWiki\Api\ApiQueryPagePropNames, MediaWiki\Api\ApiQueryPageProps, MediaWiki\Api\ApiQuerySiteinfo, MediaWiki\Api\ApiQueryTags, MediaWiki\Api\ApiQueryTokens, MediaWiki\Api\ApiQueryUserContribs, MediaWiki\Api\ApiQueryUserInfo, and MediaWiki\Api\ApiQueryUsers.
Public Member Functions | |
__construct (ApiQuery $queryModule, string $moduleName, $paramPrefix='') | |
Methods to implement | |
getCacheMode ( $params) | |
Get the cache mode for the data generated by this module. | |
requestExtraData ( $pageSet) | |
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName') | |
Public Member Functions inherited from MediaWiki\Api\ApiBase | |
__construct (ApiMain $mainModule, string $moduleName, string $modulePrefix='') | |
execute () | |
Evaluates the parameters, performs the requested query, and sets up the result. | |
getModuleManager () | |
Get the module manager, or null if this module has no submodules. | |
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. | |
getHelpUrls () | |
Return links to more detailed help pages about the module. | |
shouldCheckMaxlag () | |
Indicates if this module needs maxlag to be checked. | |
isReadMode () | |
Indicates whether this module requires read rights. | |
isWriteMode () | |
Indicates whether this module requires write access to the wiki. | |
mustBePosted () | |
Indicates whether this module must be called with a POST request. | |
isDeprecated () | |
Indicates whether this module is deprecated. | |
isInternal () | |
Indicates whether this module is considered to be "internal". | |
needsToken () | |
Returns the token type this module requires in order to execute. | |
getConditionalRequestData ( $condition) | |
Returns data for HTTP conditional request mechanisms. | |
getModuleName () | |
Get the name of the module being executed by this instance. | |
getModulePrefix () | |
Get parameter prefix (usually two letters or an empty string). | |
getMain () | |
Get the main module. | |
isMain () | |
Returns true if this module is the main module ($this === $this->mMainModule), false otherwise. | |
lacksSameOriginSecurity () | |
Returns true if the current request breaks the same-origin policy. | |
getModulePath () | |
Get the path to this module. | |
getModuleFromPath ( $path) | |
Get a module from its module path. | |
getResult () | |
Get the result object. | |
getErrorFormatter () | |
getContinuationManager () | |
setContinuationManager (?ApiContinuationManager $manager=null) | |
dynamicParameterDocumentation () | |
Indicate if the module supports dynamically-determined parameters that cannot be included in self::getAllowedParams(). | |
encodeParamName ( $paramName) | |
This method mangles parameter name based on the prefix supplied to the constructor. | |
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. | |
requireOnlyOneParameter ( $params,... $required) | |
Die if 0 or more than one of a certain set of parameters is set and not false. | |
requireMaxOneParameter ( $params,... $required) | |
Dies if more than one parameter from a certain set of parameters are set and not false. | |
requireAtLeastOneParameter ( $params,... $required) | |
Die if 0 of a certain set of parameters is set and not false. | |
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. | |
getTitleOrPageId ( $params, $load=false) | |
Attempts to load a WikiPage object from a title or pageid parameter, if possible. | |
getTitleFromTitleOrPageId ( $params) | |
Get a Title object from a title or pageid param, if it is possible. | |
handleParamNormalization ( $paramName, $value, $rawValue) | |
Handle when a parameter was Unicode-normalized. | |
validateToken ( $token, array $params) | |
Validate the supplied token. | |
getWatchlistUser ( $params) | |
Gets the user for whom to get the watchlist. | |
addBlockInfoToStatus (StatusValue $status, ?Authority $user=null) | |
Add block info to block messages in a Status. | |
addWarning ( $msg, $code=null, $data=null) | |
Add a warning for this module. | |
addDeprecation ( $msg, $feature, $data=[]) | |
Add a deprecation warning for this module. | |
addError ( $msg, $code=null, $data=null) | |
Add an error for this module without aborting. | |
addMessagesFromStatus (StatusValue $status, $types=[ 'warning', 'error'], array $filter=[]) | |
Add warnings and/or errors from a Status. | |
dieWithError ( $msg, $code=null, $data=null, $httpCode=0) | |
Abort execution with an error. | |
dieWithException (Throwable $exception, array $options=[]) | |
Abort execution with an error derived from a throwable. | |
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. | |
dieStatus (StatusValue $status) | |
Throw an ApiUsageException based on the Status object. | |
dieReadOnly () | |
Helper function for readonly errors. | |
checkUserRightsAny ( $rights) | |
Helper function for permission-denied errors. | |
checkTitleUserPermissions (PageIdentity $pageIdentity, $actions, array $options=[]) | |
Helper function for permission-denied errors. | |
dieWithErrorOrDebug ( $msg, $code=null, $data=null, $httpCode=null) | |
Will only set a warning instead of failing if the global $wgDebugAPI is set to true. | |
logFeatureUsage ( $feature) | |
Write logging information for API features to a debug log, for usage analysis. | |
getFinalSummary () | |
Get the final module summary. | |
getFinalDescription () | |
Get the final module description, after hooks have had a chance to tweak it as needed. | |
getFinalParams ( $flags=0) | |
Get the final list of parameters, after hooks have had a chance to tweak it as needed. | |
getFinalParamDescription () | |
Get final parameter descriptions, after hooks have had a chance to tweak it as needed. | |
modifyHelp (array &$help, array $options, array &$tocData) | |
Called from ApiHelp before the pieces are joined together and returned. | |
Public Member Functions inherited from MediaWiki\Context\ContextSource | |
canUseWikiPage () | |
Check whether a WikiPage object can be get with getWikiPage(). | |
exportSession () | |
Export the resolved user IP, HTTP headers, user ID, and session ID. | |
getActionName () | |
Get the action name for the current web request. | |
getAuthority () | |
getConfig () | |
getContext () | |
Get the base IContextSource object. | |
getCsrfTokenSet () | |
Get a repository to obtain and match CSRF tokens. | |
getLanguage () | |
getLanguageCode () | |
getOutput () | |
getRequest () | |
getSkin () | |
getTiming () | |
getTitle () | |
getUser () | |
getWikiPage () | |
Get the WikiPage object. | |
msg ( $key,... $params) | |
Get a Message object with context set Parameters are the same as wfMessage() | |
setContext (IContextSource $context) | |
Protected Member Functions | |
Querying | |
resetQueryParams () | |
Blank the internal arrays with query parameters. | |
getQueryBuilder () | |
Get the SelectQueryBuilder. | |
addTables ( $tables, $alias=null) | |
Add a set of tables to the internal array. | |
addJoinConds ( $join_conds) | |
Add a set of JOIN conditions to the internal array. | |
addFields ( $value) | |
Add a set of fields to select to the internal array. | |
addFieldsIf ( $value, $condition) | |
Same as addFields(), but add the fields only if a condition is met. | |
addWhere ( $value) | |
Add a set of WHERE clauses to the internal array. | |
addWhereIf ( $value, $condition) | |
Same as addWhere(), but add the WHERE clauses only if a condition is met. | |
addWhereFld ( $field, $value) | |
Equivalent to addWhere( [ $field => $value ] ) | |
addWhereIDsFld ( $table, $field, $ids) | |
Like addWhereFld for an integer list of IDs. | |
addWhereRange ( $field, $dir, $start, $end, $sort=true) | |
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction. | |
addTimestampWhereRange ( $field, $dir, $start, $end, $sort=true) | |
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps. | |
addOption ( $name, $value=null) | |
Add an option such as LIMIT or USE INDEX. | |
select ( $method, $extraQuery=[], ?array &$hookData=null) | |
Execute a SELECT query based on the values in the internal arrays. | |
processRow ( $row, array &$data, array &$hookData) | |
Call the ApiQueryBaseProcessRow hook. | |
Protected Member Functions inherited from MediaWiki\Api\ApiBase | |
getExamplesMessages () | |
Returns usage examples for this module. | |
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. | |
getWebUITokenSalt (array $params) | |
Fetch the salt used in the Web UI corresponding to this module. | |
getPermissionManager () | |
Obtain a PermissionManager instance that subclasses may use in their authorization checks. | |
getHookContainer () | |
Get a HookContainer, for running extension hooks or for hook metadata. | |
getHookRunner () | |
Get an ApiHookRunner for running core API hooks. | |
getParameter ( $paramName, $parseLimit=true) | |
Get a value for the given parameter. | |
getParameterFromSettings ( $name, $settings, $parseLimit) | |
Using the settings, determine the value for the given parameter. | |
useTransactionalTimeLimit () | |
Call wfTransactionalTimeLimit() if this request was POSTed. | |
filterIDs ( $fields, array $ids) | |
Filter out-of-range values from a list of positive integer IDs. | |
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. | |
dieContinueUsageIf ( $condition) | |
Die with the 'badcontinue' error. | |
getSummaryMessage () | |
Return the summary message. | |
getExtendedDescription () | |
Return the extended help text message. | |
getHelpFlags () | |
Generates the list of flags for the help screen and for action=paraminfo. | |
getModuleSourceInfo () | |
Returns information about the source of this module, if known. | |
Data access | |
getQuery () | |
Get the main Query module. | |
getParent () | |
Get the parent of this module.
| |
getDB () | |
Get the Query database connection (read-only) | |
getPageSet () | |
Get the PageSet object to work on. | |
Utility methods | |
titlePartToKey ( $titlePart, $namespace=NS_MAIN) | |
Convert an input title or title prefix into a dbkey. | |
validateSha1Hash ( $hash) | |
validateSha1Base36Hash ( $hash) | |
userCanSeeRevDel () | |
Check whether the current user has permission to view revision-deleted fields. | |
addPageSubItems ( $pageId, $data) | |
Add a sub-element under the page element with the given page ID. | |
addPageSubItem ( $pageId, $item, $elemname=null) | |
Same as addPageSubItems(), but one element of $data at a time. | |
setContinueEnumParameter ( $paramName, $paramValue) | |
Set a query-continue value. | |
parsePrefixedTitlePart ( $titlePart, $defaultNamespace=NS_MAIN) | |
Convert an input title or title prefix into a TitleValue. | |
executeGenderCacheFromResultWrapper (IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page') | |
Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo. | |
static | addTitleInfo (&$arr, $title, $prefix='') |
Add information (title and namespace) about a Title object to a result array. | |
Additional Inherited Members | |
Static Public Member Functions inherited from MediaWiki\Api\ApiBase | |
static | makeMessage ( $msg, IContextSource $context, ?array $params=null) |
Create a Message from a string or array. | |
static | clearCacheForTest () |
Reset static caches of database state. | |
Public Attributes inherited from MediaWiki\Api\ApiBase | |
const | PARAM_RANGE_ENFORCE = 'api-param-range-enforce' |
(boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE | |
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. | |
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. | |
const | PARAM_HELP_MSG_INFO = 'api-param-help-msg-info' |
(array) Specify additional information tags for the parameter. | |
const | PARAM_VALUE_LINKS = 'api-param-value-links' |
Deprecated and unused. | |
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 messages. | |
const | PARAM_TEMPLATE_VARS = 'param-template-vars' |
(array) Indicate that this is a templated parameter, and specify replacements. | |
const | ALL_DEFAULT_STRING = '*' |
(string|array|Message) Specify an alternative i18n documentation message for this parameter. | |
const | LIMIT_BIG1 = 500 |
Fast query, standard limit. | |
const | LIMIT_BIG2 = 5000 |
Fast query, apihighlimits limit. | |
const | LIMIT_SML1 = 50 |
Slow query, standard limit. | |
const | LIMIT_SML2 = 500 |
Slow query, apihighlimits limit. | |
const | GET_VALUES_FOR_HELP = 1 |
getAllowedParams() flag: When this is set, the result could take longer to generate, but should be more thorough. | |
Static Protected Member Functions inherited from MediaWiki\Api\ApiBase | |
static | dieDebug ( $method, $message) |
Internal code errors should be reported with this method. | |
This is a base class for all Query modules.
It provides some common functionality such as constructing various SQL queries.
Definition at line 45 of file ApiQueryBase.php.
MediaWiki\Api\ApiQueryBase::__construct | ( | ApiQuery | $queryModule, |
string | $moduleName, | ||
$paramPrefix = '' ) |
ApiQuery | $queryModule | |
string | $moduleName | |
string | $paramPrefix |
Definition at line 62 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\getMain(), and MediaWiki\Api\ApiQueryBase\resetQueryParams().
|
protected |
Add a set of fields to select to the internal array.
array | string | $value | Field name or array of field names |
Definition at line 204 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryBase\addFieldsIf(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Same as addFields(), but add the fields only if a condition is met.
array | string | $value | See addFields() |
bool | $condition | If false, do nothing |
Definition at line 214 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\addFields().
Referenced by MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), and MediaWiki\Api\ApiQueryRecentChanges\run().
|
protected |
Add a set of JOIN conditions to the internal array.
JOIN conditions are formatted as [ tablename => [ jointype, conditions ] ] e.g. [ 'page' => [ 'LEFT JOIN', 'page_id=rev_page' ] ]. Conditions may be a string or an addWhere()-style array.
array | $join_conds | JOIN conditions |
Definition at line 193 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\dieDebug(), and MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryUsers\execute(), and MediaWiki\Api\ApiQueryRecentChanges\run().
|
protected |
Add an option such as LIMIT or USE INDEX.
If an option was set before, the old value will be overwritten
string | $name | Option name |
mixed | $value | The option value, or null for a boolean option |
Definition at line 370 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), MediaWiki\Api\ApiQueryDeletedRevisions\run(), MediaWiki\Api\ApiQueryRevisions\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Same as addPageSubItems(), but one element of $data at a time.
int | $pageId | |
mixed | $item | Data à la ApiResult |
string | null | $elemname | XML element name. If null, getModuleName() is used |
Definition at line 486 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\getModuleName(), MediaWiki\Api\ApiBase\getModulePrefix(), and MediaWiki\Api\ApiBase\getResult().
Referenced by MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryImageInfo\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryDeletedRevisions\run(), and MediaWiki\Api\ApiQueryRevisions\run().
|
protected |
Add a sub-element under the page element with the given page ID.
int | $pageId | |
array | $data | Data array à la ApiResult |
Definition at line 469 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\getModuleName(), MediaWiki\Api\ApiBase\getModulePrefix(), MediaWiki\Api\ApiBase\getResult(), and MediaWiki\Api\ApiResult\setIndexedTagName().
Referenced by MediaWiki\Api\ApiQueryCategoryInfo\execute().
|
protected |
Add a set of tables to the internal array.
string | array | $tables | Table name or array of table names or nested arrays for joins using parentheses for grouping |
string | null | $alias | Table alias, or null for no alias. Cannot be used with multiple tables |
Definition at line 174 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\dieDebug(), and MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps.
string | $field | |
string | $dir | |
string | int | null | $start | |
string | int | null | $end | |
bool | $sort |
Definition at line 358 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\addWhereRange(), and MediaWiki\Api\ApiQueryBase\getDB().
Referenced by MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), MediaWiki\Api\ApiQueryDeletedRevisions\run(), and MediaWiki\Api\ApiQueryRevisions\run().
|
static |
Add information (title and namespace) about a Title object to a result array.
array | &$arr | Result array à la ApiResult |
Title | $title | |
string | $prefix | Module prefix |
Definition at line 458 of file ApiQueryBase.php.
Referenced by MediaWiki\Api\ApiImageRotate\execute(), MediaWiki\Api\ApiPatrol\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryRecentChanges\extractRowInfo(), MediaWiki\Api\ApiImportReporter\reportPage(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Add a set of WHERE clauses to the internal array.
The array should be appropriate for passing as $conds to IDatabase::select(). Arrays from multiple calls are merged with array_merge(). A string is treated as a single-element array.
When passing ‘'field’ => $arrayOfIDs` where the IDs are taken from user input, consider using addWhereIDsFld() instead.
string | array | IExpression | $value |
Definition at line 237 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryBase\addWhereIf(), MediaWiki\Api\ApiQueryBase\addWhereRange(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Equivalent to addWhere( [ $field => $value ] )
When $value is an array of integer IDs taken from user input, consider using addWhereIDsFld() instead.
string | $field | Field name |
int|string|(string|int|null)[] | $value Value; ignored if null or empty array |
Definition at line 274 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryDeletedRevisions\run(), MediaWiki\Api\ApiQueryRevisions\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Like addWhereFld for an integer list of IDs.
When passed wildly out-of-range values for integer comparison, the database may choose a poor query plan. This method validates the passed IDs against the range of values in the database to omit out-of-range values.
This should be used when the IDs are derived from arbitrary user input; it is not necessary if the IDs are already known to be within a sensible range.
This should not be used when there is not a suitable index on $field to quickly retrieve the minimum and maximum values.
string | $table | Table name |
string | $field | Field name |
int[] | $ids |
Definition at line 301 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\filterIDs(), and MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryBlocks\execute().
|
protected |
Same as addWhere(), but add the WHERE clauses only if a condition is met.
string | array | IExpression | $value | |
bool | $condition | If false, do nothing |
Definition at line 255 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\addWhere().
Referenced by MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryContributors\execute(), and MediaWiki\Api\ApiQueryRecentChanges\run().
|
protected |
Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.
string | $field | Field name |
string | $dir | If 'newer', sort in ascending order, otherwise sort in descending order |
string | int | null | $start | Value to start the list at. If $dir == 'newer' this is the lower boundary, otherwise it's the upper boundary |
string | int | null | $end | Value to end the list at. If $dir == 'newer' this is the upper boundary, otherwise it's the lower boundary |
bool | $sort | If false, don't add an ORDER BY clause |
Definition at line 329 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\addWhere(), MediaWiki\Api\ApiQueryBase\getDB(), and MediaWiki\Api\ApiQueryBase\getQueryBuilder().
Referenced by MediaWiki\Api\ApiQueryBase\addTimestampWhereRange(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), and MediaWiki\Api\ApiQueryDeletedRevisions\run().
|
protected |
Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo.
IResultWrapper | $res | Result set to work on. The result set must have _namespace and _title fields with the provided field prefix |
string | $fname | The caller function name, always use METHOD |
string | $fieldPrefix | Prefix for fields to check gender for |
Definition at line 602 of file ApiQueryBase.php.
References MediaWiki\MediaWikiServices\getInstance(), and Wikimedia\Rdbms\IResultWrapper\numRows().
Referenced by MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
MediaWiki\Api\ApiQueryBase::getCacheMode | ( | $params | ) |
Get the cache mode for the data generated by this module.
Override this in the module subclass. For possible return values and other details about cache modes, see ApiMain::setCacheMode()
Public caching will only be allowed if all the modules that supply data for a given request return a cache mode of public.
array | $params |
Reimplemented in MediaWiki\Api\ApiQueryAllCategories, MediaWiki\Api\ApiQueryAllImages, MediaWiki\Api\ApiQueryAllLinks, MediaWiki\Api\ApiQueryAllMessages, MediaWiki\Api\ApiQueryAllPages, MediaWiki\Api\ApiQueryAllUsers, MediaWiki\Api\ApiQueryBacklinks, MediaWiki\Api\ApiQueryBacklinksprop, MediaWiki\Api\ApiQueryCategories, MediaWiki\Api\ApiQueryCategoryInfo, MediaWiki\Api\ApiQueryCategoryMembers, MediaWiki\Api\ApiQueryContributors, MediaWiki\Api\ApiQueryDuplicateFiles, MediaWiki\Api\ApiQueryExternalLinks, MediaWiki\Api\ApiQueryExtLinksUsage, MediaWiki\Api\ApiQueryFileRepoInfo, MediaWiki\Api\ApiQueryImageInfo, MediaWiki\Api\ApiQueryImages, MediaWiki\Api\ApiQueryInfo, MediaWiki\Api\ApiQueryIWBacklinks, MediaWiki\Api\ApiQueryIWLinks, MediaWiki\Api\ApiQueryLangBacklinks, MediaWiki\Api\ApiQueryLangLinks, MediaWiki\Api\ApiQueryLanguageinfo, MediaWiki\Api\ApiQueryLinks, MediaWiki\Api\ApiQueryLogEvents, MediaWiki\Api\ApiQueryPagePropNames, MediaWiki\Api\ApiQueryPageProps, MediaWiki\Api\ApiQueryPagesWithProp, MediaWiki\Api\ApiQueryPrefixSearch, MediaWiki\Api\ApiQueryProtectedTitles, MediaWiki\Api\ApiQueryQueryPage, MediaWiki\Api\ApiQueryRandom, MediaWiki\Api\ApiQueryRecentChanges, MediaWiki\Api\ApiQueryRevisionsBase, MediaWiki\Api\ApiQuerySearch, MediaWiki\Api\ApiQuerySiteinfo, MediaWiki\Api\ApiQueryTags, MediaWiki\Api\ApiQueryUserContribs, and MediaWiki\Api\ApiQueryUsers.
Definition at line 85 of file ApiQueryBase.php.
|
protected |
Get the Query database connection (read-only)
Reimplemented from MediaWiki\Api\ApiBase.
Reimplemented in MediaWiki\Api\ApiQueryAllImages.
Definition at line 126 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQuery().
Referenced by MediaWiki\Api\ApiQueryBase\addTimestampWhereRange(), MediaWiki\Api\ApiQueryBase\addWhereRange(), MediaWiki\Api\ApiQuerySiteinfo\appendGeneralInfo(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryLogEvents\getCacheMode(), MediaWiki\Api\ApiQueryBase\getQueryBuilder(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryRandom\runQuery(), and MediaWiki\Api\ApiQueryBase\select().
|
protected |
Get the PageSet object to work on.
Reimplemented in MediaWiki\Api\ApiQueryGeneratorBase.
Definition at line 137 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQuery().
Referenced by MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryImageInfo\execute(), MediaWiki\Api\ApiQueryInfo\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), and MediaWiki\Api\ApiQueryPageProps\execute().
MediaWiki\Api\ApiQueryBase::getParent | ( | ) |
Get the parent of this module.
Reimplemented from MediaWiki\Api\ApiBase.
Definition at line 117 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getQuery().
Referenced by MediaWiki\Api\ApiQueryRevisionsBase\parseParameters().
MediaWiki\Api\ApiQueryBase::getQuery | ( | ) |
Get the main Query module.
Definition at line 112 of file ApiQueryBase.php.
Referenced by MediaWiki\Api\ApiQueryLanguageinfo\execute(), MediaWiki\Api\ApiQueryBase\getDB(), MediaWiki\Api\ApiQueryLanguageinfo\getExamplesMessages(), MediaWiki\Api\ApiQueryBase\getPageSet(), and MediaWiki\Api\ApiQueryBase\getParent().
|
protected |
Get the SelectQueryBuilder.
This is lazy initialised since getDB() fails in ApiQueryAllImages if it is called before the constructor completes.
Definition at line 162 of file ApiQueryBase.php.
References MediaWiki\Api\ApiQueryBase\getDB().
Referenced by MediaWiki\Api\ApiQueryBase\addFields(), MediaWiki\Api\ApiQueryBase\addJoinConds(), MediaWiki\Api\ApiQueryBase\addOption(), MediaWiki\Api\ApiQueryBase\addTables(), MediaWiki\Api\ApiQueryBase\addWhere(), MediaWiki\Api\ApiQueryBase\addWhereFld(), MediaWiki\Api\ApiQueryBase\addWhereIDsFld(), MediaWiki\Api\ApiQueryBase\addWhereRange(), MediaWiki\Api\ApiQueryUsers\execute(), and MediaWiki\Api\ApiQueryBase\select().
|
protected |
Convert an input title or title prefix into a TitleValue.
string | $titlePart | |
int | $defaultNamespace | Default namespace if none is given |
Definition at line 546 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\dieWithError(), MediaWiki\MediaWikiServices\getInstance(), and wfEscapeWikiText().
|
protected |
Call the ApiQueryBaseProcessRow hook.
Generally, a module that passed $hookData to self::select() will call this just before calling ApiResult::addValue(), and treat a false return here in the same way it treats a false return from addValue().
stdClass | $row | Database row |
array | &$data | Data to be added to the result |
array | &$hookData | Hook data from ApiQueryBase::select() |
Definition at line 441 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\getHookRunner().
Referenced by MediaWiki\Api\ApiQueryUserContribs\execute(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), and MediaWiki\Api\ApiQueryRevisions\run().
MediaWiki\Api\ApiQueryBase::requestExtraData | ( | $pageSet | ) |
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName')
Note this only makes sense for 'prop' modules, as 'list' and 'meta' modules should not be using the pageset.
ApiPageSet | $pageSet |
Reimplemented in MediaWiki\Api\ApiQueryInfo.
Definition at line 99 of file ApiQueryBase.php.
|
protected |
Blank the internal arrays with query parameters.
Definition at line 150 of file ApiQueryBase.php.
Referenced by MediaWiki\Api\ApiQueryBase\__construct(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryUsers\execute(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Execute a SELECT query based on the values in the internal arrays.
string | $method | Function the query should be attributed to. You should usually use METHOD here |
array | $extraQuery | Query data to add but not store in the object Format is [ 'tables' => ..., 'fields' => ..., 'where' => ..., 'options' => ..., 'join_conds' => ... ] |
array | null | &$hookData | If set, the ApiQueryBaseBeforeQuery and ApiQueryBaseAfterQuery hooks will be called, and the ApiQueryBaseProcessRow hook will be expected. |
Definition at line 391 of file ApiQueryBase.php.
References Wikimedia\Rdbms\SelectQueryBuilder\caller(), Wikimedia\Rdbms\SelectQueryBuilder\fetchResultSet(), Wikimedia\Rdbms\SelectQueryBuilder\fields(), MediaWiki\Api\ApiQueryBase\getDB(), MediaWiki\Api\ApiBase\getHookContainer(), MediaWiki\Api\ApiBase\getHookRunner(), MediaWiki\Api\ApiQueryBase\getQueryBuilder(), Wikimedia\Rdbms\SelectQueryBuilder\getQueryInfo(), Wikimedia\Rdbms\SelectQueryBuilder\joinConds(), Wikimedia\Rdbms\SelectQueryBuilder\options(), Wikimedia\Rdbms\SelectQueryBuilder\queryInfo(), Wikimedia\Rdbms\SelectQueryBuilder\rawTables(), and Wikimedia\Rdbms\SelectQueryBuilder\where().
Referenced by MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryExternalLinks\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), MediaWiki\Api\ApiQueryUsers\execute(), MediaWiki\Api\ApiQueryIWBacklinks\run(), MediaWiki\Api\ApiQueryLangBacklinks\run(), MediaWiki\Api\ApiQueryRecentChanges\run(), MediaWiki\Api\ApiQueryAllDeletedRevisions\run(), MediaWiki\Api\ApiQueryAllRevisions\run(), MediaWiki\Api\ApiQueryDeletedRevisions\run(), MediaWiki\Api\ApiQueryRevisions\run(), and MediaWiki\Api\ApiQueryRandom\runQuery().
|
protected |
Set a query-continue value.
string | $paramName | Parameter name |
int | string | array | $paramValue | Parameter value |
Reimplemented in MediaWiki\Api\ApiQueryGeneratorBase.
Definition at line 506 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\getContinuationManager().
Referenced by MediaWiki\Api\ApiQueryAllMessages\execute(), MediaWiki\Api\ApiQueryAllUsers\execute(), MediaWiki\Api\ApiQueryBlocks\execute(), MediaWiki\Api\ApiQueryCategoryInfo\execute(), MediaWiki\Api\ApiQueryContributors\execute(), MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), MediaWiki\Api\ApiQueryImageInfo\execute(), MediaWiki\Api\ApiQueryInfo\execute(), MediaWiki\Api\ApiQueryIWLinks\execute(), MediaWiki\Api\ApiQueryLangLinks\execute(), MediaWiki\Api\ApiQueryLanguageinfo\execute(), MediaWiki\Api\ApiQueryLogEvents\execute(), MediaWiki\Api\ApiQueryMyStashedFiles\execute(), MediaWiki\Api\ApiQueryPagePropNames\execute(), MediaWiki\Api\ApiQuerySiteinfo\execute(), MediaWiki\Api\ApiQueryTags\execute(), MediaWiki\Api\ApiQueryTokens\execute(), MediaWiki\Api\ApiQueryUserContribs\execute(), and MediaWiki\Api\ApiQueryUsers\execute().
MediaWiki\Api\ApiQueryBase::titlePartToKey | ( | $titlePart, | |
$namespace = NS_MAIN ) |
Convert an input title or title prefix into a dbkey.
$namespace should always be specified in order to handle per-namespace capitalization settings.
string | $titlePart | |
int | $namespace | Namespace of the title |
Definition at line 520 of file ApiQueryBase.php.
References MediaWiki\Api\ApiBase\dieWithError(), and wfEscapeWikiText().
Referenced by MediaWiki\Api\ApiQueryDeletedrevs\execute(), MediaWiki\Api\ApiQueryFilearchive\execute(), and MediaWiki\Api\ApiQueryAllDeletedRevisions\run().
MediaWiki\Api\ApiQueryBase::userCanSeeRevDel | ( | ) |
Check whether the current user has permission to view revision-deleted fields.
Definition at line 583 of file ApiQueryBase.php.
References MediaWiki\Api\getAuthority().
Referenced by MediaWiki\Api\ApiQueryImageInfo\getCacheMode(), MediaWiki\Api\ApiQueryLogEvents\getCacheMode(), and MediaWiki\Api\ApiQueryRecentChanges\getCacheMode().
MediaWiki\Api\ApiQueryBase::validateSha1Base36Hash | ( | $hash | ) |
string | $hash |
Definition at line 574 of file ApiQueryBase.php.
Referenced by MediaWiki\Api\ApiQueryFilearchive\execute().
MediaWiki\Api\ApiQueryBase::validateSha1Hash | ( | $hash | ) |
string | $hash |
Definition at line 566 of file ApiQueryBase.php.
Referenced by MediaWiki\Api\ApiQueryFilearchive\execute().