braunstetter/valid-form-event

Fires an event whenever a root form is submitted and valid. So child forms can react and do stuff afterwards.

v0.1.0 2022-05-08 19:55 UTC

Requires

• php: ^8.0
• symfony/form: ^6
• symfony/framework-bundle: ^4.4|^5.0|^6.0

Requires (Dev)

• matthiasnoback/symfony-dependency-injection-test: ^4.2
• nyholm/symfony-bundle-test: 1.8.1
• symfony/test-pack: ^1.0
• symfony/validator: ^6.0

MIT

• event
• form
• form-event

README

The Symfony documentation recommends keeping logic out of forms and instead doing everything inside a controller. That's probably good advice most of the time, but exceptions prove the rule.

Because when you have flexible forms, like a page builder with flexible sections, it's very helpful if the individual sections could do things once the entire form is valid. (Like uploading an image)

This bundle provides exactly this functionality.

Installation

composer require braunstetter/valid-form-event

Usage

<?php


namespace App\Form\Paragraph;

use Braunstetter\MediaBundle\Manager\FilesystemManager;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\Extension\Core\Type\FileType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolver;
use Symfony\Component\Validator\Constraints\Image;
use Braunstetter\ValidFormEvent\Form\Event\ValidFormEvent;
use App\Entity\MyCustomPageBlock;

class MyPageBlockType extends AbstractType
{

    private FilesystemManager $filesystemManager;

    public function __construct(FilesystemManager $filesystemManager)
    {
        $this->filesystemManager = $filesystemManager->setFolder('/uploads/images/page_blocks');
    }

    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
            ->add('image', FileType::class, [
                'constraints' => [
                    new Image(['maxSize' => '5M'])
                ]
            ])
            ->add('description')

            // Here is the important part.
            // Inside the 'valid' event you can do whatever you want to.
            ->addEventListener(ValidFormEvent::NAME, function (ValidFormEvent $event) {
                $form = $event->getCurrentForm() ?? $event->getForm();

                if ($image = $form->get('image')->getData()) {
                    $this->filesystemManager->upload($image);
                }
            });

    }

    public function configureOptions(OptionsResolver $resolver): void
    {
        $resolver->setDefaults([
            'data_class' => MyCustomPageBlock::class,
        ]);
    }
}

That's pretty self-explanatory.

Everything works exactly the same as with the other Symfony FormEvents. It should also be noted that the $event->getCurrentForm() method is also available. This gives you the current form you are in - but only if that form is a child of a parent form. The parent form can easily be reached with $event->getForm().

This event works with all forms, even if they are nested.