UserAction StepExecutor improvement

demos/_includes/DemoActionsUtil.php

@@ -6,9 +6,40 @@
 
 use Atk4\Data\Model;
 use Atk4\Data\Model\UserAction;
+use Atk4\Data\Persistence\Array_;
 use Atk4\Ui\Exception;
 use Atk4\Ui\Form;
 
+/**
+ *  @property string $age    @Atk4\Field()
+ *  @property string $city   @Atk4\Field()
+ *  @property string $gender @Atk4\Field()
+ */
+class ArgModel extends Model
+{
+    protected function init(): void
+    {
+        parent::init();
+        $this->addField($this->fieldName()->age, ['type' => 'integer', 'required' => true, 'caption' => 'Age must be 21 or over:']);
+        $this->addField($this->fieldName()->city);
+        $this->addField($this->fieldName()->gender, [
+            'default' => 'm',
+            'ui' => ['form' => [Form\Control\Dropdown::class, 'values' => ['m' => 'Male', 'f' => 'Female']],
+            ],
+        ]);
+    }
+
+    public function validate(string $intent = null): array
+    {
+        $error = [];
+        if ($this->get(self::hinting()->fieldName()->age) < 21) {
+            $error = [self::hinting()->fieldName()->age => 'You must be at least 21 years old.'];
+        }
+
+        return array_merge($error, parent::validate($intent));
+    }
+}
+
 class DemoActionsUtil
 {
     public static function setupDemoActions(Country $country): void
@@ -135,5 +166,23 @@ public static function setupDemoActions(Country $country): void
                 return 'Gender = ' . $gender . ' / Age = ' . $age;
             },
         ]);
+
+        $country->addUserAction('arg_using_model', [
+            'caption' => 'Arg with Model',
+            'description' => 'Ask for Arguments set via a Data\Model. Allow usage of model validate() for your arguments',
+            'args' => [
+                '__atk_model' => new ArgModel(new Array_([])),
+                'extra' => ['type' => 'string'],
+            ],
+            'fields' => [$country->fieldName()->iso3],
+            'callback' => function (Country $model, int $age, string $city, string $gender) {
+                $n = $gender === 'm' ? 'Mr.' : 'Mrs.';
+
+                return 'Thank you ' . $n . ' at age ' . $age;
+            },
+            'preview' => function (Country $model, int $age, string $city, string $gender) {
+                return 'Gender = ' . $gender . ' / Age = ' . $age;
+            },
+        ]);
     }
 }

src/UserAction/StepExecutorTrait.php

@@ -7,6 +7,7 @@
 use Atk4\Core\Factory;
 use Atk4\Data\Model;
 use Atk4\Data\Model\UserAction;
+use Atk4\Data\Persistence\Array_;
 use Atk4\Data\ValidationException;
 use Atk4\Ui\Button;
 use Atk4\Ui\Form;
@@ -70,6 +71,9 @@ trait StepExecutorTrait
     /** @var string */
     public $finalMsg = 'Complete!';
 
+    /** @var array An extended copy of UserAction arguments. It contains original action arguments and arguments set by '__atk_model'. */
+    private $cloneArgs;
+
     /**
      * Utility for setting Title for each step.
      */
@@ -107,12 +111,47 @@ protected function setFormField(Form $form, array $fields, string $step): Form
         return $form;
     }
 
+    /**
+     * Set model for userAction arguments.
+     * Override existing argument with model definition.
+     */
+    protected function initActionArguments(): Model
+    {
+        $args = $this->getAction()->args;
+        if (array_key_exists('__atk_model', $args)) {
+            /** @var Model $argsModel */
+            $argsModel = Factory::factory($args['__atk_model']);
+            // if seed is supplied, we need to initialize
+            if (!$argsModel->isInitialized()) {
+                $argsModel->invokeInit();
+            }
+
+            unset($args['__atk_model']);
+        } else {
+            $argsModel = new Model(new Array_([]));
+        }
+
+        foreach ($args as $key => $val) {
+            $argsModel->addField($key, $val);
+        }
+
+        $this->cloneArgs = [];
+        // set userAction args using model field
+        foreach ($argsModel->getFields('editable') as $k => $field) {
+            $this->cloneArgs[$k] = $field->shortName;
+        }
+
+        return $argsModel;
+    }
+
     protected function runSteps(): void
     {
-        $this->loader->set(function (Loader $p) {
+        $argModel = $this->initActionArguments();
+
+        $this->loader->set(function (Loader $p) use ($argModel) {
             switch ($this->step) {
                 case 'args':
-                    $this->doArgs($p);
+                    $this->doArgs($p, $argModel);
 
                     break;
                 case 'fields':
@@ -131,23 +170,13 @@ protected function runSteps(): void
         });
     }
 
-    protected function doArgs(View $page): void
+    protected function doArgs(View $page, Model $model): void
     {
         $this->addStepTitle($page, $this->step);
 
         $form = $this->addFormTo($page);
-        foreach ($this->action->args as $key => $val) {
-            if ($val instanceof Model) {
-                $val = ['model' => $val];
-            }
 
-            if (isset($val['model'])) {
-                $val['model'] = Factory::factory($val['model']);
-                $form->addControl($key, [Form\Control\Lookup::class])->setModel($val['model']);
-            } else {
-                $form->addControl($key, [], $val);
-            }
-        }
+        $form->setModel($model->createEntity());
 
         // set args value if available
         $this->setFormField($form, $this->getActionData('args'), $this->step);
@@ -157,8 +186,9 @@ protected function doArgs(View $page): void
         $this->jsSetPrevHandler($page, $this->step);
 
         $form->onSubmit(function (Form $form) {
+            $form->model->save();
             // collect arguments
-            $this->setActionDataFromModel('args', $form->model, array_keys($form->model->getFields()));
+            $this->setActionDataFromModel('args', $form->model, array_keys($form->model->getFields('editable')));
 
             return $this->jsStepSubmit($this->step);
         });
@@ -491,7 +521,7 @@ protected function getActionPreview()
     {
         $args = [];
 
-        foreach ($this->action->args as $key => $val) {
+        foreach ($this->cloneArgs as $key => $val) {
             $args[] = $this->getActionData('args')[$key];
         }
 
@@ -505,7 +535,7 @@ protected function getActionArgs(array $data): array
     {
         $args = [];
 
-        foreach ($this->action->args as $key => $val) {
+        foreach ($this->cloneArgs as $key => $val) {
             $args[] = $data[$key];
         }