Creative Commons License
This work is licensed under a
Creative Commons
Attribution-Share Alike 3.0
Unported License.

Master Symfony2 fundamentals

Be trained by SensioLabs experts (2 to 6 day sessions -- French or English).
trainings.sensiolabs.com

Discover the SensioLabs Support

Access to the SensioLabs Competency Center for an exclusive and tailor-made support on Symfony
sensiolabs.com

Working with Container Service Definitions

Caution: You are browsing the documentation for Symfony version 2.0 which is not maintained anymore. If some of your projects are still using this version, consider upgrading.

Working with Container Service Definitions

Getting and Setting Service Definitions

There are some helpful methods for working with the service definitions.

To find out if there is a definition for a service id:

1
$container->hasDefinition($serviceId);

This is useful if you only want to do something if a particular definition exists.

You can retrieve a definition with:

1
$container->getDefinition($serviceId);

or:

1
$container->findDefinition($serviceId);

which unlike getDefinition() also resolves aliases so if the $serviceId argument is an alias you will get the underlying definition.

The service definitions themselves are objects so if you retrieve a definition with these methods and make changes to it these will be reflected in the container. If, however, you are creating a new definition then you can add it to the container using:

1
$container->setDefinition($id, $definition);

Working with a definition

Creating a new definition

If you need to create a new definition rather than manipulate one retrieved from then container then the definition class is Definition.

Class

First up is the class of a definition, this is the class of the object returned when the service is requested from the container.

To find out what class is set for a definition:

1
$definition->getClass();

and to set a different class:

1
$definition->setClass($class); // Fully qualified class name as string

Constructor Arguments

To get an array of the constructor arguments for a definition you can use:

1
$definition->getArguments();

or to get a single argument by its position:

1
2
$definition->getArgument($index);
//e.g. $definition->getArguments(0) for the first argument

You can add a new argument to the end of the arguments array using:

1
$definition->addArgument($argument);

The argument can be a string, an array, a service parameter by using %parameter_name% or a service id by using

1
2
3
4
5
use Symfony\Component\DependencyInjection\Reference;

// ...

$definition->addArgument(new Reference('service_id'));

In a similar way you can replace an already set argument by index using:

1
$definition->replaceArgument($index, $argument);

You can also replace all the arguments (or set some if there are none) with an array of arguments:

1
$definition->replaceArguments($arguments);

Method Calls

If the service you are working with uses setter injection then you can manipulate any method calls in the definitions as well.

You can get an array of all the method calls with:

1
$definition->getMethodCalls();

Add a method call with:

1
$definition->addMethodCall($method, $arguments);

Where $method is the method name and $arguments is an array of the arguments to call the method with. The arguments can be strings, arrays, parameters or service ids as with the constructor arguments.

You can also replace any existing method calls with an array of new ones with:

1
$definition->setMethodCalls($methodCalls);

Tip

There are more examples of specific ways of working with definitions in the PHP code blocks of the configuration examples on pages such as Using a Factory to Create Services and Managing Common Dependencies with Parent Services.

Note

The methods here that change service definitions can only be used before the container is compiled, once the container is compiled you cannot manipulate service definitions further. To learn more about compiling the container see Compiling the Container.