Generate property annotations for Model

[DenTray]

Need to extend model generation logic by generating @property annotations for each model's field

Description

What needs to be done?

Enhance the existing model generation script to automatically create @property annotations for each field of the model. For each field declared in the generation command, the script should determine the corresponding PHP type and generate a @property annotation indicating the type and field name in the model's PHPDoc block. The annotations should be added to the top of the generated model file. For example, fields like -e User should generate @property int user_id, and timestamps like -t first_booked_at should generate @property Carbon first_booked_at.

Expected Outcome

What is the expected result?

The generated model file will contain accurate @property annotations reflecting each field’s type and name. For the example command:

php artisan make:entity Property -S name -e User -F price -b is_free -t first_booked_at -j meta

The model will include the following PHPDoc annotations:

/**
 * @property int user_id
 * @property float price
 * @property string name
 * @property bool is_free
 * @property Carbon first_booked_at
 * @property array meta
 */

Verification Scenarios

How can this be tested?

1. Run the model generation command with various combinations of fields and flags (like -e, -F, -S, etc.).
2. Check that the generated model file contains @property annotations correctly mapping field names to their expected types and names (including type hints like int, float, string, bool, Carbon, array).
3. Verify that all fields passed in the command are included as annotations in the model PHPDoc block without duplicates or typos.
4. Confirm the annotations are syntactically correct and do not cause PHPDoc or IDE parsing errors.
5. Ensure no debug information or errors occur during generation.

[artengin]

Ready to complete the task.

I have a couple of questions:

1. If the field type implies a null value (e.g. -s name), should the @property be written like this?

@property string|null $name

2. If the model doesn't contain any fields, should the @property block be omitted entirely, or should it be included as an empty docblock like this?

/**
 */

[artengin]

Implemented automatic generation of @property annotations.
If any changes are needed, I’ll make them promptly :)

[DenTray]

Ready to complete the task.

I have a couple of questions:

1. If the field type implies a null value (e.g. -s name), should the @property be written like this?

@property string|null $name

2. If the model doesn't contain any fields, should the @property block be omitted entirely, or should it be included as an empty docblock like this?

/**
 */

@artengin thanks for your questions!

1. Let's add null using type union (|), it is a good point
2. Let's generate TODO in this case

[DenTray]

@artengin all good, but need to add minor change, need to import Carbon class only in case model has datetime fields

[DenTray]

@artengin all works great now! Thanks!

Released in https://github.com/RonasIT/laravel-entity-generator/releases/tag/3.3.7