PageSelectQueryBuilder.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Page;
 
use Iterator;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\IExpression;
use Wikimedia\Rdbms\IReadableDatabase;
use Wikimedia\Rdbms\LikeValue;
use Wikimedia\Rdbms\SelectQueryBuilder;
 
class PageSelectQueryBuilder extends SelectQueryBuilder {
 
    private $pageStore;
 
    private $linkCache;
 
    public function __construct( IReadableDatabase $db, PageStore $pageStore, ?LinkCache $linkCache = null ) {
        parent::__construct( $db );
        $this->pageStore = $pageStore;
        $this->table( 'page' );
        $this->linkCache = $linkCache;
    }
 
    public function wherePageIds( $pageIds ): self {
        Assert::parameterType( [ 'integer', 'array' ], $pageIds, '$pageIds' );
 
        if ( $pageIds ) {
            $this->conds( [ 'page_id' => $pageIds ] );
        } else {
            $this->conds( '0 = 1' ); // force empty result set
        }
 
        return $this;
    }
 
    public function whereNamespace( int $namespace ): self {
        $this->conds( [ 'page_namespace' => $namespace ] );
        return $this;
    }
 
    public function whereTitlePrefix( int $namespace, string $prefix ): self {
        $this->whereNamespace( $namespace );
        $this->conds(
            $this->db->expr( 'page_title', IExpression::LIKE, new LikeValue( $prefix, $this->db->anyString() ) )
        );
        return $this;
    }
 
    public function whereTitles( int $namespace, $pageTitles ): self {
        Assert::parameterType( [ 'string', 'array' ], $pageTitles, '$pageTitles' );
        $this->conds( [ 'page_namespace' => $namespace ] );
        $this->conds( [ 'page_title' => $pageTitles ] );
        return $this;
    }
 
    public function orderByTitle( string $dir = self::SORT_ASC ): self {
        $this->orderBy( [ 'page_namespace', 'page_title' ], $dir );
        return $this;
    }
 
    public function orderByPageId( string $dir = self::SORT_ASC ): self {
        $this->orderBy( 'page_id', $dir );
        return $this;
    }
 
    public function fetchPageRecord(): ?PageRecord {
        $this->fields( $this->pageStore->getSelectFields() );
 
        $row = $this->fetchRow();
        if ( !$row ) {
            return null;
        }
 
        $rec = $this->pageStore->newPageRecordFromRow( $row );
        if ( $this->linkCache ) {
            $this->linkCache->addGoodLinkObjFromRow( $rec, $row );
        }
        return $rec;
    }
 
    public function fetchPageRecords(): Iterator {
        $this->fields( $this->pageStore->getSelectFields() );
 
        $result = $this->fetchResultSet();
        foreach ( $result as $row ) {
            $rec = $this->pageStore->newPageRecordFromRow( $row );
            if ( $this->linkCache ) {
                $this->linkCache->addGoodLinkObjFromRow( $rec, $row );
            }
            yield $rec;
        }
        $result->free();
    }
 
    public function fetchPageRecordArray(): array {
        $recs = [];
 
        foreach ( $this->fetchPageRecords() as $rec ) {
            $recs[ $rec->getId() ] = $rec;
        }
 
        return $recs;
    }
 
    public function fetchPageIds(): array {
        $this->field( 'page_id' );
        return array_map( 'intval', $this->fetchFieldValues() );
    }
 
}