View.php

Show:

inherited

Classes
- \Zend_View

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-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_View
Version: $Id: View.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_View
jump to top

Package: Zend\View

Concrete class for handling view scripts.

Parent(s): \Zend_View_Abstract
Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

string $_encoding = 'UTF-8'

inherited

Encoding to use in escaping mechanisms; defaults to utf-8

Inherited from: \Zend_View_Abstract::$$_encoding

Default value'UTF-8'Details

Type: string
Inherited_from: \Zend_View_Abstract::$$_encoding

string $_escape = 'htmlspecialchars'

inherited

Callback for escaping.

Inherited from: \Zend_View_Abstract::$$_escape

Default value'htmlspecialchars'Details

Type: string
Inherited_from: \Zend_View_Abstract::$$_escape

string $_file = null

inherited

Script file name to execute

Inherited from: \Zend_View_Abstract::$$_file

Default valuenullDetails

Type: string
Inherited_from: \Zend_View_Abstract::$$_file

array $_filter = array()

inherited

Stack of Zend_View_Filter names to apply as filters.

Inherited from: \Zend_View_Abstract::$$_filter

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_filter

array $_filterClass = array()

inherited

Stack of Zend_View_Filter objects that have been loaded

Inherited from: \Zend_View_Abstract::$$_filterClass

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_filterClass

array $_filterLoaded = array()

inherited

Map of filter => class pairs to help in determining filter class from name

Inherited from: \Zend_View_Abstract::$$_filterLoaded

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_filterLoaded

array $_filterLoadedDir = array()

inherited

Map of filter => classfile pairs to aid in determining filter classfile

Inherited from: \Zend_View_Abstract::$$_filterLoadedDir

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_filterLoadedDir

array $_helper = array()

inherited

Instances of helper objects.

Inherited from: \Zend_View_Abstract::$$_helper

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_helper

array $_helperLoaded = array()

inherited

Map of helper => class pairs to help in determining helper class from name

Inherited from: \Zend_View_Abstract::$$_helperLoaded

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_helperLoaded

array $_helperLoadedDir = array()

inherited

Map of helper => classfile pairs to aid in determining helper classfile

Inherited from: \Zend_View_Abstract::$$_helperLoadedDir

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_helperLoadedDir

bool $_lfiProtectionOn = true

inherited

Flag indicating whether or not LFI protection for rendering view scripts is enabled

Inherited from: \Zend_View_Abstract::$$_lfiProtectionOn

Default valuetrueDetails

Type: bool
Inherited_from: \Zend_View_Abstract::$$_lfiProtectionOn

array $_loaderTypes = array('filter', 'helper')

inherited

Plugin types

Inherited from: \Zend_View_Abstract::$$_loaderTypes

Default valuearray('filter', 'helper')Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_loaderTypes

array $_loaders = array()

inherited

Plugin loaders

Inherited from: \Zend_View_Abstract::$$_loaders

Default valuearray()Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_loaders

array $_path = array('script' => array(), 'helper' => array(), 'filter' => array())

inherited

Path stack for script, helper, and filter directories.

Inherited from: \Zend_View_Abstract::$$_path

Default valuearray('script' => array(), 'helper' => array(), 'filter' => array())Details

Type: array
Inherited_from: \Zend_View_Abstract::$$_path

boolean $_strictVars = false

inherited

Strict variables flag; when on, undefined variables accessed in the view scripts will trigger notices

Inherited from: \Zend_View_Abstract::$$_strictVars

Default valuefalseDetails

Type: boolean
Inherited_from: \Zend_View_Abstract::$$_strictVars

bool $_useStreamWrapper = false

Whether or not to use stream wrapper if short_open_tag is false

Default valuefalseDetails

Type: bool

bool $_useViewStream = false

Whether or not to use streams to mimic short tags

Default valuefalseDetails

Type: bool

Methods

__call(string $name, array $args) : string

inherited

Accesses a helper object from within a script.

Inherited from: \Zend_View_Abstract::__call()

