Class Zend_Controller_Action_HelperBroker

Description
  • copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
  • license: New BSD License

Located in /Controller/Action/HelperBroker.php (line 40)


	
			
Variable Summary
Method Summary
 static void addPath (string $path, [string $prefix = 'Zend_Controller_Action_Helper'])
 static void addPrefix (string $prefix)
 static array getExistingHelpers ()
 static boolean hasHelper (string $name)
 static boolean removeHelper (string $name)
 static void resetHelpers ()
 static void _loadHelper (string $name)
 static string _normalizeHelperName (string $name)
 void __construct (Zend_Controller_Action $actionController)
 mixed __call (string $method, array $args)
Variables
static Zend_Loader_PluginLoader_Interface $_pluginLoader (line 52)
  • access: protected
static Zend_Controller_Action_HelperBroker_PriorityStack $_stack = null (line 59)

$_helpers - Helper array

  • access: protected
Zend_Controller_Action $_actionController (line 47)

$_actionController - ActionController reference

  • access: protected
Methods
static addHelper (line 122)

addHelper() - Add helper objects

  • access: public
static void addHelper (Zend_Controller_Action_Helper_Abstract $helper)
static addPath (line 111)

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

  • access: public
static void addPath (string $path, [string $prefix = 'Zend_Controller_Action_Helper'])
  • string $path
  • string $prefix: Optional; defaults to 'Zend_Controller_Action_Helper'
static addPrefix (line 97)

addPrefix() - Add repository of helpers by prefix

  • access: public
static void addPrefix (string $prefix)
  • string $prefix
static getExistingHelper (line 176)

getExistingHelper() - get helper by name

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.

  • throws: Zend_Controller_Action_Exception
  • access: public
static Zend_Controller_Action_Helper_Abstract getExistingHelper (string $name)
  • string $name
static getExistingHelpers (line 194)

Return all registered helpers as helper => object pairs

  • access: public
static array getExistingHelpers ()
static getPluginLoader (line 81)

Retrieve PluginLoader

  • access: public
static Zend_Loader_PluginLoader getPluginLoader ()
static getStack (line 233)

Lazy load the priority stack and return it

  • access: public
static getStaticHelper (line 149)

Retrieve or initialize a helper statically

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.

  • access: public
static Zend_Controller_Action_Helper_Abstract getStaticHelper (string $name)
  • string $name
static hasHelper (line 205)

Is a particular helper loaded in the broker?

  • access: public
static boolean hasHelper (string $name)
  • string $name
static removeHelper (line 217)

Remove a particular helper from the broker

  • access: public
static boolean removeHelper (string $name)
  • string $name
static resetHelpers (line 133)

resetHelpers()

  • access: public
static void resetHelpers ()
static setPluginLoader (line 67)

Set PluginLoader for use with broker

  • access: public
static void setPluginLoader (Zend_Loader_PluginLoader_Interface $loader)
static _loadHelper (line 363)

Load a helper

  • access: protected
static void _loadHelper (string $name)
  • string $name
static _normalizeHelperName (line 348)

Normalize helper name for lookups

  • access: protected
static string _normalizeHelperName (string $name)
  • string $name
Constructor __construct (line 248)

Constructor

  • access: public
void __construct (Zend_Controller_Action $actionController)
getHelper (line 287)

getHelper() - get helper by name

  • access: public
Zend_Controller_Action_Helper_Abstract getHelper (string $name)
  • string $name
notifyPostDispatch (line 274)

notifyPostDispatch() - called by action controller dispatch method

  • access: public
void notifyPostDispatch ()
notifyPreDispatch (line 262)

notifyPreDispatch() - called by action controller dispatch method

  • access: public
void notifyPreDispatch ()
__call (line 321)

Method overloading

  • throws: Zend_Controller_Action_Exception if helper does not have a direct() method
  • access: public
mixed __call (string $method, array $args)
  • string $method
  • array $args
__get (line 337)

Retrieve helper by name as object property

  • access: public
  • string $name

Documentation generated on Mon, 21 Jun 2010 15:26:31 -0400 by phpDocumentor 1.4.3