40 private $mQueryModule,
$mDb;
45 private $queryBuilder;
54 parent::__construct( $queryModule->
getMain(), $moduleName, $paramPrefix );
55 $this->mQueryModule = $queryModule;
104 return $this->mQueryModule;
118 $this->mDb ??= $this->
getQuery()->getDB();
137 $this->mDb = $this->
getQuery()->getNamedDB( $name, $db, $groups );
147 return $this->
getQuery()->getPageSet();
160 $this->queryBuilder =
null;
172 $this->queryBuilder ??= $this->
getDB()->newSelectQueryBuilder();
173 return $this->queryBuilder;
183 protected function addTables( $tables, $alias =
null ) {
184 if ( is_array( $tables ) ) {
185 if ( $alias !==
null ) {
203 if ( !is_array( $join_conds ) ) {
247 if ( is_array( $value ) ) {
250 if ( count( $value ) ) {
284 if ( $value !==
null && !( is_array( $value ) && !$value ) ) {
313 if ( count( $ids ) ) {
314 $ids = $this->
filterIDs( [ [ $table, $field ] ], $ids );
323 return count( $ids );
338 protected function addWhereRange( $field, $dir, $start, $end, $sort =
true ) {
339 $isDirNewer = ( $dir ===
'newer' );
340 $after = ( $isDirNewer ?
'>=' :
'<=' );
341 $before = ( $isDirNewer ?
'<=' :
'>=' );
342 $db = $this->
getDB();
344 if ( $start !==
null ) {
345 $this->
addWhere( $field . $after . $db->addQuotes( $start ) );
348 if ( $end !==
null ) {
349 $this->
addWhere( $field . $before . $db->addQuotes( $end ) );
353 $this->
getQueryBuilder()->orderBy( $field, $isDirNewer ?
null :
'DESC' );
368 $db = $this->
getDB();
370 $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
400 protected function select( $method, $extraQuery = [], array &$hookData =
null ) {
402 if ( isset( $extraQuery[
'tables'] ) ) {
403 $queryBuilder->
rawTables( (array)$extraQuery[
'tables'] );
405 if ( isset( $extraQuery[
'fields'] ) ) {
406 $queryBuilder->
fields( (array)$extraQuery[
'fields'] );
408 if ( isset( $extraQuery[
'where'] ) ) {
409 $queryBuilder->
where( (array)$extraQuery[
'where'] );
411 if ( isset( $extraQuery[
'options'] ) ) {
412 $queryBuilder->
options( (array)$extraQuery[
'options'] );
414 if ( isset( $extraQuery[
'join_conds'] ) ) {
415 $queryBuilder->
joinConds( (array)$extraQuery[
'join_conds'] );
418 if ( $hookData !==
null && $this->
getHookContainer()->isRegistered(
'ApiQueryBaseBeforeQuery' ) ) {
421 $this, $info[
'tables'], $info[
'fields'], $info[
'conds'],
422 $info[
'options'], $info[
'join_conds'], $hookData
424 $queryBuilder = $this->
getDB()->newSelectQueryBuilder()->queryInfo( $info );
427 $queryBuilder->
caller( $method );
430 if ( $hookData !==
null ) {
450 protected function processRow( $row, array &$data, array &$hookData ) {
451 return $this->
getHookRunner()->onApiQueryBaseProcessRow( $this, $row, $data, $hookData );
468 $arr[$prefix .
'ns'] =
$title->getNamespace();
469 $arr[$prefix .
'title'] =
$title->getPrefixedText();
482 return $result->addValue( [
'query',
'pages', (
int)$pageId ],
497 $fit = $result->addValue( [
'query',
'pages', $pageId,
502 $result->addIndexedTagName(
531 if ( !
$t ||
$t->hasFragment() ) {
535 if ( $namespace !=
$t->getNamespace() ||
$t->isExternal() ) {
544 return substr(
$t->getDBkey(), 0, -1 );
557 $titleParser = MediaWikiServices::getInstance()->getTitleParser();
558 $t = $titleParser->parseTitle( $titlePart .
'X', $defaultNamespace );
563 if ( !
$t ||
$t->hasFragment() ||
$t->isExternal() ||
$t->getDBkey() ===
'X' ) {
568 return new TitleValue(
$t->getNamespace(), substr(
$t->getDBkey(), 0, -1 ) );
576 return (
bool)preg_match(
'/^[a-f0-9]{40}$/', $hash );
584 return (
bool)preg_match(
'/^[a-z0-9]{31}$/', $hash );
614 if ( !
$res->numRows() ) {
618 $services = MediaWikiServices::getInstance();
619 if ( !$services->getContentLanguage()->needsGenderDistinction() ) {
623 $nsInfo = $services->getNamespaceInfo();
624 $namespaceField = $fieldPrefix .
'_namespace';
625 $titleField = $fieldPrefix .
'_title';
628 foreach (
$res as $row ) {
629 if ( $nsInfo->hasGenderDistinction( $row->$namespaceField ) ) {
630 $usernames[] = $row->$titleField;
634 if ( $usernames === [] ) {
638 $genderCache = $services->getGenderCache();
639 $genderCache->doQuery( $usernames, $fname );
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
wfDeprecated( $function, $version=false, $component=false, $callerOffset=2)
Logs a warning that a deprecated feature was used.
This abstract class implements many basic API functions, and is the base of all API classes.
dieWithError( $msg, $code=null, $data=null, $httpCode=0)
Abort execution with an error.
getModulePrefix()
Get parameter prefix (usually two letters or an empty string).
filterIDs( $fields, array $ids)
Filter out-of-range values from a list of positive integer IDs.
static dieDebug( $method, $message)
Internal code errors should be reported with this method.
getMain()
Get the main module.
getResult()
Get the result object.
getModuleName()
Get the name of the module being executed by this instance.
getHookRunner()
Get an ApiHookRunner for running core API hooks.
getHookContainer()
Get a HookContainer, for running extension hooks or for hook metadata.
This is a base class for all Query modules.
selectNamedDB( $name, $db, $groups)
Change the database connection for subsequent calls to getDB().
static addTitleInfo(&$arr, $title, $prefix='')
Add information (title and namespace) about a Title object to a result array.
setContinueEnumParameter( $paramName, $paramValue)
Set a query-continue value.
parsePrefixedTitlePart( $titlePart, $defaultNamespace=NS_MAIN)
Convert an input title or title prefix into a TitleValue.
processRow( $row, array &$data, array &$hookData)
Call the ApiQueryBaseProcessRow hook.
validateSha1Base36Hash( $hash)
resetQueryParams()
Blank the internal arrays with query parameters.
getCacheMode( $params)
Get the cache mode for the data generated by this module.
addWhereIf( $value, $condition)
Same as addWhere(), but add the WHERE clauses only if a condition is met.
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.
getQueryBuilder()
Get the SelectQueryBuilder.
addPageSubItems( $pageId, $data)
Add a sub-element under the page element with the given page ID.
addFields( $value)
Add a set of fields to select to the internal array.
addPageSubItem( $pageId, $item, $elemname=null)
Same as addPageSubItems(), but one element of $data at a time.
getParent()
Get the parent of this module.Stability: stableto override 1.25 ApiBase|null
addOption( $name, $value=null)
Add an option such as LIMIT or USE INDEX.
addTables( $tables, $alias=null)
Add a set of tables to the internal array.
addTimestampWhereRange( $field, $dir, $start, $end, $sort=true)
Add a WHERE clause corresponding to a range, similar to addWhereRange, but converts $start and $end t...
getDB()
Get the Query database connection (read-only)
executeGenderCacheFromResultWrapper(IResultWrapper $res, $fname=__METHOD__, $fieldPrefix='page')
Preprocess the result set to fill the GenderCache with the necessary information before using self::a...
select( $method, $extraQuery=[], array &$hookData=null)
Execute a SELECT query based on the values in the internal arrays.
addFieldsIf( $value, $condition)
Same as addFields(), but add the fields only if a condition is met.
addWhereIDsFld( $table, $field, $ids)
Like addWhereFld for an integer list of IDs.
requestExtraData( $pageSet)
Override this method to request extra fields from the pageSet using $pageSet->requestField('fieldName...
addJoinConds( $join_conds)
Add a set of JOIN conditions to the internal array.
getQuery()
Get the main Query module.
addWhereFld( $field, $value)
Equivalent to addWhere( [ $field => $value ] )
getPageSet()
Get the PageSet object to work on.
titlePartToKey( $titlePart, $namespace=NS_MAIN)
Convert an input title or title prefix into a dbkey.
addWhere( $value)
Add a set of WHERE clauses to the internal array.
__construct(ApiQuery $queryModule, $moduleName, $paramPrefix='')
userCanSeeRevDel()
Check whether the current user has permission to view revision-deleted fields.
This is the main query class.
static setIndexedTagName(array &$arr, $tag)
Set the tag name for numeric-keyed values in XML format.
Represents a page (or page fragment) title within MediaWiki.
static makeTitleSafe( $ns, $title, $fragment='', $interwiki='')
Create a new Title from a namespace index and a DB key.
trait ApiQueryBlockInfoTrait