category Zend
package Zend_Controller
subpackage Zend_Controller_Action
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

Method overloading

__call(string $method, array $args) : mixed

Parameters

$method

string

$args

array

Exceptions

\Zend_Controller_Action_Exception if helper does not have a direct() method

Returns

mixed

Constructor

__construct(\Zend_Controller_Action $actionController) : void

Parameters

$actionController

\Zend_Controller_Action

Retrieve helper by name as object property

__get(string $name) : \Zend_Controller_Action_Helper_Abstract

Parameters

$name

string

Returns

\Zend_Controller_Action_Helper_Abstract

addHelper() - Add helper objects

addHelper(\Zend_Controller_Action_Helper_Abstract $helper) : void
Static

Parameters

$helper

\Zend_Controller_Action_Helper_Abstract

addPath() - Add path to repositories where Action_Helpers could be found.

addPath(string $path, string $prefix = 'Zend_Controller_Action_Helper') : void
Static

Parameters

$path

string

$prefix

string

Optional; defaults to 'Zend_Controller_Action_Helper'

addPrefix() - Add repository of helpers by prefix

addPrefix(string $prefix) 
Static

Parameters

$prefix

string

getExistingHelper() - get helper by name

getExistingHelper(string $name) : \Zend_Controller_Action_Helper_Abstract
Static

Static method to retrieve helper object. Only retrieves helpers already initialized with the broker (either via addHelper() or on-demand loading via getHelper()).

Throws an exception if the referenced helper does not exist in the stack; use \hasHelper() to check if the helper is registered prior to retrieving it.

Parameters

$name

string

Exceptions

\Zend_Controller_Action_Exception

Returns

\Zend_Controller_Action_Helper_Abstract

Return all registered helpers as helper => object pairs

getExistingHelpers() : array
Static

Returns

array

getHelper() - get helper by name

getHelper(string $name) : \Zend_Controller_Action_Helper_Abstract

Parameters

$name

string

Returns

\Zend_Controller_Action_Helper_Abstract

Retrieve PluginLoader

getPluginLoader() : \Zend_Loader_PluginLoader
Static

Returns

\Zend_Loader_PluginLoader

Lazy load the priority stack and return it

getStack() : \Zend_Controller_Action_HelperBroker_PriorityStack
Static

Returns

\Zend_Controller_Action_HelperBroker_PriorityStack

Retrieve or initialize a helper statically

getStaticHelper(string $name) : \Zend_Controller_Action_Helper_Abstract
Static

Retrieves a helper object statically, loading on-demand if the helper does not already exist in the stack. Always returns a helper, unless the helper class cannot be found.

Parameters

$name

string

Returns

\Zend_Controller_Action_Helper_Abstract

Is a particular helper loaded in the broker?

hasHelper(string $name) : boolean
Static

Parameters

$name

string

Returns

boolean

notifyPostDispatch() - called by action controller dispatch method

notifyPostDispatch() : void

notifyPreDispatch() - called by action controller dispatch method

notifyPreDispatch() : void

Remove a particular helper from the broker

removeHelper(string $name) : boolean
Static

Parameters

$name

string

Returns

boolean

resetHelpers()

resetHelpers() : void
Static

Set PluginLoader for use with broker

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader) : void
Static

Parameters

$loader

\Zend_Loader_PluginLoader_Interface

Load a helper

_loadHelper(string $name) : void
Static

Parameters

$name

string

Normalize helper name for lookups

_normalizeHelperName(string $name) : string
Static

Parameters

$name

string

Returns

string

 Properties

 

$_actionController - ActionController reference

$_actionController : \Zend_Controller_Action

Default

 

$_pluginLoader

$_pluginLoader : \Zend_Loader_PluginLoader_Interface

Default

Static
 

$_helpers - Helper array

$_stack : \Zend_Controller_Action_HelperBroker_PriorityStack

Default

null
Static