Yuri Kuznetsov
409 lines
10 KiB
PHP
409 lines
10 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\Repository;
|
|
|
|
use Espo\ORM\{
|
|
Collection,
|
|
SthCollection,
|
|
Entity,
|
|
EntityManager,
|
|
QueryParams\Select,
|
|
QueryParams\SelectBuilder,
|
|
Mapper\Mapper,
|
|
};
|
|
|
|
use RuntimeException;
|
|
|
|
/**
|
|
* Builds select parameters for related records for RDB repository.
|
|
*/
|
|
class RDBRelationSelectBuilder
|
|
{
|
|
protected $entityManager;
|
|
|
|
protected $entity;
|
|
|
|
protected $entityType;
|
|
|
|
protected $foreignEntityType;
|
|
|
|
protected $relationName;
|
|
|
|
protected $relationType = null;
|
|
|
|
protected $builder = null;
|
|
|
|
protected $additionalSelect = [];
|
|
|
|
protected $selectIsAdded = false;
|
|
|
|
private $middleTableAlias = null;
|
|
|
|
protected $returnSthCollection = false;
|
|
|
|
public function __construct(EntityManager $entityManager, Entity $entity, string $relationName, ?Select $query = null)
|
|
{
|
|
$this->entityManager = $entityManager;
|
|
|
|
$this->entity = $entity;
|
|
|
|
$this->relationName = $relationName;
|
|
|
|
$this->relationType = $entity->getRelationType($relationName);
|
|
|
|
$this->entityType = $entity->getEntityType();
|
|
|
|
$this->foreignEntityType = $entity->getRelationParam($relationName, 'entity');
|
|
|
|
if ($query) {
|
|
$this->builder = $this->createSelectBuilder()->clone($query);
|
|
} else {
|
|
$this->builder = $this->createSelectBuilder()->from($this->foreignEntityType);
|
|
}
|
|
}
|
|
|
|
protected function createSelectBuilder() : SelectBuilder
|
|
{
|
|
return new SelectBuilder($this->entityManager->getQueryComposer());
|
|
}
|
|
|
|
protected function getMapper() : Mapper
|
|
{
|
|
return $this->entityManager->getMapper();
|
|
}
|
|
|
|
/**
|
|
* Apply middle table conditions for a many-to-many relationship.
|
|
*
|
|
* Usage example:
|
|
* `->columnsWhere(['column' => $value])`
|
|
*/
|
|
public function columnsWhere(array $where) : self
|
|
{
|
|
if ($this->relationType !== Entity::MANY_MANY) {
|
|
throw new RuntimeException("Can't add columns where for not many-to-many relationship.");
|
|
}
|
|
|
|
$transformedWhere = $this->applyMiddleAliasToWhere($where);
|
|
|
|
$this->where($transformedWhere);
|
|
|
|
return $this;
|
|
}
|
|
|
|
protected function applyMiddleAliasToWhere(array $where) : array
|
|
{
|
|
$transformedWhere = [];
|
|
|
|
$middleName = lcfirst(
|
|
$this->entity->getRelationParam($this->relationName, 'relationName')
|
|
);
|
|
|
|
foreach ($where as $key => $value) {
|
|
$transformedKey = $key;
|
|
$transformedValue = $value;
|
|
|
|
if (is_int($key)) {
|
|
$transformedKey = $key;
|
|
}
|
|
|
|
if (
|
|
is_string($key) &&
|
|
strlen($key) &&
|
|
strpos($key, '.') === false &&
|
|
$key[0] === strtolower($key[0])
|
|
) {
|
|
$transformedKey = $middleName . '.' . $key;
|
|
}
|
|
|
|
if (is_array($value)) {
|
|
$transformedValue = $this->applyMiddleAliasToWhere($value);
|
|
}
|
|
|
|
$transformedWhere[$transformedKey] = $transformedValue;
|
|
}
|
|
|
|
return $transformedWhere;
|
|
}
|
|
|
|
/**
|
|
* Find related records by a criteria.
|
|
*/
|
|
public function find() : Collection
|
|
{
|
|
$query = $this->builder->build();
|
|
|
|
$related = $this->getMapper()->selectRelated($this->entity, $this->relationName, $query);
|
|
|
|
if ($related instanceof Collection) {
|
|
return $this->handleReturnCollection($related);
|
|
}
|
|
|
|
$collection = $this->entityManager->getCollectionFactory()->create($this->foreignEntityType);
|
|
$collection->setAsFetched();
|
|
|
|
if ($related instanceof Entity) {
|
|
$collection[] = $related;
|
|
}
|
|
|
|
return $collection;
|
|
}
|
|
|
|
/**
|
|
* Find a first related records by a criteria.
|
|
*/
|
|
public function findOne() : ?Entity
|
|
{
|
|
$collection = $this->sth()->limit(0, 1)->find();
|
|
|
|
foreach ($collection as $entity) {
|
|
return $entity;
|
|
}
|
|
|
|
return null;
|
|
}
|
|
|
|
/**
|
|
* Get a number of related records that meet criteria.
|
|
*/
|
|
public function count() : int
|
|
{
|
|
$query = $this->builder->build();
|
|
|
|
return $this->getMapper()->countRelated($this->entity, $this->relationName, $query);
|
|
}
|
|
|
|
|
|
/**
|
|
* Add JOIN.
|
|
*
|
|
* @see Espo\ORM\QueryParams\SelectBuilder::join()
|
|
*/
|
|
public function join($relationName, ?string $alias = null, ?array $conditions = null) : self
|
|
{
|
|
$this->builder->join($relationName, $alias, $conditions);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add LEFT JOIN.
|
|
*
|
|
* @see Espo\ORM\QueryParams\SelectBuilder::leftJoin()
|
|
*/
|
|
public function leftJoin($relationName, ?string $alias = null, ?array $conditions = null) : self
|
|
{
|
|
$this->builder->leftJoin($relationName, $alias, $conditions);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Set DISTINCT parameter.
|
|
*/
|
|
public function distinct() : self
|
|
{
|
|
$this->builder->distinct();
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Return STH collection. Recommended for fetching large number of records.
|
|
*/
|
|
public function sth() : self
|
|
{
|
|
$this->returnSthCollection = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add a WHERE clause.
|
|
*
|
|
* @see Espo\ORM\QueryParams\SelectBuilder::where()
|
|
*
|
|
* @param array|string $keyOrClause
|
|
* @param ?array|string $value
|
|
*/
|
|
public function where($keyOrClause = [], $value = null) : self
|
|
{
|
|
if ($this->isManyMany()) {
|
|
if (is_string($keyOrClause)) {
|
|
$keyOrClause = $this->applyRelationAliasToWhereClauseKey($keyOrClause);
|
|
} else
|
|
if (is_array($keyOrClause)) {
|
|
$keyOrClause = $this->applyRelationAliasToWhereClause($keyOrClause);
|
|
}
|
|
}
|
|
|
|
$this->builder->where($keyOrClause, $value);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Add a HAVING clause.
|
|
*
|
|
* @see Espo\ORM\QueryParams\SelectBuilder::having()
|
|
*/
|
|
public function having($keyOrClause = [], $value = null) : self
|
|
{
|
|
$this->builder->having($keyOrClause, $params2);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Apply ORDER.
|
|
*
|
|
* @see Espo\ORM\QueryParams\SelectBuilder::order()
|
|
*
|
|
* @param string|array|int $orderBy
|
|
* @param bool|string $direction
|
|
*/
|
|
public function order($orderBy, $direction = 'ASC') : self
|
|
{
|
|
$this->builder->order($orderBy, $direction);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Apply OFFSET and LIMIT.
|
|
*/
|
|
public function limit(?int $offset = null, ?int $limit = null) : self
|
|
{
|
|
$this->builder->limit($offset, $limit);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Specify SELECT. Which attributes to select. All attributes are selected by default.
|
|
*
|
|
* @see Espo\ORM\QueryParams\SelectBuilder::select()
|
|
*
|
|
* @param array|string $select
|
|
*/
|
|
public function select($select, ?string $alias = null) : self
|
|
{
|
|
$this->builder->select($select, $alias);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* Specify GROUP BY.
|
|
*/
|
|
public function groupBy(array $groupBy) : self
|
|
{
|
|
$this->builder->groupBy($groupBy);
|
|
|
|
return $this;
|
|
}
|
|
|
|
protected function getMiddleTableAlias() : ?string
|
|
{
|
|
if (!$this->isManyMany()) {
|
|
return null;
|
|
}
|
|
|
|
if (!$this->middleTableAlias) {
|
|
$middleName = $this->entity->getRelationParam($this->relationName, 'relationName');
|
|
|
|
if (!$middleName) {
|
|
throw new RuntimeException("No relation name.");
|
|
}
|
|
|
|
$this->middleTableAlias = lcfirst($middleName);
|
|
}
|
|
|
|
return $this->middleTableAlias;
|
|
}
|
|
|
|
protected function applyRelationAliasToWhereClauseKey(string $item) : string
|
|
{
|
|
if (!$this->isManyMany()) {
|
|
return $item;
|
|
}
|
|
|
|
$alias = $this->getMiddleTableAlias();
|
|
|
|
return str_replace('@relation.', $alias . '.', $item);
|
|
}
|
|
|
|
protected function applyRelationAliasToWhereClause(array $where) : array
|
|
{
|
|
if (!$this->isManyMany()) {
|
|
return $where;
|
|
}
|
|
|
|
$transformedWhere = [];
|
|
|
|
$alias = $this->getMiddleTableAlias();
|
|
|
|
foreach ($where as $key => $value) {
|
|
$transformedKey = $key;
|
|
$transformedValue = $value;
|
|
|
|
if (is_int($key)) {
|
|
$transformedKey = $key;
|
|
}
|
|
|
|
if (is_string($key)) {
|
|
$transformedKey = $this->applyRelationAliasToWhereClauseKey($key);
|
|
}
|
|
|
|
if (is_array($value)) {
|
|
$transformedValue = $this->applyRelationAliasToWhereClause($value);
|
|
}
|
|
|
|
$transformedWhere[$transformedKey] = $transformedValue;
|
|
}
|
|
|
|
return $transformedWhere;
|
|
}
|
|
|
|
protected function isManyMany() : bool
|
|
{
|
|
return $this->relationType === Entity::MANY_MANY;
|
|
}
|
|
|
|
protected function handleReturnCollection(SthCollection $collection) : Collection
|
|
{
|
|
if ($this->returnSthCollection) {
|
|
return $collection;
|
|
}
|
|
|
|
return $this->entityManager->getCollectionFactory()->createFromSthCollection($collection);
|
|
}
|
|
}
|