MediaWiki  master
ApiQueryBase Class Reference

This is a base class for all Query modules. More...

Inheritance diagram for ApiQueryBase:
Collaboration diagram for ApiQueryBase:

Public Member Functions

 __construct (ApiQuery $queryModule, $moduleName, $paramPrefix='')
 
Methods to implement
 getCacheMode ( $params)
 Get the cache mode for the data generated by this module. More...
 
 requestExtraData ( $pageSet)
 Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName') More...
 
Deprecated methods
 showHiddenUsersAddBlockInfo ( $showBlockInfo)
 Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information. More...
 
- Public Member Functions inherited from ApiBase
 __construct (ApiMain $mainModule, $moduleName, $modulePrefix='')
 
 execute ()
 Evaluates the parameters, performs the requested query, and sets up the result. More...
 
 getModuleManager ()
 Get the module manager, or null if this module has no sub-modules. More...
 
 getCustomPrinter ()
 If the module may only be used with a certain format module, it should override this method to return an instance of that formatter. More...
 
 getHelpUrls ()
 Return links to more detailed help pages about the module. More...
 
 shouldCheckMaxlag ()
 Indicates if this module needs maxlag to be checked. More...
 
 isReadMode ()
 Indicates whether this module requires read rights. More...
 
 isWriteMode ()
 Indicates whether this module requires write mode. More...
 
 mustBePosted ()
 Indicates whether this module must be called with a POST request. More...
 
 isDeprecated ()
 Indicates whether this module is deprecated. More...
 
 isInternal ()
 Indicates whether this module is "internal" Internal API modules are not (yet) intended for 3rd party use and may be unstable. More...
 
 needsToken ()
 Returns the token type this module requires in order to execute. More...
 
 getConditionalRequestData ( $condition)
 Returns data for HTTP conditional request mechanisms. More...
 
 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...
 
 lacksSameOriginSecurity ()
 Returns true if the current request breaks the same-origin policy. More...
 
 getModulePath ()
 Get the path to this module. More...
 
 getModuleFromPath ( $path)
 Get a module from its module path. More...
 
 getResult ()
 Get the result object. More...
 
 getErrorFormatter ()
 Get the error formatter. More...
 
 getContinuationManager ()
 Get the continuation manager. More...
 
 setContinuationManager (ApiContinuationManager $manager=null)
 Set the continuation manager. More...
 
 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...
 
 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...
 
 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 (LinkTarget $linkTarget, $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 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...
 
- Public Member Functions inherited from ContextSource
 canUseWikiPage ()
 Check whether a WikiPage object can be get with getWikiPage(). More...
 
 exportSession ()
 Export the resolved user IP, HTTP headers, user ID, and session ID. More...
 
 getConfig ()
 
 getContext ()
 Get the base IContextSource object. More...
 
 getLanguage ()
 
 getOutput ()
 
 getRequest ()
 
 getSkin ()
 
 getStats ()
 
 getTiming ()
 
 getTitle ()
 
 getUser ()
 
 getWikiPage ()
 Get the WikiPage object. More...
 
 msg ( $key,... $params)
 Get a Message object with context set Parameters are the same as wfMessage() More...
 
 setContext (IContextSource $context)
 

Public Attributes

 $mDb
 
- Public Attributes inherited from ApiBase
string $mModulePrefix
 
const ALL_DEFAULT_STRING = '*'
 
const GET_VALUES_FOR_HELP = 1
 getAllowedParams() flag: When set, the result could take longer to generate, but should be more thorough. More...
 
const LIMIT_BIG1 = 500
 Fast query, standard limit. More...
 
const LIMIT_BIG2 = 5000
 Fast query, apihighlimits limit. More...
 
const LIMIT_SML1 = 50
 Slow query, standard limit. More...
 
const LIMIT_SML2 = 500
 Slow query, apihighlimits limit. More...
 
const PARAM_DFLT = ParamValidator::PARAM_DEFAULT
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ISMULTI = ParamValidator::PARAM_ISMULTI
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_TYPE = ParamValidator::PARAM_TYPE
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX = IntegerDef::PARAM_MAX
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX2 = IntegerDef::PARAM_MAX2
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MIN = IntegerDef::PARAM_MIN
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ALLOW_DUPLICATES = ParamValidator::PARAM_ALLOW_DUPLICATES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_DEPRECATED = ParamValidator::PARAM_DEPRECATED
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_REQUIRED = ParamValidator::PARAM_REQUIRED
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_SUBMODULE_MAP = SubmoduleDef::PARAM_SUBMODULE_MAP
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_SUBMODULE_PARAM_PREFIX = SubmoduleDef::PARAM_SUBMODULE_PARAM_PREFIX
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ALL = ParamValidator::PARAM_ALL
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_EXTRA_NAMESPACES = NamespaceDef::PARAM_EXTRA_NAMESPACES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_SENSITIVE = ParamValidator::PARAM_SENSITIVE
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_DEPRECATED_VALUES = EnumDef::PARAM_DEPRECATED_VALUES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ISMULTI_LIMIT1 = ParamValidator::PARAM_ISMULTI_LIMIT1
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_ISMULTI_LIMIT2 = ParamValidator::PARAM_ISMULTI_LIMIT2
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX_BYTES = StringDef::PARAM_MAX_BYTES
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_MAX_CHARS = StringDef::PARAM_MAX_CHARS
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE More...
 
const PARAM_RANGE_ENFORCE = 'api-param-range-enforce'
 (boolean) Inverse of IntegerDef::PARAM_IGNORE_RANGE 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...
 

Protected Member Functions

Querying
 resetQueryParams ()
 Blank the internal arrays with query parameters. More...
 
 getQueryBuilder ()
 Get the SelectQueryBuilder. More...
 
 addTables ( $tables, $alias=null)
 Add a set of tables to the internal array. More...
 
 addJoinConds ( $join_conds)
 Add a set of JOIN conditions to the internal array. More...
 
 addFields ( $value)
 Add a set of fields to select to the internal array. More...
 
 addFieldsIf ( $value, $condition)
 Same as addFields(), but add the fields only if a condition is met. More...
 
 addWhere ( $value)
 Add a set of WHERE clauses to the internal array. More...
 
 addWhereIf ( $value, $condition)
 Same as addWhere(), but add the WHERE clauses only if a condition is met. More...
 
 addWhereFld ( $field, $value)
 Equivalent to addWhere( [ $field => $value ] ) More...
 
 addWhereIDsFld ( $table, $field, $ids)
 Like addWhereFld for an integer list of IDs. More...
 
 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. More...
 
 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. More...
 
 addOption ( $name, $value=null)
 Add an option such as LIMIT or USE INDEX. More...
 
 select ( $method, $extraQuery=[], array &$hookData=null)
 Execute a SELECT query based on the values in the internal arrays. More...
 
 processRow ( $row, array &$data, array &$hookData)
 Call the ApiQueryBaseProcessRow hook. More...
 
- Protected Member Functions inherited from ApiBase
 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...
 
 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...
 
 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...
 
 getWatchlistValue ( $watchlist, $titleObj, $userOption=null)
 Return true if we're to watch the page, false if not, null if no change. More...
 
 getParameterFromSettings ( $name, $settings, $parseLimit)
 Using the settings determine the value for the given parameter. More...
 
 setWatch ( $watch, $titleObj, $userOption=null)
 Set a watch (or unwatch) based the based on a watchlist parameter. More...
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed. More...
 
 filterIDs ( $fields, array $ids)
 Filter out-of-range values from a list of positive integer IDs. More...
 
 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...
 

Private Attributes

 $mQueryModule
 
SelectQueryBuilder $queryBuilder
 

Data access

 getQuery ()
 Get the main Query module. More...
 
 getParent ()
 Get the parent of this module.
Since
1.25
Returns
ApiBase|null
More...
 
 selectNamedDB ( $name, $db, $groups)
 Selects the query database connection with the given name. More...
 
 getDB ()
 Get the Query database connection (read-only) More...
 
 getPageSet ()
 Get the PageSet object to work on. More...
 

Utility methods

 titlePartToKey ( $titlePart, $namespace=NS_MAIN)
 Convert an input title or title prefix into a dbkey. More...
 
 prefixedTitlePartToKey ( $titlePart, $defaultNamespace=NS_MAIN)
 Convert an input title or title prefix into a namespace constant and dbkey. More...
 
 validateSha1Hash ( $hash)
 
 validateSha1Base36Hash ( $hash)
 
 userCanSeeRevDel ()
 Check whether the current user has permission to view revision-deleted fields. More...
 
 addPageSubItems ( $pageId, $data)
 Add a sub-element under the page element with the given page ID. More...
 
 addPageSubItem ( $pageId, $item, $elemname=null)
 Same as addPageSubItems(), but one element of $data at a time. More...
 
 setContinueEnumParameter ( $paramName, $paramValue)
 Set a query-continue value. More...
 
 parsePrefixedTitlePart ( $titlePart, $defaultNamespace=NS_MAIN)
 Convert an input title or title prefix into a TitleValue. More...
 
 executeGenderCacheFromResultWrapper (IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
 Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo. More...
 
static addTitleInfo (&$arr, $title, $prefix='')
 Add information (title and namespace) about a Title object to a result array. More...
 

Additional Inherited Members

- Static Public Member Functions inherited from ApiBase
static makeMessage ( $msg, IContextSource $context, array $params=null)
 Create a Message from a string or array. More...
 
- Static Protected Member Functions inherited from ApiBase
static dieDebug ( $method, $message)
 Internal code errors should be reported with this method. More...
 

Detailed Description

This is a base class for all Query modules.

It provides some common functionality such as constructing various SQL queries.

Definition at line 35 of file ApiQueryBase.php.

Constructor & Destructor Documentation

◆ __construct()

ApiQueryBase::__construct ( ApiQuery  $queryModule,
  $moduleName,
  $paramPrefix = '' 
)
Parameters
ApiQuery$queryModule
string$moduleName
string$paramPrefix

Reimplemented in ApiQueryImageInfo.

Definition at line 50 of file ApiQueryBase.php.

References ApiBase\getMain(), and resetQueryParams().

Member Function Documentation

◆ addFields()

◆ addFieldsIf()

ApiQueryBase::addFieldsIf (   $value,
  $condition 
)
protected

◆ addJoinConds()

ApiQueryBase::addJoinConds (   $join_conds)
protected

◆ addOption()

◆ addPageSubItem()

ApiQueryBase::addPageSubItem (   $pageId,
  $item,
  $elemname = null 
)
protected

Same as addPageSubItems(), but one element of $data at a time.

Parameters
int$pageIdPage ID
mixed$itemData à la ApiResult
string | null$elemnameXML element name. If null, getModuleName() is used
Returns
bool Whether the element fit in the result

Definition at line 491 of file ApiQueryBase.php.

References ApiBase\getModuleName(), ApiBase\getModulePrefix(), and ApiBase\getResult().

Referenced by ApiQueryExternalLinks\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryImageInfo\execute(), ApiQueryContributors\execute(), ApiQueryDeletedRevisions\run(), ApiQueryImages\run(), ApiQueryCategories\run(), ApiQueryDuplicateFiles\run(), ApiQueryLinks\run(), ApiQueryBacklinksprop\run(), and ApiQueryRevisions\run().

◆ addPageSubItems()

ApiQueryBase::addPageSubItems (   $pageId,
  $data 
)
protected

Add a sub-element under the page element with the given page ID.

Parameters
int$pageIdPage ID
array$dataData array à la ApiResult
Returns
bool Whether the element fit in the result

Definition at line 474 of file ApiQueryBase.php.

References ApiBase\getModuleName(), ApiBase\getModulePrefix(), ApiBase\getResult(), and ApiResult\setIndexedTagName().

Referenced by ApiQueryCategoryInfo\execute().

◆ addTables()

ApiQueryBase::addTables (   $tables,
  $alias = null 
)
protected

Add a set of tables to the internal array.

Parameters
string | array$tablesTable name or array of table names or nested arrays for joins using parentheses for grouping
string | null$aliasTable alias, or null for no alias. Cannot be used with multiple tables

Definition at line 178 of file ApiQueryBase.php.

References ApiBase\dieDebug(), and getQueryBuilder().

Referenced by ApiQueryExternalLinks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryBlocks\execute(), ApiQueryPagePropNames\execute(), ApiQueryFilearchive\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryAllUsers\execute(), ApiQueryContributors\execute(), ApiQueryUsers\execute(), ApiQueryInfo\getDisplayTitle(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryUserContribs\prepareQuery(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryImages\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryLinks\run(), ApiQueryAllImages\run(), ApiQueryBacklinksprop\run(), ApiQueryRevisions\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), and ApiQueryBacklinks\runSecondQuery().

◆ addTimestampWhereRange()

ApiQueryBase::addTimestampWhereRange (   $field,
  $dir,
  $start,
  $end,
  $sort = true 
)
protected

Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end to database timestamps.

See also
addWhereRange
Parameters
string$field
string$dir
string | int | null$start
string | int | null$end
bool$sort

Definition at line 362 of file ApiQueryBase.php.

References addWhereRange(), and getDB().

Referenced by ApiQueryBlocks\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryCategoryMembers\run(), ApiQueryAllImages\run(), ApiQueryRevisions\run(), and ApiQueryRecentChanges\run().

◆ addTitleInfo()

◆ addWhere()

ApiQueryBase::addWhere (   $value)
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.

See also
IDatabase::select()
Parameters
string | array$value

Definition at line 241 of file ApiQueryBase.php.

References getQueryBuilder().

Referenced by addWhereIf(), addWhereRange(), ApiQueryExternalLinks\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryCategoryInfo\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryBlocks\execute(), ApiQueryFilearchive\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryAllUsers\execute(), ApiQueryContributors\execute(), ApiQueryUsers\execute(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryUserContribs\prepareQuery(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryImages\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryLinks\run(), ApiQueryAllImages\run(), ApiQueryBacklinksprop\run(), ApiQueryRevisions\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), and ApiQueryBacklinks\runSecondQuery().

◆ addWhereFld()

◆ addWhereIDsFld()

ApiQueryBase::addWhereIDsFld (   $table,
  $field,
  $ids 
)
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.

Since
1.33
Parameters
string$tableTable name
string$fieldField name
int[]$idsIDs
Returns
int Count of IDs actually included

Definition at line 305 of file ApiQueryBase.php.

References ApiBase\filterIDs(), and getQueryBuilder().

Referenced by ApiQueryBlocks\execute().

◆ addWhereIf()

ApiQueryBase::addWhereIf (   $value,
  $condition 
)
protected

Same as addWhere(), but add the WHERE clauses only if a condition is met.

Parameters
string | array$value
bool$conditionIf false, do nothing
Returns
bool $condition

Definition at line 259 of file ApiQueryBase.php.

References addWhere().

Referenced by ApiQueryBlocks\execute(), ApiQueryContributors\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryBacklinksprop\run(), and ApiQueryRecentChanges\run().

◆ addWhereRange()

ApiQueryBase::addWhereRange (   $field,
  $dir,
  $start,
  $end,
  $sort = true 
)
protected

Add a WHERE clause corresponding to a range, and an ORDER BY clause to sort in the right direction.

Parameters
string$fieldField name
string$dirIf 'newer', sort in ascending order, otherwise sort in descending order
string | null$startValue to start the list at. If $dir == 'newer' this is the lower boundary, otherwise it's the upper boundary
string | null$endValue to end the list at. If $dir == 'newer' this is the upper boundary, otherwise it's the lower boundary
bool$sortIf false, don't add an ORDER BY clause

Definition at line 333 of file ApiQueryBase.php.

References addWhere(), getDB(), and getQueryBuilder().

Referenced by addTimestampWhereRange(), ApiQueryBlocks\execute(), ApiQueryFilearchive\execute(), ApiQueryPagePropNames\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryAllUsers\execute(), ApiQueryUserContribs\prepareQuery(), ApiQueryDeletedRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryAllPages\run(), ApiQueryCategoryMembers\run(), ApiQueryAllImages\run(), and ApiQueryAllLinks\run().

◆ executeGenderCacheFromResultWrapper()

ApiQueryBase::executeGenderCacheFromResultWrapper ( IResultWrapper  $res,
  $fname = __METHOD__,
  $fieldPrefix = 'page' 
)
protected

Preprocess the result set to fill the GenderCache with the necessary information before using self::addTitleInfo.

Parameters
IResultWrapper$resResult set to work on. The result set must have _namespace and _title fields with the provided field prefix
string$fnameThe caller function name, always use METHOD
string$fieldPrefixPrefix for fields to check gender for

Definition at line 623 of file ApiQueryBase.php.

References $res.

Referenced by ApiQueryLogEvents\execute(), ApiQueryUserContribs\execute(), ApiQueryAllRevisions\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryExtLinksUsage\run(), ApiQueryPagesWithProp\run(), ApiQueryCategoryMembers\run(), ApiQueryLinks\run(), ApiQueryBacklinksprop\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), and ApiQueryBacklinks\runSecondQuery().

◆ getCacheMode()

◆ getDB()

ApiQueryBase::getDB ( )
protected

◆ getPageSet()

◆ getParent()

ApiQueryBase::getParent ( )

Get the parent of this module.

Since
1.25
Returns
ApiBase|null

Reimplemented from ApiBase.

Definition at line 105 of file ApiQueryBase.php.

References getQuery().

Referenced by ApiQueryRevisionsBase\parseParameters().

◆ getQuery()

ApiQueryBase::getQuery ( )

Get the main Query module.

Returns
ApiQuery

Definition at line 100 of file ApiQueryBase.php.

References $mQueryModule.

Referenced by ApiQueryLanguageinfo\execute(), getDB(), ApiQueryLanguageinfo\getExamplesMessages(), getPageSet(), getParent(), and selectNamedDB().

◆ getQueryBuilder()

ApiQueryBase::getQueryBuilder ( )
protected

Get the SelectQueryBuilder.

This is lazy initialised since getDB() fails in ApiQueryAllImages if it is called before the constructor completes.

Returns
SelectQueryBuilder

Definition at line 164 of file ApiQueryBase.php.

References $queryBuilder, and getDB().

Referenced by addFields(), addJoinConds(), addOption(), addTables(), addWhere(), addWhereFld(), addWhereIDsFld(), addWhereRange(), and select().

◆ parsePrefixedTitlePart()

ApiQueryBase::parsePrefixedTitlePart (   $titlePart,
  $defaultNamespace = NS_MAIN 
)
protected

Convert an input title or title prefix into a TitleValue.

Since
1.35
Parameters
string$titlePartTitle part
int$defaultNamespaceDefault namespace if none is given
Returns
TitleValue

Definition at line 552 of file ApiQueryBase.php.

References $t, ApiBase\dieWithError(), and wfEscapeWikiText().

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

◆ prefixedTitlePartToKey()

ApiQueryBase::prefixedTitlePartToKey (   $titlePart,
  $defaultNamespace = NS_MAIN 
)

Convert an input title or title prefix into a namespace constant and dbkey.

Since
1.26
Deprecated:
sine 1.35, use parsePrefixedTitlePart() instead.
Parameters
string$titlePartTitle part parsePrefixedTitlePart instead
int$defaultNamespaceDefault namespace if none is given
Returns
array (int, string) Namespace number and DBkey

Definition at line 577 of file ApiQueryBase.php.

References $t, parsePrefixedTitlePart(), and wfDeprecated().

◆ processRow()

ApiQueryBase::processRow (   $row,
array &  $data,
array &  $hookData 
)
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().

Since
1.28
Parameters
object$rowDatabase row
array&$dataData to be added to the result
array&$hookDataHook data from ApiQueryBase::select()
Returns
bool Return false if row processing should end with continuation

Definition at line 445 of file ApiQueryBase.php.

References ApiBase\getHookRunner().

Referenced by ApiQueryUserContribs\execute(), ApiQueryAllRevisions\run(), ApiQueryRevisions\run(), and ApiQueryRecentChanges\run().

◆ requestExtraData()

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.

Parameters
ApiPageSet$pageSet

Reimplemented in ApiQueryInfo.

Definition at line 86 of file ApiQueryBase.php.

◆ resetQueryParams()

◆ select()

ApiQueryBase::select (   $method,
  $extraQuery = [],
array &  $hookData = null 
)
protected

Execute a SELECT query based on the values in the internal arrays.

Parameters
string$methodFunction the query should be attributed to. You should usually use METHOD here
array$extraQueryQuery data to add but not store in the object Format is [ 'tables' => ..., 'fields' => ..., 'where' => ..., 'options' => ..., 'join_conds' => ... ]
array | null&$hookDataIf set, the ApiQueryBaseBeforeQuery and ApiQueryBaseAfterQuery hooks will be called, and the ApiQueryBaseProcessRow hook will be expected.
Returns
IResultWrapper

Definition at line 395 of file ApiQueryBase.php.

References $queryBuilder, $res, Wikimedia\Rdbms\SelectQueryBuilder\caller(), Wikimedia\Rdbms\SelectQueryBuilder\fetchResultSet(), Wikimedia\Rdbms\SelectQueryBuilder\fields(), getDB(), ApiBase\getHookRunner(), getQueryBuilder(), Wikimedia\Rdbms\SelectQueryBuilder\getQueryInfo(), Hooks\isRegistered(), Wikimedia\Rdbms\SelectQueryBuilder\joinConds(), Wikimedia\Rdbms\SelectQueryBuilder\options(), Wikimedia\Rdbms\SelectQueryBuilder\rawTables(), and Wikimedia\Rdbms\SelectQueryBuilder\where().

Referenced by ApiQueryExternalLinks\execute(), ApiQueryCategoryInfo\execute(), ApiQueryMyStashedFiles\execute(), ApiQueryLangLinks\execute(), ApiQueryIWLinks\execute(), ApiQueryBlocks\execute(), ApiQueryPagePropNames\execute(), ApiQueryFilearchive\execute(), ApiQueryDeletedrevs\execute(), ApiQueryLogEvents\execute(), ApiQueryAllUsers\execute(), ApiQueryUserContribs\execute(), ApiQueryContributors\execute(), ApiQueryUsers\execute(), ApiQueryInfo\getDisplayTitle(), ApiQueryInfo\getProtectionInfo(), ApiQueryInfo\getTSIDs(), ApiQueryInfo\getVisitingWatcherInfo(), ApiQueryDeletedRevisions\run(), ApiQueryAllRevisions\run(), ApiQueryProtectedTitles\run(), ApiQueryImages\run(), ApiQueryAllDeletedRevisions\run(), ApiQueryExtLinksUsage\run(), ApiQueryIWBacklinks\run(), ApiQueryLangBacklinks\run(), ApiQueryCategories\run(), ApiQueryAllCategories\run(), ApiQueryPagesWithProp\run(), ApiQueryCategoryMembers\run(), ApiQueryAllPages\run(), ApiQueryLinks\run(), ApiQueryAllImages\run(), ApiQueryRevisions\run(), ApiQueryBacklinksprop\run(), ApiQueryAllLinks\run(), ApiQueryRecentChanges\run(), ApiQueryBacklinks\runFirstQuery(), ApiQueryRandom\runQuery(), and ApiQueryBacklinks\runSecondQuery().

◆ selectNamedDB()

ApiQueryBase::selectNamedDB (   $name,
  $db,
  $groups 
)

Selects the query database connection with the given name.

See ApiQuery::getNamedDB() for more information

Parameters
string$nameName to assign to the database connection
int$dbOne of the DB_* constants
string | string[]$groupsQuery groups
Returns
IDatabase

Definition at line 129 of file ApiQueryBase.php.

References $mDb, and getQuery().

Referenced by ApiQueryWatchlist\run().

◆ setContinueEnumParameter()

◆ showHiddenUsersAddBlockInfo()

ApiQueryBase::showHiddenUsersAddBlockInfo (   $showBlockInfo)

Filters hidden users (where the user doesn't have the right to view them) Also adds relevant block information.

Deprecated:
since 1.34, use ApiQueryBlockInfoTrait instead
Parameters
bool$showBlockInfo

Definition at line 668 of file ApiQueryBase.php.

References addBlockInfoToQuery(), and wfDeprecated().

◆ titlePartToKey()

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.

Parameters
string$titlePartTitle part
int$namespaceNamespace of the title
Returns
string DBkey (no namespace prefix)

Definition at line 526 of file ApiQueryBase.php.

References $t, ApiBase\dieWithError(), Title\makeTitleSafe(), and wfEscapeWikiText().

Referenced by ApiQueryFilearchive\execute(), ApiQueryDeletedrevs\execute(), ApiQueryAllDeletedRevisions\run(), ApiQueryAllCategories\run(), ApiQueryAllPages\run(), ApiQueryAllImages\run(), and ApiQueryAllLinks\run().

◆ userCanSeeRevDel()

ApiQueryBase::userCanSeeRevDel ( )

Check whether the current user has permission to view revision-deleted fields.

Returns
bool

Definition at line 604 of file ApiQueryBase.php.

References ApiBase\getPermissionManager(), and ContextSource\getUser().

Referenced by ApiQueryLogEvents\getCacheMode(), ApiQueryImageInfo\getCacheMode(), ApiQueryRevisionsBase\getCacheMode(), and ApiQueryRecentChanges\getCacheMode().

◆ validateSha1Base36Hash()

ApiQueryBase::validateSha1Base36Hash (   $hash)
Parameters
string$hash
Returns
bool

Definition at line 595 of file ApiQueryBase.php.

Referenced by ApiQueryFilearchive\execute(), and ApiQueryAllImages\run().

◆ validateSha1Hash()

ApiQueryBase::validateSha1Hash (   $hash)
Parameters
string$hash
Returns
bool

Definition at line 587 of file ApiQueryBase.php.

Referenced by ApiQueryFilearchive\execute(), and ApiQueryAllImages\run().

Member Data Documentation

◆ $mDb

ApiQueryBase::$mDb

Definition at line 38 of file ApiQueryBase.php.

Referenced by getDB(), and selectNamedDB().

◆ $mQueryModule

ApiQueryBase::$mQueryModule
private

Definition at line 38 of file ApiQueryBase.php.

Referenced by getQuery().

◆ $queryBuilder

SelectQueryBuilder ApiQueryBase::$queryBuilder
private

Definition at line 43 of file ApiQueryBase.php.

Referenced by getQueryBuilder(), and select().


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