improve Model::$with phpdoc type

atk4 · Jan 16, 2022 · 6c64608 · 6c64608
1 parent 277c607
commit 6c64608
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/src/Model.php b/src/Model.php
@@ -147,7 +147,7 @@ class Model implements \IteratorAggregate
     /** @var array Array of set order by. */
     public $order = [];
 
-    /** @var array Array of WITH cursors set. */
+    /** @var array<string, array{'model': Model, 'mapping': array<int|string, string>, 'recursive': bool}> */
     public $with = [];
 
     /**
@@ -1075,7 +1075,7 @@ public function withId($id)
     public function addWith(self $model, string $alias, array $mapping = [], bool $recursive = false)
     {
         if (isset($this->with[$alias])) {
-            throw (new Exception('With cursor already set with this alias'))
+            throw (new Exception('With cursor already set with given alias'))
                 ->addMoreInfo('alias', $alias);
         }
 

diff --git a/src/Persistence/Sql.php b/src/Persistence/Sql.php
@@ -212,7 +212,6 @@ public function initQuery(Model $model): Query
             );
         }
 
-        // add With cursors
         $this->initWithCursors($model, $query);
 
         return $query;
@@ -223,11 +222,12 @@ public function initQuery(Model $model): Query
      */
     public function initWithCursors(Model $model, Query $query): void
     {
-        if (!$with = $model->with) {
+        $with = $model->with;
+        if (count($with) === 0) {
             return;
         }
 
-        foreach ($with as $alias => ['model' => $withModel, 'mapping' => $withMapping, 'recursive' => $recursive]) {
+        foreach ($with as $alias => ['model' => $withModel, 'mapping' => $withMapping, 'recursive' => $withRecursive]) {
             // prepare field names
             $fieldsFrom = $fieldsTo = [];
             foreach ($withMapping as $from => $to) {
@@ -237,14 +237,13 @@ public function initWithCursors(Model $model, Query $query): void
 
             // prepare sub-query
             if ($fieldsFrom) {
-                $withModel->setOnlyFields($fieldsFrom);
+                $withModel->setOnlyFields($fieldsFrom); // TODO this mutates model state
             }
             // 2nd parameter here strictly define which fields should be selected
             // as result system fields will not be added if they are not requested
             $subQuery = $withModel->action('select', [$fieldsFrom]);
 
-            // add With cursor
-            $query->with($subQuery, $alias, $fieldsTo ?: null, $recursive);
+            $query->with($subQuery, $alias, $fieldsTo ?: null, $withRecursive);
         }
     }