API Documentation

Controller/Action/HelperBroker.php

Includes Classes 
category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Zend_Controller_Action
version
$Id: HelperBroker.php 20096 2010-01-06 02:05:09Z bkarwin $
Classes
Zend_Controller_Action_HelperBroker

Description

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

Zend_Controller_Action_HelperBroker
jump to top

category
Zend
copyright
Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license
http://framework.zend.com/license/new-bsd New BSD License
package
Zend_Controller
subpackage
Zend_Controller_Action
Properties
$_actionController
$_pluginLoader
$_stack
Methods
setPluginLoader
getPluginLoader
addPrefix
addPath
addHelper
resetHelpers
getStaticHelper
getExistingHelper
getExistingHelpers
hasHelper
removeHelper
getStack
__construct
notifyPreDispatch
notifyPostDispatch
getHelper
__call
__get
_normalizeHelperName
_loadHelper

Description

Properties

$_actionController
jump to class

Zend_Controller_Action $_actionController = ''

$_actionController - ActionController reference

Details

$_actionController
Zend_Controller_Action
visibility
protected
default
final
false
static
false

$_pluginLoader
jump to class

Zend_Loader_PluginLoader_Interface $_pluginLoader = ''

Details

$_pluginLoader
Zend_Loader_PluginLoader_Interface
visibility
protected
default
final
false
static
true

$_stack
jump to class

Zend_Controller_Action_HelperBroker_PriorityStack $_stack = 'null'

$_helpers - Helper array

Details

$_stack
Zend_Controller_Action_HelperBroker_PriorityStack
visibility
protected
default
null
final
false
static
true

Methods

__call
jump to class

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

Method overloading

Arguments
$method
string
$args
array
Output
mixed
Details
visibility
public
final
false
static
false
throws
if helper does not have a direct() method

__construct
jump to class

__construct( Zend_Controller_Action $actionController ) : void

Constructor

Arguments
$actionController
Zend_Controller_Action
Details
visibility
public
final
false
static
false

__get
jump to class

__get( string $name ) : Zend_Controller_Action_Helper_Abstract

Retrieve helper by name as object property

Arguments
$name
string
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
false

_loadHelper
jump to class

_loadHelper( string $name ) : void

Load a helper

Arguments
$name
string
Details
visibility
protected
final
false
static
true

_normalizeHelperName
jump to class

_normalizeHelperName( string $name ) : string

Normalize helper name for lookups

Arguments
$name
string
Output
string
Details
visibility
protected
final
false
static
true

addHelper
jump to class

addHelper( Zend_Controller_Action_Helper_Abstract $helper ) : void

addHelper() - Add helper objects

Arguments
$helper
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
true

addPath
jump to class

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

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

Arguments
$path
string
$prefix
string
Optional; defaults to 'Zend_Controller_Action_Helper'
Details
visibility
public
final
false
static
true

addPrefix
jump to class

addPrefix( string $prefix ) :

addPrefix() - Add repository of helpers by prefix

Arguments
$prefix
string
Details
visibility
public
final
false
static
true

getExistingHelper
jump to class

getExistingHelper( string $name ) : Zend_Controller_Action_Helper_Abstract

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 {@link hasHelper()} to check if the helper is registered prior to retrieving it.

Arguments
$name
string
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
true
throws

getExistingHelpers
jump to class

getExistingHelpers( ) : array

Return all registered helpers as helper => object pairs

Output
array
Details
visibility
public
final
false
static
true

getHelper
jump to class

getHelper( string $name ) : Zend_Controller_Action_Helper_Abstract

getHelper() - get helper by name

Arguments
$name
string
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
false

getPluginLoader
jump to class

getPluginLoader( ) : Zend_Loader_PluginLoader

Retrieve PluginLoader

Output
Zend_Loader_PluginLoader
Details
visibility
public
final
false
static
true

getStack
jump to class

getStack( ) : Zend_Controller_Action_HelperBroker_PriorityStack

Lazy load the priority stack and return it

Output
Zend_Controller_Action_HelperBroker_PriorityStack
Details
visibility
public
final
false
static
true

getStaticHelper
jump to class

getStaticHelper( string $name ) : Zend_Controller_Action_Helper_Abstract

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.

Arguments
$name
string
Output
Zend_Controller_Action_Helper_Abstract
Details
visibility
public
final
false
static
true

hasHelper
jump to class

hasHelper( string $name ) : boolean

Is a particular helper loaded in the broker?

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
true

notifyPostDispatch
jump to class

notifyPostDispatch( ) : void

notifyPostDispatch() - called by action controller dispatch method

Details
visibility
public
final
false
static
false

notifyPreDispatch
jump to class

notifyPreDispatch( ) : void

notifyPreDispatch() - called by action controller dispatch method

Details
visibility
public
final
false
static
false

removeHelper
jump to class

removeHelper( string $name ) : boolean

Remove a particular helper from the broker

Arguments
$name
string
Output
boolean
Details
visibility
public
final
false
static
true

resetHelpers
jump to class

resetHelpers( ) : void

resetHelpers()

Details
visibility
public
final
false
static
true

setPluginLoader
jump to class

setPluginLoader( Zend_Loader_PluginLoader_Interface $loader ) : void

Set PluginLoader for use with broker

Arguments
$loader
Zend_Loader_PluginLoader_Interface
Details
visibility
public
final
false
static
true
Documentation was generated by DocBlox.