Download the PHP package fresh/vich-uploader-serialization-bundle without Composer
On this page you can find all versions of the php package fresh/vich-uploader-serialization-bundle. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download fresh/vich-uploader-serialization-bundle
More information about fresh/vich-uploader-serialization-bundle
Files in fresh/vich-uploader-serialization-bundle
Package vich-uploader-serialization-bundle
Short Description Provides integration between VichUploaderBundle and JMSSerializerBundle.
License MIT
Homepage https://github.com/fre5h/VichUploaderSerializationBundle
Informations about the package vich-uploader-serialization-bundle
VichUploaderSerializationBundle
:package: Provides integration between VichUploaderBundle and
JMSSerializerBundle.
Allows to generate full or relative URIs to entity fields mapped with @Vich
and @JMS
annotations during the serialization.
Requirements 🧐
- PHP 7.3, 7.4, 8.0, 8.1, 8.2
- Symfony 5.0, 5.1, 5.2, 5.3, 5.4, 6.0, 6.1, 6.2
Installation 🌱
Usage 🧑🎓
Add the next class to the use
section of your entity class.
Bundle provides two annotations which allow the serialization of @Vich\UploadableField
fields in your entities.
At first you have to add @Fresh\VichSerializableClass
to the entity class which has uploadable fields.
Then you have to add @Fresh\VichSerializableField
annotation to the uploadable field you want to serialize.
Annotation @Fresh\VichSerializableClass
does not have any option.
Annotation @Fresh\VichSerializableField
has one required option value (or field) which value should link to the field with @Vich\UploadableField
annotation.
It can be set like this @Fresh\VichSerializableField("photoFile")
or @Fresh\VichSerializableField(field="photoFile")
.
Also there is another option includeHost
, it is not required and by default is set to true.
But if you need, you can exclude the host from the generated URI, just use the next variant of the annotation @Fresh\VichSerializableField("photoFile", includeHost=false)
.
And also don't forget that to serialize Vich uploadable fields they also should be marked with @JMS
annotations to be serialized.
The generated URI by default:
The generated URI with includeHost
set to false
:
Example of entity with serialized uploadable fields
Don't make a mistake!
Additional example of a wrong usage of provided annotations to attract your attention.
Use @Fresh\VichSerializableField
only with the field which is mapped with @ORM\Column
,
because this field is mapped to a database and keeps the name of the stored file.
Don't use the @Fresh\VichSerializableField
with a field which also mapped with @Vich\UploadableField
,
this is a wrong use case and will throw an exception!
So the next example is the incorrect usage of provided annotations! Don't do so!
Contributing 🤝
See CONTRIBUTING file.
All versions of vich-uploader-serialization-bundle with dependencies
doctrine/cache Version ^1.11
doctrine/common Version ^2.11|^3.0
doctrine/persistence Version ^1.3|^2.0
jms/serializer-bundle Version ^3.7|v4.0
monolog/monolog Version ^2.0
symfony/config Version ^5.0|^6.0
symfony/dependency-injection Version ^5.0|^6.0
symfony/property-access Version ^5.0|^6.0
symfony/routing Version ^5.0|^6.0
vich/uploader-bundle Version ^1.16