vendor/vich/uploader-bundle/src/Form/Type/VichFileType.php line 26

  1. <?php
  3. namespace Vich\UploaderBundle\Form\Type;
  5. use Symfony\Component\Form\AbstractType;
  6. use Symfony\Component\Form\Extension\Core\Type;
  7. use Symfony\Component\Form\FormBuilderInterface;
  8. use Symfony\Component\Form\FormEvent;
  9. use Symfony\Component\Form\FormEvents;
  10. use Symfony\Component\Form\FormInterface;
  11. use Symfony\Component\Form\FormView;
  12. use Symfony\Component\OptionsResolver\OptionsResolver;
  13. use Symfony\Component\PropertyAccess\PropertyAccess;
  14. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  15. use Symfony\Component\PropertyAccess\PropertyPath;
  16. use Vich\UploaderBundle\Form\DataTransformer\FileTransformer;
  17. use Vich\UploaderBundle\Handler\UploadHandler;
  18. use Vich\UploaderBundle\Mapping\PropertyMappingFactory;
  19. use Vich\UploaderBundle\Storage\StorageInterface;
  21. /**
  22.  * @author Kévin Gomez <contact@kevingomez.fr>
  23.  * @author Konstantin Myakshin <koc-dp@yandex.ru>
  24.  * @author Massimiliano Arione <max.arione@gmail.com>
  25.  */
  26. class VichFileType extends AbstractType
  27. {
  28.     protected readonly PropertyAccessorInterface $propertyAccessor;
  30.     public function __construct(
  31.         protected readonly StorageInterface $storage,
  32.         protected readonly UploadHandler $handler,
  33.         protected readonly PropertyMappingFactory $factory,
  34.         PropertyAccessorInterface $propertyAccessor = null
  35.     ) {
  36.         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  37.     }
  39.     public function configureOptions(OptionsResolver $resolver): void
  40.     {
  41.         $resolver->setDefaults([
  42.             'allow_delete' => true,
  43.             'asset_helper' => false,
  44.             'download_uri' => true,
  45.             'download_label' => 'vich_uploader.link.download',
  46.             'delete_label' => 'vich_uploader.form_label.delete_confirm',
  47.             'error_bubbling' => false,
  48.         ]);
  50.         $resolver->setAllowedTypes('allow_delete', 'bool');
  51.         $resolver->setAllowedTypes('asset_helper', 'bool');
  52.         $resolver->setAllowedTypes('download_uri', ['bool', 'string', 'callable']);
  53.         $resolver->setAllowedTypes('download_label', ['bool', 'string', 'callable', PropertyPath::class]);
  54.         $resolver->setAllowedTypes('error_bubbling', 'bool');
  55.     }
  57.     public function buildForm(FormBuilderInterface $builder, array $options): void
  58.     {
  59.         $builder->add('file', Type\FileType::class, [
  60.             'required' => $options['required'],
  61.             'label' => $options['label'],
  62.             'attr' => $options['attr'],
  63.             'translation_domain' => $options['translation_domain'],
  64.         ]);
  66.         $builder->addModelTransformer(new FileTransformer());
  68.         if ($options['allow_delete']) {
  69.             $this->buildDeleteField($builder, $options);
  70.         }
  71.     }
  73.     protected function buildDeleteField(FormBuilderInterface $builder, array $options): void
  74.     {
  75.         // add delete only if there is a file
  76.         $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) use ($options): void {
  77.             $form = $event->getForm();
  78.             $parent = $form->getParent();
  79.             // no object: no delete button
  80.             if (null === $parent) {
  81.                 return;
  82.             }
  83.             $object = $parent->getData();
  85.             // no object or no uploaded file: no delete button
  86.             if (null === $object || null === $this->storage->resolveUri($object, $this->getFieldName($form))) {
  87.                 return;
  88.             }
  90.             $form->add('delete', Type\CheckboxType::class, [
  91.                 'label' => $options['delete_label'],
  92.                 'mapped' => false,
  93.                 'translation_domain' => $options['translation_domain'],
  94.                 'required' => false,
  95.             ]);
  96.         });
  98.         // delete file if needed
  99.         $builder->addEventListener(FormEvents::POST_SUBMIT, function (FormEvent $event): void {
  100.             $form = $event->getForm();
  101.             $object = $form->getParent()->getData();
  102.             $delete = $form->has('delete') ? $form->get('delete')->getData() : false;
  104.             if (!$delete) {
  105.                 return;
  106.             }
  108.             $this->handler->remove($object, $this->getFieldName($form));
  109.         });
  110.     }
  112.     public function buildView(FormView $view, FormInterface $form, array $options): void
  113.     {
  114.         $object = $form->getParent()->getData();
  115.         $view->vars['object'] = $object;
  117.         $view->vars['download_uri'] = null;
  118.         if ($options['download_uri'] && $object) {
  119.             $view->vars['download_uri'] = $this->resolveUriOption($options['download_uri'], $object, $form);
  120.             $view->vars = \array_replace(
  121.                 $view->vars,
  122.                 $this->resolveDownloadLabel($options['download_label'], $object, $form)
  123.             );
  124.         }
  126.         $view->vars['asset_helper'] = $options['asset_helper'];
  127.     }
  129.     public function getBlockPrefix(): string
  130.     {
  131.         return 'vich_file';
  132.     }
  134.     final protected function getFieldName(FormInterface $form): string
  135.     {
  136.         return $form->getConfig()->getOption('property_path') ?? $form->getName();
  137.     }
  139.     protected function resolveUriOption(mixed $uriOption, object $object, FormInterface $form): string|bool|null
  140.     {
  141.         if (true === $uriOption) {
  142.             return $this->storage->resolveUri($object, $this->getFieldName($form));
  143.         }
  145.         if (\is_callable($uriOption)) {
  146.             return $uriOption($object, $this->storage->resolveUri($object, $this->getFieldName($form)));
  147.         }
  149.         return $uriOption;
  150.     }
  152.     protected function resolveDownloadLabel(mixed $downloadLabel, object $object, FormInterface $form): array
  153.     {
  154.         if (true === $downloadLabel) {
  155.             $fieldName = $this->getFieldName($form);
  156.             $mapping = $this->factory->fromField($object, $fieldName);
  157.             if (null === $mapping) {
  158.                 throw new \UnexpectedValueException(\sprintf('Cannot find mapping for "%s" field', $fieldName));
  159.             }
  161.             return ['download_label' => $mapping->readProperty($object, 'originalName'), 'translation_domain' => false];
  162.         }
  164.         if (\is_callable($downloadLabel)) {
  165.             $result = $downloadLabel($object);
  167.             return [
  168.                 'download_label' => $result['download_label'] ?? $result,
  169.                 'translation_domain' => $result['translation_domain'] ?? false,
  170.             ];
  171.         }
  173.         if ($downloadLabel instanceof PropertyPath) {
  174.             return [
  175.                 'download_label' => $this->propertyAccessor->getValue($object, $downloadLabel),
  176.                 'translation_domain' => false,
  177.             ];
  178.         }
  180.         return ['download_label' => $downloadLabel];
  181.     }
  182. }