Fallback attributes in the @ApiResource annotation #1788
Conversation
meyerbaptiste
force-pushed
the
fallback_attributes_api_resource_annotation
branch
3 times, most recently
from
cf73222 to
1e4dbad
Compare
src/Annotation/ApiResource.php
Outdated
| /** | ||
| * @var string | ||
| */ | ||
| private $accessControl; |
There was a problem hiding this comment.
Can you add a reference to the PHPStorm plugin issue, so we'll not forget and drop those properties later :)
| * @Attribute("shortName", type="string"), | ||
| * @Attribute("subresourceOperations", type="array"), | ||
| * @Attribute("validationGroups", type="mixed") | ||
| * ) |
There was a problem hiding this comment.
FTR I'm using vim and all I see is noise 😈
(it's friday I'm allowed to rage coz I'm a hater)
There was a problem hiding this comment.
Dear @soyuka,
I encourage you to download a real IDE. Here is the link to PHPStorm: https://www.jetbrains.com/phpstorm/download/.
I hope this could help you to find the truth!
Yours sincerely.
There was a problem hiding this comment.
More seriously, @Attribute annotations are needed when using a constructor in your annotation class. The noise here are the private properties.
meyerbaptiste
force-pushed
the
fallback_attributes_api_resource_annotation
branch
from
1e4dbad to
87edf6c
Compare
meyerbaptiste
force-pushed
the
fallback_attributes_api_resource_annotation
branch
from
87edf6c to
2cbee1d
Compare
| private $routePrefix; | ||
|
|
||
| /** | ||
| * @see https://github.com/Haehnchen/idea-php-annotation-plugin/issues/112 |
There was a problem hiding this comment.
Why not having it on the class level since it's on every property?
There was a problem hiding this comment.
Because we may introduce other properties for valid reasons later.
|
Thanks @meyerbaptiste |
|
I wonder if these could be fully documented in the docs? |
|
Yes it will be @bendavies, it's on my todo list 😉 |
|
Didn't see this earlier, but I also think it's bad, as the attributes were arbitrary keys we used, and many of them were specific to the Symfony integration. But now they've been elevated to a more important status. |
This PR adds the ability to configure resource attributes directly at the first level of the
@ApiResourceannotation. This improves the DX by adding autocompletion on annotation properties with modern IDEs.Attribute keys are normally in snake_case but we use lowerCamelCase at the first level of the
@ApiResourceannotation. So I made the choice to define them also in lowerCamelCase here but they are then normalized to snake_case.About private properties (see the second commit), they are "virtual" because of this issue: Haehnchen/idea-php-annotation-plugin#112. I don't like that, so if you have a better idea, just tell me.
In the same way, what about priorities? For example, actually:
validationGroups={"foo"}, attributes={"validation_groups"={"bar"}}=['bar'].Are you agree? Or do you want
['foo']or['foo', 'bar']instead?