If the helper class has a 'view' property, sets it with the current view object.

Parameters

Name	Type	Description
$name	string	The helper name.
$args	array	The parameters for the helper.

Returns

Type	Description
string	The result of the helper output.

__construct(array $config = array()) : void

Constructor

Parameters

Name	Type	Description
$config	array

__get(string $key) : null

inherited

Prevent E_NOTICE for nonexistent values

Inherited from: \Zend_View_Abstract::__get()

If strictVars() is on, raises a notice.

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
null

__isset(string $key) : boolean

inherited

Allows testing with empty() and isset() to work inside templates.

Inherited from: \Zend_View_Abstract::__isset()

Parameters

Name	Type	Description
$key	string

Returns

Type	Description
boolean

__set(string $key, mixed $val) : void

inherited

Directly assigns a variable to the view script.

Inherited from: \Zend_View_Abstract::__set()

Checks first to ensure that the caller is not attempting to set a protected or private member (by checking for a prefixed underscore); if not, the public member is set; otherwise, an exception is raised.

Parameters

Name	Type	Description
$key	string	The variable name.
$val	mixed	The variable value.

Throws

Exception	Description
\Zend_View_Exception	if an attempt to set a private or protected member is detected

__unset(string $key) : void

inherited

Allows unset() on object properties to work

Inherited from: \Zend_View_Abstract::__unset()

Parameters

Name	Type	Description
$key	string

_addPath(string $type, string | array $path, string $prefix = null) : void

inherited

Adds paths to the path stack in LIFO order.

Inherited from: \Zend_View_Abstract::_addPath()

Zend_View::_addPath($type, 'dirname') adds one directory to the path stack.

Zend_View::_addPath($type, $array) adds one directory for each array element value.

In the case of filter and helper paths, $prefix should be used to specify what class prefix to use with the given path.

Parameters

Name	Type	Description
$type	string	The path type ('script', 'helper', or 'filter').
$path	string \| array	The path specification.
$prefix	string	Class prefix to use with path (helpers and filters only)

_addPluginPath(string $type, string $classPrefix, array $paths) : \Zend_View_Abstract

inherited

Add a prefixPath for a plugin type

Inherited from: \Zend_View_Abstract::_addPluginPath()

Parameters

Name	Type	Description
$type	string
$classPrefix	string
$paths	array

Returns

Type	Description
\Zend_View_Abstract

_filter(string $buffer) : string

inherited

Applies the filter callback to a buffer.

Inherited from: \Zend_View_Abstract::_filter()

Parameters

Name	Type	Description
$buffer	string	The buffer contents.

Returns

Type	Description
string	The filtered buffer.

_getPaths(string $type) : array

inherited

Return all paths for a given path type

Inherited from: \Zend_View_Abstract::_getPaths()

Parameters

Name	Type	Description
$type	string	The path type ('helper', 'filter', 'script')

Returns

Type	Description
array

_getPlugin(string $type, string $name) : object

inherited

Retrieve a plugin object

Inherited from: \Zend_View_Abstract::_getPlugin()

Parameters

Name	Type	Description
$type	string
$name	string

Returns

Type	Description
object

_getPluginPath(string $type, string $name) : string | false

inherited

Get a path to a given plugin class of a given type

Inherited from: \Zend_View_Abstract::_getPluginPath()

Parameters

Name	Type	Description
$type	string
$name	string

Returns

Type	Description
string \| false

_run() : mixed

Includes the view script in a scope with only public $this variables.

Returns

Type	Description
mixed

_script(string $name) : void

inherited

Finds a view script from the available directories.

Inherited from: \Zend_View_Abstract::_script()

Parameters

Name	Type	Description
$name	string	The base name of the script.

_setFilterClass(string $name, string $class, string $file) : void

inherited

Inherited from: \Zend_View_Abstract::_setFilterClass()

Parameters

Name	Type	Description
$name	string
$class	string
$file	string	path to class file

_setHelperClass(string $name, string $class, string $file) : void

inherited

Inherited from: \Zend_View_Abstract::_setHelperClass()

