Skip to content
This repository has been archived by the owner on Feb 13, 2021. It is now read-only.

Latest commit

 

History

History
128 lines (89 loc) · 5.24 KB

UPGRADE.md

File metadata and controls

128 lines (89 loc) · 5.24 KB
Raw

Upgrading from v1.12.0 to 1.13.0

  • not using a namer is deprecated. You should always configure a namer.
  • DownloadHandler doesn't convert names of files anymore. You should not relay on it for your files, but convert names at upload time (using a namer, see previous point).
  • namer use symfony/string instead of behat/transliterator. This should not cause any visibile effect.
  • support for templating component was removed. You should use Twig.
  • Flysystem now is supported also via league/flysystem-bundle

Upgrading from v1.11.0 to 1.12.0

  • Propel support has been dropped. It was likely not working since a while. If you need to use this bundle with Propel, you need to use a previous bundle version.
  • Default configuration directory changed from Resources/config/vich_uploader to config/vich_uploader. Old path is still supported, but deprecated.

Upgrading from v1.8.0 to 1.11.0

  • minor BC-BREAK: methods resolvePath and resolveUri in StorageInterface now accepts null in second argument. This will affect you only if you implementd a custom storage, without extending base AbstractStorage class.

Upgrading from v1.6.0 to 1.8.0

  • we enforced, via type-hinting, as many parameters and return values as we can. This is formally a BC break, but likely you don't need to change anything in your code. Anyway, if you implemented an interface or extended a bundle class with your custom class, you need to check to be consistent with such type hinting.

Upgrading from v1.0.0 to 1.6.0

  • the transliteration is now using behat\transliterator instead of a custom one. Some minor differences are that dash is not preserved anymore and names are lowercased.
  • the form option download_link now is deprecated, use download_uri instead.
  • BC-BREAK in order to fixing #704 for xml and yaml mapping you should prepend relative from bundle sub-namespace to each mapping file. For example for Entity\Product mapping file would be renamed from Product.xml to Entity.Product.xml, for Document\Article: Article.yml -> Document.Article.yml.

Upgrading from v0.14.0 to v1.0.0

No BC breaks.

Upgrading from v0.13.0 to v0.14.0

No BC breaks.

Upgrading from v0.12.0 to v0.13.0

  • the resolvePath and resolveUri Storage methods now take a field name instead of a mapping name. The same goes for the UploaderExtension and UploaderHelper asset method. This reverts the broken behavior introduced in v0.10.0.
  • the mapping option for form types is removed as the mapping to use is inferred from the field's name.

Upgrading from v0.11.0 to v0.12.0

  • the storage configuration paramater changed. It accepts the name of the storage engine to use (file_system, gaufrette or flysystem).
  • the gaufrette and flysystem configuration parameters were deleted.

Upgrading from v0.10.0 to v0.11.0

  • Symfony versions prior to 2.3 are not supported anymore.

Upgrading from v0.9.0 to v0.10.0

  • inject_on_load config param defaults to false. Set it to true if you want to keep your old behavior.

  • the NamerInterface and DirectoryNamerInterface were modified.

  • the resolvePath and resolveUri Storage methods now take a mapping name instead of a field name. The same goes for the UploaderExtension and UploaderHelper asset method.

Upgrading from v0.5.0 to 0.6.0

  • getUriPrefix default value is now /uploads

  • delete_on_update config param added. It defaults to true.

Upgrading from v0.4.0 to v0.5.0

  • gaufrette and KnpGaufretteBundle are now soft dependencies

  • storage configuration entry added.

  • web_dir_name configuration entry deprecated.

  • mapping:upload_dir configuration entry renamed to mapping:upload_destination

  • mapping:uri_prefix configuration entry added

  • The old vich_uploader.uploader service has been split into two new services for a more modular, separation of concerns approach. The new services are vich_uploader.storage.gaufrette and vich_uploader.file_injector. The storage service is responsible for saving and removing files as well as resolving their path. The injector service is responsible for injecting File instances back into the object upon retrieval from the datastore.

Upgrading from v0.2.0 to v0.3.0

  • Annotations have changed namespace from Vich\UploaderBundle\Annotation to Vich\UploaderBundle\Mapping\Annotation. You will need to update your use statement for the annotations used in your entity or document classes.

  • The mappings configuration entry prototype has had a new option added to it. The inject_on_load config option specifies whether or not the uploadable fields should have an instnace of Symfony\Component\HttpFoundation\File\File created and injected into the property upon retrieval from the datastore. THis option has a default value of true.