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

  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\Options;
  13. use Symfony\Component\OptionsResolver\OptionsResolver;
  14. use Symfony\Component\PropertyAccess\PropertyAccess;
  15. use Symfony\Component\PropertyAccess\PropertyAccessorInterface;
  16. use Symfony\Component\PropertyAccess\PropertyPath;
  17. use Vich\UploaderBundle\Form\DataTransformer\FileTransformer;
  18. use Vich\UploaderBundle\Handler\UploadHandler;
  19. use Vich\UploaderBundle\Mapping\PropertyMappingFactory;
  20. use Vich\UploaderBundle\Storage\StorageInterface;
  22. /**
  23.  * @author Kévin Gomez <contact@kevingomez.fr>
  24.  * @author Konstantin Myakshin <koc-dp@yandex.ru>
  25.  * @author Massimiliano Arione <max.arione@gmail.com>
  26.  */
  27. class VichFileType extends AbstractType
  28. {
  29.     /**
  30.      * @var StorageInterface
  31.      */
  32.     protected $storage;
  34.     /**
  35.      * @var UploadHandler
  36.      */
  37.     protected $handler;
  39.     /**
  40.      * @var PropertyMappingFactory
  41.      */
  42.     protected $factory;
  44.     /**
  45.      * @var PropertyAccessorInterface
  46.      */
  47.     protected $propertyAccessor;
  49.     public function __construct(
  50.         StorageInterface $storage,
  51.         UploadHandler $handler,
  52.         PropertyMappingFactory $factory,
  53.         PropertyAccessorInterface $propertyAccessor = null
  54.     ) {
  55.         $this->storage = $storage;
  56.         $this->handler = $handler;
  57.         $this->factory = $factory;
  58.         $this->propertyAccessor = $propertyAccessor ?: PropertyAccess::createPropertyAccessor();
  59.     }
  61.     public function configureOptions(OptionsResolver $resolver): void
  62.     {
  63.         $resolver->setDefaults([
  64.             'allow_delete' => true,
  65.             'asset_helper' => false,
  66.             'download_link' => null,
  67.             'download_uri' => true,
  68.             'download_label' => 'vich_uploader.link.download',
  69.             'delete_label' => 'vich_uploader.form_label.delete_confirm',
  70.             'error_bubbling' => false,
  71.         ]);
  73.         $resolver->setAllowedTypes('allow_delete', 'bool');
  74.         $resolver->setAllowedTypes('asset_helper', 'bool');
  75.         $resolver->setAllowedTypes('download_link', ['null', 'bool']);
  76.         $resolver->setAllowedTypes('download_uri', ['bool', 'string', 'callable']);
  77.         $resolver->setAllowedTypes('download_label', ['bool', 'string', 'callable', PropertyPath::class]);
  78.         $resolver->setAllowedTypes('error_bubbling', 'bool');
  80.         $downloadUriNormalizer = static function (Options $options, $downloadUri) {
  81.             if (null !== $options['download_link']) {
  82.                 @\trigger_error('The "download_link" option is deprecated since version 1.6 and will be removed in 2.0. You should use "download_uri" instead.', \E_USER_DEPRECATED);
  84.                 return $options['download_link'];
  85.             }
  87.             return $downloadUri;
  88.         };
  90.         $resolver->setNormalizer('download_uri', $downloadUriNormalizer);
  91.     }
  93.     public function buildForm(FormBuilderInterface $builder, array $options): void
  94.     {
  95.         $builder->add('file', Type\FileType::class, [
  96.             'required' => $options['required'],
  97.             'label' => $options['label'],
  98.             'attr' => $options['attr'],
  99.             'translation_domain' => $options['translation_domain'],
  100.         ]);
  102.         $builder->addModelTransformer(new FileTransformer());
  104.         if ($options['allow_delete']) {
  105.             $this->buildDeleteField($builder, $options);
  106.         }
  107.     }
  109.     protected function buildDeleteField(FormBuilderInterface $builder, array $options): void
  110.     {
  111.         // add delete only if there is a file
  112.         $builder->addEventListener(FormEvents::PRE_SET_DATA, function (FormEvent $event) use ($options): void {
  113.             $form = $event->getForm();
  114.             $parent = $form->getParent();
  115.             // no object: no delete button
  116.             if (null === $parent) {
  117.                 return;
  118.             }
  119.             $object = $parent->getData();
  121.             // no object or no uploaded file: no delete button
  122.             if (null === $object || null === $this->storage->resolveUri($object, $this->getFieldName($form))) {
  123.                 return;
  124.             }
  126.             $form->add('delete', Type\CheckboxType::class, [
  127.                 'label' => $options['delete_label'],
  128.                 'mapped' => false,
  129.                 'translation_domain' => $options['translation_domain'],
  130.                 'required' => false,
  131.             ]);
  132.         });
  134.         // delete file if needed
  135.         $builder->addEventListener(FormEvents::POST_SUBMIT, function (FormEvent $event): void {
  136.             $form = $event->getForm();
  137.             $object = $form->getParent()->getData();
  138.             $delete = $form->has('delete') ? $form->get('delete')->getData() : false;
  140.             if (!$delete) {
  141.                 return;
  142.             }
  144.             $this->handler->remove($object, $this->getFieldName($form));
  145.         });
  146.     }
  148.     public function buildView(FormView $view, FormInterface $form, array $options): void
  149.     {
  150.         $object = $form->getParent()->getData();
  151.         $view->vars['object'] = $object;
  153.         $view->vars['download_uri'] = null;
  154.         if ($options['download_uri'] && $object) {
  155.             $view->vars['download_uri'] = $this->resolveUriOption($options['download_uri'], $object, $form);
  156.             $view->vars = \array_replace(
  157.                 $view->vars,
  158.                 $this->resolveDownloadLabel($options['download_label'], $object, $form)
  159.             );
  160.         }
  162.         $view->vars['asset_helper'] = $options['asset_helper'];
  163.     }
  165.     public function getBlockPrefix(): string
  166.     {
  167.         return 'vich_file';
  168.     }
  170.     final protected function getFieldName(FormInterface $form): string
  171.     {
  172.         return $form->getConfig()->getOption('property_path') ?? $form->getName();
  173.     }
  175.     /**
  176.      * @param bool|callable $uriOption
  177.      *
  178.      * @return string|bool|null
  179.      */
  180.     protected function resolveUriOption($uriOption, object $object, FormInterface $form)
  181.     {
  182.         if (true === $uriOption) {
  183.             return $this->storage->resolveUri($object, $this->getFieldName($form));
  184.         }
  186.         if (\is_callable($uriOption)) {
  187.             return $uriOption($object, $this->storage->resolveUri($object, $this->getFieldName($form)));
  188.         }
  190.         return $uriOption;
  191.     }
  193.     /**
  194.      * @param bool|callable|object $downloadLabel
  195.      */
  196.     protected function resolveDownloadLabel($downloadLabel, object $object, FormInterface $form): array
  197.     {
  198.         if (true === $downloadLabel) {
  199.             $mapping = $this->factory->fromField($object, $this->getFieldName($form));
  201.             return ['download_label' => $mapping->readProperty($object, 'originalName'), 'translation_domain' => false];
  202.         }
  204.         if (\is_callable($downloadLabel)) {
  205.             $result = $downloadLabel($object);
  207.             return [
  208.                 'download_label' => $result['download_label'] ?? $result,
  209.                 'translation_domain' => $result['translation_domain'] ?? false,
  210.             ];
  211.         }
  213.         if ($downloadLabel instanceof PropertyPath) {
  214.             return [
  215.                 'download_label' => $this->propertyAccessor->getValue($object, $downloadLabel),
  216.                 'translation_domain' => false,
  217.             ];
  218.         }
  220.         return ['download_label' => $downloadLabel];
  221.     }
  222. }