Parameters

Name	Type	Description
$name	string
$class	string
$file	string	path to class file

_setPath(string $type, string | array $path, string $classPrefix = null) : void

inherited

Resets the path stack for helpers and filters.

Inherited from: \Zend_View_Abstract::_setPath()

Parameters

Name	Type	Description
$type	string	The path type ('helper' or 'filter').
$path	string \| array	The directory (-ies) to set as the path.
$classPrefix	string	Class prefix to apply to elements of $path

addBasePath(string $path, $classPrefix = 'Zend_View') : \Zend_View_Abstract

inherited

Given a base path, add script, helper, and filter paths relative to it

Inherited from: \Zend_View_Abstract::addBasePath()

Assumes a directory structure of:

basePath/
    scripts/
    helpers/
    filters/

Parameters

Name	Type	Description
$path	string
$classPrefix

Returns

Type	Description
\Zend_View_Abstract

addFilter(string | array $name) : \Zend_View_Abstract

inherited

Add one or more filters to the stack in FIFO order.

Inherited from: \Zend_View_Abstract::addFilter()

Parameters

Name	Type	Description
$name	string \| array	One or more filters to add.

Returns

Type	Description
\Zend_View_Abstract

addFilterPath(string | array $path, string $classPrefix = 'Zend_View_Filter_') : \Zend_View_Abstract

inherited

Adds to the stack of filter paths in LIFO order.

Inherited from: \Zend_View_Abstract::addFilterPath()

Parameters

Name	Type	Description
$path	string \| array	The directory (-ies) to add.
$classPrefix	string	Class prefix to use with classes in this directory; defaults to Zend_View_Filter

Returns

Type	Description
\Zend_View_Abstract

addHelperPath(string | array $path, string $classPrefix = 'Zend_View_Helper_') : \Zend_View_Abstract

inherited

Adds to the stack of helper paths in LIFO order.

Inherited from: \Zend_View_Abstract::addHelperPath()

Parameters

Name	Type	Description
$path	string \| array	The directory (-ies) to add.
$classPrefix	string	Class prefix to use with classes in this directory; defaults to Zend_View_Helper

Returns

Type	Description
\Zend_View_Abstract

addScriptPath(string | array $path) : \Zend_View_Abstract

inherited

Adds to the stack of view script paths in LIFO order.

Inherited from: \Zend_View_Abstract::addScriptPath()

Parameters

Name	Type	Description
$path	string \| array	The directory (-ies) to add.

Returns

Type	Description
\Zend_View_Abstract

assign(string | array $spec, mixed $value = null) : \Zend_View_Abstract

inherited

Assigns variables to the view script via differing strategies.

Inherited from: \Zend_View_Abstract::assign()

Zend_View::assign('name', $value) assigns a variable called 'name' with the corresponding $value.

Zend_View::assign($array) assigns the array keys as variable names (with the corresponding array values).

Parameters

Name	Type	Description
$spec	string \| array	The assignment strategy to use.
$value	mixed	(Optional) If assigning a named variable, use this as the value.

Returns

Type	Description
\Zend_View_Abstract	Fluent interface

Throws

Exception	Description
\Zend_View_Exception	if $spec is neither a string nor an array, or if an attempt to set a private or protected member is detected

Details

See: \global\__set()

clearVars() : void

inherited

Clear all assigned variables

Inherited from: \Zend_View_Abstract::clearVars()

Clears all variables assigned to Zend_View either via assign() or property overloading (__set()).

escape(mixed $var) : mixed

inherited

Escapes a value for output in a view script.

Inherited from: \Zend_View_Abstract::escape()

If escaping mechanism is one of htmlspecialchars or htmlentities, uses $_encoding setting.

Parameters

Name	Type	Description
$var	mixed	The output to escape.

Returns

Type	Description
mixed	The escaped value.

getAllPaths() : array

inherited

Return associative array of path types => paths

Inherited from: \Zend_View_Abstract::getAllPaths()

Returns

Type	Description
array

