Feature/refactor crud2

demos/crud.php

@@ -2,9 +2,29 @@
 
 require 'init.php';
 require 'database.php';
+$m = new Country($db);
+//$m->getAction('edit')->system =true;
+//$m->getAction('delete')->system =true;
 
 $g = $app->add(['CRUD', 'ipp'=>5]);
-$g->setModel(new Country($db));
+$g->setModel($m);
+
+// callback for model action edit form.
+$g->onEditAction(function ($form) {
+    $form->js(true, $form->getField('name')->jsInput()->attr('readonly', true));
+});
+
+// callback for model action add form.
+$g->onAddAction(function ($form) {
+    $form->js(true, $form->getField('iso')->jsInput()->val('WW'));
+});
+
+// callback for both model action edit and add.
+$g->onAction(function ($form, $ex) {
+    $form->onSubmit(function ($f) use ($ex) {
+        return [$ex->hide(), new \atk4\ui\jsToast('Submit all right! This demo does not saved data.')];
+    });
+});
 
 $app->add(['ui'=>'divider']);
 
@@ -16,13 +36,13 @@
 $crud = $cc->add([
     'CRUD',
     //'fieldsCreate' => ['name', 'iso', 'iso3', 'numcode', 'phonecode'], // when creating then show more fields
-    'fieldsDefault'=> ['name'], // when updating then only allow to update name
+    'displayFields'=> ['name'], // when updating then only allow to update name
+    'editFields'   => ['name', 'iso', 'iso3'],
     'ipp'          => 5,
     'paginator'    => ['range'=>2, 'class'=>['blue inverted']],  // reduce range on the paginator
     'menu'         => ['class'=>['green inverted']],
     'table'        => ['class'=>['red inverted']],
 ]);
-
 // Condition on the model can be applied on a model
 $m = new Country($db);
 $m->addCondition('numcode', '<', 200);

src/ActionExecutor/UserAction.php

@@ -289,15 +289,17 @@ protected function doFields(View $modal)
         $this->jsSetSubmitBtn($modal, $f, $this->step);
         $this->jsSetPrevHandler($modal, $this->step);
 
