Clone user actions for entity lazily

Author: mvorisek

src/Model.php

@@ -437,11 +437,15 @@ public function createEntity(): self
     {
         $this->assertIsModel();
 
-        $this->_model = $this;
+        $userActionsBackup = $this->userActions;
         try {
+            $this->_model = $this;
+            $this->userActions = [];
+
             $model = clone $this;
         } finally {
             $this->_model = null;
+            $this->userActions = $userActionsBackup;
         }
         $model->_entityId = null;
 
@@ -458,6 +462,8 @@ public function createEntity(): self
      */
     protected function init(): void
     {
+        $this->assertIsModel();
+
         $this->_init();
 
         if ($this->id_field) {

src/Model/UserAction.php

@@ -79,6 +79,32 @@ class UserAction
     /** @var bool Atomic action will automatically begin transaction before and commit it after completing. */
     public $atomic = true;
 
+    /**
+     * Return model associated with this action.
+     */
+    public function getModel(): Model
+    {
+        return $this->getOwner()->getModel(true); // @phpstan-ignore-line
+    }
+
+    public function getEntity(): Model
+    {
+        if ($this->getOwner()->isEntity()) { // @phpstan-ignore-line
+            return $this->getOwner(); // @phpstan-ignore-line
+        }
+
+        if ($this->entity === null) {
+            $this->setEntity($this->getOwner()->createEntity()); // @phpstan-ignore-line
+        }
+
+        return $this->entity;
+    }
+
+    public function setEntity(Model $entity): void
+    {
+        $this->entity = $entity;
+    }
+
     /**
      * Attempt to execute callback of the action.
      *
@@ -210,32 +236,6 @@ public function getConfirmation()
         return $this->confirmation;
     }
 
-    /**
-     * Return model associated with this action.
-     */
-    public function getModel(): Model
-    {
-        return $this->getOwner()->getModel(true); // @phpstan-ignore-line
-    }
-
-    public function getEntity(): Model
-    {
-        if ($this->getOwner()->isEntity()) { // @phpstan-ignore-line
-            return $this->getOwner(); // @phpstan-ignore-line
-        }
-
-        if ($this->entity === null) {
-            $this->setEntity($this->getOwner()->createEntity()); // @phpstan-ignore-line
-        }
-
-        return $this->entity;
-    }
-
-    public function setEntity(Model $entity): void
-    {
-        $this->entity = $entity;
-    }
-
     public function getCaption(): string
     {
         return $this->caption ?? ucwords(str_replace('_', ' ', $this->short_name));

src/Model/UserActionsTrait.php

@@ -5,6 +5,7 @@
 namespace Atk4\Data\Model;
 
 use Atk4\Core\Factory;
+use Atk4\Data\Exception;
 
 trait UserActionsTrait
 {
@@ -28,6 +29,10 @@ trait UserActionsTrait
      */
     public function addUserAction(string $name, $defaults = []): UserAction
     {
+        if ($this->isEntity() && $this->getModel()->hasUserAction($name)) {
+            $this->assertIsModel();
+        }
+
         if ($defaults instanceof \Closure) {
             $defaults = ['callback' => $defaults];
         }
@@ -49,9 +54,27 @@ public function addUserAction(string $name, $defaults = []): UserAction
      */
     public function hasUserAction(string $name): bool
     {
+        if ($this->isEntity() && $this->getModel()->hasUserAction($name)) {
+            return true;
+        }
+
         return $this->_hasInCollection($name, 'userActions');
     }
 
+    private function addUserActionFromModel(string $name, UserAction $action): void
+    {
+        $this->assertIsEntity();
+        $action->getOwner()->assertIsModel();
+        if (\Closure::bind(fn () => $action->entity, null, UserAction::class)() !== null) {
+            throw new Exception('Model action entity is expected to be null');
+        }
+
+        // clone action and store it in entity
+        $action = clone $action;
+        $action->unsetOwner();
+        $this->_addIntoCollection($name, $action, 'userActions');
+    }
+
     /**
      * Returns list of actions for this model. Can filter actions by records they apply to.
      * It will also skip system user actions (where system === true).
@@ -62,6 +85,12 @@ public function hasUserAction(string $name): bool
      */
     public function getUserActions(string $appliesTo = null): array
     {
+        if ($this->isEntity()) {
+            foreach (array_diff_key($this->getModel()->getUserActions($appliesTo), $this->userActions) as $name => $action) {
+                $this->addUserActionFromModel($name, $action);
+            }
+        }
+
         return array_filter($this->userActions, function ($action) use ($appliesTo) {
             return !$action->system && ($appliesTo === null || $action->appliesTo === $appliesTo);
         });
@@ -72,6 +101,10 @@ public function getUserActions(string $appliesTo = null): array
      */
     public function getUserAction(string $name): UserAction
     {
+        if ($this->isEntity() && !$this->_hasInCollection($name, 'userActions') && $this->getModel()->hasUserAction($name)) {
+            $this->addUserActionFromModel($name, $this->getModel()->getUserAction($name));
+        }
+
         return $this->_getFromCollection($name, 'userActions');
     }
 
@@ -82,10 +115,12 @@ public function getUserAction(string $name): UserAction
      */
     public function removeUserAction(string $name)
     {
-        foreach ((array) $name as $action) {
-            $this->_removeFromCollection($action, 'userActions');
+        if ($this->isEntity() && $this->getModel()->hasUserAction($name)) {
+            $this->assertIsModel();
         }
 
+        $this->_removeFromCollection($name, 'userActions');
+
         return $this;
     }