Files
espocrm/application/Espo/Core/Select/Bool/Applier.php
Yuri Kuznetsov 702b3f4e2b cs ref
2023-02-17 15:46:44 +02:00

126 lines
4.0 KiB
PHP

<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM - Open Source CRM application.
* Copyright (C) 2014-2023 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\Core\Select\Bool;
use Espo\Core\Select\OrmSelectBuilder;
use Espo\Core\Exceptions\Error;
use Espo\Core\Select\SelectManager;
use Espo\Core\Select\Bool\FilterFactory as BoolFilterFactory;
use Espo\ORM\Query\Select;
use Espo\ORM\Query\SelectBuilder as QueryBuilder;
use Espo\ORM\Query\Part\Where\OrGroupBuilder;
use Espo\ORM\Query\Part\WhereClause;
use Espo\Entities\User;
class Applier
{
public function __construct(
private string $entityType,
private User $user,
private BoolFilterFactory $boolFilterFactory,
private SelectManager $selectManager
) {}
/**
* @param string[] $boolFilterNameList
* @throws Error
*/
public function apply(QueryBuilder $queryBuilder, array $boolFilterNameList): void
{
$orGroupBuilder = new OrGroupBuilder();
$isMultiple = count($boolFilterNameList) > 1;
if ($isMultiple) {
$queryBefore = $queryBuilder->build();
}
foreach ($boolFilterNameList as $filterName) {
$this->applyBoolFilter($queryBuilder, $orGroupBuilder, $filterName);
}
if ($isMultiple) {
$this->handleMultiple($queryBefore, $queryBuilder);
}
$queryBuilder->where(
$orGroupBuilder->build()
);
}
/**
* @throws Error
*/
private function applyBoolFilter(
QueryBuilder $queryBuilder,
OrGroupBuilder $orGroupBuilder,
string $filterName
): void {
if ($this->boolFilterFactory->has($this->entityType, $filterName)) {
$filter = $this->boolFilterFactory->create($this->entityType, $this->user, $filterName);
$filter->apply($queryBuilder, $orGroupBuilder);
return;
}
// For backward compatibility.
if (
$this->selectManager->hasBoolFilter($filterName) &&
$queryBuilder instanceof OrmSelectBuilder
) {
$rawWhereClause = $this->selectManager->applyBoolFilterToQueryBuilder($queryBuilder, $filterName);
$whereItem = WhereClause::fromRaw($rawWhereClause);
$orGroupBuilder->add($whereItem);
return;
}
throw new Error("No bool filter '{$filterName}' for '{$this->entityType}'.");
}
private function handleMultiple(Select $queryBefore, QueryBuilder $queryBuilder): void
{
$queryAfter = $queryBuilder->build();
$joinCountBefore = count($queryBefore->getJoins()) + count($queryBefore->getLeftJoins());
$joinCountAfter = count($queryAfter->getJoins()) + count($queryAfter->getLeftJoins());
if ($joinCountBefore < $joinCountAfter) {
$queryBuilder->distinct();
}
}
}