feat: add Model field casting by kenjis · Pull Request #8243 · codeigniter4/CodeIgniter4

kenjis · 2023-11-23T06:08:00Z

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis · 2023-11-23T06:08:00Z

~~Needs #8230, #8260, #8539~~

Description
Entity is optional, and some devs do not want to use it.
See https://forum.codeigniter.com/showthread.php?tid=85956
This PR provides field type casting in Model so that all custom entities (or arrays) can use type casting.
This PR can solve #7177, #5905.

Model Field Casting

This casting only works when data comes from and goes to database.

[Object] --- toDataSource() ---> [DB driver]
[Object] <-- fromDataSource() -- [DB driver]

To use this feature, add property $casts to a Model.

protected$casts = [
'id' => 'int',
'email' => 'json-array',
'created_at' => 'datetime',
'updated_at' => 'datetime',
];

Entity and this feature

Entity casting works at (1)(4), but this casting works at (2)(3).

[App Code] --- (1) --> [Entity] --- (2) --> [Database]
[App Code] <-- (4) --- [Entity] <-- (3) --- [Database]

If you use this feature with Entity, do not use casting in Entity.
Using both casting at the same time does not work.

When using casting in Model, Entity has correct typed PHP values in the attributes.
This behavior is completely different from the previous behavior.
Do not expect the attributes hold raw data from database.

TODO

Checklist:

Securely signed commits
Component(s) with PHPDoc blocks, only if necessary or adds value
Unit testing, with >80% coverage
User guide updated
Conforms to style guide

kenjis · 2023-12-02T08:46:42Z

Implementation of this feature is complete.
I believe you can use casts in almost any class (custom entity) that is not an Entity.

If you use casting in Model with Entity, do not use casting in Entity. Using both casting at the same time does not work. When using casting in Model, Entity has correct typed PHP values in the attributes. This behavior is completely different from the previous behavior. Do not expect the attributes hold raw data from database.

To add custom cast handlers.

The framework should not throw Error.

To fix PhpStorm errors.

kenjis · 2024-02-13T01:35:05Z

Updated to use $db->dateFormat and $updateOnlyChanged.

kenjis added enhancement PRs that improve existing functionalities 4.5 labels Nov 23, 2023

kenjis marked this pull request as draft November 23, 2023 06:08

kenjis mentioned this pull request Nov 23, 2023
feat: add DataConverter to convert types #8230
Merged
5 tasks

kenjis force-pushed the feat-model-type-casting branch 17 times, most recently from 922e64b to 69606e2Compare November 29, 2023 05:18

kenjis force-pushed the feat-model-type-casting branch 6 times, most recently from f958080 to 6183c84Compare December 2, 2023 08:19

kenjis added database Issues or pull requests that affect the database layer bug Verified issues on the current code behavior or pull requests that will fix them labels Dec 4, 2023

kenjis added 23 commits February 13, 2024 08:49

chore: add skip_violations
5cf81ef

refactor: add declare(strict_types=1)
c5dbff3

refactor: fix inherited method visibility
6d43772

chore: add skip to use $created_at
059b085

feat: add $casts to template for make:model
20ef735

docs: add docs
9a6d5da

docs: add changelog
6a00193

docs: add about datetime format
405a249

docs: add@internalto DataCaster and DataConverter
303af1d

docs: update doc comments
5c32e46

docs: remove@internal
e354b40

docs: add@todo
0588960

feat: add $castHandlers to BaseModel
5aefb00
To add custom cast handlers.

fix: replace TypeError with InvalidArgumentException
2c576be
The framework should not throw Error.

docs: add about Custom Casting
411bf80

refactor: add readonly
464f627

test: add PHPDoc types
2043a51
To fix PhpStorm errors.

docs: fix rebase mistake
a8b1e4e

feat: use $db->dateFormat in DataCaster and DataConverter
45f10a3

feat: use $db->dateFormat in DatetimeCast
7cf4b87

chore: DataCaster depends on Database
8f0ac00

chore: skip rector bug
94c7f08

kenjis force-pushed the feat-model-type-casting branch from a08a87d to 94c7f08Compare February 12, 2024 23:53

kenjis marked this pull request as ready for review February 12, 2024 23:54

kenjis added 2 commits February 13, 2024 09:35

fix: take $updateOnlyChanged into account when using casts
eb2eb0a

refactor: add readonly
4ea7da1

kenjis merged commit eac87d1 into codeigniter4:4.5Feb 17, 2024

kenjis deleted the feat-model-type-casting branch February 17, 2024 02:08