getEncoding() : string

inherited

Return current escape encoding

Inherited from: \Zend_View_Abstract::getEncoding()

Returns

Type	Description
string

getEngine() : \Zend_View_Abstract

inherited

Return the template engine object

Inherited from: \Zend_View_Abstract::getEngine()

Returns the object instance, as it is its own template engine

Returns

Type	Description
\Zend_View_Abstract

getFilter(string $name) : object

inherited

Get a filter object by name

Inherited from: \Zend_View_Abstract::getFilter()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
object

getFilterPath(string $name) : string | false

inherited

Get full path to a filter class file specified by $name

Inherited from: \Zend_View_Abstract::getFilterPath()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string \| false	False on failure, path on success

getFilterPaths() : array

inherited

Returns an array of all currently set filter paths

Inherited from: \Zend_View_Abstract::getFilterPaths()

Returns

Type	Description
array

getFilters() : array

inherited

Return array of all currently active filters

Inherited from: \Zend_View_Abstract::getFilters()

Only returns those that have already been instantiated.

Returns

Type	Description
array

getHelper(string $name) : object

inherited

Get a helper by name

Inherited from: \Zend_View_Abstract::getHelper()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
object

getHelperPath(string $name) : string | false

inherited

Get full path to a helper class file specified by $name

Inherited from: \Zend_View_Abstract::getHelperPath()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string \| false	False on failure, path on success

getHelperPaths() : array

inherited

Returns an array of all currently set helper paths

Inherited from: \Zend_View_Abstract::getHelperPaths()

Returns

Type	Description
array

getHelpers() : array

inherited

Get array of all active helpers

Inherited from: \Zend_View_Abstract::getHelpers()

Only returns those that have already been instantiated.

Returns

Type	Description
array

getPluginLoader(string $type) : \Zend_Loader_PluginLoader

inherited

Retrieve plugin loader for a specific plugin type

Inherited from: \Zend_View_Abstract::getPluginLoader()

Parameters

Name	Type	Description
$type	string

Returns

Type	Description
\Zend_Loader_PluginLoader

getScriptPath(string $name) : false | string

inherited

Return full path to a view script specified by $name

Inherited from: \Zend_View_Abstract::getScriptPath()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
false \| string	False if script not found

Throws

Exception	Description
\Zend_View_Exception	if no script directory set

getScriptPaths() : array

inherited

Returns an array of all currently set script paths

Inherited from: \Zend_View_Abstract::getScriptPaths()

Returns

Type	Description
array

getVars() : array

inherited

Return list of all assigned variables

Inherited from: \Zend_View_Abstract::getVars()

Returns all public properties of the object. Reflection is not used here as testing reflection properties for visibility is buggy.

Returns

Type	Description
array

init() : void

inherited

Allow custom object initialization when extending Zend_View_Abstract or Zend_View

Inherited from: \Zend_View_Abstract::init()

Triggered by the constructor as its final action.

isLfiProtectionOn() : bool

inherited

Return status of LFI protection flag

Inherited from: \Zend_View_Abstract::isLfiProtectionOn()

Returns

Type	Description
bool

registerHelper(\Zend_View_Helper_Abstract | object $helper, string $name) : \Zend_View_Abstract

inherited

Registers a helper object, bypassing plugin loader

Inherited from: \Zend_View_Abstract::registerHelper()

Parameters

Name	Type	Description
$helper	\Zend_View_Helper_Abstract \| object
$name	string

Returns

Type	Description
\Zend_View_Abstract

Throws

Exception	Description
\Zend_View_Exception

render(string $name) : string

inherited

Processes a view script and returns the output.

Inherited from: \Zend_View_Abstract::render()

Parameters

Name	Type	Description
$name	string	The script name to process.

Returns

Type	Description
string	The script output.

setBasePath(string $path, $classPrefix = 'Zend_View') : \Zend_View_Abstract

inherited

Given a base path, sets the script, helper, and filter paths relative to it

Inherited from: \Zend_View_Abstract::setBasePath()

