viscous/espocrm
1
0
Fork 0
mirror of https://github.com/espocrm/espocrm.git synced 2026-07-01 00:16:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

ORM: Join sub-query (#2757)

Browse Source 
* orm join sub-query

* tests
This commit is contained in:
Yuri Kuznetsov
2023-05-31 17:01:43 +03:00
committed by GitHub
parent 260a5c89ef
commit d4aa9745ca
5 changed files with 276 additions and 68 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
application/Espo/ORM/Query/Part/Join.php
View File

@@ -29,6 +29,8 @@
namespace Espo\ORM\Query\Part;
use Espo\ORM\Query\Select;
use LogicException;
use RuntimeException;
/**
@@ -38,11 +40,18 @@ use RuntimeException;
*/
class Join
{
/** A table join. */
public const TYPE_TABLE = 0;
/** A relation join. */
public const TYPE_RELATION = 1;
/** A sub-query join. */
public const TYPE_SUB_QUERY = 3;
private ?WhereItem $conditions = null;
private bool $onlyMiddle = false;
private function __construct(
private string $target,
private string|Select $target,
private ?string $alias = null
) {
if ($target === '' || $alias === '') {
@@ -51,10 +60,10 @@ class Join
}
/**
* Get a join target. A relationName or table.
* A relationName is in camelCase, a table is in CamelCase.
* Get a join target. A relation name, table or sub-query.
* A relation name is in camelCase, a table is in CamelCase.
*/
public function getTarget(): string
public function getTarget(): string|Select
{
return $this->target;
}
@@ -75,16 +84,51 @@ class Join
return $this->conditions;
}
/**
* Is a sub-query join.
*/
public function isSubQuery(): bool
{
return !is_string($this->target);
}
/**
* Is a table join.
*/
public function isTable(): bool
{
return $this->target[0] === ucfirst($this->target[0]);
return is_string($this->target) && $this->target[0] === ucfirst($this->target[0]);
}
/**
* Is a relation join.
*/
public function isRelation(): bool
{
return !$this->isTable();
return !$this->isSubQuery() && !$this->isTable();
}
/**
* Get a join type.
*
* @return self::TYPE_TABLE|self::TYPE_RELATION|self::TYPE_SUB_QUERY
*/
public function getType(): int
{
if ($this->isSubQuery()) {
return self::TYPE_SUB_QUERY;
}
if ($this->isRelation()) {
return self::TYPE_RELATION;
}
return self::TYPE_TABLE;
}
/**
* Is only middle table to be joined.
*/
public function isOnlyMiddle(): bool
{
return $this->onlyMiddle;
@@ -93,18 +137,23 @@ class Join
/**
* Create.
*
* @param string $target
* A relation name or table. A relationName should be in camelCase, a table in CamelCase.
* When joining a table, conditions should be specified.
* When joining a relation, conditions will be applied automatically.
* @param string|Select $target
* A relation name, table or sub-query. A relation name should be in camelCase, a table in CamelCase.
* When joining a table or sub-query, conditions should be specified.
* When joining a relation, conditions will be applied automatically, additional conditions can
* be specified as well.
* @param ?string $alias An alias.
*/
public static function create(string $target, ?string $alias = null): self
public static function create(string|Select $target, ?string $alias = null): self
{
return new self($target, $alias);
}
/**
* Create with a table target.
*
* @param string $table A table name. Should start with an upper case letter.
* @param ?string $alias An alias.
*/
public static function createWithTableTarget(string $table, ?string $alias = null): self
{
@@ -113,12 +162,26 @@ class Join
/**
* Create with a relation target. Conditions will be applied automatically.
*
* @param string $relation A relation name. Should start with a lower case letter.
* @param ?string $alias An alias.
*/
public static function createWithRelationTarget(string $relation, ?string $alias = null): self
{
return self::create(lcfirst($relation), $alias);
}
/**
* Create with a sub-query.
*
* @param Select $subQuery A sub-query.
* @param string $alias An alias.
*/
public static function createWithSubQuery(Select $subQuery, string $alias): self
{
return new self($subQuery, $alias);
}
/**
* Clone with an alias.
*/
@@ -146,6 +209,10 @@ class Join
*/
public function withOnlyMiddle(bool $onlyMiddle = true): self
{
if (!$this->isRelation()) {
throw new LogicException("Only-middle is compatible only with relation joins.");
}
$obj = clone $this;
$obj->onlyMiddle = $onlyMiddle;

58
application/Espo/ORM/Query/SelectingBuilderTrait.php
View File

@@ -35,6 +35,7 @@ use Espo\ORM\Query\Part\Order;
use Espo\ORM\Query\Part\Join;
use InvalidArgumentException;
use LogicException;
use RuntimeException;
trait SelectingBuilderTrait
@@ -156,42 +157,55 @@ trait SelectingBuilderTrait
/**
* Add JOIN.
*
* @param Join|string $target
* A relation name or table. A relation name should be in camelCase, a table in CamelCase.
* @param Join|string|Select $target A relation name, table or sub-query. A relation name should be in camelCase,
* a table in CamelCase.
* @param ?string $alias An alias.
* @param WhereItem|array<string|int, mixed>|null $conditions Join conditions.
*/
public function join($target, ?string $alias = null, $conditions = null): self
{
public function join(
$target,
?string $alias = null,
WhereItem|array|null $conditions = null
): self {
return $this->joinInternal('joins', $target, $alias, $conditions);
}
/**
* Add LEFT JOIN.
*
* @param Join|string $target
* A relation name or table. A relation name should be in camelCase, a table in CamelCase.
* @param Join|string|Select $target A relation name, table or sub-query. A relation name should be in camelCase,
* a table in CamelCase.
* @param ?string $alias An alias.
* @param WhereItem|array<string|int, mixed>|null $conditions Join conditions.
*/
public function leftJoin($target, ?string $alias = null, $conditions = null): self
{
public function leftJoin(
$target,
?string $alias = null,
WhereItem|array|null $conditions = null
): self {
return $this->joinInternal('leftJoins', $target, $alias, $conditions);
}
/**
* @param 'leftJoins'|'joins' $type
* @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<string|int, mixed>|null $conditions Join conditions.
*
* @todo Support USE INDEX in Join.
* $target can be an array for backward compatibility.
* @param Join|string|Select $target $target
* @param WhereItem|array<string|int, mixed>|null $conditions
*/
private function joinInternal(string $type, $target, ?string $alias = null, $conditions = null): self
{
private function joinInternal(
string $type,
$target,
?string $alias = null,
WhereItem|array|null $conditions = null
): self {
$onlyMiddle = false;
/** @var string|Join|array<int, mixed> $target */
if ($target instanceof Join) {
$alias = $alias ?? $target->getAlias();
$conditions = $conditions ?? $target->getConditions();
@@ -199,11 +213,8 @@ trait SelectingBuilderTrait
$target = $target->getTarget();
}
/** @phpstan-var mixed $conditions */
/** @phpstan-var mixed $target */
if ($conditions !== null && !is_array($conditions) && !$conditions instanceof WhereItem) {
throw new InvalidArgumentException("Conditions must be WhereItem or array.");
if ($target instanceof Select && !$alias) {
throw new LogicException("Sub-query join can't be used w/o alias.");
}
$noLeftAlias = false;
@@ -228,7 +239,12 @@ trait SelectingBuilderTrait
return $this;
}
if (is_null($alias) && is_null($conditions) && $this->hasJoinAliasInternal($type, $target)) {
if (
is_null($alias) &&
is_null($conditions) &&
is_string($target) &&
$this->hasJoinAliasInternal($type, $target)
) {
return $this;
}