Controller/Action/HelperBroker.php

Show:

inherited

Classes
- \Zend_Controller_Action_HelperBroker

Table of Contents

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.

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License
Package: Zend_Controller
Subpackage: Zend_Controller_Action
Version: $Id: HelperBroker.php 24593 2012-01-05 20:35:02Z matthew $

\Zend_Controller_Action_HelperBroker
jump to top

Package: Zend\Controller\Zend\Controller\Action

Category: Zend
Copyright: Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
License: New BSD License

Properties

\Zend_Controller_Action $_actionController

$_actionController - ActionController reference

Details

Type: \Zend_Controller_Action

\Zend_Loader_PluginLoader_Interface $_pluginLoader

static

Details

Type: \Zend_Loader_PluginLoader_Interface

\Zend_Controller_Action_HelperBroker_PriorityStack $_stack = null

static

$_helpers - Helper array

Default valuenullDetails

Type: \Zend_Controller_Action_HelperBroker_PriorityStack

Methods

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

Method overloading

Parameters

Name	Type	Description
$method	string
$args	array

Returns

Type	Description
mixed

Throws

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

__construct(\Zend_Controller_Action $actionController) : void

Constructor

Parameters

Name	Type	Description
$actionController	\Zend_Controller_Action

__get(string $name) : \Zend_Controller_Action_Helper_Abstract

Retrieve helper by name as object property

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Controller_Action_Helper_Abstract

_loadHelper(string $name) : void

static

Load a helper

Parameters

Name	Type	Description
$name	string

_normalizeHelperName(string $name) : string

static

Normalize helper name for lookups

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
string

addHelper(\Zend_Controller_Action_Helper_Abstract $helper) : void

static

addHelper() - Add helper objects

Parameters

Name	Type	Description
$helper	\Zend_Controller_Action_Helper_Abstract

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

static

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

Parameters

Name	Type	Description
$path	string
$prefix	string	Optional; defaults to 'Zend_Controller_Action_Helper'

addPrefix(string $prefix) : void

static

addPrefix() - Add repository of helpers by prefix

Parameters

Name	Type	Description
$prefix	string

getExistingHelper(string $name) : \Zend_Controller_Action_Helper_Abstract

static

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.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Controller_Action_Helper_Abstract

Throws

Exception	Description
\Zend_Controller_Action_Exception

getExistingHelpers() : array

static

Return all registered helpers as helper => object pairs

Returns

Type	Description
array

getHelper(string $name) : \Zend_Controller_Action_Helper_Abstract

getHelper() - get helper by name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Controller_Action_Helper_Abstract

getPluginLoader() : \Zend_Loader_PluginLoader

static

Retrieve PluginLoader

Returns

Type	Description
\Zend_Loader_PluginLoader

getStack() : \Zend_Controller_Action_HelperBroker_PriorityStack

static

Lazy load the priority stack and return it

Returns

Type	Description
\Zend_Controller_Action_HelperBroker_PriorityStack

getStaticHelper(string $name) : \Zend_Controller_Action_Helper_Abstract

static

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.

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\Zend_Controller_Action_Helper_Abstract

hasHelper(string $name) : boolean

static

Is a particular helper loaded in the broker?

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

notifyPostDispatch() : void

notifyPostDispatch() - called by action controller dispatch method

notifyPreDispatch() : void

notifyPreDispatch() - called by action controller dispatch method

removeHelper(string $name) : boolean

static

Remove a particular helper from the broker

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
boolean

resetHelpers() : void

static

resetHelpers()

setPluginLoader(\Zend_Loader_PluginLoader_Interface $loader) : void

static

Set PluginLoader for use with broker

Parameters

Name	Type	Description
$loader	\Zend_Loader_PluginLoader_Interface

Controller/Action/HelperBroker.php

\Zend_Controller_Action_HelperBrokerjump to top

Properties

Methods

\Zend_Controller_Action_HelperBroker
jump to top