Helper for rendering a template fragment in its own variable scope.

package Default
inherited_from \Zend\View\Helper\AbstractHelper

 Methods

Renders a template fragment within a variable scope distinct from the calling View object. It proxies to view's render function

__invoke(string|\Zend\View\Model\ModelInterface $name = null, array|object $values = null) : string | \Zend\View\Helper\Partial

Parameters

$name

string\Zend\View\Model\ModelInterface

Name of view script, or a view model

$values

arrayobject

Variables to populate in the view

Exceptions

\Zend\View\Exception\RuntimeException

Returns

string\Zend\View\Helper\Partial

Retrieve object key

getObjectKey() : null | string

The objectKey is the variable to which an object in the iterator will be assigned.

Returns

nullstring

Get the view object

getView() : null | \Zend\View\Renderer\RendererInterface
Inherited
inherited_from \Zend\View\Helper\HelperInterface::getView()

Returns

null\Zend\View\Renderer\RendererInterface

Set object key

setObjectKey(string|null $key) : \Zend\View\Helper\Partial
fluent This method is part of a fluent interface and will return the same instance

Parameters

$key

stringnull

Returns

\Zend\View\Helper\Partial

Set the View object

setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited
inherited_from \Zend\View\Helper\HelperInterface::setView()

Parameters

$view

\Zend\View\Renderer\RendererInterface

Returns

\Zend\View\Helper\AbstractHelper

 Properties

 

Variable to which object will be assigned

$objectKey : string

Default

 

View object instance

$view : \Zend\View\Renderer\RendererInterface

Default

null