Convert hardcoded strings in demos to hintable fields #1559

mvorisek · 2020-12-04T16:25:53Z

Preface

The hintable support is another major game changer in sense of cleaness and maintainability. For now, adding it to demos only and it is up too every user to use it or not.

Description

Annotate model fields and used them magically as a real properties.

Usage

add Model class phpdoc
use the properties either as standard value property or supermagically for field names itself (see below)

standard ("value") property

$model->is_folder === $model->get('is_folder')
$model->is_folder = false === $model->set('is_folder', false)

shorter to type
refactorable
typed for static analysis

"name" property

$model->fieldName()->is_folder === 'is_folder'

refactorable name

demos/collection/card-deck.php

mvorisek · 2020-12-07T10:26:20Z

@DarkSide666 @georgehristov @ibelar please review, very powerfull lib I released for atk4. For now, I am adding it as a dev dependency ie. for demos only

I will then adjust everything in demos to make it analyseable/typehintable/refactorable.

romaninsh · 2020-12-09T10:07:22Z

As pointed by others:

Checking if we'll need to bundle it into our ZIP distribution....

Edit: looks like it is unspecified.

romaninsh · 2020-12-09T10:10:22Z

@mvorisek - I think this is fine but would be nice to have a bit more info in the readme file there just to understand what is that library doing and why is it needed:

https://github.com/mvorisek/atk4-hintable-mirror

Edit: found notes here, reading: https://github.com/mvorisek/atk4-hintable-mirror/blob/develop/src/Data/HintableModel.php#L14

romaninsh · 2020-12-09T10:16:04Z

@mvorisek - why not bring magic properties natively into ATK Model ?

georgehristov · 2020-12-09T10:23:03Z

@mvorisek I would also suggest adding native trait \Atk4\Data\Model\HintableTrait

mvorisek · 2020-12-09T10:56:29Z

I think this is fine but would be nice to have a bit more info in the readme file there just to understand what is that library doing and why is it needed:

Edit: found notes here, reading: https://github.com/mvorisek/atk4-hintable-mirror/blob/develop/src/Data/HintableModel.php#L14

updated PR title

@mvorisek - why not bring magic properties natively into ATK Model ?

I need more control over this than waiting days until someone merge something. This is why I also removed the PRs for it a few months ago.

@mvorisek I would also suggest adding native trait \Atk4\Data\Model\HintableTrait

There are two issues with trait:

HintableModel can not be then specified as a type
- I checked now, very minor issue as super well written and specifying this type does not bring any benefict for end user ;-)
Model::init method must be overrided
- trait can NOT enforce it, see https://3v4l.org/MX9pm
- user can alias a init method from trait or we can offer aliased method from trait directly
- we can check if init() method from trait was called or not later, thus this should not be issue as well

So I can change the functionality to trait and offer it also under \Atk4\Data\Model\HintableTrait name.

If welcomed, I can add it also as atk4/data dep (so it does not have to be required in any other project) and possibly annotate Model id field in Model class phpdoc directly.

DarkSide666

LGTM

demos/form-control/dropdown-plus.php

ibelar · 2021-01-18T15:04:33Z

Is there a specific reason to prefix table field name using 'xxx' or 'yyy'? Why not using the table name instead like 'country_name', 'stats_name' etd?

mvorisek · 2021-01-18T19:47:31Z

Is there a specific reason to prefix table field name using 'xxx' or 'yyy'? Why not using the table name instead like 'country_name', 'stats_name' etd?

The reason I added is solely to identify direct usage of original/actual DB field names.

~~I have choosen xxx_ to be able to easily find it. I would merge and revert later once everything is replaced (I replaced only for classes in init-db.php).~~

Beatifulness addressed in atk4/data#831

mvorisek · 2021-01-20T10:55:32Z

tests/DemosTest.php

