View/Helper/Partial.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 [email protected] so we can send you a copy immediately.
Category
Zend  
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_View  
Subpackage
Helper  
Version
$Id$  

\Zend_View_Helper_Partial
jump to top

Package: Zend_View\Helper
Helper for rendering a template fragment in its own variable scope.
Parent(s)
\Zend_View_Helper_Abstract
Children
\Zend_View_Helper_PartialLoop
Copyright
Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertyprotectedstring $_objectKey
Variable to which object will be assigned
Details
Type
string

Methods

methodpubliccloneView() : \Zend_View_Interface

Clone the current View

Returns
TypeDescription
\Zend_View_Interface
methodpublicgetObjectKey() : null | string

Retrieve object key

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

Renders 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.
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
methodpublicsetObjectKey(string $key) : \Zend_View_Helper_Partial

Set object key

Parameters
NameTypeDescription
$keystring
Returns
TypeDescription
\Zend_View_Helper_Partial
Documentation was generated by phpDocumentor 2.2.0 .