alxishin/extra-param-converter-bundle

Symfony2 bundle that extends Sensio ParamConverter functionality, allowing to convert simple GET and complex POST data

BuExtraParamConverterBundle

Todo: update the read me with our additions, _(*1)

BuExtraParamConverterBundle extends Sensio ParamConverter functionality, allowing to convert simple GET and complex POST data to entities, decode json data and strip tags from data., _(*2)

Requires SensioFrameworkExtraBundle., _(*3)

, _(*4)

Installation

Add bundle with composer:, _(*5)

composer require bu/extra-param-converter-bundle dev-master, _(*6)

Register bundle in AppKernel.php: ``` php <?php // app/AppKernel.php, _(*7)

public function registerBundles() { $bundles = array( // ... new Bu\ExtraParamConverterBundle\BuExtraParamConverterBundle(), ); }, _(*8)

Sensio ParamConverter should be enabled, ie parameter `sensio_framework_extra.request.converters` in your app config should be set to true (set by default).


Usage
-------------
**GetConverter**

You don't need to write any annotations, following code will work with any GET request with `user` parameter, like "/getUserDetails?user=123"
``` php
public function detailsAction(User $user)
{
    ...
}

where 123 is user id. It will throw NotFoundHttpException if can't find User by this id., _(*9)

PostConverter ``` php use Bu\ExtraParamConverterBundle\Configuration\ExtraParamConverter;, _(*10)

/**
 * @ExtraParamConverter("data", jsonData=true, stripTags=true, namespace="App", entities={"groups"={"class"="Group"}, "role"={"class"="Role"}})
 */
public function saveUserAction(array $data)
{
    // $data['groups'] ...
}

In this example:

 * raw post data will be json-decoded (jsonData=false by default for standard form submit)
 * all string values will be filtered (stripTags=false by default)
 * all "groups" will converted to "Group" entities, array [id1, id2, id3] - to array of "App:Group" entities
 * all "role" will converted to "Role" entity, single value to single entity
 * all is processed recursively to deepest level
 * result will available in $data (confugired by first unnamed parameter in annotation)
 * exceptions will be thrown in number of incorrect situations:
    * invalid json data, invalid post data
    * entities are defined without namespace (you can ommit them both if want only jsonDecode/stripTags)
    * key defined for entity not found in data
    * any entity not found by id


Recommented to set doctrine mapping alias for your bundle:

Doctrine Configuration

doctrine: orm: mappings: ApplicationMySuperBundle: alias: My ``` This will allow you to use short namespace "My" instead of long autogenerated "ApplicationMySuperBundle"., _(*11)

License

This bundle is under the MIT license., _(*12)