https://github.com/titomiguelcosta/zorbusbadrequestbundle
A Symfony2 Bundle to validate the Request before executing a controller action
https://github.com/titomiguelcosta/zorbusbadrequestbundle
Last synced: 3 months ago
JSON representation
A Symfony2 Bundle to validate the Request before executing a controller action
- Host: GitHub
- URL: https://github.com/titomiguelcosta/zorbusbadrequestbundle
- Owner: titomiguelcosta
- Created: 2014-03-22T12:33:40.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-01-02T16:20:20.000Z (over 10 years ago)
- Last Synced: 2025-01-29T20:44:15.081Z (5 months ago)
- Language: PHP
- Size: 156 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Bad Request Bundle
==================
This bundles adds a BadRequest annotation to be used in a controller action to validate the request.
Instalation
-----------
* In composer.json add the package to the require section:
"zorbus/bad-request-bundle": "dev-master"
* Enable the bundle in AppKernel.php
```php
public function registerBundles()
{
$bundles = array(
...,
new Zorbus\BadRequestBundle\ZorbusBadRequestBundle(),
);
}
```
Description
-----------
The annotation accepts one mandatory argument, the full class name that extends the form AbstractType and has the definitions of the fields to validate against the Request.
The value returned by getData from the Type is automatically available as an argument in the Action as long the types hints match.
In the following example, the options in ModelType have a data_class that points to Model. The name of the variable, in this case $model, can be anything allowed by PHP.
Example
-------
```php
use Zorbus\BadRequestBundle\Annotation\BadRequest;
class DefaultController extends Controller
{
/**
* @BadRequest("Your\Namespace\Type\ModelType")
* @return Response
*/
public function indexAction(Model $model)
{
return $this->render('ZorbusDemoBundle:Default:index.html.twig', array('model' => $model));
}
}
```
Bad Request Types
-----------------
Check the Symfony Form component. The input types are classes that extend AbstractType.
If you want to bind the request to a method different than POST, you must specify the option method in the setDefaultOption method.
Almost for sure you will want to disable the csrf protection, if so, add the option csrf_protection to false.
An example:
```php
namespace Zorbus\DemoBundle\Type;
use Symfony\Component\Form\AbstractType;
use Symfony\Component\Form\FormBuilderInterface;
use Symfony\Component\OptionsResolver\OptionsResolverInterface;
class PersonType extends AbstractType
{
public function buildForm(FormBuilderInterface $builder, array $options)
{
$builder->add('name');
}
public function setDefaultOptions(OptionsResolverInterface $resolver)
{
$resolver->setDefaults(array(
'data_class' => 'Zorbus\DemoBundle\Model\Person',
'csrf_protection' => false,
'method' => 'GET'
));
}
public function getName()
{
return '';
}
}
```