eZPublishCommunityProject  2013.5
eZ\Publish\Core\MVC\Symfony\FieldType\View\ParameterProviderInterface Interface Reference

Interface for services providing additional parameters to a fieldtype's view template (using ez_render_field() helper). More...

+ Inheritance diagram for eZ\Publish\Core\MVC\Symfony\FieldType\View\ParameterProviderInterface:

Public Member Functions

 getViewParameters (Field $field)
 Returns a hash of parameters to inject to the associated fieldtype's view template. More...
 

Detailed Description

Interface for services providing additional parameters to a fieldtype's view template (using ez_render_field() helper).

Each instance of this interface needs to be correctly registered in the ParameterProviderRegistry.

See Also

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\FieldType\View\ParameterProviderInterface::getViewParameters ( Field  $field)

Returns a hash of parameters to inject to the associated fieldtype's view template.

Returned parameters will only be available for associated field type

Key is the parameter name (the variable name exposed in the template, in the 'parameters' array). Value is the parameter's value.

Parameters
\eZ\Publish\API\Repository\Values\Content\Field$fieldThe field parameters are provided for.
Returns
array

Implemented in eZ\Publish\Core\MVC\Symfony\FieldType\Page\ParameterProvider.


The documentation for this interface was generated from the following file: