Skip to content

EspoCRM – Open Source CRM Application

RDBRelation collection generic type

Yurii80f043354ea6
diff --git a/application/Espo/ORM/Repository/RDBRelation.php b/application/Espo/ORM/Repository/RDBRelation.php
index 9bad9707f2..edb832696d 100644
--- a/application/Espo/ORM/Repository/RDBRelation.php
+++ b/application/Espo/ORM/Repository/RDBRelation.php
@@ -98,7 +98,7 @@ class RDBRelation
/**
* Create a select builder.
*
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*
* @since 9.2.5
*/
@@ -228,7 +228,7 @@ class RDBRelation
* 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.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function join($target, ?string $alias = null, $conditions = null): Builder
{
@@ -242,7 +242,7 @@ class RDBRelation
* 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.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function leftJoin($target, ?string $alias = null, $conditions = null): Builder
{
@@ -252,7 +252,7 @@ class RDBRelation
/**
* Set DISTINCT parameter.
*
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function distinct(): Builder
{
@@ -262,7 +262,7 @@ class RDBRelation
/**
* Set to return STH collection. Recommended for fetching large number of records.
*
- * @return Builder<TEntity>
+ * @return Builder<TEntity, SthCollection<TEntity>>
*/
public function sth(): Builder
{
@@ -279,7 +279,7 @@ class RDBRelation
*
* @param WhereItem|array<string|int, mixed>|string $clause A key or where clause.
* @param array<int, mixed>|scalar|null $value A value. Should be omitted if the first argument is not string.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function where($clause = [], $value = null): Builder
{
@@ -296,7 +296,7 @@ class RDBRelation
*
* @param WhereItem|array<string|int, mixed>|string $clause A key or where clause.
* @param array<int, mixed>|string|null $value A value. Should be omitted if the first argument is not string.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function having($clause = [], $value = null): Builder
{
@@ -316,7 +316,7 @@ class RDBRelation
* An attribute to order by or an array or order items.
* Passing an array will reset a previously set order.
* @param (Order::ASC|Order::DESC)|bool|null $direction A direction.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function order($orderBy = Attribute::ID, $direction = null): Builder
{
@@ -326,7 +326,7 @@ class RDBRelation
/**
* Apply OFFSET and LIMIT.
*
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function limit(?int $offset = null, ?int $limit = null): Builder
{
@@ -346,7 +346,7 @@ class RDBRelation
* @param Selection|Selection[]|Expression|Expression[]|string[]|string|array<int, string[]|string> $select
* An array of expressions or one expression.
* @param string|null $alias An alias. Actual if the first parameter is not an array.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function select($select = [], ?string $alias = null): Builder
{
@@ -363,7 +363,7 @@ class RDBRelation
* * `groupBy([$expr1, $expr2, ...])`
*
* @param Expression|Expression[]|string|string[] $groupBy
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function group($groupBy): Builder
{
@@ -373,7 +373,7 @@ class RDBRelation
/**
* @deprecated Use `group` method.
* @param Expression|Expression[]|string|string[] $groupBy
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function groupBy($groupBy): Builder
{
@@ -387,7 +387,7 @@ class RDBRelation
* `->columnsWhere(['column' => $value])`
*
* @param WhereItem|array<string|int, mixed> $clause Where clause.
- * @return Builder<TEntity>
+ * @return Builder<TEntity, EntityCollection<TEntity>>
*/
public function columnsWhere($clause): Builder
{
diff --git a/application/Espo/ORM/Repository/RDBRelationSelectBuilder.php b/application/Espo/ORM/Repository/RDBRelationSelectBuilder.php
index 61b041a06d..ea8b03faf9 100644
--- a/application/Espo/ORM/Repository/RDBRelationSelectBuilder.php
+++ b/application/Espo/ORM/Repository/RDBRelationSelectBuilder.php
@@ -49,11 +49,13 @@ use Espo\ORM\Query\Part\Order;
use LogicException;
use RuntimeException;
use InvalidArgumentException;
+use UnexpectedValueException;
/**
* Builds select parameters for related records for RDB repository.
*
* @template TEntity of Entity = Entity
+ * @template TCollection of EntityCollection|SthCollection = EntityCollection<TEntity>
*/
class RDBRelationSelectBuilder
{
@@ -128,7 +130,7 @@ class RDBRelationSelectBuilder
* `->columnsWhere(['column' => $value])`
*
* @param WhereItem|array<int|string, mixed> $clause Where clause.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function columnsWhere($clause): self
{
@@ -187,7 +189,7 @@ class RDBRelationSelectBuilder
/**
* Find related records by a criteria.
*
- * @return EntityCollection<TEntity>|SthCollection<TEntity>
+ * @return TCollection
*/
public function find(): EntityCollection|SthCollection
{
@@ -198,7 +200,7 @@ class RDBRelationSelectBuilder
if ($related instanceof Collection) {
/** @var Collection<TEntity> $related */
- /** @var EntityCollection<TEntity>|SthCollection<TEntity> */
+ /** @var TCollection */
return $this->handleReturnCollection($related);
}
@@ -211,6 +213,7 @@ class RDBRelationSelectBuilder
$collection[] = $related;
}
+ /** @var TCollection */
return $collection;
}
@@ -259,7 +262,7 @@ class RDBRelationSelectBuilder
* 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.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function join($target, ?string $alias = null, $conditions = null): self
{
@@ -275,7 +278,7 @@ class RDBRelationSelectBuilder
* 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<int|string, mixed>|null $conditions Join conditions.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function leftJoin($target, ?string $alias = null, $conditions = null): self
{
@@ -287,7 +290,7 @@ class RDBRelationSelectBuilder
/**
* Set DISTINCT parameter.
*
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function distinct(): self
{
@@ -299,7 +302,7 @@ class RDBRelationSelectBuilder
/**
* Return STH collection. Recommended for fetching large number of records.
*
- * @return self<TEntity>
+ * @return self<TEntity, SthCollection<TEntity>>
*/
public function sth(): self
{
@@ -318,7 +321,7 @@ class RDBRelationSelectBuilder
*
* @param WhereItem|array<int|string, mixed>|string $clause A key or where clause.
* @param array<int, mixed>|scalar|null $value A value. Should be omitted if the first argument is not string.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function where($clause = [], $value = null): self
{
@@ -347,7 +350,7 @@ class RDBRelationSelectBuilder
*
* @param WhereItem|array<int|string, mixed>|string $clause A key or where clause.
* @param array<int, mixed>|string|null $value A value. Should be omitted if the first argument is not string.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function having($clause = [], $value = null): self
{
@@ -369,7 +372,7 @@ class RDBRelationSelectBuilder
* An attribute to order by or an array or order items.
* Passing an array will reset a previously set order.
* @param (Order::ASC|Order::DESC)|bool|null $direction Select::ORDER_ASC|Select::ORDER_DESC.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function order($orderBy = Attribute::ID, $direction = null): self
{
@@ -381,7 +384,7 @@ class RDBRelationSelectBuilder
/**
* Apply OFFSET and LIMIT.
*
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function limit(?int $offset = null, ?int $limit = null): self
{
@@ -403,7 +406,7 @@ class RDBRelationSelectBuilder
* @param Selection|Selection[]|Expression|Expression[]|string[]|string|array<int, string[]|string> $select
* An array of expressions or one expression.
* @param string|null $alias An alias. Actual if the first parameter is not an array.
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function select($select, ?string $alias = null): self
{
@@ -422,7 +425,7 @@ class RDBRelationSelectBuilder
* * `groupBy([$expr1, $expr2, ...])`
*
* @param Expression|Expression[]|string|string[] $groupBy
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function group($groupBy): self
{
@@ -434,7 +437,7 @@ class RDBRelationSelectBuilder
/**
* @deprecated Use `group` method.
* @param Expression|Expression[]|string|string[] $groupBy
- * @return self<TEntity>
+ * @return self<TEntity, TCollection>
*/
public function groupBy($groupBy): self
{
@@ -508,10 +511,14 @@ class RDBRelationSelectBuilder
/**
* @param Collection<TEntity> $collection
- * @return Collection<TEntity>
+ * @return EntityCollection<TEntity>|SthCollection<TEntity>
*/
- private function handleReturnCollection(Collection $collection): Collection
+ private function handleReturnCollection(Collection $collection): EntityCollection|SthCollection
{
+ if (!$collection instanceof EntityCollection && !$collection instanceof SthCollection) {
+ throw new UnexpectedValueException();
+ }
+
if (!$collection instanceof SthCollection) {
return $collection;
}
@@ -520,7 +527,7 @@ class RDBRelationSelectBuilder
return $collection;
}
- /** @var Collection<TEntity> */
+ /** @var EntityCollection<TEntity> */
return $this->entityManager->getCollectionFactory()->createFromSthCollection($collection);
}