View/Helper/Partial.php
- category
- Zend
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_View
- subpackage
- Helper
- version
- $Id: Partial.php 20096 2010-01-06 02:05:09Z bkarwin $
- Classes
- Zend_View_Helper_Partial
Description
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.
Zend_View_Helper_Partial
- Extends from
- Zend_View_Helper_Abstract
- copyright
- Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
- license
- http://framework.zend.com/license/new-bsd New BSD License
- package
- Zend_View
- subpackage
- Helper
- Properties
- $_objectKey
- Methods
- partial
- cloneView
- setObjectKey
- getObjectKey
Description
Helper for rendering a template fragment in its own variable scope.
Properties
$_objectKey
string $_objectKey = ''Variable to which object will be assigned
Details
- $_objectKey
- string
- visibility
- protected
- default
- final
- false
- static
- false
Methods
cloneView
cloneView(
)
:
Zend_View_InterfaceClone the current View
Output
Details
- visibility
- public
- final
- false
- static
- false
getObjectKey
getObjectKey(
)
:
null|stringRetrieve object key
The objectKey is the variable to which an object in the iterator will be assigned.
Output
- null|string
Details
- visibility
- public
- final
- false
- static
- false
partial
partial(
string $name
=
null, string|array $module
=
null, array $model
=
null
)
:
string|Zend_View_Helper_PartialRenders a template fragment within a variable scope distinct from the calling View object.
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.
Arguments
- $name
- string
Name of view script - $module
- stringarray
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
Output
- string|Zend_View_Helper_Partial
Details
- visibility
- public
- final
- false
- static
- false
setObjectKey
setObjectKey(
string $key
)
:
Zend_View_Helper_PartialSet object key
Arguments
- $key
- string
Output
Details
- visibility
- public
- final
- false
- static
- false