Helper for rendering a template fragment in its own variable scope; iterates
over data provided and renders for each iteration.
Methods
Renders a template fragment within a variable scope distinct from the
calling View object.
__invoke(string $name, array $values) : string
If no arguments are provided, returns object instance.
Parameters
$name
stringName of view script
$values
arrayVariables to populate in the view
Exceptions
Returns
string
Retrieve object key
getObjectKey() : null | string
Inherited
The objectKey is the variable to which an object in the iterator will be
assigned.
| inherited_from |
\Zend\View\Helper\Partial::getObjectKey() |
Returns
nullstring
Get the partial counter
getPartialCounter() : int
Get the view object
getView() : null | \Zend\View\Renderer\RendererInterface
Inherited
| inherited_from |
\Zend\View\Helper\AbstractHelper::getView() |
| inherited_from |
\Zend\View\Helper\Partial::getView() |
Returns
Set object key in this loop and any child loop
setObjectKey(string | null $key) : \Zend\View\Helper\self
Parameters
$key
stringnull
Returns
\Zend\View\Helper\self
Set the View object
setView(\Zend\View\Renderer\RendererInterface $view) : \Zend\View\Helper\AbstractHelper
Inherited
| inherited_from |
\Zend\View\Helper\AbstractHelper::setView() |
| inherited_from |
\Zend\View\Helper\Partial::setView() |
Parameters
Returns
Increment nestedLevel and default objectKey to parent's value
nestObjectKey() : \Zend\View\Helper\self
Returns
\Zend\View\Helper\self
Decrement nestedLevel and restore objectKey to parent's value
unNestObjectKey() : \Zend\View\Helper\self
Returns
\Zend\View\Helper\self
Properties
Variable to which object will be assigned
$objectKey : string
Inherited
| inherited_from |
\Zend\View\Helper\Partial::$$objectKey |
Marker to where the pointer is at in the loop
$partialCounter : int
The current nesting level
$nestingLevel : int
Stack with object keys for each nested level
$objectKeyStack : array