51 private $queryBuilder;
60 parent::__construct( $queryModule->
getMain(), $moduleName, $paramPrefix );
61 $this->mQueryModule = $queryModule;
110 return $this->mQueryModule;
124 $this->mDb ??= $this->
getQuery()->getDB();
135 return $this->
getQuery()->getPageSet();
148 $this->queryBuilder =
null;
160 $this->queryBuilder ??= $this->
getDB()->newSelectQueryBuilder();
161 return $this->queryBuilder;
171 protected function addTables( $tables, $alias =
null ) {
172 if ( is_array( $tables ) ) {
173 if ( $alias !==
null ) {
191 if ( !is_array( $join_conds ) ) {
235 if ( is_array( $value ) ) {
238 if ( count( $value ) ) {
272 if ( $value !==
null && !( is_array( $value ) && !$value ) ) {
301 if ( count( $ids ) ) {
302 $ids = $this->
filterIDs( [ [ $table, $field ] ], $ids );
311 return count( $ids );
326 protected function addWhereRange( $field, $dir, $start, $end, $sort =
true ) {
327 $isDirNewer = ( $dir ===
'newer' );
328 $after = ( $isDirNewer ?
'>=' :
'<=' );
329 $before = ( $isDirNewer ?
'<=' :
'>=' );
330 $db = $this->
getDB();
332 if ( $start !==
null ) {
333 $this->
addWhere( $db->expr( $field, $after, $start ) );
336 if ( $end !==
null ) {
337 $this->
addWhere( $db->expr( $field, $before, $end ) );
341 $this->
getQueryBuilder()->orderBy( $field, $isDirNewer ?
null :
'DESC' );
356 $db = $this->
getDB();
358 $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
388 protected function select( $method, $extraQuery = [], array &$hookData =
null ) {
390 if ( isset( $extraQuery[
'tables'] ) ) {
391 $queryBuilder->
rawTables( (array)$extraQuery[
'tables'] );
393 if ( isset( $extraQuery[
'fields'] ) ) {
394 $queryBuilder->
fields( (array)$extraQuery[
'fields'] );
396 if ( isset( $extraQuery[
'where'] ) ) {
397 $queryBuilder->
where( (array)$extraQuery[
'where'] );
399 if ( isset( $extraQuery[
'options'] ) ) {
400 $queryBuilder->
options( (array)$extraQuery[
'options'] );
402 if ( isset( $extraQuery[
'join_conds'] ) ) {
403 $queryBuilder->
joinConds( (array)$extraQuery[
'join_conds'] );
406 if ( $hookData !==
null && $this->
getHookContainer()->isRegistered(
'ApiQueryBaseBeforeQuery' ) ) {
409 $this, $info[
'tables'], $info[
'fields'], $info[
'conds'],
410 $info[
'options'], $info[
'join_conds'], $hookData
412 $queryBuilder = $this->
getDB()->newSelectQueryBuilder()->
queryInfo( $info );
415 $queryBuilder->
caller( $method );
418 if ( $hookData !==
null ) {
419 $this->
getHookRunner()->onApiQueryBaseAfterQuery( $this, $res, $hookData );
438 protected function processRow( $row, array &$data, array &$hookData ) {
439 return $this->
getHookRunner()->onApiQueryBaseProcessRow( $this, $row, $data, $hookData );
456 $arr[$prefix .
'ns'] = $title->getNamespace();
457 $arr[$prefix .
'title'] = $title->getPrefixedText();
470 return $result->addValue( [
'query',
'pages', (
int)$pageId ],
485 $fit = $result->addValue( [
'query',
'pages', $pageId,
490 $result->addIndexedTagName(
518 $t = Title::makeTitleSafe( $namespace, $titlePart .
'x' );
519 if ( !$t || $t->hasFragment() ) {
523 if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
532 return substr( $t->getDBkey(), 0, -1 );
545 $titleParser = MediaWikiServices::getInstance()->getTitleParser();
546 $t = $titleParser->parseTitle( $titlePart .
'X', $defaultNamespace );
551 if ( !$t || $t->hasFragment() || $t->isExternal() || $t->getDBkey() ===
'X' ) {
556 return new TitleValue( $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) );
564 return (
bool)preg_match(
'/^[a-f0-9]{40}$/', $hash );
572 return (
bool)preg_match(
'/^[a-z0-9]{31}$/', $hash );
606 $services = MediaWikiServices::getInstance();
607 if ( !$services->getContentLanguage()->needsGenderDistinction() ) {
611 $nsInfo = $services->getNamespaceInfo();
612 $namespaceField = $fieldPrefix .
'_namespace';
613 $titleField = $fieldPrefix .
'_title';
616 foreach ( $res as $row ) {
617 if ( $nsInfo->hasGenderDistinction( $row->$namespaceField ) ) {
618 $usernames[] = $row->$titleField;
622 if ( $usernames === [] ) {
626 $genderCache = $services->getGenderCache();
627 $genderCache->doQuery( $usernames, $fname );
wfEscapeWikiText( $input)
Escapes the given text so that it may be output using addWikiText() without any linking,...
array $params
The job parameters.
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.
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.to 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.
trait ApiQueryBlockInfoTrait