@ParamConverter

1) Fetch Automatically

If your route wildcards match properties on your entity, then the converter will automatically fetch them:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

/**
 * Fetch via primary key because {id} is in the route.
 *
 * @Route("/blog/{id}")
 */
public function showByPk(Post $post)
{
}

/**
 * Perform a findOneBy() where the slug property matches {slug}.
 *
 * @Route("/blog/{slug}")
 */
public function show(Post $post)
{
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

/**
 * Fetch via primary key because {id} is in the route.
 */
#[Route('/blog/{id}')]
public function showByPk(Post $post)
{
}

/**
 * Perform a findOneBy() where the slug property matches {slug}.
 */
#[Route('/blog/{slug}')]
public function show(Post $post)
{
}

Automatic fetching works in these situations:

• If {id} is in your route, then this is used to fetch by primary key via the find() method.
• The converter will attempt to do a findOneBy() fetch by using all of the wildcards in your route that are actually properties on your entity (non-properties are ignored).

You can control this behavior by actually adding the @ParamConverter annotation and using the @ParamConverter options.

2) Fetch via an Expression

If automatic fetching doesn't work, use an expression:

1
2
3
4
5
6
7
8
9

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Entity;

/**
 * @Route("/blog/{post_id}")
 * @Entity("post", expr="repository.find(post_id)")
 */
public function show(Post $post)
{
}

1
2
3
4
5
6
7

use Sensio\Bundle\FrameworkExtraBundle\Configuration\Entity;

#[Route('/blog/{post_id}')]
#[Entity('post', expr: 'repository.find(post_id)')]
public function show(Post $post)
{
}

Use the special @Entity annotation with an expr option to fetch the object by calling a method on your repository. The repository method will be your entity's Repository class and any route wildcards - like {post_id} are available as variables.

This can also be used to help resolve multiple arguments:

1
2
3
4
5
6
7

/**
 * @Route("/blog/{id}/comments/{comment_id}")
 * @Entity("comment", expr="repository.find(comment_id)")
 */
public function show(Post $post, Comment $comment)
{
}

1
2
3
4
5

#[Route('/blog/{id}/comments/{comment_id}')]
#[Entity('comment', expr: 'repository.find(comment_id)')]
public function show(Post $post, Comment $comment)
{
}

In the example above, the $post parameter is handled automatically, but $comment is configured with the annotation since they cannot both follow the default convention.

DoctrineConverter Options

A number of options are available on the @ParamConverter or (@Entity) annotation to control behavior:

• id: If an id option is configured and matches a route parameter, then the converter will find by the primary key:

  Annotations Attributes

  1
  2
  3
  4
  5
  6
  7

  /**
   * @Route("/blog/{post_id}")
   * @ParamConverter("post", options={"id" = "post_id"})
   */
  public function showPost(Post $post)
  {
  }

  1
  2
  3
  4
  5

  #[Route('/blog/{post_id}')]
  #[Entity('post', options: ['id' => 'post_id'])]
  public function showPost(Post $post)
  {
  }

• mapping: Configures the properties and values to use with the findOneBy() method: the key is the route placeholder name and the value is the Doctrine property name:

  Annotations Attributes

  1
  2
  3
  4
  5
  6
  7
  8

  /**
   * @Route("/blog/{date}/{slug}/comments/{comment_slug}")
   * @ParamConverter("post", options={"mapping": {"date": "date", "slug": "slug"}})
   * @ParamConverter("comment", options={"mapping": {"comment_slug": "slug"}})
   */
  public function showComment(Post $post, Comment $comment)
  {
  }

  1
  2
  3
  4
  5
  6

  #[Route('/blog/{date}/{slug}/comments/{comment_slug}')]
  #[ParamConverter('post', options: ['mapping' => ['date' => 'date', 'slug' => 'slug']])]
  #[ParamConverter('comment', options: ['mapping' => ['comment_slug' => 'slug']])]
  public function showComment(Post $post, Comment $comment)
  {
  }

• exclude Configures the properties that should be used in the findOneBy() method by excluding one or more properties so that not all are used:

  Annotations Attributes

  1
  2
  3
  4
  5
  6
  7

  /**
   * @Route("/blog/{date}/{slug}")
   * @ParamConverter("post", options={"exclude": {"date"}})
   */
  public function show(Post $post, \DateTime $date)
  {
  }

  1
  2
  3
  4
  5

  #[Route('/blog/{date}/{slug}')]
  #[ParamConverter('post', options: ['exclude' => ['date']])]
  public function show(Post $post, \DateTime $date)
  {
  }

• strip_null If true, then when findOneBy() is used, any values that are null will not be used for the query.

• entity_manager By default, the Doctrine converter uses the default entity manager, but you can configure this:

  Annotations Attributes

  1
  2
  3
  4
  5
  6
  7

  /**
   * @Route("/blog/{id}")
   * @ParamConverter("post", options={"entity_manager" = "foo"})
   */
  public function show(Post $post)
  {
  }

  1
  2
  3
  4
  5

  #[Route('/blog/{id}')]
  #[ParamConverter('post', options: ['entity_manager' => 'foo'])]
  public function show(Post $post)
  {
  }

• evict_cache If true, forces Doctrine to always fetch the entity from the database instead of cache.