API Documentation

Zend/View/Helper/Partial.php

Show: inherited
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: Partial.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Helper_Partial

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedstring  $_objectKey= ''

Variable to which object will be assigned

Details
Type
string

Methods

methodpubliccloneView( ) : \Zend_View_Interface

Clone the current View

Returns
Type Description
\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
Type Description
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
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

Returns
Type Description
string|\Zend_View_Helper_Partial
methodpublicsetObjectKey( string $key ) : \Zend_View_Helper_Partial

Set object key

Parameters
Name Type Description
$key string
Returns
Type Description
\Zend_View_Helper_Partial
Documentation was generated by DocBlox 0.15.1.