Public Member Functions
	__construct (Zend_View_Interface $view=null, array $options=array())
	Constructor.

	__clone ()
	Clone - also make sure the view is cloned.

	setView (Zend_View_Interface $view)
	Set the view object.

	getModule ()
	Get current module name.

	getModuleDirectory ()
	Get module directory.

	getInflector ()
	Get inflector.

	setInflector (Zend_Filter_Inflector $inflector, $reference=false)
	Set inflector.

	initView ($path=null, $prefix=null, array $options=array())
	Initialize the view object.

	init ()
	init - initialize view

	setViewBasePathSpec ($path)
	Set view basePath specification.

	getViewBasePathSpec ()
	Retrieve the current view basePath specification string.

	setViewScriptPathSpec ($path)
	Set view script path specification.

	getViewScriptPathSpec ()
	Retrieve the current view script path specification string.

	setViewScriptPathNoControllerSpec ($path)
	Set view script path specification (no controller variant)

	getViewScriptPathNoControllerSpec ()
	Retrieve the current view script path specification string (no controller variant)

	getViewScript ($action=null, array $vars=array())
	Get a view script based on an action and/or other variables.

	setNeverRender ($flag=true)
	Set the neverRender flag (i.e., globally dis/enable autorendering)

	getNeverRender ()
	Retrieve neverRender flag value.

	setNoRender ($flag=true)
	Set the noRender flag (i.e., whether or not to autorender)

	getNoRender ()
	Retrieve noRender flag value.

	setScriptAction ($name)
	Set the view script to use.

	getScriptAction ()
	Retrieve view script name.

	setResponseSegment ($name)
	Set the response segment name.

	getResponseSegment ()
	Retrieve named response segment name.

	setNoController ($flag=true)
	Set the noController flag (i.e., whether or not to render into controller subdirectories)

	getNoController ()
	Retrieve noController flag value.

	setNeverController ($flag=true)
	Set the neverController flag (i.e., whether or not to render into controller subdirectories)

	getNeverController ()
	Retrieve neverController flag value.

	setViewSuffix ($suffix)
	Set view script suffix.

	getViewSuffix ()
	Get view script suffix.

	setRender ($action=null, $name=null, $noController=null)
	Set options for rendering a view script.

	renderScript ($script, $name=null)
	Render a view script (optionally to a named response segment)

	render ($action=null, $name=null, $noController=null)
	Render a view based on path specifications.

	renderBySpec ($action=null, array $vars=array(), $name=null)
	Render a script based on specification variables.

	postDispatch ()
	postDispatch - auto render a view

	direct ($action=null, $name=null, $noController=null)
	Use this helper as a method; proxies to setRender()

Public Member Functions inherited from Zend_Controller_Action_Helper_Abstract
	setActionController (Zend_Controller_Action $actionController=null)
	setActionController()

	getActionController ()
	Retrieve current action controller.

	getFrontController ()
	Retrieve front controller instance.

	init ()
	Hook into action controller initialization.

	preDispatch ()
	Hook into action controller preDispatch() workflow.

	postDispatch ()
	Hook into action controller postDispatch() workflow.

	getRequest ()
	getRequest() -

	getResponse ()
	getResponse() -

	getName ()
	getName()

Public Attributes
	$view

Protected Member Functions
	_setInflectorTarget ($target)
	Set inflector target.

	_setModuleDir ($dir)
	Set internal module directory representation.

	_getModuleDir ()
	Get internal module directory representation.

	_generateDefaultPrefix ()
	Generate a class prefix for helper and filter classes.

	_getBasePath ()
	Retrieve base path based on location of current action controller.

	_setOptions (array $options)
	Set options.

	_translateSpec (array $vars=array())
	Inflect based on provided vars.

	_shouldRender ()
	Should the ViewRenderer render a view script?

Protected Attributes
	$_delimiters

	$_inflector

	$_inflectorTarget = ''

	$_moduleDir = ''

	$_neverController = false

	$_neverRender = false

	$_noController = false

	$_noRender = false

	$_pathDelimiters

	$_responseSegment = null

	$_scriptAction = null

	$_viewBasePathSpec = ':moduleDir/views'

	$_viewScriptPathSpec = ':controller/:action.:suffix'

	$_viewScriptPathNoControllerSpec = ':action.:suffix'

	$_viewSuffix = 'phtml'

