Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

📝 (Doctrine) Update docs & package suggestions #1351

Merged
merged 4 commits into from
Jan 30, 2023
Merged
Show file tree
Hide file tree
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions UPGRADE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,3 +13,4 @@
* the new default type for mapping is "attribute". You can still use annotations, but you need an explicit definition (set "annotation" as value for "vich_uploader.metadata.type" config key)
* the service "vich_uploader.current_date_time_helper" has been removed. The `DateTimeHelper` interface has been
removed as well.
* if your project use `doctrine-bundle` >= 2.8 version, you must require `doctrine/annotations` in order to use annotations or attributes for mapping
1 change: 1 addition & 0 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -58,6 +58,7 @@
"symfony/yaml": "^5.4 || ^6.0"
},
"suggest": {
"doctrine/annotations": "If your project use doctrine-bundle:>=2.8, this package is required to use annotations or attributes",
"doctrine/doctrine-bundle": "For integration with Doctrine",
"doctrine/mongodb-odm-bundle": "For integration with Doctrine ODM",
"doctrine/orm": "For integration with Doctrine ORM",
Expand Down
7 changes: 7 additions & 0 deletions docs/known_issues.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,3 +132,10 @@ in a separate API call. In the other hand, for other adapters setting the metada
metadata is joined with the file during the upload.
To summarize, [Gaufrette support for metadata is flawed](https://github.com/KnpLabs/Gaufrette/issues/108)
(see issue [GH-163](https://github.com/dustin10/VichUploaderBundle/issues/163)).

## Doctrine/annotations package required when using doctrine-bundle >= 2.8

If your project is using `doctrine-bundle:>=2.8`, you must require `doctrine/annotations` package from
your project as it is not required in `doctrine-bundle` anymore from this version.
This bundle is using a `Reader` interface from this package in order to work for both annotations
and attributes mapping.