Name $.atkAjaxec() plugin better (#2249)

composer.json

@@ -60,7 +60,7 @@
     },
     "require-release": {
         "php": ">=7.4 <8.4",
-        "atk4/data": "~5.3.0",
+        "atk4/data": "~6.0.0",
         "nyholm/psr7": "^1.6",
         "nyholm/psr7-server": "^1.0",
         "symfony/filesystem": "^4.4 || ^5.3 || ^6.0",

demos/form-control/calendar.php

@@ -31,11 +31,11 @@
     'options' => ['clickOpens' => false],
 ])->set(new \DateTime());
 $control->addAction(['Today', 'icon' => 'calendar day'])
-    ->on('click', $control->getJsInstance()->setDate($app->uiPersistence->typecastSaveField($control->entityField->getField(), new \DateTime())));
+    ->on('click', $control->jsFlatpickr()->setDate($app->uiPersistence->typecastSaveField($control->entityField->getField(), new \DateTime())));
 $control->addAction(['Select...', 'icon' => 'calendar'])
-    ->on('click', $control->getJsInstance()->open());
+    ->on('click', $control->jsFlatpickr()->open());
 $control->addAction(['Clear', 'icon' => 'times red'])
-    ->on('click', $control->getJsInstance()->clear());
+    ->on('click', $control->jsFlatpickr()->clear());
 
 $form->onSubmit(static function (Form $form) use ($app) {
     $data = [];

demos/interactive/sse.php

@@ -47,7 +47,7 @@
 }));
 
 $buttonStop->on('click', new JsBlock([
-    $button->js()->atkServerEvent('stop'),
+    $button->js()->atkServerSentEvent('stop'),
     $button->js()->removeClass('disabled'),
 ]));
 

docs/crud.md

