UnionQueryBuilder.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\Rdbms;
 
use Wikimedia\Rdbms\Platform\ISQLPlatform;
 
class UnionQueryBuilder {
    public const SORT_ASC = 'ASC';
 
    public const SORT_DESC = 'DESC';
 
    private $sqbs = [];
 
    private IDatabase $db;
 
    private $all = IReadableDatabase::UNION_DISTINCT;
 
    private $options = [];
 
    private $caller = __CLASS__;
 
    public function __construct( IDatabase $db ) {
        $this->db = $db;
    }
 
    public function add( SelectQueryBuilder $selectQueryBuilder ) {
        $this->sqbs[] = $selectQueryBuilder;
        return $this;
    }
 
    public function all() {
        $this->all = $this->db::UNION_ALL;
        return $this;
    }
 
    public function limit( $limit ) {
        if ( !$this->db->unionSupportsOrderAndLimit() ) {
            return $this;
        }
        $this->options['LIMIT'] = $limit;
        return $this;
    }
 
    public function offset( $offset ) {
        if ( !$this->db->unionSupportsOrderAndLimit() ) {
            return $this;
        }
        $this->options['OFFSET'] = $offset;
        return $this;
    }
 
    public function orderBy( $fields, $direction = null ) {
        if ( !$this->db->unionSupportsOrderAndLimit() ) {
            return $this;
        }
        if ( $direction === null ) {
            $this->mergeOption( 'ORDER BY', $fields );
        } elseif ( is_array( $fields ) ) {
            $fieldsWithDirection = [];
            foreach ( $fields as $field ) {
                $fieldsWithDirection[] = "$field $direction";
            }
            $this->mergeOption( 'ORDER BY', $fieldsWithDirection );
        } else {
            $this->mergeOption( 'ORDER BY', "$fields $direction" );
        }
        return $this;
    }
 
    private function mergeOption( $name, $newArrayOrValue ) {
        $value = isset( $this->options[$name] )
            ? (array)$this->options[$name] : [];
        if ( is_array( $newArrayOrValue ) ) {
            $value = array_merge( $value, $newArrayOrValue );
        } else {
            $value[] = $newArrayOrValue;
        }
        $this->options[$name] = $value;
    }
 
    public function caller( $fname ) {
        $this->caller = $fname;
        return $this;
    }
 
    public function fetchResultSet() {
        // @codeCoverageIgnoreStart
        if ( defined( 'MW_PHPUNIT_TEST' ) && str_contains( $this->db->getSoftwareLink(), 'MySQL' ) ) {
            // MySQL cannot open the same temporary table twice in the same query, and integration tests
            // use temporary tables, so we need to emulate the UNION query (T412067).
            $resultSets = array_map( static fn ( $qb ) => $qb->fetchResultSet(), $this->sqbs );
            $res = [];
            foreach ( $resultSets as $resultSet ) {
                $res = array_merge( $res, iterator_to_array( $resultSet ) );
            }
            if ( $this->all === $this->db::UNION_DISTINCT ) {
                $res = array_unique( $res );
            }
            return new FakeResultWrapper( $res );
        }
        // @codeCoverageIgnoreEnd
        $query = new Query( $this->getSQL(), ISQLPlatform::QUERY_CHANGE_NONE, 'SELECT' );
        return $this->db->query( $query, $this->caller );
    }
 
    public function fetchField() {
        $this->limit( 1 );
        foreach ( $this->fetchResultSet() as $row ) {
            $row = (array)$row;
            if ( count( $row ) !== 1 ) {
                throw new \UnexpectedValueException(
                    __METHOD__ . ' expects the query to have only one field' );
            }
            return $row[ array_key_first( $row ) ];
        }
        return false;
    }
 
    public function fetchFieldValues() {
        $values = [];
        foreach ( $this->fetchResultSet() as $row ) {
            $row = (array)$row;
            if ( count( $row ) !== 1 ) {
                throw new \UnexpectedValueException(
                    __METHOD__ . ' expects the query to have only one field' );
            }
            $values[] = $row[ array_key_first( $row ) ];
        }
        return $values;
    }
 
    public function fetchRow() {
        $this->limit( 1 );
        foreach ( $this->fetchResultSet() as $row ) {
            return $row;
        }
        return false;
    }
 
    public function getSQL() {
        $sqls = [];
        foreach ( $this->sqbs as $sqb ) {
            $sqls[] = $sqb->getSQL();
        }
        return $this->db->unionQueries( $sqls, $this->all, $this->options );
    }
 
}