dedup load across persistences

Author: mvorisek

phpstan.neon.dist

@@ -23,10 +23,6 @@ parameters:
         # for src/FieldSqlExpression.php
         - '~^Call to an undefined method Atk4\\Data\\Model\:\:expr\(\)\.$~'
         # for src/Model.php
-        - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:load\(\)\.$~'
-        - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:tryLoad\(\)\.$~'
-        - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:loadAny\(\)\.$~'
-        - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:tryLoadAny\(\)\.$~'
         - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:update\(\)\.$~'
         - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:insert\(\)\.$~'
         - '~^Call to an undefined method Atk4\\Data\\Persistence\:\:export\(\)\.$~'

src/Persistence.php

@@ -20,6 +20,11 @@ class Persistence
     /** @const string */
     public const HOOK_AFTER_ADD = self::class . '@afterAdd';
 
+    /** @const string */
+    protected const ID_LOAD_ONE = self::class . '@idLoadOne';
+    /** @const string */
+    protected const ID_LOAD_ANY = self::class . '@idLoadAny';
+
     /**
      * Connects database.
      *
@@ -113,6 +118,53 @@ public function getDatabasePlatform(): Platforms\AbstractPlatform
         return new Persistence\GenericPlatform();
     }
 
+    /**
+     * Tries to load data record, but will not fail if record can't be loaded.
+     *
+     * @param mixed $id
+     */
+    public function tryLoad(Model $model, $id): ?array
+    {
+        throw new Exception('Not implemented'); // finish in https://github.com/atk4/data/pull/847
+    }
+
+    /**
+     * Loads a record from model and returns a associative array.
+     *
+     * @param mixed $id
+     */
+    public function load(Model $model, $id): array
+    {
+        $data = $this->tryLoad($model, $id);
+
+        if (!$data) {
+            $noId = $id === self::ID_LOAD_ONE || $id === self::ID_LOAD_ANY;
+
+            throw (new Exception('No record was found', 404))
+                ->addMoreInfo('model', $model)
+                ->addMoreInfo('id', $noId ? null : $id)
+                ->addMoreInfo('scope', $model->scope()->toWords());
+        }
+
+        return $data;
+    }
+
+    /**
+     * Tries to load any one record.
+     */
+    public function tryLoadAny(Model $model): ?array
+    {
+        return $this->tryLoad($model, self::ID_LOAD_ANY);
+    }
+
+    /**
+     * Loads any one record.
+     */
+    public function loadAny(Model $model): array
+    {
+        return $this->load($model, self::ID_LOAD_ANY);
+    }
+
     /**
      * Will convert one row of data from native PHP types into
      * persistence types. This will also take care of the "actual"

src/Persistence/Array_.php

@@ -161,7 +161,7 @@ public function load(Model $model, $id, string $table = null): array
     /**
      * Tries to load first available record and return data record.
      */
-    public function loadAny(Model $model, string $table = null): ?array
+    public function loadAny(Model $model, string $table = null): array
     {
         $row = $this->tryLoadAny($model, $table);
         if ($row === null) {

src/Persistence/Array_/Join.php

@@ -6,9 +6,12 @@
 
 use Atk4\Data\Exception;
 use Atk4\Data\Model;
+use Atk4\Data\Persistence;
 
 /**
  * Provides model joining functionality specific for the Array_ persistence.
+ *
+ * @property Persistence\Array_|null $persistence
  */
 class Join extends Model\Join
 {
@@ -51,7 +54,8 @@ public function afterLoad(): void
         }
 
         try {
-            $data = $model->persistence->load($model, $this->id, $this->foreign_table);
+            $data = Persistence\Array_::assertInstanceOf($model->persistence)
+                ->load($model, $this->id, $this->foreign_table);
         } catch (Exception $e) {
             throw (new Exception('Unable to load joined record', $e->getCode(), $e))
                 ->addMoreInfo('table', $this->foreign_table)

src/Persistence/Sql.php

@@ -30,11 +30,6 @@ class Sql extends Persistence
     /** @const string */
     public const HOOK_BEFORE_DELETE_QUERY = self::class . '@beforeDeleteQuery';
 
-    /** @const string */
-    protected const ID_LOAD_ONE = self::class . '@idLoadOne';
-    /** @const string */
-    protected const ID_LOAD_ANY = self::class . '@idLoadAny';
-
     /**
      * Connection object.
      *
@@ -667,11 +662,6 @@ public function action(Model $model, string $type, array $args = [])
         return $query;
     }
 
-    /**
-     * Tries to load data record, but will not fail if record can't be loaded.
-     *
-     * @param mixed $id
-     */
     public function tryLoad(Model $model, $id): ?array
     {
         $noId = $id === self::ID_LOAD_ONE || $id === self::ID_LOAD_ANY;
@@ -718,43 +708,6 @@ public function tryLoad(Model $model, $id): ?array
         return $data;
     }
 
-    /**
-     * Loads a record from model and returns a associative array.
-     *
-     * @param mixed $id
-     */
-    public function load(Model $model, $id): array
-    {
-        $data = $this->tryLoad($model, $id);
-
-        if (!$data) {
-            $noId = $id === self::ID_LOAD_ONE || $id === self::ID_LOAD_ANY;
-
-            throw (new Exception('No record was found', 404))
-                ->addMoreInfo('model', $model)
-                ->addMoreInfo('id', $noId ? null : $id)
-                ->addMoreInfo('scope', $model->scope()->toWords());
-        }
-
-        return $data;
-    }
-
-    /**
-     * Tries to load any one record.
-     */
-    public function tryLoadAny(Model $model): ?array
-    {
-        return $this->tryLoad($model, self::ID_LOAD_ANY);
-    }
-
-    /**
-     * Loads any one record.
-     */
-    public function loadAny(Model $model): array
-    {
-        return $this->load($model, self::ID_LOAD_ANY);
-    }
-
     /**
      * Inserts record in database and returns new record ID.
      */

src/Persistence/Sql/Join.php

@@ -13,7 +13,6 @@
  * Provides model joining functionality specific for the Sql persistence.
  *
  * @property Persistence\Sql $persistence
- * @property static          $join
  */
 class Join extends Model\Join implements \Atk4\Dsql\Expressionable
 {