Abstract class for Zend_View to help enforce private constructs.
category | Zend |
---|---|
package | Zend_View |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
__call(string $name, array $args) : string
If the helper class has a 'view' property, sets it with the current view object.
string
The helper name.
array
The parameters for the helper.
string
The result of the helper output.__construct(array $config = array()
)
array
Configuration key-value pairs.
__get(string $key) : null
If \strictVars() is on, raises a notice.
string
null
__isset(string $key) : boolean
inherited_from | \Zend_View_Interface::__isset() |
---|
string
boolean
__set(string $key, mixed $val) : void
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.
inherited_from | \Zend_View_Interface::__set() |
---|
string
The variable name.
mixed
The variable value.
\Zend_View_Exception |
if an attempt to set a private or protected member is detected |
---|
__unset(string $key) : void
inherited_from | \Zend_View_Interface::__unset() |
---|
string
addBasePath(string $path, string $classPrefix = 'Zend_View'
) : \Zend_View_Abstract
Assumes a directory structure of:
basePath/
scripts/
helpers/
filters/
inherited_from | \Zend_View_Interface::addBasePath() |
---|
string
\Zend_View_Abstract
addFilter($name) : \Zend_View_Abstract
\Zend_View_Abstract
addFilterPath($path, string $classPrefix = 'Zend_View_Filter_'
) : \Zend_View_Abstract
string
Class prefix to use with classes in this directory; defaults to Zend_View_Filter
\Zend_View_Abstract
addHelperPath($path, string $classPrefix = 'Zend_View_Helper_'
) : \Zend_View_Abstract
string
Class prefix to use with classes in this directory; defaults to Zend_View_Helper
\Zend_View_Abstract
addScriptPath($path) : \Zend_View_Abstract
\Zend_View_Abstract
assign(string|array $spec, mixed $value = null
) : \Zend_View_Abstract
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).
see | |
---|---|
inherited_from | \Zend_View_Interface::assign() |
\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 |
---|
\Zend_View_Abstract
Fluent interfaceclearVars() : void
Clears all variables assigned to Zend_View either via \assign() or property overloading (__set()).
inherited_from | \Zend_View_Interface::clearVars() |
---|
escape(mixed $var) : mixed
If escaping mechanism is one of htmlspecialchars or htmlentities, uses \$_encoding setting.
mixed
The output to escape.
mixed
The escaped value.getAllPaths() : array
array
getEncoding() : string
string
getEngine() : \Zend_View_Abstract
Returns the object instance, as it is its own template engine
inherited_from | \Zend_View_Interface::getEngine() |
---|
\Zend_View_Abstract
getFilter(string $name) : object
string
object
getFilterPath(string $name) : string | false
string
string
false
False on failure, path on successgetFilterPaths() : array
array
getFilters() : array
Only returns those that have already been instantiated.
array
getHelper(string $name) : object
string
object
getHelperPath(string $name) : string | false
string
string
false
False on failure, path on successgetHelperPaths() : array
array
getHelpers() : array
Only returns those that have already been instantiated.
array
getPluginLoader(string $type) : \Zend_Loader_PluginLoader
string
\Zend_Loader_PluginLoader
getScriptPath(string $name) : false | string
string
\Zend_View_Exception |
if no script directory set |
---|
false
string
False if script not foundgetScriptPaths() : array
inherited_from | \Zend_View_Interface::getScriptPaths() |
---|
array
getVars() : array
Returns all public properties of the object. Reflection is not used here as testing reflection properties for visibility is buggy.
array
init() : void
Triggered by __construct() as its final action.
isLfiProtectionOn() : boolean
boolean
registerHelper(\Zend_View_Helper_Abstract|object $helper, string $name) : \Zend_View_Abstract
\Zend_View_Helper_Abstract
object
string
\Zend_View_Exception |
---|
\Zend_View_Abstract
render(string $name) : string
inherited_from | \Zend_View_Interface::render() |
---|
string
The script name to process.
string
The script output.setBasePath(string $path, string $classPrefix = 'Zend_View'
) : \Zend_View_Abstract
Assumes a directory structure of:
basePath/
scripts/
helpers/
filters/
inherited_from | \Zend_View_Interface::setBasePath() |
---|
string
\Zend_View_Abstract
setEncoding(string $encoding) : \Zend_View_Abstract
string
\Zend_View_Abstract
setEscape(mixed $spec) : \Zend_View_Abstract
mixed
The callback for _escape() to use.
\Zend_View_Abstract
setFilter($name) : \Zend_View_Abstract
To clear all filters, use Zend_View::setFilter(null).
\Zend_View_Abstract
setFilterPath($path, string $classPrefix = 'Zend_View_Filter_'
) : \Zend_View_Abstract
To clear all paths, use Zend_View::setFilterPath(null).
string
The class prefix to apply to all elements in $path; defaults to Zend_View_Filter
\Zend_View_Abstract
setHelperPath(string|array $path, string $classPrefix = 'Zend_View_Helper_'
) : \Zend_View_Abstract
To clear all paths, use Zend_View::setHelperPath(null).
string
array
The directory (-ies) to set as the path.
string
The class prefix to apply to all elements in $path; defaults to Zend_View_Helper
\Zend_View_Abstract
setLfiProtection(boolean $flag) : \Zend_View_Abstract
boolean
\Zend_View_Abstract
setPluginLoader(\Zend_Loader_PluginLoader $loader, string $type) : \Zend_View_Abstract
\Zend_Loader_PluginLoader
string
\Zend_View_Abstract
setScriptPath($path) : \Zend_View_Abstract
To clear all paths, use Zend_View::setScriptPath(null).
inherited_from | \Zend_View_Interface::setScriptPath() |
---|
\Zend_View_Abstract
strictVars(boolean $flag = true
) : \Zend_View_Abstract
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.
boolean
\Zend_View_Abstract
_run() : mixed
mixed
_script(string $name) : void
string
The base name of the script.
_addPath(string $type, string|array $path, string $prefix = null
) : void
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.
string
The path type ('script', 'helper', or 'filter').
string
array
The path specification.
string
Class prefix to use with path (helpers and filters only)
_addPluginPath(string $type, string $classPrefix, array $paths) : \Zend_View_Abstract
string
string
array
\Zend_View_Abstract
_filter(string $buffer) : string
string
The buffer contents.
string
The filtered buffer._getPaths(string $type) : array
string
The path type ('helper', 'filter', 'script')
array
_getPlugin(string $type, string $name) : object
string
string
object
_getPluginPath(string $type, string $name) : string | false
string
string
string
false
_setFilterClass(string $name, string $class, string $file) : void
string
string
string
path to class file
_setHelperClass(string $name, string $class, string $file) : void
string
string
string
path to class file
_setPath(string $type, string|array $path, string $classPrefix = null
)
string
The path type ('helper' or 'filter').
string
array
The directory (-ies) to set as the path.
string
Class prefix to apply to elements of $path
$_encoding : string
'UTF-8'
$_escape : string
'htmlspecialchars'
$_file : string
null
$_filter : array
array()
$_filterClass : array
array()
$_filterLoaded : array
array()
$_filterLoadedDir : array
array()
$_helper : array
array()
$_helperLoaded : array
array()
$_helperLoadedDir : array
array()
$_lfiProtectionOn : boolean
true
$_loaderTypes : array
array('filter', 'helper')
$_loaders : array
array()
$_path : array
array('script' => array(), 'helper' => array(), 'filter' => array())
$_strictVars : boolean
false