, (*1)
This bundle provides a collection of annotations for Symfony2 Controllers,
designed to streamline the creation of certain objects and enable smaller and
more concise actions., (*2)
Table of contents
- Reference
-
Entity Provider
-
Controller Annotations
-
Custom annotations
Reference
By default, all annotations are loaded, but any individual annotation can be
completely disabled by setting to false active parameter., (*3)
Default values are:, (*4)
``` yml
controller_extra:
resolver_priority: -8
request: current
paginator:
active: true
default_name: paginator
default_page: 1
default_limit_per_page: 10
entity:
active: true
default_name: entity
default_persist: true
default_mapping_fallback: false
default_factory_method: create
default_factory_mapping: true
form:
active: true
default_name: form
object_manager:
active: true
default_name: form
flush:
active: true
default_manager: default
json_response:
active: true
default_status: 200
default_headers: []
log:
active: true
default_level: info
default_execute: pre, (*5)
> ResolverEventListener is subscribed to `kernel.controller` event with
> priority -8. This element can be configured and customized with
> `resolver_priority` config value. If you need to get ParamConverter entities,
> make sure that this value is lower than 0. The reason is that this listener
> must be executed always after ParamConverter one.
# Entity provider
In some annotations, you can define an entity by several ways. This chapter is
about how you can define them.
## By namespace
You can define an entity using its namespace. A simple new `new()` be performed.
``` php
/**
* Simple controller method
*
* @SomeAnnotation(
* class = "Mmoreram\CustomBundle\Entity\MyEntity",
* )
*/
public function indexAction()
{
}
By doctrine shortcut
You can define an entity using Doctrine shortcut notations. With this format
you should ensure that your Entities follow Symfony Bundle standards and your
entities are placed under Entity/ folder., (*6)
``` php
/**
* Simple controller method
*
* @SomeAnnotation(
* class = "MmoreramCustomBundle:MyEntity",
* )
*/
public function indexAction()
{
}, (*7)
## By parameter
You can define an entity using a simple config parameter. Some projects
use parameters to define all entity namespaces (To allow overriding). If you
define the entity with a parameter, this bundle will try to instance it
with a simple `new()` accessing directly to the container ParametersBag.
``` yml
parameters:
#
# Entities
#
my.bundle.entity.myentity: Mmoreram\CustomBundle\Entity\MyEntity
``` php
/**
* Simple controller method
*
* @SomeAnnotation(
* class = "my.bundle.entity.myentity",
* )
*/
public function indexAction()
{
}, (*8)
# Controller annotations
This bundle provide a reduced but useful set of annotations for your controller
actions.
## @CreatePaginator
Creates a Doctrine Paginator object, given a request and a configuration. This
annotation just injects into de controller a new
`Doctrine\ORM\Tools\Pagination\Pagination` instance ready to be iterated.
You can enable/disable this bundle by overriding `active` flag in configuration file
`config.yml`
``` yml
controller_extra:
pagination:
active: true
By default, if name option is not set, the generated object will be placed
in a parameter named $paginator. This behaviour can be configured using
default_name in configuration., (*9)
This annotation can be configured with these sections, (*10)
Paginator Entity
To create a new Pagination object you need to refer to an existing Entity. You
can check all available formats you can define it just reading the
Entity Provider section., (*11)
``` php
<?php, (*12)
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*13)
/**
* Simple controller method
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*14)
### Paginator page
You need to specify Paginator annotation the page to fetch. By default, if none
is specified, this bundle will use the default one defined in configuration. You
can override in `config.yml`
``` yml
controller_extra:
pagination:
default_page: 1
You can refer to an existing Request attribute using ~value~ format, to any
$_GET element by using format ?field? or to any $_POST by using format
#field#, (*15)
You can choose between Master Request or Current Request accessing to its
attributes, by configuring the request value of the configuration., (*16)
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*17)
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/{foo}
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* page = "~foo~"
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*18)
or you can hardcode the page to use.
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* page = 1
* )
*/
public function indexAction(Paginator $paginator)
{
}
Paginator limit
You need to specify Paginator annotation the limit to fetch. By default, if none
is specified, this bundle will use the default one defined in configuration. You
can override in config.yml, (*19)
``` yml
controller_extra:
pagination:
default_limit_per_page: 10, (*20)
You can refer to an existing Request attribute using `~value~` format, to any
`$_GET` element by using format `?field?` or to any `$_POST` by using format
`#field#`
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/{foo}/{limit}
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* page = "~foo~",
* limit = "~limit~"
* )
*/
public function indexAction(Paginator $paginator)
{
}
or you can hardcode the page to use., (*21)
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*22)
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* page = 1,
* limit = 10
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*23)
### Paginator OrderBy
You can order your Pagination just defining the fields you want to orderBy and
the desired direction. The `orderBy` section must be defined as an array of
arrays, and each array should contain these positions:
* First position: Entity alias (Principal object is set as `x`)
* Second position: Entity field
* Third position: Direction
* Fourth position: Custom direction map ***(optional)***
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
/**
* Simple controller method
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* orderBy = {
* {"x", "createdAt", "ASC"},
* {"x", "updatedAt", "DESC"},
* {"x", "id", 1, {
* 0 => "ASC",
* 1 => "DESC",
* }},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}
With the third and fourth value you can define a map where to match your own
direction nomenclature with DQL one. DQL nomenclature just accept ASC for
Ascendant and DESC for Descendant., (*24)
This is very useful when you need to match a url format with the DQL one. You
can refer to an existing Request attribute using ~value~ format, to any
$_GET element by using format ?field? or to any $_POST by using format
#field#, (*25)
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*26)
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/order/{field}/{direction}
*
* For example, some matchings...
*
* /myroute/paginate/order/id/1 -> ORDER BY id DESC
* /myroute/paginate/order/enabled/0 - ORDER BY enabled ASC
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* orderBy = {
* {"x", "createdAt", "ASC"},
* {"x", "updatedAt", "DESC"},
* {"x", "~field~", ~direction~, {
* 0 => "ASC",
* 1 => "DESC",
* }},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*27)
The order of the definitions will alter the order of the DQL query.
### Paginator Wheres
You can define some where statements in your Paginator. The `wheres` section
must be defined as an array of arrays, and each array should contain these
positions:
* First position: Entity alias (Principal object is set as `x`)
* Second position: Entity field
* Third position: Operator *=, <=, >, LIKE...*
* Fourth position: Value to compare with
* Fifth position: Is a filter. By default, false
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
/**
* Simple controller method
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* wheres = {
* {"x", "enabled", "=", true},
* {"x", "age", ">", 18},
* {"x", "name", "LIKE", "Eferv%"},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}
You can refer to an existing Request attribute using ~value~ format, to any
$_GET element by using format ?field? or to any $_POST by using format
#field#, (*28)
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*29)
/**
* Simple controller method
*
* This Controller matches pattern /myroute/{field}
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* wheres = {
* {"x", "name", "LIKE", "~field~"},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*30)
You can use as well this feature for optional filtering by setting the last
position to `true`. In that case, if the filter value is not found, such line
will be ignored.
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
/**
* Simple controller method
*
* This Controller matches pattern /myroute?query=name%
* This Controller matches pattern /myroute as well
*
* In both cases this will work. In the first case we will apply the where line
* in the paginator. In the second case, we wont.
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* wheres = {
* {"x", "name", "LIKE", "?query?", true},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}
Paginator Not Nulls
You can also define some fields to not null. Is same as wheres section, but
specific for NULL assignments. The notNulls section must be defined as an array
of arrays, and each array should contain these positions:, (*31)
- First position: Object (Principal object is set as
x)
- Second position: Field
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*32)
/**
* Simple controller method
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* notNulls = {
* {"x", "enabled"},
* {"x", "deleted"},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*33)
### Paginator Left Join
You can do some left joins in this section. The `leftJoins` section must be
defined as an array of array, where each array can have these fields:
* First position: Entity alias (Principal object is set as `x`)
* Second position: Entity relation (Address)
* Third position: Relation identifier (a)
* Fourth position: If true, this relation is added in select group. Otherwise, wont
be loaded until its request ***(optional)***
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
/**
* Simple controller method
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* leftJoins = {
* {"x", "User", "u", true},
* {"x", "Address", "a", true},
* {"x", "Cart", "c"},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}
Paginator Inner Join
You can do some inner joins in this section. The innerJoins section must be
defined as an array of array, where each array can have these fields:, (*34)
- First position: Entity alias (x)
- Second position: Entity relation (Address)
- Third position: Relation identifier (a)
- Fourth position: If true, this relation is added in select group. Otherwise, wont
be loaded until its request (optional)
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*35)
/**
* Simple controller method
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* innerJoins = {
* {"x", "User", "u", true},
* {"x", "Address", "a", true},
* {"x", "Cart", "c"},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*36)
### Paginator Attributes
A nice feature of this annotation is that you can also inject into your
controller a `Mmoreram\ControllerExtraBundle\ValueObject\PaginatorAttributes`
instance with some interesting information about your pagination.
* currentPage : Current page fetched
* totalElements : Total elements given your criteria. If none criteria is
defined in your configuration, this value will show all elements of a certain entity.
* totalPages : Total pages you can fetch given a criteria.
* limitPerPage: Maximum number of elements in each page.
To inject this object you need to define the "attributes" annotation field with
the method parameter name.
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
use Mmoreram\ControllerExtraBundle\ValueObject\PaginatorAttributes;
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/
*
* @CreatePaginator(
* attributes = "paginatorAttributes",
* entityNamespace = "MmoreramCustomBundle:User",
* page = 1,
* limit = 10
* )
*/
public function indexAction(
Paginator $paginator,
PaginatorAttributes $paginatorAttributes
)
{
$currentPage = $paginatorAttributes->getCurrentPage();
$totalElements = $paginatorAttributes->getTotalElements();
$totalPages = $paginatorAttributes->getTotalPages();
$limitPerPage = $paginatorAttributes->getLimitPerPage();
}
Paginator Example
This is a completed example and its DQL resolution, (*37)
``` php
use Doctrine\ORM\Tools\Pagination\Pagination;
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;, (*38)
/**
* Simple controller method
*
* This Controller matches pattern /paginate/nb/{limit}/{page}
*
* Where:
*
* * limit = 10
* * page = 1
*
* @CreatePaginator(
* entityNamespace = "ControllerExtraBundle:Fake",
* page = "~page~",
* limit = "~limit~",
* orderBy = {
* { "x", "createdAt", "ASC" },
* { "x", "updatedAt", "DESC" },
* { "x", "id", "0", {
* "1" = "ASC",
* "2" = "DESC",
* }}
* },
* wheres = {
* { "x", "enabled" , "=", true }
* },
* leftJoins = {
* { "x", "relation", "r" },
* { "x", "relation2", "r2" },
* { "x", "relation5", "r5", true },
* },
* innerJoins = {
* { "x", "relation3", "r3" },
* { "x", "relation4", "r4", true },
* },
* notNulls = {
* {"x", "address1"},
* {"x", "address2"},
* }
* )
*/
public function indexAction(Paginator $paginator)
{
}, (*39)
The DQL generated by this annotation is
``` sql
SELECT x, r4, r5
FROM Mmoreram\\ControllerExtraBundle\\Tests\\FakeBundle\\Entity\\Fake x
INNER JOIN x.relation3 r3
INNER JOIN x.relation4 r4
LEFT JOIN x.relation r
LEFT JOIN x.relation2 r2
LEFT JOIN x.relation5 r5
WHERE enabled = ?where0
AND x.address1 IS NOT NULL
AND x.address2 IS NOT NULL
ORDER BY createdAt ASC, id ASC
This annotation can create a PagerFanta instance if you need it. You only have
to define your parameter as such, and the annotation resolver will wrap your
paginator with a Pagerfanta object instance., (*40)
``` php
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
use Pagerfanta\Pagerfanta;, (*41)
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* page = 1,
* limit = 10
* )
*/
public function indexAction(Pagerfanta $paginator)
{
}, (*42)
### KNPPaginator Add-on
This annotation can create a KNPPaginator instance if you need it. You only have
to define your parameter as such, and the annotation resolver will wrap your
paginator with a KNPPaginator object instance.
``` php
use Mmoreram\ControllerExtraBundle\Annotation\CreatePaginator;
use Knp\Component\Pager\Pagination\PaginationInterface;
/**
* Simple controller method
*
* This Controller matches pattern /myroute/paginate/
*
* @CreatePaginator(
* entityNamespace = "MmoreramCustomBundle:User",
* page = 1,
* limit = 10
* )
*/
public function indexAction(PaginationInterface $paginator)
{
}
@LoadEntity
Loads an entity from your database, or creates a new one., (*43)
``` php
<?php, (*44)
use Mmoreram\ControllerExtraBundle\Annotation\Entity;
use Mmoreram\ControllerExtraBundle\Entity\User;, (*45)
/**
* Simple controller method
*
* @Entity(
* namespace = "MmoreramCustomBundle:User",
* name = "user"
* )
*/
public function indexAction(User $user)
{
}, (*46)
> By default, if `name` option is not set, the generated object will be placed
> in a parameter named `$entity`. This behaviour can be configured using
> `default_name` in configuration.
You can also use setters in Entity annotation. It means that you can simply call
entity setters using Request attributes.
``` php
<?php
use Mmoreram\ControllerExtraBundle\Annotation\Entity;
use Mmoreram\ControllerExtraBundle\Entity\Address;
use Mmoreram\ControllerExtraBundle\Entity\User;
/**
* Simple controller method
*
* @Entity(
* namespace = "MmoreramCustomBundle:Address",
* name = "address"
* )
* @Entity(
* namespace = "MmoreramCustomBundle:User",
* name = "user",
* setters = {
* "setAddress": "address"
* }
* )
*/
public function indexAction(Address $address, User $user)
{
}
When User instance is built, method setAddress is called using as parameter
the new Address instance., (*47)
New entities are just created with a simple new(), so they are not persisted.
By default, they will be persisted using configured manager, but you can disable
this feature using persist option., (*48)
``` php
<?php, (*49)
use Mmoreram\ControllerExtraBundle\Annotation\Entity;
use Mmoreram\ControllerExtraBundle\Entity\User;, (*50)
/**
* Simple controller method
*
* @Entity(
* namespace = "MmoreramCustomBundle:User",
* name = "user",
* persist = false
* )
*/
public function indexAction(User $user)
{
}, (*51)
### Entity Mapping
When you define a new Entity annotation, you can also request the mapped entity
given a map. It means that if a map is defined, this bundle will try to request
the mapped instance satisfying it.
The keys of the map represent the names of the mapped fields and the values
represent their desired values. Remember than you can refer to any Request
attribute by using format `~field~`, to any `$_GET` element by using format
`?field?` or to any `$_POST` by using format `#field#`
``` php
<?php
use Mmoreram\ControllerExtraBundle\Annotation\Entity;
use Mmoreram\ControllerExtraBundle\Entity\User;
/**
* Simple controller method
*
* This Controller matches pattern /user/edit/{id}/{username}
*
* @Entity(
* namespace = "MmoreramCustomBundle:User",
* name = "user",
* mapping = {
* "id": "~id~",
* "username": "~username~"
* }
* )
*/
public function indexAction(User $user)
{
}
In this case, you will try to get the mapped instance of User with passed id. If
some mapping is defined and any entity is found, a new EntityNotFoundException`
is thrown., (*52)
Entity Mapping Fallback
So what if one ore more than one mapping references are not found? For example,
you're trying to map the {id} parameter from your route, but this parameter is
not even defined. Whan happens here? Well, you can assume then that you want to
pass a new entity instance by using the mappingFallback., (*53)
By default, if mapping_fallback option is not set, the used value will be
the parameter default_mapping_fallback defined in configuration. By default
this value is false, (*54)
Don't confuse with the scenario where you're looking for an entity in your
database, all mapping references have been resolved, and the entity is not
found. In that case, a common "EntityNotFound" exception will be thrown by
Doctrine., (*55)
Lets see an example. Because we have enabled the mappingFallback, and because
the mapping definition does not match the assigned route, we will return a new
empty User entity., (*56)
``` php
<?php, (*57)
use Mmoreram\ControllerExtraBundle\Annotation\Entity;
use Mmoreram\ControllerExtraBundle\Entity\User;, (*58)
/**
* Simple controller method
*
* This Controller matches pattern /user/edit/{id}
*
* @LoadEntity(
* namespace = "MmoreramCustomBundle:User",
* name = "user",
* mapping = {
* "id": "~id~",
* "username": "~nonexisting~"
* },
* mappingFallback = true
* )
*/
public function indexAction(User $user)
{
// $user->getId() === null
}, (*59)
### Entity Repository
By default, the Doctrine entity manager provides the right repository per each
entity (not the default one, but the right specific one). Although, you can
define a custom repository to be used in your annotation by using the repository
configuration.
``` php
/**
* Simple controller method
*
* @CreateEntity(
* namespace = "MmoreramCustomBundle:User",
* mapping = {
* "id": "~id~",
* "username": "~username~"
* }
* repository = {
* "class" = "Mmoreram\CustomBundle\Repository\AnotherRepository",
* },
* )
*/
public function indexAction(User $user)
{
}
By default, the method findOneBy will always be used, unless you define
another one., (*60)
``` php
/**
* Simple controller method
*
* @CreateEntity(
* namespace = "MmoreramCustomBundle:User",
* mapping = {
* "id": "~id~",
* "username": "~username~"
* }
* repository = {
* "class" = "Mmoreram\CustomBundle\Repository\AnotherRepository",
* "method" = "find",
* },
* )
*/
public function indexAction(User $user)
{
}, (*61)
### Entity Factory
When the annotation considers that a new entity must be created, because no
mapping information has been provided, or because the mapping fallback has been
activated, by default a new instance will be created by using the *namespace*
value.
This configuration block has three positions
* class - factory class
* method - Method to use when retrieving the object
* static - Method is static
You can define the factory with a simple namespace
``` php
/**
* Simple controller method
*
* @CreateEntity(
* namespace = "MmoreramCustomBundle:User",
* factory = {
* "class" = "Mmoreram\CustomBundle\Factory\UserFactory",
* "method" = "create",
* "static" = true,
* },
* )
*/
public function indexAction(User $user)
{
}
If you want to define your Factory as a service, with the possibility of
overriding namespace, you can simply define service name. All other options have
the same behaviour., (*62)
``` yml
parameters:, (*63)
#
# Factories
#
my.bundle.factory.user_factory: Mmoreram\CustomBundle\Factory\UserFactory
``` php
/**
* Simple controller method
*
* @CreateEntity(
* class = {
* "factory" = my.bundle.factory.user_factory,
* "method" = "create",
* "static" = true,
* },
* )
*/
public function indexAction(User $user)
{
}
If you do not define the method, default one will be used. You can
override this default value by defining new one in your config.yml. Same with
static value, (*64)
``` yml
controller_extra:
entity:
default_factory_method: create
default_factory_static: true, (*65)
## @CreateForm
Provides form injection in your controller actions. This annotation only needs
a name to be defined in, where you must define namespace where your form is
placed.
``` php
<?php
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
use Symfony\Component\Form\AbstractType;
/**
* Simple controller method
*
* @CreateForm(
* class = "\Mmoreram\CustomBundle\Form\Type\UserType",
* name = "userType"
* )
*/
public function indexAction(AbstractType $userType)
{
}
By default, if name option is not set, the generated object will be placed
in a parameter named $form. This behaviour can be configured using
default_name in configuration., (*66)
You can not just define your Type location using the namespace, in which case
a new AbstractType element will be created. but you can also define it using
service alias, in which case this bundle will return an instance using Symfony
DI., (*67)
``` php
<?php, (*68)
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
use Symfony\Component\Form\AbstractType;, (*69)
/**
* Simple controller method
*
* @CreateForm(
* class = "user_type",
* name = "userType"
* )
*/
public function indexAction(AbstractType $userType)
{
}, (*70)
This annotation allows you to not only create an instance of FormType, but
also allows you to inject a Form object or a FormView object
To inject a Form object you only need to cast method value as such.
``` php
<?php
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
use Symfony\Component\Form\Form;
/**
* Simple controller method
*
* @CreateForm(
* class = "user_type",
* name = "userForm"
* )
*/
public function indexAction(Form $userForm)
{
}
You can also, using [SensioFrameworkExtraBundle][1]'s [ParamConverter][2],
create a Form object with an previously created entity. you can define this
entity using entity parameter., (*71)
``` php
<?php, (*72)
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Symfony\Component\Form\Form;, (*73)
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
use Mmoreram\ControllerExtraBundle\Entity\User;, (*74)
/**
* Simple controller method
*
* @Route(
* path = "/user/{id}",
* name = "view_user"
* )
* @ParamConverter("user", class="MmoreramCustomBundle:User")
* @CreateForm(
* class = "user_type",
* entity = "user"
* name = "userForm",
* )
*/
public function indexAction(User $user, Form $userForm)
{
}, (*75)
To handle current request, you can set `handleRequest` to true. By default
this value is set to `false`
``` php
<?php
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Symfony\Component\Form\Form;
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
use Mmoreram\ControllerExtraBundle\Entity\User;
/**
* Simple controller method
*
* @Route(
* path = "/user/{id}",
* name = "view_user"
* )
* @ParamConverter("user", class="MmoreramCustomBundle:User")
* @CreateForm(
* class = "user_type",
* entity = "user"
* handleRequest = true,
* name = "userForm",
* )
*/
public function indexAction(User $user, Form $userForm)
{
}
You can also add as a method parameter if the form is valid, using validate
setting. Annotation will place result of $form->isValid() in specified method
argument., (*76)
``` php
<?php, (*77)
use Sensio\Bundle\FrameworkExtraBundle\Configuration\Route;
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Symfony\Component\Form\Form;, (*78)
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
use Mmoreram\ControllerExtraBundle\Entity\User;, (*79)
/**
* Simple controller method
*
* @Route(
* path = "/user/{id}",
* name = "view_user"
* )
* @ParamConverter("user", class="MmoreramCustomBundle:User")
* @CreateForm(
* class = "user_type",
* entity = "user"
* handleRequest = true,
* name = "userForm",
* validate = "isValid",
* )
*/
public function indexAction(User $user, Form $userForm, $isValid)
{
}, (*80)
To inject a FormView object you only need to cast method variable as such.
``` php
<?php
use Symfony\Component\Form\FormView;
use Mmoreram\ControllerExtraBundle\Annotation\CreateForm;
/**
* Simple controller method
*
* @CreateForm(
* class = "user_type",
* name = "userFormView"
* )
*/
public function indexAction(FormView $userFormView)
{
}
@Flush
Flush annotation allows you to flush entityManager at the end of request using
kernel.response event, (*81)
``` php
<?php, (*82)
use Mmoreram\ControllerExtraBundle\Annotation\Flush;, (*83)
/**
* Simple controller method
*
* @Flush
*/
public function indexAction()
{
}, (*84)
If not otherwise specified, default Doctrine Manager will be flushed with this
annotation. You can overwrite default Manager in your `config.yml` file.
``` yml
controller_extra:
flush:
default_manager: my_custom_manager
You can also override this value in every single Flush Annotation
instance defining manager value, (*85)
``` php
<?php, (*86)
use Mmoreram\ControllerExtraBundle\Annotation\Flush;, (*87)
/**
* Simple controller method
*
* @Flush(
* manager = "my_own_manager"
* )
*/
public function indexAction()
{
}, (*88)
If you want to change default manager in all annotation instances, you should
override bundle parameter in your `config.yml` file.
``` yml
controller_extra:
flush:
default_manager: my_own_manager
If any parameter is set, annotation will flush all. If you only need to flush
one or many entities, you can define explicitly which entity must be flushed., (*89)
``` php
<?php, (*90)
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;, (*91)
use Mmoreram\ControllerExtraBundle\Annotation\Flush;
use Mmoreram\ControllerExtraBundle\Entity\User;, (*92)
/**
* Simple controller method
*
* @ParamConverter("user", class="MmoreramCustomBundle:User")
* @Flush(
* entity = "user"
* )
*/
public function indexAction(User $user)
{
}, (*93)
You can also define a set of entities to flush
``` php
<?php
use Sensio\Bundle\FrameworkExtraBundle\Configuration\ParamConverter;
use Mmoreram\ControllerExtraBundle\Annotation\Flush;
use Mmoreram\ControllerExtraBundle\Entity\Address;
use Mmoreram\ControllerExtraBundle\Entity\User;
/**
* Simple controller method
*
* @ParamConverter("user", class="MmoreramCustomBundle:User")
* @ParamConverter("address", class="MmoreramCustomBundle:Address")
* @Flush(
* entity = {
* "user",
* "address"
* }
* )
*/
public function indexAction(User $user, Address $address)
{
}
If multiple @Mmoreram\Flush are defined in same action, last instance will
overwrite previous. Anyway just one instance should be defined., (*94)
@ToJsonResponse
JsonResponse annotation allows you to create a
Symfony\Component\HttpFoundation\JsonResponse object, given a simple
controller return value., (*95)
``` php
<?php, (*96)
use Mmoreram\ControllerExtraBundle\Annotation\ToJsonResponse;, (*97)
/**
* Simple controller method
*
* @ToJsonResponse
*/
public function indexAction(User $user, Address $address)
{
return array(
'This is my response'
);
}, (*98)
By default, JsonResponse is created using default `status` and `headers` defined
in bundle parameters. You can overwrite them in your `config.yml` file.
``` yml
controller_extra:
json_response:
default_status: 403
default_headers:
"User-Agent": "Googlebot/2.1"
You can also overwrite these values in each @JsonResponse annotation., (*99)
``` php
<?php, (*100)
use Mmoreram\ControllerExtraBundle\Annotation\ToJsonResponse;, (*101)
/**
* Simple controller method
*
* @ToJsonResponse(
* status = 403,
* headers = {
* "User-Agent": "Googlebot/2.1"
* }
* )
*/
public function indexAction(User $user, Address $address)
{
return array(
'This is my response'
);
}, (*102)
If an Exception is returned the response status is set by default to 500 and the
Exception message is returned as response.
`STATUS 500 Internal server error`
``` json
{
message : 'Exception message'
}
In case we use a HttpExceptionInterface the use the exception status code as
status code. In case we launch this exception, (*103)
``` php
use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;, (*104)
..., (*105)
return new NotFoundHttpException('Resource not found');, (*106)
We'll receive this response
`STATUS 404 Not Found`
``` json
{
message : 'Resource not found'
}
If the exception is being launched on an annotation (e.g. Entity annotation)
remember to add the JsonResponse annotation at the beginning or at least before
any annotation that could cause an exception., (*107)
If multiple @Mmoreram\JsonResponse are defined in same action, last instance
will overwrite previous. Anyway just one instance should be defined., (*108)
@Log
Log annotation allows you to log any plain message before or after controller
action execution, (*109)
``` php
<?php, (*110)
use Mmoreram\ControllerExtraBundle\Annotation\Log;, (*111)
/**
* Simple controller method
*
* @Log("Executing index Action")
*/
public function indexAction()
{
}, (*112)
You can define the level of the message. You can define default one if none is
specified overriding it in your `config.yml` file.
``` yml
controller_extra:
log:
default_level: warning
Every Annotation instance can overwrite this value using level field., (*113)
``` php
<?php, (*114)
use Mmoreram\ControllerExtraBundle\Annotation\Log;, (*115)
/**
* Simple controller method
*
* @Log(
* value = "Executing index Action",
* level = @Log::LVL_WARNING
* )
*/
public function indexAction()
{
}, (*116)
Several levels can be used, as defined in [Psr\Log\LoggerInterface][6]
interface
* @Mmoreram\Log::LVL_EMERG
* @Mmoreram\Log::LVL_CRIT
* @Mmoreram\Log::LVL_ERR
* @Mmoreram\Log::LVL_WARN
* @Mmoreram\Log::LVL_NOTICE
* @Mmoreram\Log::LVL_INFO
* @Mmoreram\Log::LVL_DEBUG
* @Mmoreram\Log::LVL_LOG
You can also define the execution of the log. You can define default one if
none is specified overriding it in your `config.yml` file.
``` yml
controller_extra:
log:
default_execute: pre
Every Annotation instance can overwrite this value using level field., (*117)
``` php
<?php, (*118)
use Mmoreram\ControllerExtraBundle\Annotation\Log;, (*119)
/**
* Simple controller method
*
* @Log(
* value = "Executing index Action",
* execute = @Log::EXEC_POST
* )
*/
public function indexAction()
{
}, (*120)
Several executions can be used,
* @Mmoreram\Log::EXEC_PRE - Logged before controller execution
* @Mmoreram\Log::EXEC_POST - Logged after controller execution
* @Mmoreram\Log::EXEC_BOTH - Logged both
## @Get
The Get annotation allows you to get any parameter from the request query string.
For a `GET` request like:
GET /my-page?foo=bar HTTP/1.1, (*121)
You can can simply get the `foo` var using the `GET` annotation
``` php
<?php
use Mmoreram\ControllerExtraBundle\Annotation\Get;
/**
* Simple controller method
*
* @Get(
* path = "foo"
* )
*/
public function indexAction($foo)
{
// Use the foo var
}
You can also customize the var name and the default value in case the var is not
sent on the query string., (*122)
For a GET request like:, (*123)
GET /my-page HTTP/1.1
And this annotation, (*124)
``` php
<?php, (*125)
use Mmoreram\ControllerExtraBundle\Annotation\Get;, (*126)
/**
* Simple controller method
*
* @Get(
* path = "foo",
* name = "varName",
* default = 'bar',
* )
*/
public function indexAction($varName)
{
// This would print 'bar'
echo $varName;
}, (*127)
## @Post
The Post annotation allows you to get any parameter from the post request body.
For a `POST` request like:
POST /my-page HTTP/1.1
foo=bar, (*128)
You can can simply get the `foo` var using the `POST` annotation
``` php
<?php
use Mmoreram\ControllerExtraBundle\Annotation\Post;
/**
* Simple controller method
*
* @Post(
* path = "foo"
* )
*/
public function indexAction($foo)
{
// Use the foo var
}
You can also customize the var name and the default value in case the var is not
sent on the query string., (*129)
For a POST request like:, (*130)
POST /my-page HTTP/1.1
And this annotation, (*131)
``` php
<?php, (*132)
use Mmoreram\ControllerExtraBundle\Annotation\Post;, (*133)
/**
* Simple controller method
*
* @Post(
* path = "foo",
* name = "varName",
* default = 'bar',
* )
*/
public function indexAction($varName)
{
// This would print 'bar'
echo $varName;
}, (*134)
# Custom annotations
Using this bundle you can now create, in a very easy way, your own controller
annotation.
## Annotation
The annotation object. You need to define the fields your custom annotation
will contain. Must extends `Mmoreram\ControllerExtraBundle\Annotation\Annotation`
abstract class.
``` php
<?php
namespace My\Bundle\Annotation;
use Mmoreram\ControllerExtraBundle\Annotation\Annotation;
/**
* Entity annotation driver
*
* @Annotation
* @Target({"METHOD"})
*/
final class MyCustomAnnotation extends Annotation
{
/**
* @var string
*
* Dummy field
*/
public $field;
/**
* Get Dummy field
*
* @return string Dummy field
*/
public function getField()
{
return $this->field;
}
}
Resolver
Once you have defined your own annotation, you have to resolve how this
annotation works in a controller. You can manage this using a Resolver. Must
extend Mmoreram\ControllerExtraBundle\Resolver\AnnotationResolver; abstract
class., (*135)
``` php
<?php, (*136)
namespace My\Bundle\Resolver;, (*137)
use Symfony\Component\HttpFoundation\Request;, (*138)
use Mmoreram\ControllerExtraBundle\Resolver\AnnotationResolver;
use Mmoreram\ControllerExtraBundle\Annotation\Annotation;, (*139)
/**
* MyCustomAnnotation Resolver
*/
class MyCustomAnnotationResolver extends AnnotationResolver
{
/**
* Specific annotation evaluation.
*
* This method must be implemented in every single EventListener
* with specific logic
*
* All method code will executed only if specific active flag is true
*
* @param Request $request
* @param Annotation $annotation
* @param ReflectionMethod $method
*/
public function evaluateAnnotation(
Request $request,
Annotation $annotation,
ReflectionMethod $method
)
{
/**
* You can now manage your annotation.
* You can access to its fields using public methods.
*
* Annotation fields can be public and can be acceded directly,
* but is better for testing to use getters; they can be mocked.
*/
$field = $annotation->getField();, (*140)
/**
* You can also access to existing method parameters.
*
* Available parameters are:
*
* # ParamConverter parameters ( See `resolver_priority` config value )
* # All method defined parameters, included Request object if is set.
*/
$entity = $request->attributes->get('entity');
/**
* And you can now place new elements in the controller action.
* In this example we are creating new method parameter
* called $myNewField with some value
*/
$request->attributes->set(
'myNewField',
new $field()
);
return $this;
}
}, (*141)
This class will be defined as a service, so this method is computed just
before executing current controller. You can also subscribe to some kernel
events and do whatever you need to do ( You can check
`Mmoreram\ControllerExtraBundle\Resolver\LogAnnotationResolver` for some
examples.
## Definition
Once Resolver is done, we need to define our service as an Annotation
Resolver. We will use a custom `tag`.
``` yml
parameters:
#
# Resolvers
#
my.bundle.resolver.my_custom_annotation_resolver.class: My\Bundle\Resolver\MyCustomAnnotationResolver
services:
#
# Resolvers
#
my.bundle.resolver.my_custom_annotation_resolver:
class: %my.bundle.resolver.my_custom_annotation_resolver.class%
tags:
- { name: controller_extra.annotation }
Registration
We need to register our annotation inside our application. We can just do it in
the boot() method of bundle.php file., (*142)
``` php
<?php, (*143)
namespace My\Bundle;, (*144)
use Symfony\Component\HttpKernel\Bundle\Bundle;
use Doctrine\Common\Annotations\AnnotationRegistry;, (*145)
/**
* MyBundle
*/
class ControllerExtraBundle extends Bundle
{, (*146)
/**
* Boots the Bundle.
*/
public function boot()
{
$kernel = $this->container->get('kernel');
AnnotationRegistry::registerFile($kernel
->locateResource("@MyBundle/Annotation/MyCustomAnnotation.php")
);
}
}
```, (*147)
Et voilà! We can now use our custom Annotation in our project controllers., (*148)
Wallogit.com
