Show HelperBroker.php syntax highlighted
<?php
/**
* 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
* @package Zend_Controller
* @copyright Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
/** Zend_Controller_Action_Exception */
require_once 'Zend/Controller/Action/Exception.php';
/** Zend_Controller_Action_Helper_Abstract */
require_once 'Zend/Controller/Action/Helper/Abstract.php';
/** Zend_Loader **/
require_once 'Zend/Loader.php';
/**
* @category Zend
* @package Zend_Controller
* @subpackage Zend_Controller_Action
* @copyright Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
final class Zend_Controller_Action_HelperBroker
{
/**
* $_helpers - Helper array
*
* @var Zend_Controller_Action_Helper_Abstract[]
*/
static protected $_helpers = array();
/**
* $_paths - paths to Action_Helpers
*
* @var array
*/
static protected $_paths = array(array(
'dir' => 'Zend/Controller/Action/Helper/',
'prefix' => 'Zend_Controller_Action_Helper_'
));
/**
* $_actionController - ActionController reference
*
* @var Zend_Controller_Action
*/
protected $_actionController;
/**
* addHelper() - Add helper objects
*
* @param Zend_Controller_Action_Helper_Abstract $helper
* @return void
*/
static public function addHelper(Zend_Controller_Action_Helper_Abstract $helper)
{
$helper_name = $helper->getName();
self::$_helpers[$helper_name] = $helper;
return;
}
/**
* addPrefix() - Add repository of helpers by prefix
*
* @param string $prefix
*/
static public function addPrefix($prefix)
{
$path = str_replace('_', DIRECTORY_SEPARATOR, $prefix);
self::addPath($path, $prefix);
return;
}
/**
* resetHelpers()
*
* @return void
*/
static public function resetHelpers()
{
self::$_helpers = array();
return;
}
/**
* addPath() - Add path to repositories where Action_Helpers could be found.
*
* @param string $path
* @param string $prefix
* @return void
*/
static public function addPath($path, $prefix)
{
// make sure it ends in a PATH_SEPARATOR
if (substr($path, -1, 1) != DIRECTORY_SEPARATOR) {
$path .= DIRECTORY_SEPARATOR;
}
// make sure it ends in a PATH_SEPARATOR
if (substr($prefix, -1, 1) != '_') {
$prefix .= '_';
}
$info['dir'] = $path;
$info['prefix'] = $prefix;
self::$_paths[] = $info;
return;
}
/**
* __construct() -
*
* @param Zend_Controller_Action $actionController
* @return void
*/
public function __construct(Zend_Controller_Action $actionController)
{
$this->_actionController = $actionController;
foreach (self::$_helpers as $helper) {
$helper->init();
}
}
/**
* notifyPreDispatch() - called by action controller dispatch method
*
* @return void
*/
public function notifyPreDispatch()
{
foreach (self::$_helpers as $helper) {
$helper->preDispatch();
}
}
/**
* notifyPostDispatch() - called by action controller dispatch method
*
* @return void
*/
public function notifyPostDispatch()
{
foreach (self::$_helpers as $helper) {
$helper->postDispatch();
}
}
/**
* getHelper() - get helper by name
*
* @param string $name
* @return Zend_Controller_Action_Helper_Abstract
*/
public function getHelper($name)
{
if (strpos($name, '_') !== false) {
$name = str_replace(' ', '', ucwords(str_replace('_', ' ', $name)));
}
$name = ucfirst($name);
if (!array_key_exists($name, self::$_helpers)) {
$this->_loadHelper($name);
}
$helper = self::$_helpers[$name];
$helper->setActionController($this->_actionController);
return $helper;
}
/**
* _loadHelper()
*
* @param string $name
* @return void
*/
protected function _loadHelper($name)
{
$file = $name . '.php';
foreach (self::$_paths as $info) {
$dir = $info['dir'];
$prefix = $info['prefix'];
$class = $prefix . $name;
if (class_exists($class)) {
$helper = new $class();
if (!$helper instanceof Zend_Controller_Action_Helper_Abstract) {
throw new Zend_Controller_Action_Exception('Helper name ' . $name . ' -> class ' . $class . ' is not of type Zend_Controller_Action_Helper_Abstract');
}
self::$_helpers[$helper->getName()] = $helper;
return;
} elseif (Zend_Loader::isReadable($dir . $file)) {
include_once $dir . $file;
if (class_exists($class, false)) {
$helper = new $class();
if (!$helper instanceof Zend_Controller_Action_Helper_Abstract) {
throw new Zend_Controller_Action_Exception('Helper name ' . $name . ' -> class ' . $class . ' is not of type Zend_Controller_Action_Helper_Abstract');
}
self::$_helpers[$helper->getName()] = $helper;
}
return;
}
}
throw new Zend_Controller_Action_Exception('Action Helper by name ' . $name . ' not found.');
}
/**
* __call()
*
* @param string $method
* @param array $args
* @return mixed
* @throws Zend_Controller_Action_Exception if helper does not have a direct() method
*/
public function __call($method, $args)
{
$helper = $this->getHelper($method);
if (method_exists($helper, 'direct')) {
return call_user_func_array(array($helper, 'direct'), $args);
}
throw new Zend_Controller_Action_Exception('Helper "' . $method . '" does not support overloading via direct()');
}
/**
* __get()
*
* @param string $name
* @return Zend_Controller_Action_Helper_Abstract
*/
public function __get($name)
{
return $this->getHelper($name);
}
}
See more files for this project here