Symfony2 controller Traits
, (*1)
This php 5.4+ library is a collection of traits
that adds behaviors to Symfony2 controllers., (*2)
It currently handles:, (*3)
Usage
All you have to do is to define a Controller and use some traits., (*4)
, (*5)
crudable:
Crudable trait is an abstract trait used internally by ORMBehavior and ODMBehavior.
* To use Doctrine ORM persistence in your CRUD, just use ORMBehavior like below.
* To use Propel ORM persistence in your CRUD, just use PropelBehavior., (*6)
``` php, (*7)
<?php, (*8)
namespace Acme\DemoBundle\Controller;, (*9)
use Knp\ControllerBehaviors\Crudable\Doctrine\ORMBehavior;, (*10)
use Symfony\Bundle\FrameworkBundle\Controller\Controller;, (*11)
class MemberController extends Controller
{
// make aliases of actions to make them FOSRestBundle compliant, (*12)
use ORMBehavior {
ORMBehavior::getListResponse as getMembersAction;
ORMBehavior::getShowResponse as getMemberAction;
ORMBehavior::getNewResponse as newMembersAction;
ORMBehavior::getEditResponse as editMemberAction;
ORMBehavior::getCreateResponse as postMembersAction;
ORMBehavior::getUpdateResponse as putMemberAction;
ORMBehavior::getDeleteResponse as deleteMemberAction;
}
}, (*13)
#### Form
The create, edit and update actions of Crudable
will search for a `<Object>Type` in the `Form` folder of the bundle.
In the examples below, it would be in `src/Acme/DemoBundle/Form/MemberType`.
To modify this behavior, just override
the [default implementation](https://github.com/KnpLabs/ControllerBehaviors/blob/master/src/Knp/ControllerBehaviors/Crudable/CrudableBehavior.php#L544)
of the trait, like this:
``` php
<?php
protected function createNewForm($object)
{
return $this->createForm('my_super_type_id', $object, ['some_option' => true]);
}
Templates
Templates are also searched using conventions. By default it will search in the Resources\views/<ControllerName> folder of your bundle., (*14)
<ControllerName> here can be contain a subfolder (think of an Admin subfolder for example)., (*15)
To modify this behavior, just override
the default implementation
of the trait, like this:, (*16)
``` php, (*17)
<?php, (*18)
protected function getViewsPathPrefix()
{
return '::';
}
### Filterable
Filterable behavior is a simple trait that stores and retrieves some informations for a given controller,
like filter form data.
Once you posted data to `postFilterMembersAction`, you can retrieve it later by using the `getFilters` method.
It also provides a way to handle a filter form, whose type yould be defined in `src/Acme/DemoBundle/Form/MemberFilterType` in this example.
``` php
<?php
use Knp\ControllerBehaviors\FilterableBehavior;
class MemberController extends Controller
{
// make aliases of actions to make them FOSRestBundle compliant
use FilterableBehavior {
FilterableBehavior::getFilterResponse as postFilterMembersAction;
}
}
In order to make this filter form visible in the view, you can override default view parameters handling:, (*19)
``` php, (*20)
<?php, (*21)
protected function getListViewParameters(array $parameters)
{
return array_merge([
'filterForm' => $this->createFilterForm()->createView(),
], $parameters);
}
### Paginable
Paginable behavior is a simple trait that uses [Knp paginator](https://github.com/KnpLabs/KnpPaginatorBundle) to paginate a resultset.
``` php
<?php
use Knp\ControllerBehaviors\Paginatable\KnpPaginatorBehavior;
class MemberController extends Controller
{
use KnpPaginatorBehavior;
public function getObjectsToList()
{
return $this->paginateQueryBuilder(
$this->getObjectRepository()->getJoinAllFilteredQB($this->getFilters()) // returns an ORM Query Builder
);
}
}
Wallogit.com
Knplabs