Добавлен DataProvider

Author: Smoren

src/QueryRelationDataProvider.php

@@ -0,0 +1,101 @@
+<?php
+
+
+namespace Smoren\Yii2\QueryRelationManager;
+
+
+use yii\data\BaseDataProvider;
+use yii\db\Connection;
+use yii\db\Query;
+
+class QueryRelationDataProvider extends BaseDataProvider
+{
+    /**
+     * @var QueryRelationManager
+     */
+    public $queryRelationManager;
+
+    /**
+     * @var Connection|array|string the DB connection object or the application component ID of the DB connection.
+     * If not set, the default DB connection will be used.
+     * Starting from version 2.0.2, this can also be a configuration array for creating the object.
+     */
+    public $db;
+
+    /**
+     * @var string|callable имя столбца с ключом или callback-функция, возвращающие его
+     */
+    public $key;
+
+    /**
+     * Prepares the data models that will be made available in the current page.
+     * @return array the available data models
+     * @throws QueryRelationManagerException
+     */
+    protected function prepareModels()
+    {
+        $pagination = $this->getPagination();
+
+        if($pagination === false) {
+            $models = $this->queryRelationManager->all($this->db);
+        } else {
+            $limit = $pagination->getLimit();
+            $offset = $pagination->getOffset();
+
+            $pagination->totalCount = $this->getTotalCount();
+
+            $pkField = $this->queryRelationManager->getMainTablePkField();
+
+            $ids = $this->queryRelationManager
+                ->prepare()
+                ->select($pkField)
+                ->distinct()
+                ->limit($limit)
+                ->offset($offset)
+                ->column();
+
+            $models = $this->queryRelationManager->filter(function(Query $q) use ($pkField, $ids) {
+                $q->andWhere([$pkField => $ids]);
+            })->all();
+        }
+
+        return $models;
+    }
+
+    /**
+     * Prepares the keys associated with the currently available data models.
+     * @param array $models the available data models
+     * @return array the keys
+     */
+    protected function prepareKeys($models)
+    {
+        if($this->key !== null) {
+            $keys = [];
+
+            foreach($models as $model) {
+                if(is_string($this->key)) {
+                    $keys[] = $model[$this->key];
+                } else {
+                    $keys[] = call_user_func($this->key, $model);
+                }
+            }
+
+            return $keys;
+        } else {
+            return array_keys($models);
+        }
+    }
+
+    /**
+     * Returns a value indicating the total number of data models in this data provider.
+     * @return int total number of data models in this data provider.
+     */
+    protected function prepareTotalCount()
+    {
+        return $this->queryRelationManager
+            ->prepare()
+            ->select($this->queryRelationManager->getMainTablePkField())
+            ->distinct()
+            ->count();
+    }
+}

src/QueryRelationManager.php

@@ -20,15 +20,20 @@ class QueryRelationManager
     protected $query;
 
     /**
-     * @var string псевдоним таблицы, данные из которой хотим получить
+     * @var string псевдоним основной таблицы запроса
      */
     protected $mainTableAlias;
 
     /**
-     * @var string имя таблицы, данные из которой хотим получить
+     * @var string имя основной таблицы запроса
      */
     protected $mainTableName;
 
+    /**
+     * @var string первичный ключ основной таблицы запроса
+     */
+    protected $mainTablePkField;
+
     /**
      * @var callable[] список анонимных функций, которые будут модифицировать запрос
      */
@@ -342,37 +347,11 @@ public function all(?Connection $db = null): array
         return array_values($maps[$this->mainTableAlias]);
     }
 
-    /**
-     * Возвращает текст SQL-запроса
-     * @return string текст SQL-запроса
-     */
-    public function getRawSql(): string
-    {
-        $this->prepare();
-
-        return $this->query->createCommand()->getRawSql();
-    }
-
-    /**
-     * QueryRelationManager constructor.
-     * @param string $className имя класса сущности ActiveRecord
-     * @param string $alias псевдоним таблицы сущности
-     * @param string $fieldJoinTo имя поля, на которое будут ссылаться подключаемые сущности
-     * @param string $primaryFieldName имя поля первичного ключа таблицы
-     * @throws QueryRelationManagerException
-     */
-    protected function __construct(string $className, string $alias, string $fieldJoinTo, string $primaryFieldName = 'id')
-    {
-        $this->mainTableAlias = $alias;
-        $this->mainTableName = $this->getTableName($className);
-        $this->addAliases($className, $alias, $fieldJoinTo, $primaryFieldName);
-    }
-
     /**
      * Создает и выстраивает SQL-запрос
-     * @return $this
+     * @return Query
      */
-    protected function prepare(): self
+    public function prepare(): Query
     {
         $this->query = new Query();
 
@@ -403,7 +382,43 @@ protected function prepare(): self
             $modifier($this->query);
         }
 
-        return $this;
+        return $this->query;
+    }
+
+    /**
+     * Возвращает текст SQL-запроса
+     * @return string текст SQL-запроса
+     */
+    public function getRawSql(): string
+    {
+        $this->prepare();
+
+        return $this->query->createCommand()->getRawSql();
+    }
+
+    /**
+     * Возвращает первичный ключ основной таблицы с префиксом в виде алиаса этой таблицы
+     * @return string
+     */
+    public function getMainTablePkField(): string
+    {
+        return "{$this->mainTableAlias}.{$this->mainTableField}";
+    }
+
+    /**
+     * QueryRelationManager constructor.
+     * @param string $className имя класса сущности ActiveRecord
+     * @param string $alias псевдоним таблицы сущности
+     * @param string $fieldJoinTo имя поля, на которое будут ссылаться подключаемые сущности
+     * @param string $primaryFieldName имя поля первичного ключа таблицы
+     * @throws QueryRelationManagerException
+     */
+    protected function __construct(string $className, string $alias, string $fieldJoinTo, string $primaryFieldName = 'id')
+    {
+        $this->mainTableAlias = $alias;
+        $this->mainTableName = $this->getTableName($className);
+        $this->mainTableField = $fieldJoinTo;
+        $this->addAliases($className, $alias, $fieldJoinTo, $primaryFieldName);
     }
 
     /**