API Documentation

Zend/View/Abstract.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  
Version
$Id: Abstract.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_View_Abstract

Package: Zend\View

Abstract class for Zend_View to help enforce private constructs.

Implements
\Zend_View_Interface
Children
\Zend_View
Category
Zend  
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivatestring  $_encoding= ''UTF-8''

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

Default value'UTF-8'Details
Type
string
Propertyprivatestring  $_escape= ''htmlspecialchars''

Callback for escaping.

Default value'htmlspecialchars'Details
Type
string
Propertyprivatestring  $_file= 'null'

Script file name to execute

Default valuenullDetails
Type
string
Propertyprivatearray  $_filter= 'array()'

Stack of Zend_View_Filter names to apply as filters.

Default valuearray()Details
Type
array
Propertyprivatearray  $_filterClass= 'array()'

Stack of Zend_View_Filter objects that have been loaded

Default valuearray()Details
Type
array
Propertyprivatearray  $_filterLoaded= 'array()'

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

Default valuearray()Details
Type
array
Propertyprivatearray  $_filterLoadedDir= 'array()'

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

Default valuearray()Details
Type
array
Propertyprivatearray  $_helper= 'array()'

Instances of helper objects.

Default valuearray()Details
Type
array
Propertyprivatearray  $_helperLoaded= 'array()'

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

Default valuearray()Details
Type
array
Propertyprivatearray  $_helperLoadedDir= 'array()'

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

Default valuearray()Details
Type
array
Propertyprivatebool  $_lfiProtectionOn= 'true'

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

Default valuetrueDetails
Type
bool
Propertyprivatearray  $_loaderTypes= 'array('filter''

Plugin types

Default valuearray('filter'Details
Type
array
Propertyprivatearray  $_loaders= 'array()'

Plugin loaders

Default valuearray()Details
Type
array
Propertyprivatearray  $_path= 'array( 'script' => array()'

Path stack for script, helper, and filter directories.

Default valuearray( 'script' => array()Details
Type
array
Propertyprivateboolean  $_strictVars= 'false'

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

Default valuefalseDetails
Type
boolean

Methods

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

Accesses a helper object from within a script.

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.
methodpublic__construct( array $config = array() ) : void

Constructor.

Parameters
Name Type Description
$config array

Configuration key-value pairs.

methodpublic__get( string $key ) : null

Prevent E_NOTICE for nonexistent values

If {@link strictVars()} is on, raises a notice.

Parameters
Name Type Description
$key string
Returns
Type Description
null
methodpublic__isset( string $key ) : boolean

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

Parameters
Name Type Description
$key string
Returns
Type Description
boolean
methodpublic__set( string $key, mixed $val ) : void

Directly assigns a variable to the view script.

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
methodpublic__unset( string $key ) : void

Allows unset() on object properties to work

Parameters
Name Type Description
$key string
methodprivate_addPath( string $type, string|array $path, string $prefix = null ) : void

Adds paths to the path stack in LIFO order.

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)

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

Add a prefixPath for a plugin type

Parameters
Name Type Description
$type string
$classPrefix string
$paths array
Returns
Type Description
\Zend_View_Abstract
methodprivate_filter( string $buffer ) : string

Applies the filter callback to a buffer.

Parameters
Name Type Description
$buffer string

The buffer contents.

Returns
Type Description
string The filtered buffer.
methodprivate_getPaths( string $type ) : array

Return all paths for a given path type

Parameters
Name Type Description
$type string

The path type ('helper', 'filter', 'script')

Returns
Type Description
array
methodprivate_getPlugin( string $type, string $name ) : object

Retrieve a plugin object

Parameters
Name Type Description
$type string
$name string
Returns
Type Description
object
methodprivate_getPluginPath( string $type, string $name ) : string|false

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

Parameters
Name Type Description
$type string
$name string
Returns
Type Description
string|false
methodprotected_run( ) : mixed
abstract

Use to include the view script in a scope that only allows public members.

Returns
Type Description
mixed
methodprotected_script( string $name ) : void

Finds a view script from the available directories.

Parameters
Name Type Description
$name string

The base name of the script.

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

Register filter class as loaded

Parameters
Name Type Description
$name string
$class string
$file string

path to class file

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

Register helper class as loaded

Parameters
Name Type Description
$name string
$class string
$file string

path to class file

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

Resets the path stack for helpers and filters.

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

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

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

Assumes a directory structure of:

basePath/
    scripts/
    helpers/
    filters/
Parameters
Name Type Description
$path string
$classPrefix
Returns
Type Description
\Zend_View_Abstract
methodpublicaddFilter( string|array $name ) : \Zend_View_Abstract

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

Parameters
Name Type Description
$name string|array

One or more filters to add.

Returns
Type Description
\Zend_View_Abstract
methodpublicaddFilterPath( string|array $path, string $classPrefix = 'Zend_View_Filter_' ) : \Zend_View_Abstract

Adds to the stack of filter paths in LIFO order.

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
methodpublicaddHelperPath( string|array $path, string $classPrefix = 'Zend_View_Helper_' ) : \Zend_View_Abstract

Adds to the stack of helper paths in LIFO order.

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
methodpublicaddScriptPath( string|array $path ) : \Zend_View_Abstract

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

Parameters
Name Type Description
$path string|array

The directory (-ies) to add.

Returns
Type Description
\Zend_View_Abstract
methodpublicassign( string|array $spec, mixed $value = null ) : \Zend_View_Abstract

Assigns variables to the view script via differing strategies.

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
\__set()  
methodpublicclearVars( ) : void

Clear all assigned variables

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

methodpublicescape( mixed $var ) : mixed

Escapes a value for output in a view script.

If escaping mechanism is one of htmlspecialchars or htmlentities, uses {@link $_encoding} setting.

Parameters
Name Type Description
$var mixed

The output to escape.

Returns
Type Description
mixed The escaped value.
methodpublicgetAllPaths( ) : array

Return associative array of path types => paths

Returns
Type Description
array
methodpublicgetEncoding( ) : string

Return current escape encoding

Returns
Type Description
string
methodpublicgetEngine( ) : \Zend_View_Abstract

Return the template engine object

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

Returns
Type Description
\Zend_View_Abstract
methodpublicgetFilter( string $name ) : object

Get a filter object by name

Parameters
Name Type Description
$name string
Returns
Type Description
object
methodpublicgetFilterPath( string $name ) : string|false

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

Parameters
Name Type Description
$name string
Returns
Type Description
string|false False on failure, path on success
methodpublicgetFilterPaths( ) : array

Returns an array of all currently set filter paths

Returns
Type Description
array
methodpublicgetFilters( ) : array

Return array of all currently active filters

Only returns those that have already been instantiated.

Returns
Type Description
array
methodpublicgetHelper( string $name ) : object

Get a helper by name

Parameters
Name Type Description
$name string
Returns
Type Description
object
methodpublicgetHelperPath( string $name ) : string|false

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

Parameters
Name Type Description
$name string
Returns
Type Description
string|false False on failure, path on success
methodpublicgetHelperPaths( ) : array

Returns an array of all currently set helper paths

Returns
Type Description
array
methodpublicgetHelpers( ) : array

Get array of all active helpers

Only returns those that have already been instantiated.

Returns
Type Description
array
methodpublicgetPluginLoader( string $type ) : \Zend_Loader_PluginLoader

Retrieve plugin loader for a specific plugin type

Parameters
Name Type Description
$type string
Returns
Type Description
\Zend_Loader_PluginLoader
methodpublicgetScriptPath( string $name ) : false|string

Return full path to a view script specified by $name

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
methodpublicgetScriptPaths( ) : array

Returns an array of all currently set script paths

Returns
Type Description
array
methodpublicgetVars( ) : array

Return list of all assigned variables

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

Returns
Type Description
array
methodpublicinit( ) : void

Allow custom object initialization when extending Zend_View_Abstract or Zend_View

Triggered by {@link __construct() the constructor} as its final action.

methodpublicisLfiProtectionOn( ) : bool

Return status of LFI protection flag

Returns
Type Description
bool
methodpublicregisterHelper( \Zend_View_Helper_Abstract|object $helper, string $name ) : \Zend_View_Abstract

Registers a helper object, bypassing plugin loader

Parameters
Name Type Description
$helper \Zend_View_Helper_Abstract|object
$name string
Returns
Type Description
\Zend_View_Abstract
Throws
Exception Description
\Zend_View_Exception
methodpublicrender( string $name ) : string

Processes a view script and returns the output.

Parameters
Name Type Description
$name string

The script name to process.

Returns
Type Description
string The script output.
methodpublicsetBasePath( string $path,  $classPrefix = 'Zend_View' ) : \Zend_View_Abstract

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

Assumes a directory structure of:

basePath/
    scripts/
    helpers/
    filters/
Parameters
Name Type Description
$path string
$classPrefix
Returns
Type Description
\Zend_View_Abstract
methodpublicsetEncoding( string $encoding ) : \Zend_View_Abstract

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

Parameters
Name Type Description
$encoding string
Returns
Type Description
\Zend_View_Abstract
methodpublicsetEscape( mixed $spec ) : \Zend_View_Abstract

Sets the _escape() callback.

Parameters
Name Type Description
$spec mixed

The callback for _escape() to use.

Returns
Type Description
\Zend_View_Abstract
methodpublicsetFilter( string|array $name ) : \Zend_View_Abstract

Resets the filter stack.

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
methodpublicsetFilterPath( string|array $path, string $classPrefix = 'Zend_View_Filter_' ) : \Zend_View_Abstract

Resets the stack of filter paths.

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
methodpublicsetHelperPath( string|array $path, string $classPrefix = 'Zend_View_Helper_' ) : \Zend_View_Abstract

Resets the stack of helper paths.

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
methodpublicsetLfiProtection( bool $flag ) : \Zend_View_Abstract

Set LFI protection flag

Parameters
Name Type Description
$flag bool
Returns
Type Description
\Zend_View_Abstract
methodpublicsetPluginLoader( \Zend_Loader_PluginLoader $loader, string $type ) : \Zend_View_Abstract

Set plugin loader for a particular plugin type

Parameters
Name Type Description
$loader \Zend_Loader_PluginLoader
$type string
Returns
Type Description
\Zend_View_Abstract
methodpublicsetScriptPath( string|array $path ) : \Zend_View_Abstract

Resets the stack of view script paths.

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
methodpublicstrictVars( boolean $flag = true ) : \Zend_View_Abstract

Enable or disable strict vars

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

Use in conjunction with {@link Zend_View_Helper_DeclareVars the declareVars() helper} to enforce strict variable handling in your view scripts.

Parameters
Name Type Description
$flag boolean
Returns
Type Description
\Zend_View_Abstract
Documentation was generated by DocBlox 0.15.1.