Protected Attributes inherited from Zend_Controller_Action_Helper_Abstract
	$_actionController = null
	$_actionController

	$_frontController = null

Constructor & Destructor Documentation

__construct	(	Zend_View_Interface	$view = `null`,
		array	$options = `array()`
	)

Constructor.

Optionally set view object and options.

Parameters

Zend_View_Interface	$view
array	$options

Returns: void

Member Function Documentation

__clone ( )

Clone - also make sure the view is cloned.

Returns: void

_generateDefaultPrefix ( )

protected

Generate a class prefix for helper and filter classes.

Returns: string

_getBasePath ( )

protected

Retrieve base path based on location of current action controller.

Returns: string

_getModuleDir ( )

protected

Get internal module directory representation.

Returns: string

_setInflectorTarget ( $target )

protected

Set inflector target.

Parameters

string $target

Returns: void

_setModuleDir ( $dir )

protected

Set internal module directory representation.

Parameters

string $dir

Returns: void

_setOptions ( array $options )

protected

Set options.

Parameters

array $options

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

_shouldRender ( )

protected

Should the ViewRenderer render a view script?

Returns: boolean

_translateSpec ( array $vars = array() )

protected

Inflect based on provided vars.

Allowed variables are:

:moduleDir - current module directory
:module - current module name
:controller - current controller name
:action - current action name
:suffix - view script file suffix

Parameters

array $vars

Returns: string

direct	(	$action = `null`,
		$name = `null`,
		$noController = `null`
	)

Use this helper as a method; proxies to setRender()

Parameters

string	$action
string	$name
boolean	$noController

Returns: void

getInflector ( )

Get inflector.

Returns: Zend_Filter_Inflector

See Also: Zend_Filter_Inflector; Zend_Filter_PregReplace; Zend_Filter_Word_UnderscoreToSeparator

getModule ( )

Get current module name.

Returns: string

getModuleDirectory ( )

Get module directory.

Exceptions

Zend_Controller_Action_Exception

Returns: string

See Also: Zend_Controller_Action_Exception

getNeverController ( )

Retrieve neverController flag value.

Returns: boolean

getNeverRender ( )

Retrieve neverRender flag value.

Returns: boolean

getNoController ( )

Retrieve noController flag value.

Returns: boolean

getNoRender ( )

Retrieve noRender flag value.

Returns: boolean

getResponseSegment ( )

Retrieve named response segment name.

Returns: string

getScriptAction ( )

Retrieve view script name.

Returns: string

getViewBasePathSpec ( )

Retrieve the current view basePath specification string.

Returns: string

getViewScript	(		$action = `null`,
		array	$vars = `array()`
	)

Get a view script based on an action and/or other variables.

Uses values found in current request if no values passed in $vars.

If $_noController is set, uses $_viewScriptPathNoControllerSpec; otherwise, uses $_viewScriptPathSpec.

Parameters

string	$action
array	$vars

Returns: string

getViewScriptPathNoControllerSpec ( )

Retrieve the current view script path specification string (no controller variant)

Returns: string

getViewScriptPathSpec ( )

Retrieve the current view script path specification string.

Returns: string

getViewSuffix ( )

Get view script suffix.

Returns: string

init ( )

init - initialize view

Returns: void

initView	(		$path = `null`,
			$prefix = `null`,
		array	$options = `array()`
	)

Initialize the view object.

$options may contain the following keys:

neverRender - flag dis/enabling postDispatch() autorender (affects all subsequent calls)
noController - flag indicating whether or not to look for view scripts in subdirectories named after the controller
noRender - flag indicating whether or not to autorender postDispatch()
responseSegment - which named response segment to render a view script to
scriptAction - what action script to render
viewBasePathSpec - specification to use for determining view base path
viewScriptPathSpec - specification to use for determining view script paths
viewScriptPathNoControllerSpec - specification to use for determining view script paths when noController flag is set
viewSuffix - what view script filename suffix to use

