Callback/sticky args refactor

src/Callback.php

@@ -74,13 +74,23 @@ public function init(): void
             $this->urlTrigger = $this->name;
         }
 
-        $this->app->stickyGet($this->urlTrigger);
+        $this->setAppSticky();
     }
 
     public function setUrlTrigger(string $trigger)
     {
         $this->urlTrigger = $trigger;
-        $this->app->stickyGet($this->urlTrigger);
+        $this->setAppSticky();
+    }
+
+    /**
+     * Set app sticky argument only when using GET method.
+     */
+    public function setAppSticky()
+    {
+        if (!$this->isPostTriggered) {
+            $this->app->stickyGet($this->urlTrigger);
+        }
     }
 
     public function getUrlTrigger(): string
@@ -115,12 +125,8 @@ public function set($callback, $args = [])
      */
     public function terminateJson(View $view = null)
     {
-        if (!$view) {
-            $view = $this->owner;
-        }
-
         if ($this->canTerminate()) {
-            $this->app->terminateJson($view);
+            $this->app->terminateJson($view ?: $this->owner);
         }
     }
 
@@ -144,9 +150,9 @@ public function isTriggered(): bool
     }
 
     /**
-     * Return this callback mode.
+     * Return callback triggered value.
      */
-    public function getMode(): string
+    public function getTriggeredValue(): string
     {
         if ($this->isPostTriggered) {
             return  $_POST[$this->urlTrigger] ?? '';
@@ -159,26 +165,32 @@ public function getMode(): string
      * Return URL that will trigger action on this call-back. If you intend to request
      * the URL direcly in your browser (as iframe, new tab, or document location), you
      * should use getUrl instead.
-     *
-     * @param string $mode
-     *
-     * @return string
      */
-    public function getJsUrl($mode = 'ajax')
+    public function getJsUrl(string $value = 'ajax'): string
     {
-        return $this->owner->jsUrl([$this->urlTrigger => $mode, '__atk_callback' => 1]);
+        return $this->owner->jsUrl($this->getUrlArguments($value));
     }
 
     /**
      * Return URL that will trigger action on this call-back. If you intend to request
      * the URL loading from inside JavaScript, it's always advised to use getJsUrl instead.
      *
-     * @param string $mode
-     *
-     * @return string
      */
-    public function getUrl($mode = 'callback')
+    public function getUrl(string $value = 'callback'): string
     {
-        return $this->owner->url([$this->urlTrigger => $mode, '__atk_callback' => 1]);
+        return $this->owner->url($this->getUrlArguments($value));
+    }
+
+    /**
+     * Return proper url argument for this callback.
+     */
+    private function getUrlArguments(string $value): array
+    {
+        $args = ['__atk_callback' => 1];
+        if (!$this->isPostTriggered) {
+            $args[$this->urlTrigger] = $value;
+        }
+
+        return $args;
     }
 }

src/Component/InlineEdit.php

@@ -108,23 +108,21 @@ public function setModel(\atk4\data\Model $model)
         parent::setModel($model);
         $this->field = $this->field ? $this->field : $this->model->title_field;
         if ($this->autoSave && $this->model->loaded()) {
-            if ($this->cb->triggered()) {
-                $value = $_POST['value'] ? $_POST['value'] : null;
-                $this->cb->set(function () use ($value) {
-                    try {
-                        $this->model->set($this->field, $this->app->ui_persistence->typecastLoadField($this->model->getField($this->field), $value));
-                        $this->model->save();
-
-                        return $this->jsSuccess('Update successfully');
-                    } catch (ValidationException $e) {
-                        $this->app->terminateJson([
-                            'success' => true,
-                            'hasValidationError' => true,
-                            'atkjs' => $this->jsError(call_user_func($this->formatErrorMsg, $e, $value))->jsRender(),
-                        ]);
-                    }
-                });
-            }
+            $value = $_POST['value'] ?? null;
+            $this->cb->set(function () use ($value) {
+                try {
+                    $this->model->set($this->field, $this->app->ui_persistence->typecastLoadField($this->model->getField($this->field), $value));
+                    $this->model->save();
+
+                    return $this->jsSuccess('Update successfully');
+                } catch (ValidationException $e) {
+                    $this->app->terminateJson([
+                        'success' => true,
+                        'hasValidationError' => true,
+                        'atkjs' => $this->jsError(call_user_func($this->formatErrorMsg, $e, $value))->jsRender(),
+                    ]);
+                }
+            });
         }
 
         return $this->model;
@@ -213,15 +211,5 @@ protected function renderView(): void
             'url' => $this->cb->getJsUrl(),
             'saveOnBlur' => $this->saveOnBlur,
         ]);
-
-//        $this->js(true, (new JsVueService())->createAtkVue(
-//            '#'.$this->name,
-//            'atk-inline-edit',
-//            [
-//                'initValue'     => $initValue,
-//                'url'           => $this->cb->getJsUrl(),
-//                'saveOnBlur'    => $this->saveOnBlur,
-//            ]
-//        ));
     }
 }

src/Form/Control/Multiline.php

@@ -679,17 +679,15 @@ protected function renderView(): void
             throw new Exception('Multiline field needs to have it\'s model setup.');
         }
 
-        if ($this->cb->triggered()) {
-            $this->cb->set(function () {
-                try {
-                    return $this->renderCallback();
-                } catch (\atk4\Core\Exception $e) {
-                    $this->app->terminateJson(['success' => false, 'error' => $e->getMessage()]);
-                } catch (\Error $e) {
-                    $this->app->terminateJson(['success' => false, 'error' => $e->getMessage()]);
-                }
-            });
-        }
+        $this->cb->set(function () {
+            try {
+                return $this->renderCallback();
+            } catch (\atk4\Core\Exception $e) {
+                $this->app->terminateJson(['success' => false, 'error' => $e->getMessage()]);
+            } catch (\Error $e) {
+                $this->app->terminateJson(['success' => false, 'error' => $e->getMessage()]);
+            }
+        });
 
         $this->multiLine->template->trySetHtml('Input', $this->getInput());
         parent::renderView();

src/Form/Control/Upload.php

