Fix missing bulk action input typecast (#2164)

demos/_unit-test/scope-builder-to-query.php

@@ -34,9 +34,14 @@
         ],
     ],
 ];
-$scope = (new Form\Control\ScopeBuilder())->queryToScope($q);
 
 $product = new Product($app->db);
 
+$scopeBuilder = new Form\Control\ScopeBuilder();
+$scopeBuilder->setApp($app);
+$scopeBuilder->model = $product;
+
+$scope = $scopeBuilder->queryToScope($q);
+
 $g = Grid::addTo($app);
 $g->setModel($product->addCondition($scope));

demos/collection/lister-ipp.php

@@ -56,7 +56,7 @@
     $row->iso = mb_strtolower($row->iso);
 });
 $model = new Country($app->db);
-$model->addCondition(Country::hinting()->fieldName()->id, -1); // no such records so model will be empty
+$model->addCondition(Country::hinting()->fieldName()->id, null); // no such records so model will be empty
 $lister->setModel($model);
 
 View::addTo($app, ['ui' => 'clearing divider']);

demos/init-db.php

@@ -122,6 +122,9 @@ protected function initPreventModification(): void
     }
 }
 
+/**
+ * Improve testing by using prefixed real field and SQL names.
+ */
 class ModelWithPrefixedFields extends Model
 {
     use ModelPreventModificationTrait;

docs/form-control.md

@@ -405,7 +405,7 @@ class MyDropdown extends \Atk4\Ui\Dropdown
     public $defaultTemplate = 'my_dropdown.html';
 
     /**
-     * used when a custom callback is defined for row rendering. Sets
+     * Used when a custom callback is defined for row rendering. Sets
      * values to item template and appends it to main template
      */
     protected function _addCallBackRow($row, $key = null)

js/src/plugins/scroll.plugin.js

@@ -4,7 +4,7 @@ import AtkPlugin from './atk.plugin';
 /**
  * Add dynamic scrolling to a View that can accept page argument in URL.
  *
- * default options are:
+ * Default options are:
  * padding: 20         The amount of padding needed prior to request a page load.
  * initialPage: 1      The initial page load when calling this plugin.
  * appendTo: null      The HTML element where new content should be append to.

public/js/atkjs-ui.js

@@ -1482,7 +1482,7 @@ __webpack_require__.r(__webpack_exports__);
 /**
  * Add dynamic scrolling to a View that can accept page argument in URL.
  *
- * default options are:
+ * Default options are:
  * padding: 20         The amount of padding needed prior to request a page load.
  * initialPage: 1      The initial page load when calling this plugin.
  * appendTo: null      The HTML element where new content should be append to.

src/Form/Control/Dropdown.php

@@ -236,9 +236,9 @@ protected function renderView(): void
      */
     protected function _renderItemsForModel(): void
     {
-        foreach ($this->model as $key => $row) {
+        foreach ($this->model as $id => $row) {
             $title = $row->getTitle();
-            $this->_tItem->set('value', (string) $key);
+            $this->_tItem->set('value', (string) $id);
             $this->_tItem->set('title', $title || is_numeric($title) ? (string) $title : '');
             // add item to template
             $this->template->dangerouslyAppendHtml('Item', $this->_tItem->renderToHtml());

src/Form/Control/DropdownCascade.php

@@ -67,19 +67,19 @@ public function set($value = null)
      * Generate new dropdown values based on cascadeInput model selected ID.
      * Return an empty value set if ID is null.
      *
-     * @param string|int $id
+     * @param mixed $id
      */
     public function getNewValues($id): array
     {
-        if (!$id) {
+        if ($id === null) {
             return [['value' => '', 'text' => $this->empty, 'name' => $this->empty]];
         }
 
         $model = $this->cascadeFrom->model->load($id)->ref($this->reference);
         $values = [];
-        foreach ($model as $k => $row) {
+        foreach ($model as $row) {
             if ($this->renderRowFunction) {
-                $res = ($this->renderRowFunction)($row, $k);
+                $res = ($this->renderRowFunction)($row); // @phpstan-ignore-line
                 $values[] = ['value' => $res['value'], 'text' => $res['title'], 'name' => $res['title']];
             } else {
                 $values[] = ['value' => $row->getId(), 'text' => $row->get($model->titleField), 'name' => $row->get($model->titleField)];

src/Form/Control/Multiline.php

@@ -157,7 +157,7 @@ class Multiline extends Form\Control
     /** @var array The fields names used in each row. */
     public $rowFields;
 
-    /** @var array The data sent for each row. */
+    /** @var list<array<string, mixed>> The data sent for each row. */
     public $rowData;
 
     /** @var int The max number of records (rows) that can be added to Multiline. 0 means no limit. */
@@ -221,7 +221,7 @@ protected function init(): void
             // remove __atml ID from array field
             if ($this->form->model->getField($this->shortName)->type === 'json') {
                 $rows = [];
-                foreach ($this->rowData as $key => $cols) {
+                foreach ($this->rowData as $cols) {
                     unset($cols['__atkml']);
                     $rows[] = $cols;
                 }
@@ -234,7 +234,7 @@ protected function init(): void
             // when errors are coming from this Multiline field, then notify Multiline component about them
             // otherwise use normal field error
             if ($fieldName === $this->shortName) {
-                // multiline.js component listen to 'multiline-rows-error' event
+                // multiline js component listen to 'multiline-rows-error' event
                 $jsError = $this->jsEmitEvent($this->multiLine->name . '-multiline-rows-error', ['errors' => $this->rowErrors]);
             } else {
                 $jsError = $form->js()->form('add prompt', $fieldName, $str);

src/Form/Control/ScopeBuilder.php

@@ -559,6 +559,10 @@ public function queryToCondition(array $query): Condition
             case self::OPERATOR_NOT_IN:
                 $value = explode($this->detectDelimiter($value), $value);
 
+                break;
+            default:
+                $value = $this->getApp()->uiPersistence->typecastLoadField($this->model->getField($key), $value);
+
                 break;
         }
 

src/Form/Control/TreeItemSelector.php

@@ -21,7 +21,7 @@
  *
  * Only item ID are store within the input field.
  *
- * see demos/tree-item-selector.php to see how tree items are build.
+ * See demos/form-control/tree-item-selector.php to see how tree items are build.
  */
 class TreeItemSelector extends Form\Control
 {

src/Grid.php

@@ -496,11 +496,11 @@ public function addPopup($columnName, $popup = null, $icon = 'caret square down'
      * Similar to addActionButton but when button is clicked, modal is displayed
      * with the $title and $callback is executed.
      *
-     * @param string|array|View                 $button
-     * @param string                            $title
-     * @param \Closure(View, string|null): void $callback
-     * @param array                             $args       extra URL argument for callback
-     * @param bool|\Closure(Model): bool        $isDisabled
+     * @param string|array|View           $button
+     * @param string                      $title
+     * @param \Closure(View, mixed): void $callback
+     * @param array                       $args       extra URL argument for callback
+     * @param bool|\Closure(Model): bool  $isDisabled
      *
      * @return View
      */
@@ -510,20 +510,25 @@ public function addModalAction($button, $title, \Closure $callback, $args = [],
     }
 
     /**
-     * @return list<string>
+     * @return list<mixed>
      */
     private function explodeSelectionValue(string $value): array
     {
-        return $value === '' ? [] : explode(',', $value);
+        $res = [];
+        foreach ($value === '' ? [] : explode(',', $value) as $v) {
+            $res[] = $this->getApp()->uiPersistence->typecastLoadField($this->model->getField($this->model->idField), $v);
+        }
+
+        return $res;
     }
 
     /**
      * Similar to addActionButton but apply to a multiple records selection and display in menu.
      * When menu item is clicked, $callback is executed.
      *
-     * @param string|array|MenuItem                               $item
-     * @param \Closure(Js\Jquery, list<string>): JsExpressionable $callback
-     * @param array                                               $args     extra URL argument for callback
+     * @param string|array|MenuItem                              $item
+     * @param \Closure(Js\Jquery, list<mixed>): JsExpressionable $callback
+     * @param array                                              $args     extra URL argument for callback
      *
      * @return View
      */
@@ -541,10 +546,10 @@ public function addBulkAction($item, \Closure $callback, $args = [])
      * Similar to addModalAction but apply to a multiple records selection and display in menu.
      * When menu item is clicked, modal is displayed with the $title and $callback is executed.
      *
-     * @param string|array|MenuItem              $item
-     * @param string                             $title
-     * @param \Closure(View, list<string>): void $callback
-     * @param array                              $args     extra URL argument for callback
+     * @param string|array|MenuItem             $item
+     * @param string                            $title
+     * @param \Closure(View, list<mixed>): void $callback
+     * @param array                             $args     extra URL argument for callback
      *
      * @return View
      */

src/Table/Column/ActionButtons.php

@@ -78,12 +78,12 @@ public function addButton($button, $action = null, string $confirmMsg = '', $isD
      * Adds a new button which will open a modal dialog and dynamically
      * load contents through $callback. Will pass a virtual page.
      *
-     * @param string|array|View                 $button
-     * @param string|array                      $defaults   modal title or modal defaults array
-     * @param \Closure(View, string|null): void $callback
-     * @param View                              $owner
-     * @param array                             $args
-     * @param bool|\Closure(Model): bool        $isDisabled
+     * @param string|array|View           $button
+     * @param string|array                $defaults   modal title or modal defaults array
+     * @param \Closure(View, mixed): void $callback
+     * @param View                        $owner
+     * @param array                       $args
+     * @param bool|\Closure(Model): bool  $isDisabled
      *
      * @return View
      */

src/Table/Column/KeyValue.php

@@ -17,9 +17,9 @@
  *  3 => resetting
  *  4 => error.
  *
- * we don't need a table to define this, cause are defined in project
+ * We don't need a table to define this, cause are defined in project.
  *
- * using KeyValue Column you can show this values without using DB Relations
+ * Using KeyValue Column you can show this values without using DB Relations
  * need to be defined in field like this:
  *
  * $this->addField('course_payment_status', [

src/UserAction/ConfirmationExecutor.php

@@ -174,8 +174,8 @@ protected function doFinal(View $modal): void
     /**
      * Return proper JS statement when action execute.
      *
-     * @param mixed      $obj
-     * @param string|int $id
+     * @param mixed $obj
+     * @param mixed $id
      */
     protected function jsGetExecute($obj, $id): JsBlock
     {

src/UserAction/ModalExecutor.php

@@ -158,8 +158,8 @@ public function jsExecute(array $urlArgs = []): JsBlock
     /**
      * Return proper JS statement need after action execution.
      *
-     * @param mixed      $obj
-     * @param string|int $id
+     * @param mixed $obj
+     * @param mixed $id
      */
     protected function jsGetExecute($obj, $id): JsBlock
     {

src/UserAction/PanelExecutor.php

@@ -150,8 +150,8 @@ protected function jsSetListState(View $view, string $currentStep): void
     /**
      * Return proper JS statement need after action execution.
      *
-     * @param mixed      $obj
-     * @param string|int $id
+     * @param mixed $obj
+     * @param mixed $id
      */
     protected function jsGetExecute($obj, $id): JsBlock
     {

src/UserAction/VpExecutor.php

@@ -155,8 +155,8 @@ protected function jsSetListState(View $view, string $currentStep): void
     /**
      * Return proper JS statement need after action execution.
      *
-     * @param mixed      $obj
-     * @param string|int $id
+     * @param mixed $obj
+     * @param mixed $id
      */
     protected function jsGetExecute($obj, $id): JsBlock
     {

src/View.php

@@ -822,7 +822,7 @@ public function vue($component, $initData = [], $componentDefinition = null, $se
     /**
      * Emit an event on atkEvent bus.
      *
-     * example of adding a listener on for an emit event.
+     * Example of adding a listener on for an emit event:
      *
      * atk.eventBus.on('eventName', (data) => {
      *     console.log(data)