FormRendererEngineInterface::getResourceForBlockNameHierarchy()

mixed getResourceForBlockNameHierarchy(FormView $view, array $blockNameHierarchy, int $hierarchyLevel)

Returns the resource for a block hierarchy.

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:

formwidget textwidget 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 "urlwidget", then, if that does not exist, for the block "textwidget" etc.

The type of the resource is decided by the implementation. The resource is later passed to {@link renderBlock()} by the rendering algorithm.

Parameters

FormView	$view	The view for determining the used themes First the themes attached directly to the view with {@link setTheme()} are considered, then the ones of its parent etc.
array	$blockNameHierarchy	The block name hierarchy, with the root block at the beginning.
int	$hierarchyLevel	The level in the hierarchy at which to start looking. Level 0 indicates the root block, i.e. the first element of $blockNameHierarchy.

Return Value

mixed

The renderer resource or false, if none was found

Links:

http://api.symfony.com/master/Symfony/Component/Form/FormRendererEngineInterface.html#method_getResourceForBlockNameHierarchy

doc_Symfony

2016-10-28 06:19:09

Comments