Assumes a directory structure of:

basePath/
    scripts/
    helpers/
    filters/

Parameters

Name	Type	Description
$path	string
$classPrefix

Returns

Type	Description
\Zend_View_Abstract

setEncoding(string $encoding) : \Zend_View_Abstract

inherited

Set encoding to use with htmlentities() and htmlspecialchars()

Inherited from: \Zend_View_Abstract::setEncoding()

Parameters

Name	Type	Description
$encoding	string

Returns

Type	Description
\Zend_View_Abstract

setEscape(mixed $spec) : \Zend_View_Abstract

inherited

Sets the _escape() callback.

Inherited from: \Zend_View_Abstract::setEscape()

Parameters

Name	Type	Description
$spec	mixed	The callback for _escape() to use.

Returns

Type	Description
\Zend_View_Abstract

setFilter(string | array $name) : \Zend_View_Abstract

inherited

Resets the filter stack.

Inherited from: \Zend_View_Abstract::setFilter()

To clear all filters, use Zend_View::setFilter(null).

Parameters

Name	Type	Description
$name	string \| array	One or more filters to set.

Returns

Type	Description
\Zend_View_Abstract

setFilterPath(string | array $path, string $classPrefix = 'Zend_View_Filter_') : \Zend_View_Abstract

inherited

Resets the stack of filter paths.

Inherited from: \Zend_View_Abstract::setFilterPath()

To clear all paths, use Zend_View::setFilterPath(null).

Parameters

Name	Type	Description
$path	string \| array	The directory (-ies) to set as the path.
$classPrefix	string	The class prefix to apply to all elements in $path; defaults to Zend_View_Filter

Returns

Type	Description
\Zend_View_Abstract

setHelperPath(string | array $path, string $classPrefix = 'Zend_View_Helper_') : \Zend_View_Abstract

inherited

Resets the stack of helper paths.

Inherited from: \Zend_View_Abstract::setHelperPath()

To clear all paths, use Zend_View::setHelperPath(null).

Parameters

Name	Type	Description
$path	string \| array	The directory (-ies) to set as the path.
$classPrefix	string	The class prefix to apply to all elements in $path; defaults to Zend_View_Helper

Returns

Type	Description
\Zend_View_Abstract

setLfiProtection(bool $flag) : \Zend_View_Abstract

inherited

Set LFI protection flag

Inherited from: \Zend_View_Abstract::setLfiProtection()

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_View_Abstract

setPluginLoader(\Zend_Loader_PluginLoader $loader, string $type) : \Zend_View_Abstract

inherited

Set plugin loader for a particular plugin type

Inherited from: \Zend_View_Abstract::setPluginLoader()

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader
$type	string

Returns

Type	Description
\Zend_View_Abstract

setScriptPath(string | array $path) : \Zend_View_Abstract

inherited

Resets the stack of view script paths.

Inherited from: \Zend_View_Abstract::setScriptPath()

To clear all paths, use Zend_View::setScriptPath(null).

Parameters

Name	Type	Description
$path	string \| array	The directory (-ies) to set as the path.

Returns

Type	Description
\Zend_View_Abstract

setUseStreamWrapper(bool $flag) : \Zend_View

Set flag indicating if stream wrapper should be used if short_open_tag is off

Parameters

Name	Type	Description
$flag	bool

Returns

Type	Description
\Zend_View

strictVars(boolean $flag = true) : \Zend_View_Abstract

inherited

Enable or disable strict vars

Inherited from: \Zend_View_Abstract::strictVars()

If strict variables are enabled, __get() will raise a notice when a variable is not defined.

Use in conjunction with the declareVars() helper to enforce strict variable handling in your view scripts.

Parameters

Name	Type	Description
$flag	boolean

Returns

Type	Description
\Zend_View_Abstract

useStreamWrapper() : bool

Should the stream wrapper be used if short_open_tag is off?

Returns

Type	Description
bool

View.php

\Zend_Viewjump to top

Properties

Methods

\Zend_View
jump to top