Fixes #40: Added public method `yii\data\ActiveDataProvider::prepareQ…

…uery()` for debug facilitation

CHANGELOG.md

@@ -4,4 +4,5 @@ Yii Active Record Change Log
 3.0.0 under development
 -----------------------
 
+- Enh #40:  Added public method `yii\data\ActiveDataProvider::prepareQuery()` for debug facilitation (GHopperMSK)
 - Enh #34: Adjustments to new DI and events replacements (fabriziocaldarelli)

src/data/ActiveDataProvider.php

@@ -23,14 +23,14 @@
  * The following is an example of using ActiveDataProvider to provide ActiveRecord instances:
  *
  * ```php
- * $provider = new ActiveDataProvider( 
+ * $provider = new ActiveDataProvider(
  *      Yii::$app->db,
  *      Post::find()
  * );
  * $provider->pagination' => [
  *     'pageSize' => 20,
  * ];
- * 
+ *
  *
  * // get the posts in the current page
  * $posts = $provider->getModels(); // or $provider->models
@@ -47,7 +47,7 @@
  * $provider->pagination' => [
  *     'pageSize' => 20,
  * ];
- * 
+ *
  *
  * // get the posts in the current page
  * $posts = $provider->getModels();  // or $provider->models
@@ -100,6 +100,17 @@ public function __construct(ConnectionInterface $db, QueryInterface $query)
      * {@inheritdoc}
      */
     protected function prepareModels()
+    {
+        $query = $this->prepareQuery();
+        return $query->all($this->db);
+    }
+
+    /**
+     * Prepares the sql-query that will get the data for current page.
+     * @return QueryInterface
+     * @throws InvalidConfigException
+     */
+    public function prepareQuery()
     {
         if (!$this->query instanceof QueryInterface) {
             throw new InvalidConfigException('The "query" property must be an instance of a class that implements the QueryInterface e.g. yii\db\Query or its subclasses.');
@@ -108,15 +119,15 @@ protected function prepareModels()
         if (($pagination = $this->getPagination()) !== false) {
             $pagination->totalCount = $this->getTotalCount();
             if ($pagination->totalCount === 0) {
-                return [];
+                $query->emulateExecution();
             }
             $query->limit($pagination->getLimit())->offset($pagination->getOffset());
         }
         if (($sort = $this->getSort()) !== false) {
             $query->addOrderBy($sort->getOrders());
         }
 
-        return $query->all($this->db);
+        return $query;
     }
 
     /**