How to Access Services or Config from Inside a Form

3.0 version

Maintained

4.4 5.2 current 5.3 dev

Unmaintained

2.7 2.8 3.0 3.1 3.2 3.3 3.4 4.0 4.1 4.2 4.3 5.0 5.1

How to Access Services or Config from Inside a Form
- 1) Pass Options to your Form
- 2) Define your Form as a Service

How to Access Services or Config from Inside a Form¶

Sometimes, you may need to access a service or other configuration from inside of your form class. To do this, you have 2 options:

1) Pass Options to your Form¶

The simplest way to pass services or configuration to your form is via form options. Suppose you need to access the doctrine.orm.entity_manager service so that you can make a query. First, allow (in fact, require) a new entity_manager option to be passed to your form:

// src/AppBundle/Form/TaskType.php
// ...

class TaskType extends AbstractType
{
    // ...

    public function configureOptions(OptionsResolver $resolver)
    {
        // ...

        $resolver->setRequired('entity_manager');
    }
}

Now that you’ve done this, you must pass an entity_manager option when you create your form:

// src/AppBundle/Controller/DefaultController.php
use AppBundle\Form\TaskType;

// ...
public function newAction()
{
    $task = ...;
    $form = $this->createForm(TaskType::class, $task, array(
        'entity_manager' => $this->get('doctrine.orm.entity_manager')
    ));

    // ...
}

Finally, the entity_manager option is accessible in the $options argument of your buildForm method:

// src/AppBundle/Form/TaskType.php
// ...

class TaskType extends AbstractType
{
    public function buildForm(FormBuilderInterface $builder, array $options)
    {
        /** @var \Doctrine\ORM\EntityManager $em */
        $em = $options['entity_manager'];
        // ...
    }

    // ...
}

Use this method to pass anything to your form.

2) Define your Form as a Service¶

Alternatively, you can define your form class as a service. This is a good idea if you want to re-use the form in several places - registering it as a service makes this easier.

Suppose you need to access the doctrine.orm.entity_manager service so that you can make a query. First, add this as an argument to your form class:

// src/AppBundle/Form/TaskType.php

use Doctrine\ORM\EntityManager;
// ...

class TaskType extends AbstractType
{
    private $em;

    public function __construct(EntityManager $em)
    {
        $this->em = $em;
    }

    // ...
}

Next, register this as a service and tag it with form.type:

YAML

# src/AppBundle/Resources/config/services.yml
services:
    app.form.type.task:
        class: AppBundle\Form\TaskType
        tags:
            - { name: form.type }

XML

<!-- src/AppBundle/Resources/config/services.xml -->
<?xml version="1.0" encoding="UTF-8" ?>
<container xmlns="http://symfony.com/schema/dic/services"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">

    <services>
        <service id="app.form.type.task" class="AppBundle\Form\TaskType">
            <tag name="form.type" />
        </service>
    </services>
</container>

PHP

// src/AppBundle/Resources/config/services.php
$container
    ->register(
        'app.form.type.task',
        'AppBundle\Form\TaskType'
    )
    ->addTag('form.type')
;

That’s it! Your controller - where you create the form - doesn’t need to change at all: Symfony is smart enough to load the TaskType from the container.

Read Creating your Field Type as a Service for more information.

This work, including the code samples, is licensed under a Creative Commons BY-SA 3.0 license.