Sylius/Symfony: Image Upload with custom entity - symfony

Question

I'm trying to use Sylius' ImagesUploadListener for a custom entity.
In the documentation it says I should listen to an event like "sylius.shipping_method.pre_create". For my custom entity there is no event called that I could hook on.
So what I tried was hooking on the product.pre_create event and giving my entity as a parameter, but it seems that the image upload is only triggered on the product entity and my entity configuration is ignored. Although the ImagesUploadListener is triggered two times, once from the core and once from my configuration.
The error I get is "Column 'path' cannot be null" which basically means that the ImagesUploadListener was not performing the image upload before saving the entity.
app.listener.images_upload:
class: Sylius\Bundle\CoreBundle\EventListener\ImagesUploadListener
parent: sylius.listener.images_upload
autowire: true
autoconfigure: false
public: false
tags:
- { name: kernel.event_listener, event: sylius.product.pre_create, entity: MyBundle\Entity\MyEntity, method: uploadImages }

Answer 1

There should be an event to hook on if you created the entity correctly (the Sylius way). You need to define the entity as a Resource:
# config/packages/sylius_resource.yaml
sylius_resource:
resources:
app.name_of_etity:
driver: doctrine/orm
classes:
model: App\Entity\NameOfEntity
If you defined the resource like this, the events would be:
event: app.system_manual.pre_create
event: app.app.name_of_entity.pre_update
Follow this guide:
https://docs.sylius.com/en/1.6/cookbook/entities/custom-model.html
Update
Because you are managing your custom entity through the existing product form the above will not work. To make it work, you can create your own event listener.
final class ProductSeoTranslationImagesUploadListener
{
/** #var ImageUploaderInterface */
private $uploader;
public function __construct(ImageUploaderInterface $uploader)
{
$this->uploader = $uploader;
}
public function uploadImages(GenericEvent $event): void
{
$subject = $event->getSubject();
// Add a ProductSeoInterface so you can use this check:
Assert::isInstanceOf($subject, ProductSeoInterface::class);
foreach ($subject->getSeo()->getTranslations() as $translation) {
Assert::isInstanceOf($translation, ImagesAwareInterface::class);
$this->uploadSubjectImages($translation);
}
}
private function uploadSubjectImages(ImagesAwareInterface $subject): void
{
$images = $subject->getImages();
foreach ($images as $image) {
if ($image->hasFile()) {
$this->uploader->upload($image);
}
// Upload failed? Let's remove that image.
if (null === $image->getPath()) {
$images->removeElement($image);
}
}
}
}
Tip: Create a (Product)SeoInterface so you can perform the type check.
Don't forget to register the eventListener:
App\EventListener\ProductSeoTranslationImagesUploadListener:
tags:
- {
name: kernel.event_listener,
event: sylius.product.pre_create,
method: uploadImages,
}
- {
name: kernel.event_listener,
event: sylius.product.pre_update,
method: uploadImages,
}