Convert hardcoded strings to hintable fields

Author: mvorisek

composer.json

@@ -71,9 +71,10 @@
     "behat/mink-selenium2-driver": "^1.4",
     "friendsofphp/php-cs-fixer": "^2.16",
     "fzaninotto/faker": "^1.6",
-    "instaclick/php-webdriver": "^1.4.7",
     "guzzlehttp/guzzle": "^6.3",
+    "instaclick/php-webdriver": "^1.4.7",
     "johnkary/phpunit-speedtrap": "^3.2",
+    "mahalux/atk4-hintable": "^1.0.1",
     "phpstan/phpstan": "^0.12.58",
     "phpunit/phpcov": "*",
     "phpunit/phpunit": ">=9.3",

demos/Dockerfile

@@ -32,6 +32,7 @@ RUN (cd public && lessc agileui.less agileui.css)
 ADD composer.json .
 RUN jq 'del(."require-release")|del(."require-dev")' < composer.json > tmp && mv tmp composer.json \
     && composer require --no-update fzaninotto/faker \
+    && composer require --no-update mahalux/atk4-hintable \
     && composer install --no-dev
 
 RUN echo 'disable_functions = pcntl_exec,exec,passthru,proc_open,shell_exec,system,popen/g' >> "$PHP_INI_DIR/php.ini"

demos/collection/card-deck.php

@@ -14,13 +14,13 @@
 \Atk4\Ui\Header::addTo($app, ['Card Deck', 'size' => 1, 'subHeader' => 'Card can be display in a deck, also using model action.']);
 
 $countries = new Country($app->db);
-$countries->addCalculatedField('Cost', function ($model) {
+$countries->addCalculatedField('Cost', function (Country $country) {
     return '$ ' . number_format(random_int(500, 1500));
 });
 
 $action = $countries->addUserAction('book', [
-    'callback' => function ($model, $email, $city) {
-        return 'Your request to visit ' . ucwords($city) . ' in ' . $model->get('name') . ' was sent to: ' . $email;
+    'callback' => function (Country $country, $email, $city) {
+        return 'Your request to visit ' . ucwords($city) . ' in ' . $country->name . ' was sent to: ' . $email;
     },
     'ui' => ['button' => [null, 'icon' => 'plane']],
 ]);
@@ -31,7 +31,7 @@
 ];
 
 $infoAction = $countries->addUserAction('request_info', [
-    'callback' => function ($model, $email) {
+    'callback' => function (Country $country, $email) {
         return 'Your request for information was sent to email: ' . $email;
     },
     'appliesTo' => \Atk4\Data\Model\UserAction::APPLIES_TO_NO_RECORDS,

demos/collection/multitable.php

@@ -73,8 +73,8 @@ public function setModel(\Atk4\Data\Model $model, $route = [])
 });
 
 $model = new File($app->db);
-$model->addCondition('parent_folder_id', null);
-$model->setOrder(['is_folder' => 'desc', 'name']);
+$model->addCondition($model->fieldName()->parent_folder_id, null);
+$model->setOrder([$model->fieldName()->is_folder => 'desc', $model->fieldName()->name]);
 
 \Atk4\Ui\Header::addTo($app, ['MacOS File Finder', 'subHeader' => 'Component built around Table, Columns and JsReload']);
 

demos/init-db.php

@@ -20,6 +20,14 @@
 
 // a very basic file that sets up Agile Data to be used in some demonstrations
 
+/**
+ * @property int $id @Atk\Field(visibility="protected_set") Contains ID of the current record.
+ *                   If the value is null then the record is considered to be new.
+ */
+class HintableModel extends \Mvorisek\Atk4\Hintable\Data\HintableModel
+{
+}
+
 trait ModelLockTrait
 {
     public function lock(): void
@@ -40,7 +48,10 @@ public function lock(): void
     }
 }
 
-class Country extends \Atk4\Data\Model
+/**
+ * @property string $name @Atk\Field()
+ */
+class Country extends HintableModel
 {
     public $table = 'country';
 
@@ -156,7 +167,12 @@ class Percent extends \Atk4\Data\Field
     public $type = 'float'; // will need to be able to affect rendering and storage
 }
 
-class File extends \Atk4\Data\Model
+/**
+ * @property string $name             @Atk\Field()
+ * @property bool   $is_folder        @Atk\Field()
+ * @property int    $parent_folder_id @Atk\Field()
+ */
+class File extends HintableModel
 {
     public $table = 'file';