View/Helper/PartialLoop.php

Show: PublicProtectedPrivateinherited
Table of Contents
Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id: PartialLoop.php 25203 2013-01-10 11:02:17Z frosch $  

\Zend_View_Helper_PartialLoop

Package: Zend\View\Helper
Helper for rendering a template fragment in its own variable scope; iterates over data provided and renders for each iteration.
Parent(s)
\Zend_View_Helper_Partial < \Zend_View_Helper_Abstract
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_objectKey
inherited
Variable to which object will be assigned
Inherited from: \Zend_View_Helper_Partial::$$_objectKey
Details
Type
string
Inherited_from
\Zend_View_Helper_Partial::$$_objectKey  
>VPropertyprotectedinteger $partialCounter = 0
Marker to where the pointer is at in the loop
Default value0Details
Type
integer
>VPropertypublic\Zend_View_Interface $view = null
Default valuenullDetails
Type
\Zend_View_Interface
Inherited_from
\Zend_View_Helper_Abstract::$$view  
Inherited_from
\Zend_View_Helper_Partial::$$view  

Methods

methodpubliccloneView() : \Zend_View_Interface
inherited

Clone the current View

Inherited from: \Zend_View_Helper_Partial::cloneView()
Returns
TypeDescription
\Zend_View_Interface
methodpublicdirect() : void
inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Partial::direct()
methodpublicgetObjectKey() : null | string
inherited

Retrieve object key

Inherited from: \Zend_View_Helper_Partial::getObjectKey()

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

Returns
TypeDescription
null | string
methodpublicpartial(string $name = null, string | array $module = null, array $model = null) : string | \Zend_View_Helper_Partial
inherited

Renders a template fragment within a variable scope distinct from the calling View object.

Inherited from: \Zend_View_Helper_Partial::partial()

If no arguments are passed, returns the helper instance.

If the $model is an array, it is passed to the view object's assign() method.

If the $model is an object, it first checks to see if the object implements a 'toArray' method; if so, it passes the result of that method to to the view object's assign() method. Otherwise, the result of get_object_vars() is passed.

Parameters
NameTypeDescription
$namestring

Name of view script

$modulestring | array

If $model is empty, and $module is an array, these are the variables to populate in the view. Otherwise, the module in which the partial resides

$modelarray

Variables to populate in the view

Returns
TypeDescription
string | \Zend_View_Helper_Partial
methodpublicpartialLoop(string $name = null, string | array $module = null, array $model = null) : string

Renders a template fragment within a variable scope distinct from the calling View object.

If no arguments are provided, returns object instance.

Parameters
NameTypeDescription
$namestring

Name of view script

$modulestring | array

If $model is empty, and $module is an array, these are the variables to populate in the view. Otherwise, the module in which the partial resides

$modelarray

Variables to populate in the view

Returns
TypeDescription
string
methodpublicsetObjectKey(string $key) : \Zend_View_Helper_Partial
inherited

Set object key

Inherited from: \Zend_View_Helper_Partial::setObjectKey()
Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_View_Helper_Partial
methodpublicsetView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
Parameters
NameTypeDescription
$view\Zend_View_Interface
Returns
TypeDescription
\Zend_View_Helper_Abstract
Documentation was generated by phpDocumentor 2.0.0a12.