Deprecate field type annotation classes in favor of Field #1318
Conversation
|
I think this among the others from bigger list should have different notes? Beside that big 👍 for going through everything! |
|
Yes, we could expand the wording, should we also add an example of how the field show be mapped? |
Was thinking about it and frankly I'm not sure... existing examples are updated for the new way and we could use that until absolute removal which will need documentation changes anyway so we could postpone writing new chapter? Unless you feel like doing that :D |
|
I'm not sure we need this. I think for 1.1 just deprecating the classes is a good first step. We can then always throw deprecation notices in |
|
👍 |
|
Another 👍 after rewording deprecation notes :) |
| @@ -19,7 +19,10 @@ | |||
|
|
|||
| namespace Doctrine\ODM\MongoDB\Mapping\Annotations; | |||
|
|
|||
| /** @Annotation */ | |||
| /** | |||
| * @Annotation | |||
There was a problem hiding this comment.
Is @Annotation a convention from Doctrine ORM or Symfony? I'm curious if we should just replace this with a one-line class description (e.g. "Annotation for binary data field").
There was a problem hiding this comment.
IIRC, the @Annotation annotation tells the annotation reader that the class in question can be used as an annotation.
I'm actually 👍 to documenting annotation classes and their properties while we're at it.
|
One question above, but LGTM otherwise. Thanks for the tedious search/replace job! |
| @@ -19,7 +19,11 @@ | |||
|
|
|||
| namespace Doctrine\ODM\MongoDB\Mapping\Annotations; | |||
|
|
|||
| /** @Annotation */ | |||
| /** | |||
| * Identifies a class as document that can be stored in the database | |||
Closes #1207.
Starting with PHP 7, some of the type annotation ODM uses are reserved keywords:
To avoid having large inconsistencies we decided to deprecate all type annotations (e.g. those extending
AbstractFieldand only overwriting thetypeproperty) to be removed in ODM 2.0. This affects the following annotation classes:Instead, users should switch to using
@Field(type="...")to map fields.