Полностью переписан весь проект, потеряна обратная совместимость

Author: Smoren

src/Base/QueryRelationManagerBase.php

@@ -5,7 +5,7 @@
 
 /**
  * Class QueryRelationManagerException
- * @package Smoren\Yii2\QueryRelationManager
+ * @package Smoren\Yii2\QueryRelationManager\Base
  * @author Smoren <[email protected]>
  */
 class QueryRelationManagerException extends \Exception

src/Base/QueryRelationManagerException.php

@@ -4,41 +4,51 @@
 namespace Smoren\Yii2\QueryRelationManager\Base;
 
 
+/**
+ * Интерфейс для обертки ORM-класса запроса
+ * @package Smoren\Yii2\QueryRelationManager\Base
+ * @author Smoren <[email protected]>
+ */
 interface QueryWrapperInterface
 {
     /**
-     * @param array $arSelect
-     * @return $this
+     * Передача в запрос список выбираемых полей
+     * @param array $arSelect карта выбираемых полей ["fieldAlias" => "`table`.`fieldName`", ...]
+     * @return QueryWrapperInterface
      */
     public function select(array $arSelect): self;
 
     /**
-     * @param array $mapFrom
+     * Передача в запрос таблицы, из которой будет осуществляться выброка
+     * @param array $mapFrom имя и псевдоним таблицы ["tableAlias" => "tableName"]
      * @return $this
      */
     public function from(array $mapFrom): self;
 
     /**
-     * @param string $type
-     * @param array $mapTable
-     * @param string $condition
-     * @param array $extraJoinParams
+     * @param string $type тип присоединения ("inner", "left", "right")
+     * @param array $mapTable имя и псевдоним присоединяемой таблицы ["tableAlias" => "tableName"]
+     * @param string $condition условия присоединения
+     * @param array $extraJoinParams динамические параметры присоединения
      * @return $this
      */
     public function join(string $type, array $mapTable, string $condition, array $extraJoinParams = []): self;
 
     /**
-     * @param null $db
+     * Получение массива строк — результата запроса
+     * @param null $db объект подключения к БД
      * @return array
      */
     public function all($db = null): array;
 
     /**
+     * Получения объекта запроса
      * @return mixed
      */
     public function getQuery();
 
     /**
+     * Получение SQL-кода запроса
      * @return string
      */
     public function getRawSql(): string;

src/Base/QueryWrapperInterface.php

@@ -0,0 +1,99 @@
+<?php
+
+
+namespace Smoren\Yii2\QueryRelationManager\Base\Structs;
+
+/**
+ * Class JoinCondition
+ * Класс-хранилище данных join-отношения
+ * @package Smoren\Yii2\QueryRelationManager\Base\Structs
+ * @author Smoren <[email protected]>
+ */
+class JoinCondition
+{
+    /**
+     * Отношение "один к одному"
+     */
+    const TYPE_SINGLE = 1;
+
+    /**
+     * Отношение "один ко многим"
+     */
+    const TYPE_MULTIPLE = 2;
+
+    /**
+     * @var int тип отношения (1 — "один к одному" или 2 — "один ко многим")
+     */
+    public $type;
+
+    /**
+     * @var Table присоединяемая таблица
+     */
+    public $table;
+
+    /**
+     * @var Table таблица, к которой осуществляется присоединение
+     */
+    public $joinTo;
+
+    /**
+     * @var array основное условие присоединения
+     * ["поле присоединяемой таблицы" => "поле таблицы, к которой осуществляется присоединение", ...]
+     */
+    public $joinCondition;
+
+    /**
+     * @var string способ присоединения ("inner", "left", "right")
+     */
+    public $joinType;
+
+    /**
+     * @var string дополнительное условие присоединения
+     * Например: "and some_field = :some_value"
+     */
+    public $extraJoinCondition;
+
+    /**
+     * @var array значения параметров дополнительного условия присоединения
+     * Например: [":some_value" => "123", ...]
+     */
+    public $extraJoinParams;
+
+    /**
+     * JoinCondition constructor.
+     * @param int $type тип отношения (1 — "один к одному" или 2 — "один ко многим")
+     * @param Table $table таблица, к которой осуществляется присоединение
+     * @param Table $joinTo таблица, к которой осуществляется присоединение
+     * @param array $joinCondition основное условие присоединения
+     * @param string $joinType способ присоединения ("inner", "left", "right")
+     * @param string|null $extraJoinCondition string дополнительное условие присоединения
+     * @param array $extraJoinParams значения параметров дополнительного условия присоединения
+     */
+    public function __construct(
+        int $type, Table $table, Table $joinTo, array $joinCondition,
+        string $joinType = 'left', ?string $extraJoinCondition = null, array $extraJoinParams = []
+    )
+    {
+        $this->type = $type;
+        $this->table = $table;
+        $this->joinTo = $joinTo;
+        $this->joinCondition = $joinCondition;
+        $this->joinType = $joinType;
+        $this->extraJoinCondition = $extraJoinCondition;
+        $this->extraJoinParams = $extraJoinParams;
+    }
+
+    /**
+     * Возвращает часть SQL-запроса, содержащую условия присоединения таблицы
+     * @return string
+     */
+    public function stringify(): string
+    {
+        $joins = [];
+        foreach($this->joinCondition as $linkBy => $linkTo) {
+            $joins[] = "`{$this->table->alias}`.`{$linkBy}` = `{$this->joinTo->alias}`.`{$linkTo}`";
+        }
+
+        return implode(' AND ', $joins).' '.$this->extraJoinCondition;
+    }
+}

src/Base/Structs/JoinCondition.php

@@ -0,0 +1,90 @@
+<?php
+
+
+namespace Smoren\Yii2\QueryRelationManager\Base\Structs;
+
+
+use Smoren\Yii2\QueryRelationManager\Base\QueryRelationManagerException;
+
+/**
+ * Class JoinConditionManager
+ * Класс-коллекция объектов условий присоединения
+ * @package Smoren\Yii2\QueryRelationManager\Base\Structs
+ * @author Smoren <[email protected]>
+ */
+class JoinConditionCollection
+{
+    /**
+     * @var JoinCondition[] карта объектов условий присоединения по псевдониму присоединяемой таблицы
+     */
+    protected $mapByJoinAs = [];
+
+    /**
+     * @var JoinCondition[][] катра спика объектов условий присоединения по псевдониму таблицы, к которой осуществляется присоединение
+     */
+    protected $matrixByJoinTo = [];
+
+    /**
+     * Добавление объекта условия присоединения таблицы
+     * @param JoinCondition $condition условие присоединения таблицы
+     * @return $this
+     * @throws QueryRelationManagerException
+     */
+    public function add(JoinCondition $condition): self
+    {
+        if(isset($this->mapByJoinAs[$condition->table->alias])) {
+            throw new QueryRelationManagerException("duplicate table alias '{$condition->table->alias}'");
+        }
+        $this->mapByJoinAs[$condition->table->alias] = $condition;
+
+        if(!isset($this->matrixByJoinTo[$condition->joinTo->alias])) {
+            $this->matrixByJoinTo[$condition->joinTo->alias] = [];
+        }
+        if(isset($this->matrixByJoinTo[$condition->joinTo->alias][$condition->table->alias])) {
+            throw new QueryRelationManagerException("duplicate table alias '{$condition->table->alias}'");
+        }
+        $this->matrixByJoinTo[$condition->joinTo->alias][$condition->table->alias] = $condition;
+
+        return $this;
+    }
+
+    /**
+     * Получение объекта условия присоединения таблицы по ее псевдониму в запросе
+     * @param string $joinAs псевдоним присоединяемой таблицы
+     * @return JoinCondition
+     * @throws QueryRelationManagerException
+     */
+    public function byJoinAs(string $joinAs): JoinCondition
+    {
+        if(!isset($this->mapByJoinAs[$joinAs])) {
+            throw new QueryRelationManagerException("no condition found by table alias '{$joinAs}'");
+        }
+        return $this->mapByJoinAs[$joinAs];
+    }
+
+    /**
+     * Получение списка объекта условий присоединения таблиц по псевдониму таблицы, к которой осуществляется присоединение
+     * @param string $joinTo псевдоним таблицы, к которой осуществляется присоединение
+     * @return JoinCondition[]
+     */
+    public function byJoinTo(string $joinTo): array
+    {
+        if(!isset($this->matrixByJoinTo[$joinTo])) {
+            return [];
+        }
+        return $this->matrixByJoinTo[$joinTo];
+    }
+
+    /**
+     * Перебор коллекции
+     * @param callable $callback функция, которая будет запущена для каждого элемента коллекции с передачей оного в качестве аргумента
+     * @return $this
+     */
+    public function each(callable $callback): self
+    {
+        foreach($this->mapByJoinAs as $condition) {
+            $callback($condition);
+        }
+        return $this;
+    }
+}