Entity property with unknown type is ignored

[mabar]

Describe the bug

Properties using generic array syntax and defining key type are ignored.

To Reproduce

1. Create an entity (of type Nextras\Orm\Entity\Entity)
2. Add property @property array<string, string> $example
3. Assign value to $example property, EntityMetadata should throw exception

Expected behavior

@property array<string, string> $example is a valid property, same as (currently valid) @property array<string> $example or at least throw an exception describing syntax is not supported.

Versions::

• Orm: 4.0.2
• Dbal: 4.0.2
• Database: Postgres 13

[hrach]

The question is what is the proper fix. I'd rather refrain from depending on some phodoc parser able to handle this 🤔

[mabar]

I would say phpstan/phpdoc-parser is reasonable dependency. But not supporting it and just informing by throwing exception might be good enough too. Entity implementation using real properties and attributes may come with an alternative anyway so the opcache.save_comments could be enabled.

[hrach]

I would say there are three tasks:

• throw when invalid type is detected
• support reading array* and just validating it as an array
• support validating array against the full type

The validation is rather too complicated and I would refrain from doing so 🤔 Supporting just the parsing could be nicely and easily done without an dependency. I do not expect any other more complex types like functional types and so.

[hrach]

With the increased amount of what types can be (newly union types in PHP 8.1), we should use PHPStans phpdoc parser.

The question is how the validation should work. Probably full validation should be implemented.

[hrach]

"Full" validation actually means just:

• validate first level of intersection & union types
• no support for generics (including an array generics)
• no support for array shapes
• no support for callables
• validate simple array type (array)
• validate class/interface types
• validate primitive types (int, bool, float, string)
• validate nullable types

[mabar]

What will be the behavior for not supported types? Throw exception or note in documentation type may not be true? Exception is safer but it will likely lead to requests for types users actually do use.

[hrach]

Either:

• nothing -> you should use static analysis
• exception that can be muted by modifier (~{typeNotCheckedAtRuntime})

/shrug