Files
espocrm/application/Espo/ORM/QueryBuilder.php
bsiggel 127fa6503b chore: Update copyright year from 2025 to 2026 across core files
- Updated copyright headers in 3,055 core application files
- Changed 'Copyright (C) 2014-2025' to 'Copyright (C) 2014-2026'
- Added 123 new files from EspoCRM core updates
- Removed 4 deprecated files
- Total changes: 61,637 insertions, 54,283 deletions

This is a routine maintenance update for the new year 2026.
2026-02-07 16:05:21 +01:00

141 lines
4.3 KiB
PHP
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<?php
/************************************************************************
* This file is part of EspoCRM.
*
* EspoCRM Open Source CRM application.
* Copyright (C) 2014-2026 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;
use Espo\ORM\Query\Delete;
use Espo\ORM\Query\DeleteBuilder;
use Espo\ORM\Query\Insert;
use Espo\ORM\Query\InsertBuilder;
use Espo\ORM\Query\Part\Expression;
use Espo\ORM\Query\Part\Selection;
use Espo\ORM\Query\Query;
use Espo\ORM\Query\Select;
use Espo\ORM\Query\SelectBuilder;
use Espo\ORM\Query\Union;
use Espo\ORM\Query\UnionBuilder;
use Espo\ORM\Query\Update;
use Espo\ORM\Query\UpdateBuilder;
use RuntimeException;
/**
* Creates query builders for specific query types.
*/
class QueryBuilder
{
/**
* Specify SELECT. Columns and expressions to be selected. If not called, then
* all entity attributes will be selected. Passing an array will reset
* previously set items. Passing a SelectExpression|Expression|string will append the item.
*
* Usage options:
* * `select(SelectExpression $expression)`
* * `select([$expr1, $expr2, ...])`
* * `select(string $expression, string $alias)`
*
* @param Selection|Selection[]|Expression|string[]|string $select
* An array of expressions or one expression.
* @param ?string $alias An alias. Actual if the first parameter is not an array.
*/
public function select($select = null, ?string $alias = null): SelectBuilder
{
$builder = new SelectBuilder();
if ($select === null) {
return $builder;
}
return $builder->select($select, $alias);
}
/**
* Proceed with UPDATE builder.
*/
public function update(): UpdateBuilder
{
return new UpdateBuilder();
}
/**
* Proceed with DELETE builder.
*/
public function delete(): DeleteBuilder
{
return new DeleteBuilder();
}
/**
* Proceed with INSERT builder.
*/
public function insert(): InsertBuilder
{
return new InsertBuilder();
}
/**
* Proceed with UNION builder.
*/
public function union(): UnionBuilder
{
return new UnionBuilder();
}
/**
* Clone an existing query and proceed modifying it.
*
* @return SelectBuilder|UpdateBuilder|DeleteBuilder|InsertBuilder|UnionBuilder
* @throws RuntimeException
*/
public function clone(Query $query): SelectBuilder|UpdateBuilder|DeleteBuilder|InsertBuilder|UnionBuilder
{
if ($query instanceof Select) {
return $this->select()->clone($query);
}
if ($query instanceof Update) {
return $this->update()->clone($query);
}
if ($query instanceof Delete) {
return $this->delete()->clone($query);
}
if ($query instanceof Insert) {
return $this->insert()->clone($query);
}
if ($query instanceof Union) {
return $this->union()->clone($query);
}
throw new RuntimeException("Can't clone an unsupported query.");
}
}