Class TemplatePathStack

Summary

Fully Qualified Name: Zend\View\Resolver\TemplatePathStack
Implements: ResolverInterface

Description

Resolves view scripts based on a stack of paths

Methods

Name Description Defined By
__construct() Constructor TemplatePathStack
addPath() Add a single path to the stack TemplatePathStack
addPaths() Add many paths to the stack at once TemplatePathStack
clearPaths() Clear all paths TemplatePathStack
getDefaultSuffix() Get default file suffix TemplatePathStack
getLastLookupFailure() Get the last lookup failure message, if any TemplatePathStack
getPaths() Returns stack of paths TemplatePathStack
isLfiProtectionOn() Return status of LFI protection flag TemplatePathStack
normalizePath() Normalize a path for insertion in the stack TemplatePathStack
resolve() Retrieve the filesystem path to a view script TemplatePathStack
setDefaultSuffix() Set default file suffix TemplatePathStack
setLfiProtection() Set LFI protection flag TemplatePathStack
setOptions() Configure object TemplatePathStack
setPaths() Rest the path stack to the paths provided TemplatePathStack
setUseStreamWrapper() Set flag indicating if stream wrapper should be used if short_open_tag is off TemplatePathStack
useStreamWrapper() Should the stream wrapper be used if short_open_tag is off? TemplatePathStack

Method Details

__construct()

Constructor

Parameter Name Type Description
$options null|array|\Traversable

Returns:

addPath()

Add a single path to the stack

Parameter Name Type Description
$path string

Returns: \TemplatePathStack

addPaths()

Add many paths to the stack at once

Parameter Name Type Description
$paths array

Returns: \TemplatePathStack

clearPaths()

Clear all paths

Returns: void

getDefaultSuffix()

Get default file suffix

Returns: string

getLastLookupFailure()

Get the last lookup failure message, if any

Returns: bool|string

getPaths()

Returns stack of paths

Returns: \SplStack

isLfiProtectionOn()

Return status of LFI protection flag

Returns: bool

normalizePath()

Normalize a path for insertion in the stack

Parameter Name Type Description
$path string

Returns: string

resolve()

Retrieve the filesystem path to a view script

Parameter Name Type Description
$name string
$renderer null|\Renderer

Returns: string

setDefaultSuffix()

Set default file suffix

Parameter Name Type Description
$defaultSuffix string

Returns: \TemplatePathStack

setLfiProtection()

Set LFI protection flag

Parameter Name Type Description
$flag bool

Returns: \TemplatePathStack

setOptions()

Configure object

Parameter Name Type Description
$options array|\Traversable

Returns: void

setPaths()

Rest the path stack to the paths provided

Parameter Name Type Description
$paths \SplStack|array

Returns: \TemplatePathStack

setUseStreamWrapper()

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

Parameter Name Type Description
$flag bool

Returns: \TemplatePathStack

useStreamWrapper()

Should the stream wrapper be used if short_open_tag is off?

Returns true if the use_stream_wrapper flag is set, and if short_open_tag is disabled.

Returns: bool

Top