@@ -116,7 +116,7 @@ $g->onFormEdit(function (Form $form, ModalExecutor $ex) {
 $g->onFormAddEdit(function (Form $form, ModalExecutor $ex) {
     $form->onSubmit(function (Form $form) use ($ex) {
         return new \Atk4\Ui\Js\JsBlock([
-            $ex->hide(),
+            $ex->jsHide(),
             new \Atk4\Ui\Js\JsToast('Submit all right! This demo does not saved data.'),
         ]);
     });

docs/js.md

@@ -674,7 +674,7 @@ comes into play.
 
 (sse)=
 
-### Server Sent Event (JsSse)
+### Server-Sent Events (JsSse)
 
 :::{php:class} JsSse
 :::

docs/virtualpage.md

@@ -286,7 +286,7 @@ $loader->set(function (\Atk4\Ui\Loader $p) {
 });
 ```
 
-By setting progressBar to true, Loader component will use SSE ([Server Sent Events](https://www.w3schools.com/html/html5_serversentevents.asp))
+By setting progressBar to true, Loader component will use SSE ([Server-Sent Events](https://www.w3schools.com/html/html5_serversentevents.asp))
 and will be sending notification about your progress. Note that currently Internet Explorer does not support SSE and it's
 up to you to create a work-around.
 

js/src/JqueryPlugin/AjaxecPlugin.js → js/src/JqueryPlugin/AjaxExecutePlugin.js

@@ -2,7 +2,7 @@ import $ from 'external/jquery';
 import atk from 'atk';
 import AbstractPlugin from './AbstractPlugin';
 
-export default class AtkAjaxecPlugin extends AbstractPlugin {
+export default class AtkAjaxExecutePlugin extends AbstractPlugin {
     main() {
         if (!this.settings.url) {
             console.error('Trying to execute callback without URL');
@@ -53,7 +53,7 @@ export default class AtkAjaxecPlugin extends AbstractPlugin {
     }
 }
 
-AtkAjaxecPlugin.DEFAULTS = {
+AtkAjaxExecutePlugin.DEFAULTS = {
     url: null,
     urlOptions: {},
     confirm: null,

js/src/JqueryPlugin/ServerEventPlugin.js → js/src/JqueryPlugin/ServerSentEventPlugin.js

@@ -1,7 +1,7 @@
 import atk from 'atk';
 import AbstractPlugin from './AbstractPlugin';
 
-export default class AtkServerEventPlugin extends AbstractPlugin {
+export default class AtkServerSentEventPlugin extends AbstractPlugin {
     main() {
         const element = this.$el;
         const hasLoader = this.settings.showLoader;
@@ -43,7 +43,7 @@ export default class AtkServerEventPlugin extends AbstractPlugin {
     }
 }
 
-AtkServerEventPlugin.DEFAULTS = {
+AtkServerSentEventPlugin.DEFAULTS = {
     url: null,
     urlOptions: {},
     showLoader: false,

js/src/setupJqueryPlugins.js

@@ -1,6 +1,6 @@
 import $ from 'external/jquery';
 import atk from 'atk';
-import AjaxecPlugin from './JqueryPlugin/AjaxecPlugin';
+import AjaxExecutePlugin from './JqueryPlugin/AjaxExecutePlugin';
 import ColumnResizerPlugin from './JqueryPlugin/ColumnResizerPlugin';
 import ConditionalFormPlugin from './JqueryPlugin/ConditionalFormPlugin';
 import ConfirmPlugin from './JqueryPlugin/ConfirmPlugin';
@@ -10,7 +10,7 @@ import JsSearchPlugin from './JqueryPlugin/JsSearchPlugin';
 import JsSortablePlugin from './JqueryPlugin/JsSortablePlugin';
 import ReloadViewPlugin from './JqueryPlugin/ReloadViewPlugin';
 import ScrollPlugin from './JqueryPlugin/ScrollPlugin';
-import ServerEventPlugin from './JqueryPlugin/ServerEventPlugin';
+import ServerSentEventPlugin from './JqueryPlugin/ServerSentEventPlugin';
 import SidenavPlugin from './JqueryPlugin/SidenavPlugin';
 
 /**
@@ -46,7 +46,7 @@ atk.registerPlugin = function (name, cl, shorthand = false) {
     }
 };
 
-atk.registerPlugin('atkAjaxec', AjaxecPlugin);
+atk.registerPlugin('atkAjaxExecute', AjaxExecutePlugin);
 atk.registerPlugin('atkColumnResizer', ColumnResizerPlugin);
 atk.registerPlugin('atkConditionalForm', ConditionalFormPlugin);
 atk.registerPlugin('atkConfirm', ConfirmPlugin, true);
@@ -56,7 +56,7 @@ atk.registerPlugin('atkJsSearch', JsSearchPlugin);
 atk.registerPlugin('atkJsSortable', JsSortablePlugin);
 atk.registerPlugin('atkReloadView', ReloadViewPlugin);
 atk.registerPlugin('atkScroll', ScrollPlugin);
-atk.registerPlugin('atkServerEvent', ServerEventPlugin);
+atk.registerPlugin('atkServerSentEvent', ServerSentEventPlugin);
 atk.registerPlugin('atkSidenav', SidenavPlugin);
 
 export default null;

phpstan.neon.dist

@@ -76,7 +76,7 @@ parameters:
         -
             path: 'demos/form-control/calendar.php'
             identifier: method.notFound
-            message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::getJsInstance\(\)\.$~'
+            message: '~^Call to an undefined method Atk4\\Ui\\Form\\Control::jsFlatpickr\(\)\.$~'
             count: 3
         -
             path: 'demos/form-control/input2.php'

public/js/atkjs-ui.js

@@ -332,16 +332,16 @@ class AbstractPlugin {
 
 /***/ }),
 
-/***/ "./src/JqueryPlugin/AjaxecPlugin.js":
-/*!******************************************!*\
-  !*** ./src/JqueryPlugin/AjaxecPlugin.js ***!
-  \******************************************/
+/***/ "./src/JqueryPlugin/AjaxExecutePlugin.js":
+/*!***********************************************!*\
+  !*** ./src/JqueryPlugin/AjaxExecutePlugin.js ***!
+  \***********************************************/
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   "default": () => (/* binding */ AtkAjaxecPlugin)
+/* harmony export */   "default": () => (/* binding */ AtkAjaxExecutePlugin)
 /* harmony export */ });
 /* harmony import */ var external_jquery__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! external/jquery */ "external/jquery");
 /* harmony import */ var external_jquery__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(external_jquery__WEBPACK_IMPORTED_MODULE_0__);
@@ -350,7 +350,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-class AtkAjaxecPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__["default"] {
+class AtkAjaxExecutePlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__["default"] {
   main() {
     if (!this.settings.url) {
       console.error('Trying to execute callback without URL');
@@ -396,7 +396,7 @@ class AtkAjaxecPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__["defa
     this.$el.api(settings);
   }
 }
-AtkAjaxecPlugin.DEFAULTS = {
+AtkAjaxExecutePlugin.DEFAULTS = {
   url: null,
   urlOptions: {},
   confirm: null,
@@ -1744,16 +1744,16 @@ AtkScrollPlugin.DEFAULTS = {
 
 /***/ }),
 
-/***/ "./src/JqueryPlugin/ServerEventPlugin.js":
-/*!***********************************************!*\
-  !*** ./src/JqueryPlugin/ServerEventPlugin.js ***!
-  \***********************************************/
+/***/ "./src/JqueryPlugin/ServerSentEventPlugin.js":
+/*!***************************************************!*\
+  !*** ./src/JqueryPlugin/ServerSentEventPlugin.js ***!
+  \***************************************************/
 /***/ ((__unused_webpack_module, __webpack_exports__, __webpack_require__) => {
 
 "use strict";
 __webpack_require__.r(__webpack_exports__);
 /* harmony export */ __webpack_require__.d(__webpack_exports__, {
-/* harmony export */   "default": () => (/* binding */ AtkServerEventPlugin)
+/* harmony export */   "default": () => (/* binding */ AtkServerSentEventPlugin)
 /* harmony export */ });
 /* harmony import */ var core_js_modules_esnext_json_parse_js__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! core-js/modules/esnext.json.parse.js */ "./node_modules/core-js/modules/esnext.json.parse.js");
 /* harmony import */ var core_js_modules_esnext_json_parse_js__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(core_js_modules_esnext_json_parse_js__WEBPACK_IMPORTED_MODULE_0__);
@@ -1762,7 +1762,7 @@ __webpack_require__.r(__webpack_exports__);
 
 
 
-class AtkServerEventPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__["default"] {
+class AtkServerSentEventPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__["default"] {
   main() {
     const element = this.$el;
     const hasLoader = this.settings.showLoader;
@@ -1795,7 +1795,7 @@ class AtkServerEventPlugin extends _AbstractPlugin__WEBPACK_IMPORTED_MODULE_2__[
     }
   }
 }
-AtkServerEventPlugin.DEFAULTS = {
+AtkServerSentEventPlugin.DEFAULTS = {
   url: null,
   urlOptions: {},
   showLoader: false
@@ -3722,7 +3722,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var external_jquery__WEBPACK_IMPORTED_MODULE_0__ = __webpack_require__(/*! external/jquery */ "external/jquery");
 /* harmony import */ var external_jquery__WEBPACK_IMPORTED_MODULE_0___default = /*#__PURE__*/__webpack_require__.n(external_jquery__WEBPACK_IMPORTED_MODULE_0__);
 /* harmony import */ var atk__WEBPACK_IMPORTED_MODULE_1__ = __webpack_require__(/*! atk */ "./src/setupAtk.js");
-/* harmony import */ var _JqueryPlugin_AjaxecPlugin__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./JqueryPlugin/AjaxecPlugin */ "./src/JqueryPlugin/AjaxecPlugin.js");
+/* harmony import */ var _JqueryPlugin_AjaxExecutePlugin__WEBPACK_IMPORTED_MODULE_2__ = __webpack_require__(/*! ./JqueryPlugin/AjaxExecutePlugin */ "./src/JqueryPlugin/AjaxExecutePlugin.js");
 /* harmony import */ var _JqueryPlugin_ColumnResizerPlugin__WEBPACK_IMPORTED_MODULE_3__ = __webpack_require__(/*! ./JqueryPlugin/ColumnResizerPlugin */ "./src/JqueryPlugin/ColumnResizerPlugin.js");
 /* harmony import */ var _JqueryPlugin_ConditionalFormPlugin__WEBPACK_IMPORTED_MODULE_4__ = __webpack_require__(/*! ./JqueryPlugin/ConditionalFormPlugin */ "./src/JqueryPlugin/ConditionalFormPlugin.js");
 /* harmony import */ var _JqueryPlugin_ConfirmPlugin__WEBPACK_IMPORTED_MODULE_5__ = __webpack_require__(/*! ./JqueryPlugin/ConfirmPlugin */ "./src/JqueryPlugin/ConfirmPlugin.js");
@@ -3732,7 +3732,7 @@ __webpack_require__.r(__webpack_exports__);
 /* harmony import */ var _JqueryPlugin_JsSortablePlugin__WEBPACK_IMPORTED_MODULE_9__ = __webpack_require__(/*! ./JqueryPlugin/JsSortablePlugin */ "./src/JqueryPlugin/JsSortablePlugin.js");
 /* harmony import */ var _JqueryPlugin_ReloadViewPlugin__WEBPACK_IMPORTED_MODULE_10__ = __webpack_require__(/*! ./JqueryPlugin/ReloadViewPlugin */ "./src/JqueryPlugin/ReloadViewPlugin.js");
 /* harmony import */ var _JqueryPlugin_ScrollPlugin__WEBPACK_IMPORTED_MODULE_11__ = __webpack_require__(/*! ./JqueryPlugin/ScrollPlugin */ "./src/JqueryPlugin/ScrollPlugin.js");
-/* harmony import */ var _JqueryPlugin_ServerEventPlugin__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__(/*! ./JqueryPlugin/ServerEventPlugin */ "./src/JqueryPlugin/ServerEventPlugin.js");
+/* harmony import */ var _JqueryPlugin_ServerSentEventPlugin__WEBPACK_IMPORTED_MODULE_12__ = __webpack_require__(/*! ./JqueryPlugin/ServerSentEventPlugin */ "./src/JqueryPlugin/ServerSentEventPlugin.js");
 /* harmony import */ var _JqueryPlugin_SidenavPlugin__WEBPACK_IMPORTED_MODULE_13__ = __webpack_require__(/*! ./JqueryPlugin/SidenavPlugin */ "./src/JqueryPlugin/SidenavPlugin.js");
 
 
@@ -3782,7 +3782,7 @@ atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin = function (name, cl)
     (external_jquery__WEBPACK_IMPORTED_MODULE_0___default())[name] = options => external_jquery__WEBPACK_IMPORTED_MODULE_0___default()({})[name](options);
   }
 };
-atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkAjaxec', _JqueryPlugin_AjaxecPlugin__WEBPACK_IMPORTED_MODULE_2__["default"]);
+atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkAjaxExecute', _JqueryPlugin_AjaxExecutePlugin__WEBPACK_IMPORTED_MODULE_2__["default"]);
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkColumnResizer', _JqueryPlugin_ColumnResizerPlugin__WEBPACK_IMPORTED_MODULE_3__["default"]);
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkConditionalForm', _JqueryPlugin_ConditionalFormPlugin__WEBPACK_IMPORTED_MODULE_4__["default"]);
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkConfirm', _JqueryPlugin_ConfirmPlugin__WEBPACK_IMPORTED_MODULE_5__["default"], true);
@@ -3792,7 +3792,7 @@ atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkJsSearch', _Jquer
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkJsSortable', _JqueryPlugin_JsSortablePlugin__WEBPACK_IMPORTED_MODULE_9__["default"]);
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkReloadView', _JqueryPlugin_ReloadViewPlugin__WEBPACK_IMPORTED_MODULE_10__["default"]);
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkScroll', _JqueryPlugin_ScrollPlugin__WEBPACK_IMPORTED_MODULE_11__["default"]);
-atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkServerEvent', _JqueryPlugin_ServerEventPlugin__WEBPACK_IMPORTED_MODULE_12__["default"]);
+atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkServerSentEvent', _JqueryPlugin_ServerSentEventPlugin__WEBPACK_IMPORTED_MODULE_12__["default"]);
 atk__WEBPACK_IMPORTED_MODULE_1__["default"].registerPlugin('atkSidenav', _JqueryPlugin_SidenavPlugin__WEBPACK_IMPORTED_MODULE_13__["default"]);
 /* harmony default export */ const __WEBPACK_DEFAULT_EXPORT__ = (null);
 

src/App.php

@@ -67,7 +67,7 @@ class App
      *
      * @TODO remove, no longer needed for CDN versioning as we bundle all resources
      */
-    public $version = '5.3-dev';
+    public $version = '6.0-dev';
 
     /** @var string Name of application */
     public $title = 'Agile UI - Untitled Application';

src/Crud.php

@@ -182,7 +182,7 @@ protected function initActionExecutor(Model\UserAction $action)
     protected function jsExecute($return, Model\UserAction $action): JsBlock
     {
         $res = new JsBlock();
-        $jsAction = $this->getJsGridAction($action);
+        $jsAction = $this->jsGridAction($action);
         if ($jsAction) {
             $res->addStatement($jsAction);
         }
@@ -206,7 +206,7 @@ protected function jsExecute($return, Model\UserAction $action): JsBlock
     /**
      * Return proper JS actions depending on action behavior.
      */
-    protected function getJsGridAction(Model\UserAction $action): ?JsExpressionable
+    protected function jsGridAction(Model\UserAction $action): ?JsExpressionable
     {
         if ($this->updatedId !== null) {
             $js = $this->container->jsReload($this->_getReloadArgs());

src/Dropdown.php

@@ -49,7 +49,7 @@ public function onChange(\Closure $fx): void
         // setting dropdown option for using callback URL
         $this->dropdownOptions['onChange'] = new JsFunction(['value', 'name', 't'], [
             new JsExpression(
-                'if ($(this).data(\'currentValue\') != value) { $(this).atkAjaxec({ url: [url], urlOptions: { item: value } }); $(this).data(\'currentValue\', value); }',
+                'if ($(this).data(\'currentValue\') != value) { $(this).atkAjaxExecute({ url: [url], urlOptions: { item: value } }); $(this).data(\'currentValue\', value); }',
                 ['url' => $this->cb->getJsUrl()]
             ),
         ]);

src/Form/Control/Calendar.php

@@ -98,11 +98,11 @@ public function onChange($expr, $default = []): void
      * Get the FlatPickr instance of this input in order to
      * get it's properties like selectedDates or run it's methods.
      * Ex: clearing date via JS
-     *     $button->on('click', $f->getControl('date')->getJsInstance()->clear());.
+     *     $button->on('click', $f->getControl('date')->jsFlatpickr()->clear());.
      *
      * @return JsChain
      */
-    public function getJsInstance(): JsExpressionable
+    public function jsFlatpickr(): JsExpressionable
     {
         return (new Jquery('#' . $this->name . '_input'))->get(0)->_flatpickr;
     }

src/Js/Jquery.php

@@ -64,7 +64,7 @@
  * @method Jquery visibility(...$args)
  *
  * For atk4/ui JS (defined in js/src/plugin.js):
- * @method Jquery atkAjaxec(...$args)
+ * @method Jquery atkAjaxExecute(...$args)
  * @method Jquery atkColumnResizer(...$args)
  * @method Jquery atkConditionalForm(...$args)
  * @method Jquery atkConfirm(...$args)
@@ -74,7 +74,7 @@
  * @method Jquery atkJsSortable(...$args)
  * @method Jquery atkReloadView(...$args)
  * @method Jquery atkScroll(...$args)
- * @method Jquery atkServerEvent(...$args)
+ * @method Jquery atkServerSentEvent(...$args)
  * @method Jquery atkSidenav(...$args)
  *
  * For other:

src/JsCallback.php

@@ -38,7 +38,7 @@ public function jsExecute(): JsBlock
     {
         $this->assertIsInitialized();
 
-        return new JsBlock([(new Jquery($this->getOwner() /* TODO element and loader element should be passed explicitly */))->atkAjaxec([
+        return new JsBlock([(new Jquery($this->getOwner() /* TODO element and loader element should be passed explicitly */))->atkAjaxExecute([
             'url' => $this->getJsUrl(),
             'urlOptions' => $this->args,
             'confirm' => $this->confirm,
@@ -94,9 +94,9 @@ public function set($fx = null, $args = null)
                 throw new Exception('Jquery JsCallback chain was mutated but not returned');
             }
 
-            $ajaxec = $this->getAjaxec($response);
+            $ajaxExecute = $this->jsAjaxExecute($response);
 
-            $this->terminateAjaxIfCanTerminate($ajaxec);
+            $this->terminateAjaxIfCanTerminate($ajaxExecute);
         });
 
         return $this;
@@ -106,11 +106,11 @@ public function set($fx = null, $args = null)
      * A proper way to finish execution of AJAX response. Generates JSON
      * which is returned to frontend.
      */
-    protected function terminateAjaxIfCanTerminate(JsBlock $ajaxec): void
+    protected function terminateAjaxIfCanTerminate(JsBlock $ajaxExecute): void
     {
         $data = [
             'success' => true,
-            'atkjs' => $ajaxec->jsRender(),
+            'atkjs' => $ajaxExecute->jsRender(),
         ];
 
         if ($this->canTerminate()) {
@@ -123,7 +123,7 @@ protected function terminateAjaxIfCanTerminate(JsBlock $ajaxec): void
      *
      * @param JsExpressionable|View|string|null $response
      */
-    public function getAjaxec($response): JsBlock
+    public function jsAjaxExecute($response): JsBlock
     {
         $jsBlock = new JsBlock();
         if ($response) {