baiseiit/form-request-bundle

An adaptation of the Laravel Form Request for Symfony

v1.0.0 2023-02-15 08:48 UTC

Requires

• php: ^7.1.3 || ^8.0
• symfony/config: ^3.4 || ^4.0 || ^5.0
• symfony/dependency-injection: ^3.4 || ^4.0 || ^5.0
• symfony/http-kernel: ^3.4 || ^4.0 || ^5.0
• symfony/validator: ^3.4 || ^4.0 || ^5.0

Requires (Dev)

• dg/bypass-finals: ^1.1
• symfony/phpunit-bridge: ^3.4 || ^4.0 || ^5.0
• symfony/translation: ^3.4 || ^4.0 || ^5.0
• symfony/var-dumper: ^3.4 || ^4.0 || ^5.0

MIT

• Adam Sapraliev

README

Form Request Bundle

This bundle provides similar solution as the Laravel Form Request. Form request is custom request class that contains validation logic and it's executed (validated) before the controller action is called.

Installation

Applications that use Symfony Flex

Open a command console, enter your project directory and execute:

$ composer require baiseiit/form-request-bundle

Applications that don't use Symfony Flex

Step 1: Download the Bundle

Open a command console, enter your project directory and execute the following command to download the latest stable version of this bundle:

$ composer require baiseiit/form-request-bundle

This command requires you to have Composer installed globally, as explained in the installation chapter of the Composer documentation.

Step 2: Enable the Bundle

Then, enable the bundle by adding it to the list of registered bundles in the app/AppKernel.php file of your project:

// app/AppKernel.php

// ...
class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Adamsafr\FormRequestBundle\AdamsafrFormRequestBundle(),
        ];

        // ...
    }

    // ...
}

Configuration

Create the adamsafr_form_request.yaml file in the config/packages directory for Symfony 4 or add it in the app/config/config.yml file:

adamsafr_form_request:
  exception_listeners:
    access_denied:
      # Sets json response of the Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException
      enabled: true
    form_validation:
      # Sets json response of the Adamsafr\FormRequestBundle\Exception\FormValidationException
      enabled: true
    json_decode:
      # Sets json response of the Adamsafr\FormRequestBundle\Exception\JsonDecodeException
      enabled: true

Usage

// src/Request/UserRequest.php

namespace App\Request;

use Adamsafr\FormRequestBundle\Http\FormRequest;
use App\Service\Randomizer;
use Symfony\Component\Validator\Constraint;
use Symfony\Component\Validator\Constraints as Assert;

class UserRequest extends FormRequest
{
    /**
     * @var Randomizer
     */
    private $randomizer;

    /**
     * You can inject services here
     *
     * @param Randomizer $randomizer
     */
    public function __construct(Randomizer $randomizer)
    {
        $this->randomizer = $randomizer;
    }

    /**
     * Determine if the user is authorized to make this request.
     *
     * @return bool
     */
    public function authorize(): bool
    {
        return $this->randomizer->getNumber() > 0.5;
    }

    /**
     * Get the validation rules that apply to the request.
     *
     * @return null|Constraint|Constraint[]
     */
    public function rules()
    {
        return new Assert\Collection([
            'fields' => [
                'email' => [
                    new Assert\NotBlank(),
                    new Assert\NotNull(),
                    new Assert\Email(),
                ],
                'firstName' => new Assert\Length(['max' => 255]),
                'lastName' => new Assert\Optional([
                    new Assert\Length(['max' => 3]),
                ]),
            ],
        ]);
    }
}

// src/Controller/ApiTestController.php

namespace App\Controller;

use App\Request\UserRequest;
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;

class ApiTestController extends AbstractController
{
    public function index(UserRequest $form)
    {
        $email = $form->getRequest()->request->get('email');
    }
}

License

It is released under the MIT License.