symftony/form-handler

A Symfony form handler

v1.0.0 2024-02-05 20:35 UTC

Requires

• php: >=8.1
• symfony/form: ^6.1

Requires (Dev)

• phpspec/prophecy: ^1.0@dev
• phpspec/prophecy-phpunit: ^2.1
• phpunit/phpunit: ^9.1
• symfony/config: ^6.1
• symfony/contracts: ^3.5@dev
• symfony/dependency-injection: ^6.1
• symfony/http-kernel: ^6.1
• symfony/serializer: ^6.1
• symfony/translation: ^6.1
• symfony/validator: ^6.1

Suggests

• symfony/config: ^6.1
• symfony/dependency-injection: ^6.1
• symfony/http-kernel: ^6.1
• symfony/serializer: ^6.1
• symfony/translation: ^6.1

MIT

• Anthony

• symfony
• form
• bundle
• handler

README

Symfony form handler abstraction

Demo

You can try this library on Demo Form-handler

Installation

The recommended way to install FormHandler is through Composer.

# Install Composer
curl -sS https://getcomposer.org/installer | php

php composer require symftony/form-handler

After installing, you need to require Composer's autoloader:

require 'vendor/autoload.php';

Documentation

This bundle provide a build in FormHandler and TypeExtension.

The TypeExtension add options to the Symfony FormType

• handler_invalid = true to throw InvalidFormException
• handler_not_submitted = true to throw NotSubmittedFormException
• handler_transformation_failed = true to throw TransformationFailedFormException

If you set a data instead of true in this option the FormHandler::handle return it if the case append

Use in Symfony

Add the bundle to your kernel app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            ...
            new Symftony\FormHandler\FormBundle\FormHandlerBundle(),
            ...
        ];
    }
    ...

Use the built in FormHandler in a controller

    public function yourAction(Request $request)
    {
        $formHandler = $this->get('form_handler.form_handler.default');
        // Throw exception if the form is NotSubmit/NotValid/TransformFailed
        $form = $formHandler->createForm(TextType::class, 'my-value', 'My default data', [
            'method' => 'GET',
            'handler_invalid' => true,
            'handler_not_submitted' => true,
            'handler_transformation_failed' => true,
        ]);
        // You get the $form->getData() if all succeed
        $result = $formHandler->handleRequest($form, $request);

        return $this->render('default/index.html.twig', [
            'form' => $form->createView(),
            'result' => $result,
        ]);
    }

You can add a try/catch to handle Exception by yourself OR implement a KernelException

Extends the FormHandler

Create YourFormHandler and extends FormHandler

<?php

namespace AppBundle\Form\Handler;

use Symfony\Component\HttpFoundation\Request;
use Symftony\FormHandler\FormHandler;

class YourFormHandler extends FormHandler
{
    public function createFromRequest(Request $request, $notSubmitted = true, $invalid = true)
    {
        $form = $this->createForm(TextType::class, 'my-value', 'My default data', [
            'handler_not_submitted' => $notSubmitted,
            'handler_invalid' => $invalid,
        ]);

        $result = $this->handleRequest($form, $request);

        // DO whatever you want with your $result
        
        return $result
    }
}

Declare as a service

services:
    app.form_handler.your:
        class: AppBundle\Form\Handler\YourFormHandler
        tags:
            - { name: 'form.handler' }

/!\ Dont forget to tag with 'form.handler' Or to Inject the FormFactory by yourself

Use it!!!

    public function yourAction(Request $request)
    {
        return $this->render('default/index.html.twig', [
            'result' => $this->get('app.form_handler.your')->createFromRequest(
                $request,
                'my data if form wasn\'t post' // result if the form isn't submitted
                true // Gonna throw Exception when the form isn't valid
            ),
        ]);
    }