@@ -171,10 +171,10 @@ public function onDelete($fx = null)
         if (is_callable($fx)) {
             $this->hasDeleteCb = true;
             $action = $_POST['action'] ?? null;
-            if ($this->cb->triggered() && $action === 'delete') {
-                $this->_isCbRunning = true;
+            if ($action === 'delete') {
                 $fileName = $_POST['f_name'] ?? null;
                 $this->cb->set(function () use ($fx, $fileName) {
+                    $this->_isCbRunning = true;
                     $this->addJsAction(call_user_func_array($fx, [$fileName]));
 
                     return $this->jsActions;
@@ -193,31 +193,29 @@ public function onUpload($fx = null)
     {
         if (is_callable($fx)) {
             $this->hasUploadCb = true;
-            if ($this->cb->triggered()) {
-                $this->_isCbRunning = true;
-                $action = $_POST['action'] ?? null;
-                $files = $_FILES ?? null;
-                if ($files) {
-                    //set fileId to file name as default.
-                    $this->fileId = $files['file']['name'];
-                    // display file name to user as default.
-                    $this->setInput($this->fileId);
-                }
-                if ($action === 'upload' && !$files['file']['error']) {
-                    $this->cb->set(function () use ($fx, $files) {
-                        $this->addJsAction(call_user_func_array($fx, $files));
-                        //$value = $this->field ? $this->field->get() : $this->content;
-                        $this->addJsAction([
-                            $this->js()->atkFileUpload('updateField', [$this->fileId, $this->getInputValue()]),
-                        ]);
-
-                        return $this->jsActions;
-                    });
-                } elseif ($action === null || isset($files['file']['error'])) {
-                    $this->cb->set(function () use ($fx, $files) {
-                        return call_user_func($fx, 'error');
-                    });
-                }
+            $action = $_POST['action'] ?? null;
+            $files = $_FILES ?? null;
+            if ($files) {
+                //set fileId to file name as default.
+                $this->fileId = $files['file']['name'];
+                // display file name to user as default.
+                $this->setInput($this->fileId);
+            }
+            if ($action === 'upload' && !$files['file']['error']) {
+                $this->cb->set(function () use ($fx, $files) {
+                    $this->_isCbRunning = true;
+                    $this->addJsAction(call_user_func_array($fx, $files));
+                    //$value = $this->field ? $this->field->get() : $this->content;
+                    $this->addJsAction([
+                        $this->js()->atkFileUpload('updateField', [$this->fileId, $this->getInputValue()]),
+                    ]);
+
+                    return $this->jsActions;
+                });
+            } elseif ($action === null || isset($files['file']['error'])) {
+                $this->cb->set(function () use ($fx, $files) {
+                    return call_user_func($fx, 'error');
+                });
             }
         }
     }
@@ -230,9 +228,10 @@ protected function renderView(): void
         }
         parent::renderView();
 
-        if (!$this->_isCbRunning && (!$this->hasUploadCb || !$this->hasDeleteCb)) {
+        if (!$this->_isCbRunning && !isset($_GET['__atk_reload']) && (!$this->hasUploadCb || !$this->hasDeleteCb)) {
             throw new Exception('onUpload and onDelete callback must be called to use file upload. Missing one or both of them.');
         }
+
         if (!empty($this->accept)) {
             $this->template->trySet('accept', implode(',', $this->accept));
         }

src/JsCallback.php

@@ -168,7 +168,7 @@ public function getAjaxec($response, $chain = null): string
         return $ajaxec;
     }
 
-    public function getUrl($mode = 'callback')
+    public function getUrl(string $mode = 'callback'): string
     {
         throw new Exception('Do not use getUrl on JsCallback, use getJsUrl()');
     }

src/JsSortable.php

@@ -81,15 +81,13 @@ public function init(): void
     public function onReorder($fx = null)
     {
         if (is_callable($fx)) {
-            if ($this->triggered()) {
-                $sortOrders = explode(',', $_POST['order'] ?? '');
-                $source = $_POST['source'] ?? null;
-                $newIdx = $_POST['new_idx'] ?? null;
-                $orgIdx = $_POST['org_idx'] ?? null;
-                $this->set(function () use ($fx, $sortOrders, $source, $newIdx, $orgIdx) {
-                    return call_user_func_array($fx, [$sortOrders, $source, $newIdx, $orgIdx]);
-                });
-            }
+            $sortOrders = explode(',', $_POST['order'] ?? '');
+            $source = $_POST['source'] ?? null;
+            $newIdx = $_POST['new_idx'] ?? null;
+            $orgIdx = $_POST['org_idx'] ?? null;
+            $this->set(function () use ($fx, $sortOrders, $source, $newIdx, $orgIdx) {
+                return call_user_func_array($fx, [$sortOrders, $source, $newIdx, $orgIdx]);
+            });
         }
     }
 

src/Table/Column/JsHeader.php

@@ -19,12 +19,10 @@ class JsHeader extends JsCallback
     public function onSelectItem($fx)
     {
         if (is_callable($fx)) {
-            if ($this->triggered()) {
-                $param = [$_GET['id'],  $_GET['item'] ?? null];
-                $this->set(function () use ($fx, $param) {
-                    return call_user_func_array($fx, $param);
-                });
-            }
+            $param = [$_GET['id'] ?? null,  $_GET['item'] ?? null];
+            $this->set(function () use ($fx, $param) {
+                return call_user_func_array($fx, $param);
+            });
         }
     }
 }

src/VirtualPage.php

@@ -106,7 +106,7 @@ public function getHtml()
     {
         $this->cb->set(function () {
             // if virtual page callback is triggered
-            if ($mode = $this->cb->getMode()) {
+            if ($mode = $this->cb->getTriggeredValue()) {
                 // process callback
                 if ($this->fx) {
                     call_user_func($this->fx, $this);

src/Wizard.php

@@ -67,21 +67,21 @@ public function init(): void
             $this->stepCallback = Callback::addTo($this, ['urlTrigger' => $this->name]);
         }
 
-        $this->currentStep = (int) $this->stepCallback->getMode() ?: 0;
+        $this->currentStep = (int) $this->stepCallback->getTriggeredValue() ?: 0;
 
         $this->stepTemplate = $this->template->cloneRegion('Step');
         $this->template->del('Step');
 
         // add buttons
         if ($this->currentStep) {
             $this->buttonPrev = Button::addTo($this, ['Back', 'basic'], ['Left']);
-            $this->buttonPrev->link($this->stepCallback->getUrl($this->currentStep - 1));
+            $this->buttonPrev->link($this->stepCallback->getUrl((string) ($this->currentStep - 1)));
         }
 
         $this->buttonNext = Button::addTo($this, ['Next', 'primary'], ['Right']);
         $this->buttonFinish = Button::addTo($this, ['Finish', 'primary'], ['Right']);
 
-        $this->buttonNext->link($this->stepCallback->getUrl($this->currentStep + 1));
+        $this->buttonNext->link($this->stepCallback->getUrl((string) ($this->currentStep + 1)));
     }
 
     /**