5.4 / 2014.11
Before 5.4, if one wanted to implement a service needing siteaccess-aware settings (e.g. language settings),
they needed to inject the whole
ezpublish.config.resolver) and get the needed settings from it.
This was not very convenient nor explicit.
Goal of this feature is to allow developers to inject these dynamic settings explicitly from their service definition (yml, xml, annotation...).
Static container parameters follows the
%<parameter_name>% syntax in Symfony.
Dynamic parameters have the following:
$<parameter_name>[; <namespace>[; <scope>]]$, default namespace being
and default scope being current siteaccess.
This feature also introduces a DynamicSettingParser service that can be used for adding support of the dynamic settings syntax.
This service has
ezpublish.config.dynamic_setting.parser for ID and implements
A few limitations still remain:
- It is not possible to use dynamic settings in your semantic configuration (e.g.
ezpublish.yml) as they are meant primarily for parameter injection in services.
- It is not possible to define an array of options having dynamic settings. They will not be parsed. Workaround is to use separate arguments/setters.
- Injecting dynamic settings in request listeners is not recommended, as it won't be resolved with the correct scope (request listeners are instantiated before SiteAccess match). Workaround is to inject the ConfigResolver instead, and resolving the your setting in your
onKernelRequestmethod (or equivalent).
Injecting an eZ parameter
Defining a simple service needing
languages parameter (i.e. prioritized languages).
languages parameter is defined as
ezsettings being eZ internal namespace.
After, with setter injection (preferred)
Important: Ensure you always add
null as a default value, especially if the argument is type-hinted.
After, with constructor injection
Setter injection for dynamic settings should always be preferred, as it makes it possible to update your services that depend on them when ConfigResolver is updating its scope (e.g. when previewing content in a given SiteAccess). However, only one dynamic setting should be injected by setter.
Constructor injection will make your service be reset in that case.
Injecting 3rd party parameters