mirror of
https://github.com/espocrm/espocrm.git
synced 2026-06-28 23:16:03 +00:00
407 lines
11 KiB
PHP
407 lines
11 KiB
PHP
<?php
|
|
/************************************************************************
|
|
* This file is part of EspoCRM.
|
|
*
|
|
* EspoCRM - Open Source CRM application.
|
|
* Copyright (C) 2014-2021 Yurii Kuznietsov, Taras Machyshyn, Oleksii Avramenko
|
|
* Website: https://www.espocrm.com
|
|
*
|
|
* EspoCRM is free software: you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation, either version 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* EspoCRM 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 General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with EspoCRM. If not, see http://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 General Public License version 3.
|
|
*
|
|
* In accordance with Section 7(b) of the GNU 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\WhereItem;
|
|
use Espo\ORM\Query\Part\Expression;
|
|
use Espo\ORM\Query\Part\OrderExpression;
|
|
use Espo\ORM\Query\Part\Join;
|
|
|
|
use InvalidArgumentException;
|
|
|
|
trait SelectingBuilderTrait
|
|
{
|
|
use BaseBuilderTrait;
|
|
|
|
/**
|
|
* Add a WHERE clause.
|
|
*
|
|
* Usage options:
|
|
* * `where(WhereItem $clause)`
|
|
* * `where(array $clause)`
|
|
* * `where(string $key, string $value)`
|
|
*
|
|
* @param WhereItem|array|string $clause A key or where clause.
|
|
* @param array|string|null $value A value. Omitted if the first argument is not string.
|
|
*/
|
|
public function where($clause, $value = null): self
|
|
{
|
|
$this->applyWhereClause('whereClause', $clause, $value);
|
|
|
|
return $this;
|
|
}
|
|
|
|
private function applyWhereClause(string $type, $clause, $value): void
|
|
{
|
|
if ($clause instanceof WhereItem) {
|
|
$clause = $clause->getRaw();
|
|
}
|
|
|
|
$this->params[$type] = $this->params[$type] ?? [];
|
|
|
|
$original = $this->params[$type];
|
|
|
|
if (!is_string($clause) && !is_array($clause)) {
|
|
throw new InvalidArgumentException("Bad where clause.");
|
|
}
|
|
|
|
if (is_array($clause)) {
|
|
$new = $clause;
|
|
}
|
|
|
|
if (is_string($clause)) {
|
|
$new = [$clause => $value];
|
|
}
|
|
|
|
$containsSameKeys = (bool) count(
|
|
array_intersect(
|
|
array_keys($new),
|
|
array_keys($original)
|
|
)
|
|
);
|
|
|
|
if ($containsSameKeys) {
|
|
$this->params[$type][] = $new;
|
|
|
|
return;
|
|
}
|
|
|
|
$this->params[$type] = $new + $original;
|
|
|
|
return;
|
|
}
|
|
|
|
/**
|
|
* Apply ORDER. Passing an array will override previously set items.
|
|
* Passing non-array will append an item,
|
|
*
|
|
* Usage options:
|
|
* * `order(OrderExpression $expression)
|
|
* * `order([$expr1, $expr2, ...])
|
|
* * `order(string $expression, string $direction)
|
|
*
|
|
* @param OrderExpression|OrderExpression[]|Expression|string $orderBy
|
|
* An attribute to order by or an array or order items.
|
|
* Passing an array will reset a previously set order.
|
|
* @param string|bool|null $direction OrderExpression::ASC|OrderExpression::DESC.
|
|
*/
|
|
public function order($orderBy, $direction = null): self
|
|
{
|
|
if (is_bool($direction)) {
|
|
$direction = $direction ? OrderExpression::DESC : OrderExpression::ASC;
|
|
}
|
|
|
|
if (is_array($orderBy)) {
|
|
$this->params['orderBy'] = $this->normilizeOrderExpressionItemArray(
|
|
$orderBy,
|
|
$direction ?? OrderExpression::ASC
|
|
);
|
|
|
|
return $this;
|
|
}
|
|
|
|
if (!$orderBy) {
|
|
throw InvalidArgumentException();
|
|
}
|
|
|
|
$this->params['orderBy'] = $this->params['orderBy'] ?? [];
|
|
|
|
if ($orderBy instanceof Expression) {
|
|
$orderBy = $orderBy->getValue();
|
|
$direction = $direction ?? OrderExpression::ASC;
|
|
}
|
|
else if ($orderBy instanceof OrderExpression) {
|
|
$direction = $direction ?? $orderBy->getDirection();
|
|
$orderBy = $orderBy->getExpression()->getValue();
|
|
}
|
|
else {
|
|
$direction = $direction ?? OrderExpression::ASC;
|
|
}
|
|
|
|
$this->params['orderBy'][] = [$orderBy, $direction];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add JOIN.
|
|
*
|
|
* @param Join|string $target
|
|
* A relation name or table. A relation name should be in camelCase, a table in CamelCase.
|
|
* @param string|null $alias An alias.
|
|
* @param WhereItem|array|null $conditions Join conditions.
|
|
*/
|
|
public function join($target, ?string $alias = null, $conditions = null): self
|
|
{
|
|
if ($target instanceof Join) {
|
|
$alias = $alias ?? $target->getAlias();
|
|
$conditions = $conditions ?? $target->getConditions();
|
|
$target = $target->getTarget();
|
|
}
|
|
|
|
if ($conditions !== null && !is_array($conditions) && !$conditions instanceof WhereItem) {
|
|
throw new InvalidArgumentException("Conditions must be WhereItem or array.");
|
|
}
|
|
|
|
if ($conditions instanceof WhereItem) {
|
|
$conditions = $conditions->getRaw();
|
|
}
|
|
|
|
if (empty($this->params['joins'])) {
|
|
$this->params['joins'] = [];
|
|
}
|
|
|
|
if (is_array($target)) {
|
|
$joinList = $target;
|
|
|
|
foreach ($joinList as $item) {
|
|
$this->params['joins'][] = $item;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
if (is_null($alias) && is_null($conditions) && $this->hasJoinAlias($target)) {
|
|
return $this;
|
|
}
|
|
|
|
if (is_null($alias) && is_null($conditions)) {
|
|
$this->params['joins'][] = $target;
|
|
|
|
return $this;
|
|
}
|
|
|
|
if (is_null($conditions)) {
|
|
$this->params['joins'][] = [$target, $alias];
|
|
|
|
return $this;
|
|
}
|
|
|
|
$this->params['joins'][] = [$target, $alias, $conditions];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add LEFT JOIN.
|
|
*
|
|
* @param Join|string $target
|
|
* A relation name or table. A relation name should be in camelCase, a table in CamelCase.
|
|
* @param string|null $alias An alias.
|
|
* @param WhereItem|array|null $conditions Join conditions.
|
|
*/
|
|
public function leftJoin($target, ?string $alias = null, $conditions = null): self
|
|
{
|
|
if ($target instanceof Join) {
|
|
$alias = $alias ?? $target->getAlias();
|
|
$conditions = $conditions ?? $target->getConditions();
|
|
$target = $target->getTarget();
|
|
}
|
|
|
|
if ($conditions !== null && !is_array($conditions) && !$conditions instanceof WhereItem) {
|
|
throw new InvalidArgumentException("Conditions must be WhereItem or array.");
|
|
}
|
|
|
|
if ($conditions instanceof WhereItem) {
|
|
$conditions = $conditions->getRaw();
|
|
}
|
|
|
|
if (empty($this->params['leftJoins'])) {
|
|
$this->params['leftJoins'] = [];
|
|
}
|
|
|
|
if (is_array($target)) {
|
|
$joinList = $target;
|
|
|
|
foreach ($joinList as $item) {
|
|
$this->params['leftJoins'][] = $item;
|
|
}
|
|
|
|
return $this;
|
|
}
|
|
|
|
if (is_null($alias) && is_null($conditions) && $this->hasLeftJoinAlias($target)) {
|
|
return $this;
|
|
}
|
|
|
|
if (is_null($alias) && is_null($conditions)) {
|
|
$this->params['leftJoins'][] = $target;
|
|
|
|
return $this;
|
|
}
|
|
|
|
if (is_null($conditions)) {
|
|
$this->params['leftJoins'][] = [$target, $alias];
|
|
|
|
return $this;
|
|
}
|
|
|
|
$this->params['leftJoins'][] = [$target, $alias, $conditions];
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Whether an alias is in left joins.
|
|
*/
|
|
public function hasLeftJoinAlias(string $alias): bool
|
|
{
|
|
$leftJoins = $this->params['leftJoins'] ?? [];
|
|
|
|
if (in_array($alias, $leftJoins)) {
|
|
return true;
|
|
}
|
|
|
|
foreach ($leftJoins as $item) {
|
|
if (is_array($item) && count($item) > 1) {
|
|
if ($item[1] === $alias) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Whether an alias is in joins.
|
|
*/
|
|
public function hasJoinAlias(string $alias): bool
|
|
{
|
|
$joins = $this->params['joins'] ?? [];
|
|
|
|
if (in_array($alias, $joins)) {
|
|
return true;
|
|
}
|
|
|
|
foreach ($joins as $item) {
|
|
if (is_array($item) && count($item) > 1) {
|
|
if ($item[1] === $alias) {
|
|
return true;
|
|
}
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
private function normilizeExpressionItemArray(array $itemList): array
|
|
{
|
|
$resultList = [];
|
|
|
|
foreach ($itemList as $item) {
|
|
if ($item instanceof Expression) {
|
|
$resultList[] = $item->getValue();
|
|
|
|
continue;
|
|
}
|
|
|
|
if (!is_array($item) || !count($item) || !$item[0] instanceof Expression) {
|
|
$resultList[] = $item;
|
|
|
|
continue;
|
|
}
|
|
|
|
$newItem = [$item[0]->getValue()];
|
|
|
|
if (count($item) > 1) {
|
|
$newItem[] = $item[1];
|
|
}
|
|
|
|
$resultList[] = $newItem;
|
|
|
|
continue;
|
|
}
|
|
|
|
return $resultList;
|
|
}
|
|
|
|
private function normilizeOrderExpressionItemArray(array $itemList, $direction): array
|
|
{
|
|
$resultList = [];
|
|
|
|
foreach ($itemList as $item) {
|
|
if (is_string($item)) {
|
|
$resultList[] = [$item, $direction];
|
|
|
|
continue;
|
|
}
|
|
|
|
if (is_int($item)) {
|
|
$resultList[] = [(string) $item, $direction];
|
|
|
|
continue;
|
|
}
|
|
|
|
if ($item instanceof OrderExpression) {
|
|
$resultList[] = [
|
|
$item->getExpression()->getValue(),
|
|
$item->getDirection()
|
|
];
|
|
|
|
continue;
|
|
}
|
|
|
|
if ($item instanceof Expression) {
|
|
$resultList[] = [
|
|
$item->getValue(),
|
|
$direction
|
|
];
|
|
|
|
continue;
|
|
}
|
|
|
|
if (!is_array($item) || !count($item)) {
|
|
throw new RuntimeException("Bad order item.");
|
|
}
|
|
|
|
$itemValue = $item[0] instanceof Expression ?
|
|
$item[0]->getValue() :
|
|
$item[0];
|
|
|
|
if (!is_string($itemValue) && !is_int($itemValue)) {
|
|
throw new RuntimeException("Bad order item.");
|
|
}
|
|
|
|
$itemDirection = count($item) > 1 ? $item[1] : $direction;
|
|
|
|
if (is_bool($itemDirection)) {
|
|
$itemDirection = $itemDirection ?
|
|
OrderExpression::DESC :
|
|
OrderExpression::ASC;
|
|
}
|
|
|
|
$resultList[] = [$itemValue, $itemDirection];
|
|
}
|
|
|
|
return $resultList;
|
|
}
|
|
}
|