FormRendererEngineInterface
in
Adapter for rendering form templates with a specific templating engine.
Tags
Table of Contents
Methods
- getResourceForBlockName() : mixed
- Returns the resource for a block name.
- getResourceForBlockNameHierarchy() : mixed
- Returns the resource for a block hierarchy.
- getResourceHierarchyLevel() : int|false
- Returns the hierarchy level at which a resource can be found.
- renderBlock() : string
- Renders a block in the given renderer resource.
- setTheme() : mixed
- Sets the theme(s) to be used for rendering a view and its children.
Methods
getResourceForBlockName()
Returns the resource for a block name.
public
getResourceForBlockName(FormView $view, string $blockName) : mixed
The resource is first searched in the themes attached to $view, then in the themes of its parent view and so on, until a resource was found.
The type of the resource is decided by the implementation. The resource is later passed to by the rendering algorithm.
Parameters
- $view : FormView
-
The view for determining the used themes. First the themes attached directly to the view with are considered, then the ones of its parent etc.
- $blockName : string
Return values
mixed —the renderer resource or false, if none was found
getResourceForBlockNameHierarchy()
Returns the resource for a block hierarchy.
public
getResourceForBlockNameHierarchy(FormView $view, array<string|int, string> $blockNameHierarchy, int $hierarchyLevel) : mixed
A block hierarchy is an array which starts with the root of the hierarchy and continues with the child of that root, the child of that child etc. The following is an example for a block hierarchy:
form_widget
text_widget
url_widget
In this example, "url_widget" is the most specific block, while the other blocks are its ancestors in the hierarchy.
The second parameter $hierarchyLevel determines the level of the hierarchy that should be rendered. For example, if $hierarchyLevel is 2 for the above hierarchy, the engine will first look for the block "url_widget", then, if that does not exist, for the block "text_widget" etc.
The type of the resource is decided by the implementation. The resource is later passed to by the rendering algorithm.
Parameters
- $view : FormView
-
The view for determining the used themes. First the themes attached directly to the view with are considered, then the ones of its parent etc.
- $blockNameHierarchy : array<string|int, string>
-
The block name hierarchy, with the root block at the beginning
- $hierarchyLevel : int
-
The level in the hierarchy at which to start looking. Level 0 indicates the root block, i.e. the first element of $blockNameHierarchy.
Return values
mixed —The renderer resource or false, if none was found
getResourceHierarchyLevel()
Returns the hierarchy level at which a resource can be found.
public
getResourceHierarchyLevel(FormView $view, array<string|int, string> $blockNameHierarchy, int $hierarchyLevel) : int|false
A block hierarchy is an array which starts with the root of the hierarchy and continues with the child of that root, the child of that child etc. The following is an example for a block hierarchy:
form_widget
text_widget
url_widget
The second parameter $hierarchyLevel determines the level of the hierarchy that should be rendered.
If we call this method with the hierarchy level 2, the engine will first look for a resource for block "url_widget". If such a resource exists, the method returns 2. Otherwise it tries to find a resource for block "text_widget" (at level 1) and, again, returns 1 if a resource was found. The method continues to look for resources until the root level was reached and nothing was found. In this case false is returned.
The type of the resource is decided by the implementation. The resource is later passed to by the rendering algorithm.
Parameters
- $view : FormView
-
The view for determining the used themes. First the themes attached directly to the view with are considered, then the ones of its parent etc.
- $blockNameHierarchy : array<string|int, string>
-
The block name hierarchy, with the root block at the beginning
- $hierarchyLevel : int
-
The level in the hierarchy at which to start looking. Level 0 indicates the root block, i.e. the first element of $blockNameHierarchy.
Return values
int|falserenderBlock()
Renders a block in the given renderer resource.
public
renderBlock(FormView $view, mixed $resource, string $blockName[, array<string|int, mixed> $variables = [] ]) : string
The resource can be obtained by calling or . The type of the resource is decided by the implementation.
Parameters
- $view : FormView
-
The view to render
- $resource : mixed
-
The renderer resource
- $blockName : string
- $variables : array<string|int, mixed> = []
-
The variables to pass to the template
Return values
stringsetTheme()
Sets the theme(s) to be used for rendering a view and its children.
public
setTheme(FormView $view, mixed $themes[, bool $useDefaultThemes = true ]) : mixed
Parameters
- $view : FormView
-
The view to assign the theme(s) to
- $themes : mixed
-
The theme(s). The type of these themes is open to the implementation.
- $useDefaultThemes : bool = true