spiechu/symfony-commons-bundle

My handy toolkit for Symfony.

0.3 2018-01-24 21:23 UTC

README

TravisCI StyleCI Scrutinizer Code Coverage Read the Docs
Build Status StyleCI Scrutinizer Code Quality Code Coverage Documentation Status

Intro

Main purpose of this bundle is to introduce some "missing" functionalities to Symfony Framework.

Consider this bundle as part of my preparations for Symfony Certification. I can only learn by doing instead of passive DOC reading.

Bundle characteristics:

Bundle rules

  1. Every feature is disabled by default. You only enable what you need.
  2. No event listeners hanging around when unneeded.
  3. Provide sane defaults and extensive customisation possibilities.

Features

GET method override

Enabling this feature will allow you to use URLs like http://myapp.com/mypath?_method=DELETE or PUT to override HTTP GET request method.

Sometimes you might need such functionality for example in admin area to ban / delete users. You can expose simple links and still have clean PUT / DELETE controller actions.

Full documentation here.

Response schema validation

Response schema validation allows you to validate endpoint responses on-the-fly. You just need to annotate controller action with @ResponseSchemaValidator annotation.

Typical use case is:

// src/AppBundle/Controller/AdminController.php

use Spiechu\SymfonyCommonsBundle\Annotation\Controller\ResponseSchemaValidator;

class AdminController extends Controller
{
    /**
     * @Route("/", name="my_route")
     *
     * @ResponseSchemaValidator(
     *  json={
     *   200="@AppBundle/Resources/response_schema/my_route_200.json",
     *   500="@AppBundle/Resources/response_schema/my_route_500.json"
     *  }
     * )
     */
    public function indexAction(): Response
    {
        // ...
    }
}

Full documentation here.

API versioning

When you have multiple API versions it's usually done by extending Controllers. This bundle introduces handy @ApiVersion annotation. You need to annotate your controller classes with this custom annotation and set version like:

// src/AppBundle/Controller/V1_0/UserController.php

use Spiechu\SymfonyCommonsBundle\Annotation\Controller\ApiVersion;

/**
 * @ApiVersion("1.0")
 */
class UserController extends Controller
{
    /**
     * @Route("/", name="my_route")
     */
    public function indexAction(): Response
    {
        // ...
    }
}

Then in extending class:

// src/AppBundle/Controller/V1_1/UserController.php

use Spiechu\SymfonyCommonsBundle\Annotation\Controller\ApiVersion;
use Spiechu\SymfonyCommonsBundle\Controller\V1_0\UserController as BaseUserController;

/**
 * @ApiVersion("1.1")
 */
class UserController extends BaseUserController
{
    /**
     * @Route("/", name="my_route")
     */
    public function indexAction(): Response
    {
        // ...
    }
}

From now on you can inject Spiechu\SymfonyCommonsBundle\Service\ApiVersionProvider service to your services and check what is the current request API version.

Full documentation here.

Installation

I'm assuming you have Composer installed globally.

Flex based installation (Symfony 3.4 and 4)

Download & enable the Bundle

Run console command in Symfony project directory:

composer req spiechu/symfony-commons-bundle

Enable some/all Bundle features

# config/packages/spiechu_symfony_commons.yml

spiechu_symfony_commons:
    get_method_override:
        enabled: true
    response_schema_validation:
        enabled: true
    api_versioning:
        enabled: true

Composer based installation (Symfony 3.3 and 3.4)

Download the Bundle

Run console command in Symfony project directory:

composer require spiechu/symfony-commons-bundle

Enable the Bundle

Enable the bundle by adding the following line in the app/AppKernel.php file of your project:

// app/AppKernel.php

class AppKernel extends Kernel
{
    public function registerBundles()
    {
        $bundles = [
            // ...
            new Spiechu\SymfonyCommonsBundle\SpiechuSymfonyCommonsBundle(),
        ];

        // ...
    }
}

Enable some/all Bundle features

Preferred way of configuring Bundle is via YAML config:

# app/config/config.yml

spiechu_symfony_commons:
    get_method_override:
        enabled: true
    response_schema_validation:
        enabled: true
    api_versioning:
        enabled: true

Configuration

Configuration reference can be found here.