147 lines
4.1 KiB
PHP
147 lines
4.1 KiB
PHP
<?php
|
||
/************************************************************************
|
||
* This file is part of EspoCRM.
|
||
*
|
||
* EspoCRM – Open Source CRM application.
|
||
* Copyright (C) 2014-2025 EspoCRM, Inc.
|
||
* Website: https://www.espocrm.com
|
||
*
|
||
* This program is free software: you can redistribute it and/or modify
|
||
* it under the terms of the GNU Affero General Public License as published by
|
||
* the Free Software Foundation, either version 3 of the License, or
|
||
* (at your option) any later version.
|
||
*
|
||
* This program is distributed in the hope that it will be useful,
|
||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||
* GNU Affero General Public License for more details.
|
||
*
|
||
* You should have received a copy of the GNU Affero General Public License
|
||
* along with this program. If not, see <https://www.gnu.org/licenses/>.
|
||
*
|
||
* The interactive user interfaces in modified source and object code versions
|
||
* of this program must display Appropriate Legal Notices, as required under
|
||
* Section 5 of the GNU Affero General Public License version 3.
|
||
*
|
||
* In accordance with Section 7(b) of the GNU Affero General Public License version 3,
|
||
* these Appropriate Legal Notices must retain the display of the "EspoCRM" word.
|
||
************************************************************************/
|
||
|
||
namespace Espo\ORM\Query;
|
||
|
||
use Espo\ORM\Query\Part\Order;
|
||
|
||
use InvalidArgumentException;
|
||
|
||
class UnionBuilder implements Builder
|
||
{
|
||
use BaseBuilderTrait;
|
||
|
||
/**
|
||
* Create an instance.
|
||
*/
|
||
public static function create(): self
|
||
{
|
||
return new self();
|
||
}
|
||
|
||
/**
|
||
* Build a UNION select query.
|
||
*/
|
||
public function build(): Union
|
||
{
|
||
return Union::fromRaw($this->params);
|
||
}
|
||
|
||
/**
|
||
* Clone an existing query for a subsequent modifying and building.
|
||
*/
|
||
public function clone(Union $query): self
|
||
{
|
||
$this->cloneInternal($query);
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Use UNION ALL.
|
||
*/
|
||
public function all(): self
|
||
{
|
||
$this->params['all'] = true;
|
||
|
||
return $this;
|
||
}
|
||
|
||
public function query(Select $query): self
|
||
{
|
||
$this->params['queries'] = $this->params['queries'] ?? [];
|
||
$this->params['queries'][] = $query;
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Apply OFFSET and LIMIT.
|
||
*/
|
||
public function limit(?int $offset = null, ?int $limit = null): self
|
||
{
|
||
$this->params['offset'] = $offset;
|
||
$this->params['limit'] = $limit;
|
||
|
||
return $this;
|
||
}
|
||
|
||
/**
|
||
* Apply ORDER.
|
||
*
|
||
* @param string|array<array{string, (Order::ASC|Order::DESC)|bool}|array{string}> $orderBy A select alias.
|
||
* @param (Order::ASC|Order::DESC)|bool $direction A direction. True for DESC.
|
||
*/
|
||
public function order($orderBy, string|bool $direction = Order::ASC): self
|
||
{
|
||
if (is_bool($direction)) {
|
||
$direction = $direction ? Order::DESC : Order::ASC;
|
||
}
|
||
|
||
if (!$orderBy) {
|
||
throw new InvalidArgumentException();
|
||
}
|
||
|
||
if (is_array($orderBy)) {
|
||
foreach ($orderBy as $item) {
|
||
/** @var mixed[] $item */
|
||
|
||
if (count($item) === 2) {
|
||
/** @var array{string, bool|(Order::ASC|Order::DESC)} $item */
|
||
$this->order($item[0], $item[1]);
|
||
|
||
continue;
|
||
}
|
||
|
||
if (count($item) === 1) {
|
||
/** @var array{string} $item */
|
||
$this->order($item[0]);
|
||
|
||
continue;
|
||
}
|
||
|
||
throw new InvalidArgumentException("Bad order.");
|
||
}
|
||
|
||
return $this;
|
||
}
|
||
|
||
/** @var object|scalar $orderBy */
|
||
|
||
if (!is_string($orderBy) && !is_int($orderBy)) {
|
||
throw new InvalidArgumentException("Bad order.");
|
||
}
|
||
|
||
$this->params['orderBy'] = $this->params['orderBy'] ?? [];
|
||
$this->params['orderBy'][] = [$orderBy, $direction];
|
||
|
||
return $this;
|
||
}
|
||
}
|