@@ -234,7 +234,7 @@ protected function getPathWithAppVars(string $path): string

    public function demoFilesProvider(): array
    {
-        $excludeDirs = ['_demo-data', '_includes', '_unit-test', 'special'];
+        $excludeDirs = ['_demo-data', '_includes'];


@ibelar FYI do not add anything else here, this is why #1586 was not caught by tests before

mvorisek · 2021-01-20T10:56:13Z

src/Component/ItemSearch.php

@@ -84,7 +84,7 @@ public function getQuery()
    public function setModelCondition(Model $model): Model
    {
        if ($q = $this->getQuery()) {
-            $model->addCondition('name', 'like', '%' . $q . '%');
+            $model->addCondition($model->title_field, 'like', '%' . $q . '%');


mvorisek force-pushed the to_hintable branch 3 times, most recently from c7e040e to 88474aa Compare December 4, 2020 16:31

mvorisek requested review from georgehristov, DarkSide666 and ibelar December 4, 2020 16:33

mvorisek marked this pull request as ready for review December 4, 2020 16:33

mvorisek force-pushed the to_hintable branch from 88474aa to 50f5309 Compare December 4, 2020 16:34

PhilippGrashoff reviewed Dec 4, 2020

View reviewed changes

demos/collection/card-deck.php Show resolved Hide resolved

mvorisek force-pushed the to_hintable branch 8 times, most recently from 7ff7e3e to 6eb73ae Compare December 4, 2020 22:20

mvorisek mentioned this pull request Dec 9, 2020

Add hintable fields support atk4/data#800

Merged

mvorisek added the waitingForAnotherPR label Dec 10, 2020

DarkSide666 approved these changes Dec 11, 2020

View reviewed changes

mvorisek force-pushed the to_hintable branch from 22c6a49 to 144fd01 Compare December 11, 2020 14:34

mvorisek added MAJOR and removed waitingForAnotherPR labels Dec 11, 2020

mvorisek force-pushed the to_hintable branch from 144fd01 to cf23bc0 Compare December 11, 2020 18:39

mvorisek force-pushed the to_hintable branch 5 times, most recently from cd8ff34 to f2cce7c Compare January 16, 2021 22:57

mvorisek commented Jan 17, 2021

View reviewed changes

demos/form-control/dropdown-plus.php Show resolved Hide resolved

mvorisek added 2 commits January 20, 2021 11:06

Convert hardcoded strings to hintable fields

2fe8e65

fix guessed "their_field"

244e07f

mvorisek force-pushed the to_hintable branch from 587bbae to 244e07f Compare January 20, 2021 10:06

mvorisek mentioned this pull request Jan 20, 2021

Nice caption with debug {actual, hintable} prefix atk4/data#831

Merged

Use testing "atk_fp__" prefix

01d89a4

mvorisek commented Jan 20, 2021

View reviewed changes

fix caption prefix for Behat

0531c75

mvorisek force-pushed the to_hintable branch from efa2616 to 0531c75 Compare January 20, 2021 11:00

mvorisek added 2 commits January 20, 2021 12:10

named prefixes

ced5146

table in all prefixes

0b26080

mvorisek force-pushed the to_hintable branch from 4a17bc7 to 0b26080 Compare January 20, 2021 11:37

move prefixing to code in create DB

d8d3764

mvorisek force-pushed the to_hintable branch from e7642ec to d8d3764 Compare January 20, 2021 11:40

mvorisek added 3 commits January 20, 2021 12:41

fix CS

f26aee2

fix typo

0432422

fix caption prefix for Behat

0b72808

mvorisek merged commit 48e8190 into develop Jan 20, 2021

mvorisek deleted the to_hintable branch January 20, 2021 11:57

mvorisek restored the to_hintable branch January 20, 2021 13:30

mvorisek deleted the to_hintable branch January 20, 2021 13:31

ibelar mentioned this pull request Jan 21, 2021

Cascade Dropdown return bad results #1597

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Convert hardcoded strings in demos to hintable fields #1559

Convert hardcoded strings in demos to hintable fields #1559

mvorisek commented Dec 4, 2020 •

edited

Loading

mvorisek commented Dec 7, 2020

romaninsh commented Dec 9, 2020 •

edited

Loading

romaninsh commented Dec 9, 2020 •

edited

Loading

romaninsh commented Dec 9, 2020

georgehristov commented Dec 9, 2020

mvorisek commented Dec 9, 2020

DarkSide666 left a comment

ibelar commented Jan 18, 2021

mvorisek commented Jan 18, 2021 •

edited

Loading

mvorisek Jan 20, 2021

mvorisek Jan 20, 2021

Convert hardcoded strings in demos to hintable fields #1559

Convert hardcoded strings in demos to hintable fields #1559

Conversation

mvorisek commented Dec 4, 2020 • edited Loading

Preface

Description

Usage

standard ("value") property

"name" property

mvorisek commented Dec 7, 2020

romaninsh commented Dec 9, 2020 • edited Loading

romaninsh commented Dec 9, 2020 • edited Loading

romaninsh commented Dec 9, 2020

georgehristov commented Dec 9, 2020

mvorisek commented Dec 9, 2020

DarkSide666 left a comment

Choose a reason for hiding this comment

ibelar commented Jan 18, 2021

mvorisek commented Jan 18, 2021 • edited Loading

mvorisek Jan 20, 2021

Choose a reason for hiding this comment

mvorisek Jan 20, 2021

Choose a reason for hiding this comment

mvorisek commented Dec 4, 2020 •

edited

Loading

romaninsh commented Dec 9, 2020 •

edited

Loading

romaninsh commented Dec 9, 2020 •

edited

Loading

mvorisek commented Jan 18, 2021 •

edited

Loading