View/Helper/DeclareVars.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: DeclareVars.php 24593 2012-01-05 20:35:02Z matthew $  

\Zend_View_Helper_DeclareVars

Package: Zend\View\Helper
Helper for declaring default values of template variables
Parent(s)
\Zend_View_Helper_Abstract
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

>VPropertypublic\Zend_View $view
The view object that created this helper object.
Details
Type
\Zend_View

Methods

methodprotected_declareVar(string $key, string $value = '') : void

Set a view variable

Checks to see if a $key is set in the view object; if not, sets it to $value.

Parameters
NameTypeDescription
$keystring
$valuestring

Defaults to an empty string

methodpublicdeclareVars() : void

Declare template vars to set default values and avoid notices when using strictVars

Primarily for use when using Zend_View strictVars(), this helper can be used to declare template variables that may or may not already be set in the view object, as well as to set default values. Arrays passed as arguments to the method will be used to set default values; otherwise, if the variable does not exist, it is set to an empty string.

Usage:

$this->declareVars(
    'varName1',
    'varName2',
    array('varName3' => 'defaultValue',
          'varName4' => array()
    )
);
methodpublicdirect() : void
inherited

Strategy pattern: currently unutilized

Inherited from: \Zend_View_Helper_Abstract::direct()
methodpublicsetView(\Zend_View_Interface $view) : \Zend_View_Helper_Abstract
inherited

Set the View object

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