alks/http-extra-bundle

Addons to the symfony framework including controller argument binds to the request body/query, content negotiation and more

v0.2.0 2017-12-27 20:50 UTC

Requires

• php: >=5.6.0
• doctrine/annotations: ^1.0
• symfony/framework-bundle: ~3.1|~4.0
• willdurand/negotiation: 2.2.*

Requires (Dev)

• symfony/expression-language: ~3.1|~4.0
• symfony/serializer: ~3.1|~4.0

MIT

• Alkis Stamos

• http
• rest
• query
• params
• body

README

Adds the following annotations to the Symfony3 framework:

• @RequestParam : Matches any query parameter to an action argument.
• @RequestBody : Matches the request body (content) to an action argument.
• @RequestData : Matches any request data parameter ($request->request) to an action argument.
• @Response : Provide additional info (headers etc) for the response object.

The bundle also:

• automatically deserializes and validates the request body/data to an action argument
• generates a response when an action returns anything but a Response object
• resolves doctrine entities from a query parameter
• automatically denormalizes the request content to a class

which (if properly configured) leaves the controllers to work only with valid and structured request data. Useful when you like working with DTOs and you are not a big fan of forms.

Requirements

• PHP 5.4 or higher
• Symfony 3.1 or higher

The bundle uses value resolvers which were introduced in Symfony 3.1

Installation

1. Installing the bundle via packagist

$ composer require alks/http-extra-bundle

2.Enable the bundle in your symfony project

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Alks\HttpExtraBundle\HttpExtraBundle(),
        // ...
    );
}

Basic examples

Please note the examples below only demonstrate the bundles basic usage they are not suitable for proper application use. For more detailed examples please check the documentation.

<?php
use Alks\HttpExtraBundle\Annotation as Http;
class FooController extends \Symfony\Bundle\FrameworkBundle\Controller\Controller
{
    /**
     * This will match the "/user?username=foo" and will automatically call the user repository to find a user with the foo
     * username.
     * 
     * @Route("/user", methods={"GET"})
     * @Http\RequestParam(name="username", bindTo="user", repository="AppBundle\Repository\UserRepository")
     * @return User 
     */
    public function getUserByUsernameAction(User $user)
    {
        return $user;
    }
    
    /**
     * This will match a GET request with optional page and limit query parameters like "/posts?page=3&limit=20"
     * 
     * @Route("/posts", methods={"GET"})
     * @Http\RequestParams({"page","limit"})
     * @Http\Response(context={"groups":{"list"}}, type="json")
     */
    public function getPostsAction($page=1, $limit=10)
    {
        return $this->getDoctrine()->getRepository('AppBundle:Post')->findAllByPage($page,$limit);
    }
}

Learn more about the bundle here