Convert hardcoded strings in demos to hintable fields

[mvorisek]

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

1. add Model class phpdoc
2. 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

[mvorisek]

@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]

As pointed by others:

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

Edit: looks like it is unspecified.

[romaninsh]

@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]

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

[georgehristov]

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

[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:

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

[ibelar]

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]

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]

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

[mvorisek]

was a bug