Zend Framework动作助手(Zend_Controller_Action_Helper)用法详解
本文实例讲述了ZendFramework动作助手(Zend_Controller_Action_Helper)用法。分享给大家供大家参考，具体如下：
通过助手模式，可以把一些经常使用的功能模块做封装，从而在可以在需要的地方灵活使用，主要是在action使用。
ZendFramework中有两种助手，动作助手(Zend_Controller_Action_Helper)和试图助手(Zend_View_Helper)。
动作助手可以向任何Zend_Controller_Action的衍生动作控制器中，即时的加入功能(runtimeand/oron-demandfunctionality)，以使得增加公共的动作控制器功能时，尽量减少衍生动作控制器类的必要。
动作助手在需要调用时加载，可以在请求的时候(bootstrap)或者动作控制器创建的时候(init())实例化。
涉及到的相关文件
在/library/Zend/Controller/Action/中
│ Exception.php
│ HelperBroker.php
│ Interface.php
│
├─Helper
│ │ Abstract.php
│ │ ActionStack.php
│ │ AjaxContext.php
│ │ AutoCompleteDojo.php
│ │ AutoCompleteScriptaculous.php
│ │ Cache.php
│ │ ContextSwitch.php
│ │ FlashMessenger.php
│ │ Json.php
│ │ Redirector.php
│ │ Url.php
│ │ ViewRenderer.php
│ │
│ └─AutoComplete
│ Abstract.php
│
└─HelperBroker
PriorityStack.php
常见的动作助手有：
FlashMessenger用来处理FlashMessenger会话；
Json用来解码和发送JSON响应；
Url 用于创建Urls；
Redirector提供另一种实现方式，帮助程序重定向到内部或者外部页面；
ViewRenderer自动的完成在控制器内建立视图对象并渲染视图的过程；
AutoComplete自动响应AJAX的自动完成；
ContextSwitch和AjaxContext为你的动作提供替代响应格式；
Cache 实现cache的相关操作；
ActionStack用于操作动作堆栈。
动手的几种实例化使用方式
1.通过Zend_Controller_Action的$_helper成员的getHelper()方法。直接调用getHelper()，传入助手的名称即可。
$redirector=$this->_helper->getHelper('Redirector');
//$redirector->getName();
$redirector->gotoSimple('index2');
2.直接通过访问的_helper助手的属性对应的助手对象。
$redirector=$this->_helper->Redirector;
Zend_Controller_Action_HelperBroker
中文名称译作"助手经纪人",顾名思义，是动作助手的中间人。
在动作的实例化使用的方式的第二种方式就是通过Zend_Controller_Action_HelperBroker的魔术方法__get()来实现的。
助手经纪人用于注册助手对象和助手路径以及获取助手等等功能。
Zend_Controller_Action_HelperBroker的实现以及常用方法列表
<?php
/**
*@seeZend_Controller_Action_HelperBroker_PriorityStack
*/
require_once'Zend/Controller/Action/HelperBroker/PriorityStack.php';
/**
*@seeZend_Loader
*/
require_once'Zend/Loader.php';
/**
*@categoryZend
*@packageZend_Controller
*@subpackageZend_Controller_Action
*@copyrightCopyright(c)2005-2011ZendTechnologiesUSAInc.(http://www.zend.com)
*@licensehttp://framework.zend.com/license/new-bsdNewBSDLicense
*/
classZend_Controller_Action_HelperBroker
{
/**
*$_actionController-ActionControllerreference
*
*@varZend_Controller_Action
*/
protected$_actionController;
/**
*@varZend_Loader_PluginLoader_Interface
*/
protectedstatic$_pluginLoader;
/**
*$_helpers-Helperarray
*
*@varZend_Controller_Action_HelperBroker_PriorityStack
*/
protectedstatic$_stack=null;
/**
*SetPluginLoaderforusewithbroker
*
*@paramZend_Loader_PluginLoader_Interface$loader
*@returnvoid
*/
publicstaticfunctionsetPluginLoader($loader)
{
if((null!==$loader)&&(!$loaderinstanceofZend_Loader_PluginLoader_Interface)){
require_once'Zend/Controller/Action/Exception.php';
thrownewZend_Controller_Action_Exception('InvalidpluginloaderprovidedtoHelperBroker');
}
self::$_pluginLoader=$loader;
}
/**
*RetrievePluginLoader
*
*@returnZend_Loader_PluginLoader
*/
publicstaticfunctiongetPluginLoader()
{
if(null===self::$_pluginLoader){
require_once'Zend/Loader/PluginLoader.php';
self::$_pluginLoader=newZend_Loader_PluginLoader(array(
'Zend_Controller_Action_Helper'=>'Zend/Controller/Action/Helper/',
));
}
returnself::$_pluginLoader;
}
/**
*addPrefix()-Addrepositoryofhelpersbyprefix
*
*@paramstring$prefix
*/
staticpublicfunctionaddPrefix($prefix)
{
$prefix=rtrim($prefix,'_');
$path=str_replace('_',DIRECTORY_SEPARATOR,$prefix);
self::getPluginLoader()->addPrefixPath($prefix,$path);
}
/**
*addPath()-AddpathtorepositorieswhereAction_Helperscouldbefound.
*
*@paramstring$path
*@paramstring$prefixOptional;defaultsto'Zend_Controller_Action_Helper'
*@returnvoid
*/
staticpublicfunctionaddPath($path,$prefix='Zend_Controller_Action_Helper')
{
self::getPluginLoader()->addPrefixPath($prefix,$path);
}
/**
*addHelper()-Addhelperobjects
*
*@paramZend_Controller_Action_Helper_Abstract$helper
*@returnvoid
*/
staticpublicfunctionaddHelper(Zend_Controller_Action_Helper_Abstract$helper)
{
self::getStack()->push($helper);
return;
}
/**
*resetHelpers()
*
*@returnvoid
*/
staticpublicfunctionresetHelpers()
{
self::$_stack=null;
return;
}
/**
*Retrieveorinitializeahelperstatically
*
*Retrievesahelperobjectstatically,loadingon-demandifthehelper
*doesnotalreadyexistinthestack.Alwaysreturnsahelper,unless
*thehelperclasscannotbefound.
*
*@paramstring$name
*@returnZend_Controller_Action_Helper_Abstract
*/
publicstaticfunctiongetStaticHelper($name)
{
$name=self::_normalizeHelperName($name);
$stack=self::getStack();
if(!isset($stack->{$name})){
self::_loadHelper($name);
}
return$stack->{$name};
}
/**
*getExistingHelper()-gethelperbyname
*
*Staticmethodtoretrievehelperobject.Onlyretrieveshelpersalready
*initializedwiththebroker(eitherviaaddHelper()oron-demandloading
*viagetHelper()).
*
*Throwsanexceptionifthereferencedhelperdoesnotexistinthe
*stack;use{@linkhasHelper()}tocheckifthehelperisregistered
*priortoretrievingit.
*
*@paramstring$name
*@returnZend_Controller_Action_Helper_Abstract
*@throwsZend_Controller_Action_Exception
*/
publicstaticfunctiongetExistingHelper($name)
{
$name=self::_normalizeHelperName($name);
$stack=self::getStack();
if(!isset($stack->{$name})){
require_once'Zend/Controller/Action/Exception.php';
thrownewZend_Controller_Action_Exception('Actionhelper"'.$name.'"hasnotbeenregisteredwiththehelperbroker');
}
return$stack->{$name};
}
/**
*Returnallregisteredhelpersashelper=>objectpairs
*
*@returnarray
*/
publicstaticfunctiongetExistingHelpers()
{
returnself::getStack()->getHelpersByName();
}
/**
*Isaparticularhelperloadedinthebroker?
*
*@paramstring$name
*@returnboolean
*/
publicstaticfunctionhasHelper($name)
{
$name=self::_normalizeHelperName($name);
returnisset(self::getStack()->{$name});
}
/**
*Removeaparticularhelperfromthebroker
*
*@paramstring$name
*@returnboolean
*/
publicstaticfunctionremoveHelper($name)
{
$name=self::_normalizeHelperName($name);
$stack=self::getStack();
if(isset($stack->{$name})){
unset($stack->{$name});
}
returnfalse;
}
/**
*Lazyloadtheprioritystackandreturnit
*
*@returnZend_Controller_Action_HelperBroker_PriorityStack
*/
publicstaticfunctiongetStack()
{
if(self::$_stack==null){
self::$_stack=newZend_Controller_Action_HelperBroker_PriorityStack();
}
returnself::$_stack;
}
/**
*Constructor
*
*@paramZend_Controller_Action$actionController
*@returnvoid
*/
publicfunction__construct(Zend_Controller_Action$actionController)
{
$this->_actionController=$actionController;
foreach(self::getStack()as$helper){
$helper->setActionController($actionController);
$helper->init();
}
}
/**
*notifyPreDispatch()-calledbyactioncontrollerdispatchmethod
*
*@returnvoid
*/
publicfunctionnotifyPreDispatch()
{
foreach(self::getStack()as$helper){
$helper->preDispatch();
}
}
/**
*notifyPostDispatch()-calledbyactioncontrollerdispatchmethod
*
*@returnvoid
*/
publicfunctionnotifyPostDispatch()
{
foreach(self::getStack()as$helper){
$helper->postDispatch();
}
}
/**
*getHelper()-gethelperbyname
*
*@paramstring$name
*@returnZend_Controller_Action_Helper_Abstract
*/
publicfunctiongetHelper($name)
{
$name=self::_normalizeHelperName($name);
$stack=self::getStack();
if(!isset($stack->{$name})){
self::_loadHelper($name);
}
$helper=$stack->{$name};
$initialize=false;
if(null===($actionController=$helper->getActionController())){
$initialize=true;
}elseif($actionController!==$this->_actionController){
$initialize=true;
}
if($initialize){
$helper->setActionController($this->_actionController)
->init();
}
return$helper;
}
/**
*Methodoverloading
*
*@paramstring$method
*@paramarray$args
*@returnmixed
*@throwsZend_Controller_Action_Exceptionifhelperdoesnothaveadirect()method
*/
publicfunction__call($method,$args)
{
$helper=$this->getHelper($method);
if(!method_exists($helper,'direct')){
require_once'Zend/Controller/Action/Exception.php';
thrownewZend_Controller_Action_Exception('Helper"'.$method.'"doesnotsupportoverloadingviadirect()');
}
returncall_user_func_array(array($helper,'direct'),$args);
}
/**
*Retrievehelperbynameasobjectproperty
*
*@paramstring$name
*@returnZend_Controller_Action_Helper_Abstract
*/
publicfunction__get($name)
{
return$this->getHelper($name);
}
/**
*Normalizehelpernameforlookups
*
*@paramstring$name
*@returnstring
*/
protectedstaticfunction_normalizeHelperName($name)
{
if(strpos($name,'_')!==false){
$name=str_replace('','',ucwords(str_replace('_','',$name)));
}
returnucfirst($name);
}
/**
*Loadahelper
*
*@paramstring$name
*@returnvoid
*/
protectedstaticfunction_loadHelper($name)
{
try{
$class=self::getPluginLoader()->load($name);
}catch(Zend_Loader_PluginLoader_Exception$e){
require_once'Zend/Controller/Action/Exception.php';
thrownewZend_Controller_Action_Exception('ActionHelperbyname'.$name.'notfound',0,$e);
}
$helper=new$class();
if(!$helperinstanceofZend_Controller_Action_Helper_Abstract){
require_once'Zend/Controller/Action/Exception.php';
thrownewZend_Controller_Action_Exception('Helpername'.$name.'->class'.$class.'isnotoftypeZend_Controller_Action_Helper_Abstract');
}
self::getStack()->push($helper);
}
}
助手经纪人的常见用法：
一、注册一个助手
1.
Zend_Controller_Action_HelperBroker::addHelper($helper);
2.通过addPrefix()方法带有一个类前缀参数，用来加入自定义助手类的路径。
要求前缀遵循ZendFramework的类命名惯例。
//AddhelpersprefixedwithMy_Action_HelpersinMy/Action/Helpers/
Zend_Controller_Action_HelperBroker::addPrefix('My_Action_Helpers');
3.使用addPath()方法第一个参数为一个目录，第二个为类前缀(默认为'Zend_Controller_Action_Helper')。
用来将自己的类前缀映射到指定的目录。
//AddhelpersprefixedwithHelperinPlugins/Helpers/
Zend_Controller_Action_HelperBroker::addPath('./Plugins/Helpers',
'Helper');
二、判读助手是否存在
使用hasHelper($name)方法来判定助手经纪人中是否存在某助手，$name是助手的短名称（去掉前缀的）：
//Checkif'redirector'helperisregisteredwiththebroker:
if(Zend_Controller_Action_HelperBroker::hasHelper('redirector')){
echo'Redirectorhelperregistered';
}
从助手经纪人中获取助手有两个静态方法：getExistingHelper()和getStaticHelper()。getExistingHelper()将获取助手仅当它以前调用过或者显性地通过助手经纪人注册过，否则就抛出一个异常。getStaticHelper()的做法和getExistingHelper()一样，但如果还没有注册助手堆栈，它将尝试初始化助手，为获取你要配置的的助手，getStaticHelper()是一个好的选择。
两个方法都带一个参数，$name，它是助手的短名称（去掉前缀）。
//Checkif'redirector'helperisregisteredwiththebroker,andfetch:
if(Zend_Controller_Action_HelperBroker::hasHelper('redirector')){
$redirector=
Zend_Controller_Action_HelperBroker::getExistingHelper('redirector');
}
//Or,simplyretrieveit,notworryingaboutwhetherornotitwas
//previouslyregistered:
$redirector=
Zend_Controller_Action_HelperBroker::getStaticHelper('redirector');
}
三、removeHelper($name)删除助手经纪人中的某个助手，$name是助手的短名称。
//Conditionallyremovethe'redirector'helperfromthebroker:
if(Zend_Controller_Action_HelperBroker::hasHelper('redirector')){
Zend_Controller_Action_HelperBroker::removeHelper('redirector')
}
更多关于zend相关内容感兴趣的读者可查看本站专题：《ZendFrameWork框架入门教程》、《php优秀开发框架总结》、《Yii框架入门及常用技巧总结》、《ThinkPHP入门教程》、《php面向对象程序设计入门教程》、《php+mysql数据库操作入门教程》及《php常见数据库操作技巧汇总》
希望本文所述对大家PHP程序设计有所帮助。