eZPublishCommunityProject  2012.12
eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface Interface Reference
+ Inheritance diagram for eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface:

Public Member Functions

 addParameters (array $parameters)
 Adds a hash of parameters to the existing parameters. More...
 
 getParameter ($parameterName)
 Returns parameter value by $parameterName. More...
 
 getParameters ()
 Returns registered parameters. More...
 
 getTemplateIdentifier ()
 Returns the registered template identifier. More...
 
 hasParameter ($parameterName)
 Checks if $parameterName exists. More...
 
 setParameters (array $parameters)
 Sets $parameters that will later be injected to the template/closure. More...
 
 setTemplateIdentifier ($templateIdentifier)
 Sets $templateIdentifier to the content view. More...
 

Member Function Documentation

eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::addParameters ( array  $parameters)

Adds a hash of parameters to the existing parameters.

Parameters
array$parameters

Implemented in eZ\Publish\Core\MVC\Legacy\View\TwigContentViewLayoutDecorator, and eZ\Publish\Core\MVC\Symfony\View\ContentView.

Referenced by eZ\Publish\Core\MVC\Symfony\View\Manager\renderContentView().

eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::getParameter (   $parameterName)

Returns parameter value by $parameterName.

Throws an if $parameterName is not set.

Parameters
string$parameterName
Exceptions
\InvalidArgumentException
Returns
mixed

Implemented in eZ\Publish\Core\MVC\Legacy\View\TwigContentViewLayoutDecorator, and eZ\Publish\Core\MVC\Symfony\View\ContentView.

eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::getParameters ( )
eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::getTemplateIdentifier ( )
eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::hasParameter (   $parameterName)

Checks if $parameterName exists.

Parameters
string$parameterName
Returns
boolean

Implemented in eZ\Publish\Core\MVC\Legacy\View\TwigContentViewLayoutDecorator, and eZ\Publish\Core\MVC\Symfony\View\ContentView.

eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::setParameters ( array  $parameters)

Sets $parameters that will later be injected to the template/closure.

If some parameters were already present, $parameters will replace them.

Parameters
array$parametersHash of parameters

Implemented in eZ\Publish\Core\MVC\Legacy\View\TwigContentViewLayoutDecorator, and eZ\Publish\Core\MVC\Symfony\View\ContentView.

eZ\Publish\Core\MVC\Symfony\View\ContentViewInterface::setTemplateIdentifier (   $templateIdentifier)

Sets $templateIdentifier to the content view.

Can be either a valid template identifier such as "MyBundle:subfolder:my_template.html.twig" or a closure. In the case of a closure, it will receive an array of parameters as an argument and must return the result to display.

Must throw a exception if $templateIdentifier is invalid.

Parameters
string | \Closure$templateIdentifier
Exceptions
\eZ\Publish\Core\Base\Exceptions\InvalidArgumentType

Implemented in eZ\Publish\Core\MVC\Symfony\View\ContentView, and eZ\Publish\Core\MVC\Legacy\View\TwigContentViewLayoutDecorator.


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