Parameters

string	$path
string	$prefix
array	$options

Exceptions

Zend_Controller_Action_Exception

Returns: void

See Also: Zend_Controller_Action_Exception

postDispatch ( )

postDispatch - auto render a view

Only autorenders if:

_noRender is false
action controller is present
request has not been re-dispatched (i.e., _forward() has not been called)
response is not a redirect

Returns: void

render	(	$action = `null`,
		$name = `null`,
		$noController = `null`
	)

Render a view based on path specifications.

Renders a view based on the view script path specifications.

Parameters

string	$action
string	$name
boolean	$noController

Returns: void

renderBySpec	(		$action = `null`,
		array	$vars = `array()`,
			$name = `null`
	)

Render a script based on specification variables.

Pass an action, and one or more specification variables (view script suffix) to determine the view script path, and render that script.

Parameters

string	$action
array	$vars
string	$name

Returns: void

renderScript	(	$script,
		$name = `null`
	)

Render a view script (optionally to a named response segment)

Sets the noRender flag to true when called.

Parameters

string	$script
string	$name

Returns: void

setInflector	(	Zend_Filter_Inflector	$inflector,
			$reference = `false`
	)

Set inflector.

Parameters

Zend_Filter_Inflector	$inflector
boolean	$reference	Whether the moduleDir, target, and suffix should be set as references to ViewRenderer properties

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setNeverController ( $flag = true )

Set the neverController flag (i.e., whether or not to render into controller subdirectories)

Parameters

boolean $flag

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setNeverRender ( $flag = true )

Set the neverRender flag (i.e., globally dis/enable autorendering)

Parameters

boolean $flag

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setNoController ( $flag = true )

Set the noController flag (i.e., whether or not to render into controller subdirectories)

Parameters

boolean $flag

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setNoRender ( $flag = true )

Set the noRender flag (i.e., whether or not to autorender)

Parameters

boolean $flag

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setRender	(	$action = `null`,
		$name = `null`,
		$noController = `null`
	)

Set options for rendering a view script.

Parameters

string	$action	View script to render
string	$name	Response named segment to render to
boolean	$noController	Whether or not to render within a subdirectory named after the controller

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setResponseSegment ( $name )

Set the response segment name.

Parameters

string $name

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setScriptAction ( $name )

Set the view script to use.

Parameters

string $name

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setView ( Zend_View_Interface $view )

Set the view object.

Parameters

Zend_View_Interface $view

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setViewBasePathSpec ( $path )

Set view basePath specification.

Specification can contain one or more of the following:

:moduleDir - current module directory
:controller - name of current controller in the request
:action - name of current action in the request
:module - name of current module in the request

Parameters

string $path

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setViewScriptPathNoControllerSpec ( $path )

Set view script path specification (no controller variant)

Specification can contain one or more of the following:

:moduleDir - current module directory
:controller - name of current controller in the request
:action - name of current action in the request
:module - name of current module in the request

:controller will likely be ignored in this variant.

Parameters

string $path

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setViewScriptPathSpec ( $path )

Set view script path specification.

Specification can contain one or more of the following:

:moduleDir - current module directory
:controller - name of current controller in the request
:action - name of current action in the request
:module - name of current module in the request

Parameters

string $path

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

setViewSuffix ( $suffix )

Set view script suffix.

Parameters

string $suffix

Returns: Zend_Controller_Action_Helper_ViewRenderer Provides a fluent interface

Member Data Documentation

$_delimiters

protected

$_inflector

protected

$_inflectorTarget = ''

protected

$_moduleDir = ''

protected

$_neverController = false

protected

$_neverRender = false

protected

$_noController = false

protected

$_noRender = false

protected

$_pathDelimiters

protected

$_responseSegment = null

protected

$_scriptAction = null

protected

$_viewBasePathSpec = ':moduleDir/views'

protected

$_viewScriptPathNoControllerSpec = ':action.:suffix'

protected

$_viewScriptPathSpec = ':controller/:action.:suffix'

protected

$_viewSuffix = 'phtml'

protected

$view

Public Member Functions

Public Attributes

Protected Member Functions

Protected Attributes

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation