View/Helper/PartialLoop.php
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
- 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


string $_objectKey
- Type
- string
- Inherited_from
- \Zend_View_Helper_Partial::$$_objectKey


integer $partialCounter = 0
0
Details- Type
- integer


\Zend_View_Interface $view = null
null
Details- Type
- \Zend_View_Interface
- Inherited_from
- \Zend_View_Helper_Abstract::$$view
- Inherited_from
- \Zend_View_Helper_Partial::$$view
Methods


direct() : void
Strategy pattern: currently unutilized
Inherited from: \Zend_View_Helper_Abstract::direct()\Zend_View_Helper_Partial::direct()

getObjectKey() : null | string
The objectKey is the variable to which an object in the iterator will be assigned.
Type | Description |
---|---|
null | string |


partial(string $name = null, string | array $module = null, array $model = null) : string | \Zend_View_Helper_Partial
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.
Name | Type | Description |
---|---|---|
$name | string | Name of view script |
$module | string | 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 |
$model | array | Variables to populate in the view |
Type | Description |
---|---|
string | \Zend_View_Helper_Partial |


partialLoop(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.
Name | Type | Description |
---|---|---|
$name | string | Name of view script |
$module | string | 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 |
$model | array | Variables to populate in the view |
Type | Description |
---|---|
string |


setObjectKey(string $key) : \Zend_View_Helper_Partial
Name | Type | Description |
---|---|---|
$key | string |
Type | Description |
---|---|
\Zend_View_Helper_Partial |


setView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
Set the View object
Inherited from: \Zend_View_Helper_Abstract::setView()\Zend_View_Helper_Partial::setView()Name | Type | Description |
---|---|---|
$view | \Zend_View_Interface |
Type | Description |
---|---|
\Zend_View_Helper_Abstract |