The content Repository uses Roles and Policies to give Users access to different functions of the system.
Any bundle can expose available Policies via a
PolicyProvider which can be added to EzPublishCoreBundle's DIC extension.
PolicyProvider object provides a hash containing declared modules, functions and Limitations.
- Each Policy provider provides a collection of permission modules.
- Each module can provide functions (e.g. in
content/read"content" is the module, "read" is the function)
- Each function can provide a collection of Limitations.
First level key is the module name, value is a hash of available functions, with function name as key.
Function value is an array of available Limitations, identified by the alias declared in
LimitationType service tag.
If no Limitation is provided, value can be
null or an empty array.
1 2 3 4 5 6 7 8 9 10
Limitations need to be implemented as Limitation types and declared as services identified with
Name provided in the hash for each Limitation is the same value set in the
alias attribute in the service tag.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
An abstract class based on YAML is provided:
It defines an abstract
YamlPolicyProvider and implement
getFiles() to return absolute paths to your YAML files.
1 2 3 4 5 6 7 8 9 10 11 12 13
1 2 3
Extending existing policies¶
PolicyProvider may provide new functions to a module, and additional Limitations to an existing function.
It is however strongly encouraged to add functions to your own Policy modules.
It is not possible to remove an existing module, function or limitation from a Policy.
PolicyProvider into EzPublishCoreBundle¶
PolicyProvider to be active, it must be properly declared in EzPublishCoreBundle.
A bundle just has to retrieve CoreBundle's DIC extension and call
addPolicyProvider(). This must be done in the bundle's
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
Integrating custom Limitation types with the UI¶
To provide support for editing custom policies in the Back Office you need to implement
Next, register the service in DIC (Dependency Injection Container) with the
ez.limitation.formMapper tag and set the
limitationType attribute to the Limitation type's identifier:
1 2 3 4 5 6
If you want to provide human-readable names of the custom Limitation values, you need to implement
Then register the service in DIC with the
ez.limitation.valueMapper tag and set the
limitationType attribute to Limitation type's identifier:
1 2 3 4 5 6
If you want to completely override the way of rendering custom Limitation values in the role view,
create a Twig template containing block definition which follows the naming convention:
ez_limitation_<LIMITATION TYPE>_value. For example:
1 2 3 4
Add it to the configuration under
1 2 3 4 5
If you skip this part, Limitation values will be rendered using an
ez_limitation_value_fallback block as comma-separated list.
You can also provide translation of the Limitation type identifier by adding an entry to the translation file under the
The key must follow the naming convention:
1 2 3 4 5