-        $f->onSubmit(function ($f) {
-            // collect fields.
-            $form_fields = $f->model->get();
-            foreach ($this->action->fields as $key => $field) {
-                $this->actionData['fields'][$field] = $form_fields[$field];
-            }
+        if (!$f->hookHasCallbacks('submit')) {
+            $f->onSubmit(function ($f) {
+                // collect fields.
+                $form_fields = $f->model->get();
+                foreach ($this->action->fields as $key => $field) {
+                    $this->actionData['fields'][$field] = $form_fields[$field];
+                }
 
-            return $this->jsStepSubmit($this->step);
-        });
+                return $this->jsStepSubmit($this->step);
+            });
+        }
     }
 
     /**
@@ -391,10 +393,6 @@ protected function jsGetExecute($obj, $id)
     {
         $success = is_callable($this->jsSuccess) ? call_user_func_array($this->jsSuccess, [$this, $this->action->owner, $id]) : $this->jsSuccess;
 
-//        if (is_array($success) || $success instanceof jsExpressionable) {
-//            return $success;
-//        }
-
         return [
             $this->hide(),
             $this->hook('afterExecute', [$obj, $id]) ?:
@@ -520,8 +518,7 @@ protected function setFormField(Form $form, array $fields, string $step) :Form
         foreach ($fields as $k => $val) {
             $form->getField($k)->set($val);
         }
-
-        $form->hook('onStep', [$step]);
+        $this->hook('onStep', [$step, $form]);
 
         return $form;
     }

src/CRUD.php

@@ -14,100 +14,88 @@
  */
 class CRUD extends Grid
 {
-    /** @var array of fields to show */
-    public $fieldsDefault = null;
+    /** @var array of fields to display in Grid */
+    public $displayFields = null;
 
-    /** @var array of fields to show in grid */
-    public $fieldsRead = null;
+    /** @var array of fields to edit in Form */
+    public $editFields = null;
 
-    /** @var array Default action to perform when adding or editing is successful * */
-    public $notifyDefault = ['jsNotify', 'content' => 'Data is saved!', 'color'   => 'green'];
+    /** @var array Default notifier to perform when adding or editing is successful * */
+    public $notifyDefault = ['jsToast', 'settings'=> ['message' => 'Data is saved!', 'class' => 'success']];
 
-    /** @var array Action to perform when adding is successful * */
-    public $notifyCreate = null;
+    /** @var string default js action executor class in UI for model action. */
+    public $jsExecutor = jsUserAction::class;
 
-    /** @var array Action to perform when editing is successful * */
-    public $notifyUpdate = null;
+    /** @var string default action executor class in UI for model action. */
+    public $executor = UserAction::class;
 
     /**
      * Sets data model of CRUD.
      *
      * @param \atk4\data\Model $m
-     * @param array            $defaultFields
+     * @param array            $fields
      *
      * @throws Exception
      * @throws \atk4\core\Exception
      *
      * @return \atk4\data\Model
      */
-    public function setModel(\atk4\data\Model $m, $defaultFields = null)
+    public function setModel(\atk4\data\Model $m, $fields = null)
     {
-        if ($defaultFields !== null) {
-            $this->fieldsDefault = $defaultFields;
+        if ($fields !== null) {
+            $this->displayFields = $fields;
         }
 
-        parent::setModel($m, $this->fieldsRead ?: $this->fieldsDefault);
+        parent::setModel($m, $this->displayFields);
+
         $this->model->unload();
 
         foreach ($m->getActions(Generic::SINGLE_RECORD) as $single_record_action) {
-            if ($single_record_action->short_name === 'edit') {
-                // if edit then this executor is ok.
-                $executor = $this->owner->factory($single_record_action->ui['executor'] ?? UserAction::class);
-
-                $single_record_action->ui['executor'] = $executor;
-                $executor->addHook('afterExecute', function ($x) {
-                    return $this->jsSave($this->notifyDefault);
-                });
-            } elseif ($single_record_action->short_name === 'delete') {
-                // if delete then we need this executor.
-                $executor = $this->owner->factory($single_record_action->ui['executor'] ?? jsUserAction::class);
-                $single_record_action->ui['executor'] = $executor;
-
-                $executor->addHook('afterExecute', function ($x) {
-                    return (new jQuery())->closest('tr')->transition('fade left');
-                });
-            }
-
+            $executor = $this->factory($this->getActionExecutor($single_record_action));
+            $single_record_action->fields = ($executor instanceof jsUserAction) ? false : $this->editFields ?? true;
+            $single_record_action->ui['executor'] = $executor;
+            $executor->addHook('afterExecute', function ($x, $m, $id) {
+                return $m->loaded() ? $this->jsSave($this->notifyDefault) : $this->jsDelete();
+            });
             $this->addAction($single_record_action);
         }
 
-//        foreach ($m->getActions(Generic::NO_RECORDS) as $single_record_action) {
-//            $executor = $this->owner->add($single_record_action->ui['executor'] ?? UserAction::class);
-//            $executor->addHook('afterExecute', function ($x, $action_result) {
-//                if ($action_result === []) {
-//                    // row was deleted
-//                } else {
-//                    return $this->container->jsReload();
-//                }
-//            });
-//            $executor->setAction($single_record_action);
-//
-//            $this->menu->addItem('add')->on('click', $single_record_action);
-//
-//            //$single_record_action->ui['executor'] = [UserAction::class, 'jsSuccess'=>];
-//            //$this->addAction($single_record_action);
-//        }
+        foreach ($m->getActions(Generic::NO_RECORDS) as $single_record_action) {
+            $executor = $this->factory($this->getActionExecutor($single_record_action));
+            $single_record_action->fields = ($executor instanceof jsUserAction) ? false : $this->editFields ?? true;
+            $single_record_action->ui['executor'] = $executor;
+            $executor->addHook('afterExecute', function ($x, $m, $id) {
+                return $m->loaded() ? $this->jsSave($this->notifyDefault) : $this->jsDelete();
+            });
+            $btn = $this->menu->addItem(['Add new '.$this->model->getModelCaption(), 'icon' => 'plus']);
+            $btn->on('click.atk_CRUD', $single_record_action, [$this->name.'_sort' => $this->getSortBy()]);
+        }
 
         return $this->model;
     }
 
+    /**
+     * Return proper action executor base on model action.
+     *
+     * @param $action
+     *
+     * @throws \atk4\core\Exception
+     *
+     * @return object
+     */
+    protected function getActionExecutor($action)
+    {
+        $executor = (!$action->args && !$action->fields && !$action->preview) ? $this->jsExecutor : $this->executor;
+
+        return $this->factory($executor);
+    }
+
     /**
      * Apply ordering to the current model as per the sort parameters.
      */
     public function applySort()
     {
         parent::applySort();
-
-        if ($this->getSortBy() && $this->itemCreate) {
-            //Remove previous click handler to Add new Item button and attach new one using sort argument.
-            $this->container->js(true, $this->itemCreate->js()->off('click.atk_CRUD'));
-            $this->container->js(true,
-                                 $this->itemCreate->js()->on('click.atk_CRUD',
-                                 new jsFunction([
-                                     new jsModal('Add new', $this->pageCreate, [$this->name.'_sort' => $this->getSortBy()]),
-                                 ]))
-            );
-        }
     }
 
     /**
@@ -120,14 +108,86 @@ public function applySort()
     public function jsSave($notifier)
     {
         return [
-            // close modal
-//            new jsExpression('$(".atk-dialog-content").trigger("close")'),
-
-            // display notification
             $this->factory($notifier, null, 'atk4\ui'),
-
             // reload Grid Container.
             $this->container->jsReload([$this->name.'_sort' => $this->getSortBy()]),
         ];
     }
+
+    /**
+     *  Return js statement necessary to remove a row in Grid when
+     *  use in $(this) context.
+     *
+     * @return mixed
+     */
+    public function jsDelete()
+    {
+        return (new jQuery())->closest('tr')->transition('fade left');
+    }
+
+    /**
+     * Set callback for edit action in CRUD.
+     * Callback function will receive the Edit Form and Executor as param.
+     *
+     * @param callable $fx
+     *
+     * @throws Exception
+     */
+    public function onEditAction(callable $fx)
+    {
+        $this->setOnActionForm($fx, 'edit');
+    }
+
+    /**
+     * Set callback for add action in CRUD.
+     * Callback function will receive the Edit Form and Executor as param.
+     *
+     * @param callable $fx
+     *
+     * @throws Exception
+     */
+    public function onAddAction(callable $fx)
+    {
+        $this->setOnActionForm($fx, 'add');
+    }
+
+    /**
+     * Set callback for both edit and add action form.
+     * Callback function will receive Forms and Executor as param.
+     *
+     * @param callable $fx
+     *
+     * @throws Exception
+     */
+    public function onAction(callable $fx)
+    {
+        $this->onEditAction($fx);
+        $this->onAddAction($fx);
+    }
+
+    /**
+     * Set onAction callback using UserAction executor.
+     *
+     * @param callable $fx
+     * @param string   $actionName
+     *
+     * @throws Exception
+     * @throws \atk4\core\Exception
+     * @throws \atk4\data\Exception
+     */
+    public function setOnActionForm(callable $fx, string $actionName)
+    {
+        if (!$this->model) {
+            throw new Exception('Model need to be set prior to use on Form');
+        }
+
+        $ex = $this->model->getAction($actionName)->ui['executor'];
+        if ($ex && $ex instanceof UserAction) {
+            $ex->addHook('onStep', function ($ex, $step, $form) use ($fx) {
+                if ($step === 'fields') {
+                    return call_user_func($fx, $form, $ex);
+                }
+            });
+        }
+    }
 }

src/View.php

@@ -1156,7 +1156,7 @@ public function on($event, $selector = null, $action = null, $defaults = null)
             $actions[] = $cb;
         } elseif ($action instanceof Generic) {
             // Setup UserAction executor.
-            if ($action->ui['executor'] ?? null) {
+            if (isset($action->ui['executor'])) {
                 $class = $action->ui['executor'];
             } elseif (isset($defaults['executor'])) {
                 $class = $defaults['executor'];
@@ -1172,10 +1172,10 @@ public function on($event, $selector = null, $action = null, $defaults = null)
                 if (isset($arguments[0])) {
                     $arguments[$ex->name] = $arguments[0];
                 }
-                if ($arguments['id'] ?? null) {
+                if (isset($arguments['id'])) {
                     $arguments[$ex->name] = $arguments['id'];
                     unset($arguments['id']);
-                } elseif ($arguments[0] ?? null) {
+                } elseif (isset($arguments[0])) {
                     // if id is not specify we assume arguments[0] is the model id.
                     $arguments[$ex->name] = $arguments[0];
                     unset($arguments[0]);

src/jsToast.php

@@ -2,13 +2,17 @@
 
 namespace atk4\ui;
 
+use atk4\core\DIContainerTrait;
+
 /**
  * Class jsToast
  * Generate a Fomantic-ui toast module command in js.
  *  $('body').toast({options}).
  */
 class jsToast implements jsExpressionable
 {
+    use DIContainerTrait;
+
     /**
      * Various setting options as per Fomantic ui toast module.
      *