Externally Stored Product Images

Out-of-the-box, product images are stored in-house and with the support of Digital Asset Manager. If you need to switch the product images field to the externally stored files flow, you have to do it manually via code as the Stored Externally entity field config cannot be changed from the UI for the already existing fields.

Note

The rule of thumb is to decide how product images field should work before you create products and upload images. Otherwise, you may have to create a data migration for the already existing product images.

Note

Switching to the externally stored product images flow disables Digital Asset Manager for that field.

Below you can find the example of how to manually switch to the externally stored product images flow.

1. Create the migration that switches attachment.is_stored_externally entity field config to true:

   src/Acme/Bundle/DemoBundle/Migrations/Schema/v1_0/EnableIsStoredExternallyForProductImage.php

   namespace Acme\Bundle\DemoBundle\Migrations\Schema\v1_0;
   
   use Doctrine\DBAL\Schema\Schema;
   use Oro\Bundle\EntityConfigBundle\Migration\UpdateEntityConfigFieldValueQuery;
   use Oro\Bundle\MigrationBundle\Migration\Migration;
   use Oro\Bundle\MigrationBundle\Migration\QueryBag;
   use Oro\Bundle\ProductBundle\Entity\ProductImage;
   
   class EnableIsStoredExternallyForProductImage implements Migration
   {
       /**
        * @inheritDoc
        */
       public function up(Schema $schema, QueryBag $queries)
       {
           $queries->addPostQuery(
               new UpdateEntityConfigFieldValueQuery(ProductImage::class, 'image', 'attachment', 'is_stored_externally', true)
           );
       }
   }
   

Note

This code works with the upgrade only. If you need it to work with installation, update these metadata with the data migration.

2. Create the form type extension for the Oro\Bundle\ProductBundle\Form\Type\ProductImageType form type to toggle the isExternalFile form option:

   src/Acme/Bundle/DemoBundle/Form/Extension/ProductImageExtension.php

   namespace Acme\Bundle\DemoBundle\Form\Extension;
   
   use Oro\Bundle\AttachmentBundle\Form\Type\ImageType;
   use Oro\Bundle\ProductBundle\Form\Type\ProductImageType;
   use Symfony\Component\Form\AbstractTypeExtension;
   use Symfony\Component\Form\FormBuilderInterface;
   
   class ProductImageExtension extends AbstractTypeExtension
   {
       /**
        * @inheritDoc
        */
       public static function getExtendedTypes(): iterable
       {
           return [ProductImageType::class];
       }
   
       /**
        * @inheritDoc
        */
       public function buildForm(FormBuilderInterface $builder, array $options): void
       {
           $builder->add('image', ImageType::class, ['allowDelete' => false, 'isExternalFile' => true]);
       }
   }
   

   src/Acme/Bundle/DemoBundle/Resources/config/services.yml

   services:
       acme.form.extension.product_image:
           class: Acme\Bundle\DemoBundle\Form\Extension\ProductImageExtension
           tags:
               - { name: form.type_extension }
   

Note

The product image field is system-owned, therefore you need to create a form extension as the product image field’s options should be controlled explicitly by a developer. For the custom extend fields added to a form automatically, form options are generated automatically so you do not have to create a form extension that toggles an option.

Afterward, the product images field on a the product form will switch from the file upload input to the external URL input. The application will not process, resize or modify product images, but return an external URL as is. Product images import will also switch to the externally stored files, so it will not try to upload files, but only pick their URLs.

Note

If you need to have more control on how the externally stored files URLs are used for displaying images, look towards custom URL provider.