batenburg/response-factory-bundle

A response factory bundle, to clean your controller code.

v1.1.8 2021-01-10 12:02 UTC

Requires

• php: >= 7.2.0
• symfony/dependency-injection: ^4.3 || ^4.4 || ^5.0 || ^5.1
• symfony/framework-bundle: ^4.3 || ^4.4 || ^5.0 || ^5.1
• symfony/twig-bundle: ^4.3 || ^4.4 || ^5.0 || ^5.1
• twig/twig: ^2.1 || ^3.0

Requires (Dev)

• phpunit/phpunit: ^8.5 || ^9.0
• squizlabs/php_codesniffer: ^3.5
• vimeo/psalm: ^4.3

MIT

• Patrick Batenburg

README

Response factory for the Symfony Framework.

Build Status:

What is Response factory Bundle?

The response factory bundle is a bundle with a response factory, to make clean code in your Symfony controllers. It is inspired by the response factory from laravel.

For who?

Everybody who loves clean code.

Installation

Install with composer:

composer require batenburg/response-factory-bundle

Register the bundle, add the following line to config/bundles.php:

    Batenburg\ResponseFactoryBundle\ResponseFactoryBundle::class => ['all' => true],

Usage

After the installation is completed, the ResponseFactoryInterface can be resolved by dependency injection. Or through the container. It is highly recommended to use dependency injection.

An example::

<?php

namespace App\Controller;

use Batenburg\ResponseFactoryBundle\Component\HttpFoundation\Contract\ResponseFactoryInterface;
use Batenburg\ResponseFactoryBundle\Component\HttpFoundation\Response;

class BrandController
{

    /**
     * @var ResponseFactoryInterface
     */
    private $responseFactory;

    /**
     * @param ResponseFactoryInterface $responseFactory
     */
    public function __construct(ResponseFactoryInterface $responseFactory)
    {
        $this->responseFactory = $responseFactory;
    }

    /**
     * @return Response
     */
    public function create(): Response
    {
        return $this->responseFactory->render('brand/create.html.twig');
    }
}

Note

To use the constructor injection, you must register the controller in you yaml file::

App\Controller\BrandController:
    tags: ['controller.service_arguments']
    arguments:
        $responseFactory: '@batenburg.response_factory_bundle.component.http_foundation.response_factory'

Using dependency injection on a method, will resolved automatically.

License

The Caching Bundle is open-sourced software licensed under the MIT license.