个人中心
gpt4 book ai didi

Zend Framework动作助手(Zend_Controller_Action_Helper)用法详解

转载 作者：qq735679552 更新时间：2022-09-28 22:32:09 26 4
gpt4 key购买 nike

CFSDN坚持开源创造价值，我们致力于搭建一个资源共享平台，让每一个IT人在这里找到属于你的精彩世界.

这篇CFSDN的博客文章Zend Framework动作助手(Zend_Controller_Action_Helper)用法详解由作者收集整理，如果你对这篇文章有兴趣，记得点赞哟.

本文实例讲述了Zend Framework动作助手(Zend_Controller_Action_Helper)用法。分享给大家供大家参考，具体如下:

通过助手模式，可以把一些经常使用的功能模块做封装，从而在可以在需要的地方灵活使用，主要是在action使用.

Zend Framework中有两种助手，动作助手(Zend_Controller_Action_Helper)和试图助手(Zend_View_Helper).

动作助手可以向任何Zend_Controller_Action的衍生动作控制器中，即时的加入功能(runtime and/or on-demand functionality)，以使得增加公共的动作控制器功能时，尽量减少衍生动作控制器类的必要.

动作助手在需要调用时加载，可以在请求的时候(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 用来处理Flash Messenger会话； Json 用来解码和发送 JSON 响应； Url  用于创建Urls； Redirector 提供另一种实现方式，帮助程序重定向到内部或者外部页面； ViewRenderer 自动的完成在控制器内建立视图对象并渲染视图的过程； AutoComplete 自动响应 AJAX 的自动完成； ContextSwitch 和 AjaxContext 为你的动作提供替代响应格式； Cache  实现cache的相关操作； ActionStack 用于操作动作堆栈.

动手的几种实例化使用方式 。

1.通过Zend_Controller_Action的 $_helper成员的getHelper()方法。直接调用getHelper()，传入助手的名称即可.

?
1
2
3
$redirector = $this ->_helper->getHelper( 'Redirector' );
//$redirector->getName();
$redirector ->gotoSimple( 'index2' );

2.直接通过访问的_helper助手的属性对应的助手对象.

?
1
$redirector = $this ->_helper->Redirector;

Zend_Controller_Action_HelperBroker 。

中文名称译作"助手经纪人",顾名思义，是动作助手的中间人.

在动作的实例化使用的方式的第二种方式就是通过Zend_Controller_Action_HelperBroker的魔术方法__get()来实现的.

助手经纪人用于注册助手对象和助手路径以及获取助手等等功能.

Zend_Controller_Action_HelperBroker的实现以及常用方法列表 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
<?php
/**
  * @see Zend_Controller_Action_HelperBroker_PriorityStack
  */
require_once 'Zend/Controller/Action/HelperBroker/PriorityStack.php' ;
/**
  * @see Zend_Loader
  */
require_once 'Zend/Loader.php' ;
/**
  * @category  Zend
  * @package  Zend_Controller
  * @subpackage Zend_Controller_Action
  * @copyright Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)
  * @license  http://framework.zend.com/license/new-bsd   New BSD License
  */
class Zend_Controller_Action_HelperBroker
{
   /**
    * $_actionController - ActionController reference
    *
    * @var Zend_Controller_Action
    */
   protected $_actionController ;
   /**
    * @var Zend_Loader_PluginLoader_Interface
    */
   protected static $_pluginLoader ;
   /**
    * $_helpers - Helper array
    *
    * @var Zend_Controller_Action_HelperBroker_PriorityStack
    */
   protected static $_stack = null;
   /**
    * Set PluginLoader for use with broker
    *
    * @param Zend_Loader_PluginLoader_Interface $loader
    * @return void
    */
   public static function setPluginLoader( $loader )
   {
     if ((null !== $loader ) && (! $loader instanceof Zend_Loader_PluginLoader_Interface)) {
       require_once 'Zend/Controller/Action/Exception.php' ;
       throw new Zend_Controller_Action_Exception( 'Invalid plugin loader provided to HelperBroker' );
     }
     self:: $_pluginLoader = $loader ;
   }
   /**
    * Retrieve PluginLoader
    *
    * @return Zend_Loader_PluginLoader
    */
   public static function getPluginLoader()
   {
     if (null === self:: $_pluginLoader ) {
       require_once 'Zend/Loader/PluginLoader.php' ;
       self:: $_pluginLoader = new Zend_Loader_PluginLoader( array (
         'Zend_Controller_Action_Helper' => 'Zend/Controller/Action/Helper/' ,
       ));
     }
     return self:: $_pluginLoader ;
   }
   /**
    * addPrefix() - Add repository of helpers by prefix
    *
    * @param string $prefix
    */
   static public function addPrefix( $prefix )
   {
     $prefix = rtrim( $prefix , '_' );
     $path  = str_replace ( '_' , DIRECTORY_SEPARATOR, $prefix );
     self::getPluginLoader()->addPrefixPath( $prefix , $path );
   }
   /**
    * addPath() - Add path to repositories where Action_Helpers could be found.
    *
    * @param string $path
    * @param string $prefix Optional; defaults to 'Zend_Controller_Action_Helper'
    * @return void
    */
   static public function addPath( $path , $prefix = 'Zend_Controller_Action_Helper' )
   {
     self::getPluginLoader()->addPrefixPath( $prefix , $path );
   }
   /**
    * addHelper() - Add helper objects
    *
    * @param Zend_Controller_Action_Helper_Abstract $helper
    * @return void
    */
   static public function addHelper(Zend_Controller_Action_Helper_Abstract $helper )
   {
     self::getStack()->push( $helper );
     return ;
   }
   /**
    * resetHelpers()
    *
    * @return void
    */
   static public function resetHelpers()
   {
     self:: $_stack = null;
     return ;
   }
   /**
    * 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.
    *
    * @param string $name
    * @return Zend_Controller_Action_Helper_Abstract
    */
   public static function getStaticHelper( $name )
   {
     $name = self::_normalizeHelperName( $name );
     $stack = self::getStack();
     if (!isset( $stack ->{ $name })) {
       self::_loadHelper( $name );
     }
     return $stack ->{ $name };
   }
   /**
    * 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.
    *
    * @param string $name
    * @return Zend_Controller_Action_Helper_Abstract
    * @throws Zend_Controller_Action_Exception
    */
   public static function getExistingHelper( $name )
   {
     $name = self::_normalizeHelperName( $name );
     $stack = self::getStack();
     if (!isset( $stack ->{ $name })) {
       require_once 'Zend/Controller/Action/Exception.php' ;
       throw new Zend_Controller_Action_Exception( 'Action helper "' . $name . '" has not been registered with the helper broker' );
     }
     return $stack ->{ $name };
   }
   /**
    * Return all registered helpers as helper => object pairs
    *
    * @return array
    */
   public static function getExistingHelpers()
   {
     return self::getStack()->getHelpersByName();
   }
   /**
    * Is a particular helper loaded in the broker?
    *
    * @param string $name
    * @return boolean
    */
   public static function hasHelper( $name )
   {
     $name = self::_normalizeHelperName( $name );
     return isset(self::getStack()->{ $name });
   }
   /**
    * Remove a particular helper from the broker
    *
    * @param string $name
    * @return boolean
    */
   public static function removeHelper( $name )
   {
     $name = self::_normalizeHelperName( $name );
     $stack = self::getStack();
     if (isset( $stack ->{ $name })) {
       unset( $stack ->{ $name });
     }
     return false;
   }
   /**
    * Lazy load the priority stack and return it
    *
    * @return Zend_Controller_Action_HelperBroker_PriorityStack
    */
   public static function getStack()
   {
     if (self:: $_stack == null) {
       self:: $_stack = new Zend_Controller_Action_HelperBroker_PriorityStack();
     }
     return self:: $_stack ;
   }
   /**
    * Constructor
    *
    * @param Zend_Controller_Action $actionController
    * @return void
    */
   public function __construct(Zend_Controller_Action $actionController )
   {
     $this ->_actionController = $actionController ;
     foreach (self::getStack() as $helper ) {
       $helper ->setActionController( $actionController );
       $helper ->init();
     }
   }
   /**
    * notifyPreDispatch() - called by action controller dispatch method
    *
    * @return void
    */
   public function notifyPreDispatch()
   {
     foreach (self::getStack() as $helper ) {
       $helper ->preDispatch();
     }
   }
   /**
    * notifyPostDispatch() - called by action controller dispatch method
    *
    * @return void
    */
   public function notifyPostDispatch()
   {
     foreach (self::getStack() as $helper ) {
       $helper ->postDispatch();
     }
   }
   /**
    * getHelper() - get helper by name
    *
    * @param string $name
    * @return Zend_Controller_Action_Helper_Abstract
    */
   public function getHelper( $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 ;
   }
   /**
    * Method overloading
    *
    * @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' )) {
       require_once 'Zend/Controller/Action/Exception.php' ;
       throw new Zend_Controller_Action_Exception( 'Helper "' . $method . '" does not support overloading via direct()' );
     }
     return call_user_func_array( array ( $helper , 'direct' ), $args );
   }
   /**
    * Retrieve helper by name as object property
    *
    * @param string $name
    * @return Zend_Controller_Action_Helper_Abstract
    */
   public function __get( $name )
   {
     return $this ->getHelper( $name );
   }
   /**
    * Normalize helper name for lookups
    *
    * @param string $name
    * @return string
    */
   protected static function _normalizeHelperName( $name )
   {
     if ( strpos ( $name , '_' ) !== false) {
       $name = str_replace ( ' ' , '' , ucwords( str_replace ( '_' , ' ' , $name )));
     }
     return ucfirst( $name );
   }
   /**
    * Load a helper
    *
    * @param string $name
    * @return void
    */
   protected static function _loadHelper( $name )
   {
     try {
       $class = self::getPluginLoader()->load( $name );
     } catch (Zend_Loader_PluginLoader_Exception $e ) {
       require_once 'Zend/Controller/Action/Exception.php' ;
       throw new Zend_Controller_Action_Exception( 'Action Helper by name ' . $name . ' not found' , 0, $e );
     }
     $helper = new $class ();
     if (! $helper instanceof Zend_Controller_Action_Helper_Abstract) {
       require_once 'Zend/Controller/Action/Exception.php' ;
       throw new Zend_Controller_Action_Exception( 'Helper name ' . $name . ' -> class ' . $class . ' is not of type Zend_Controller_Action_Helper_Abstract' );
     }
     self::getStack()->push( $helper );
   }
}

助手经纪人的常见用法:

1、注册一个助手 。

1. 。

?
1
Zend_Controller_Action_HelperBroker::addHelper( $helper );

2.通过addPrefix()方法带有一个类前缀参数，用来加入自定义助手类的路径。 要求前缀遵循Zend Framework的类命名惯例.

?
1
2
// Add helpers prefixed with My_Action_Helpers in My/Action/Helpers/
Zend_Controller_Action_HelperBroker::addPrefix( 'My_Action_Helpers' );

3.使用addPath()方法第一个参数为一个目录，第二个为类前缀(默认为'Zend_Controller_Action_Helper').

用来将自己的类前缀映射到指定的目录.

?
1
2
3
// Add helpers prefixed with Helper in Plugins/Helpers/
Zend_Controller_Action_HelperBroker::addPath( './Plugins/Helpers' ,
                        'Helper' );

2、判读助手是否存在 。

使用hasHelper($name)方法来判定助手经纪人中是否存在某助手，$name是助手的短名称（去掉前缀的）:

?
1
2
3
4
// Check if 'redirector' helper is registered with the broker:
if (Zend_Controller_Action_HelperBroker::hasHelper( 'redirector' )) {
   echo 'Redirector helper registered' ;
}

从助手经纪人中获取助手有两个静态方法：getExistingHelper() 和 getStaticHelper() 。getExistingHelper()将获取助手仅当它以前调用过或者显性地通过助手经纪人注册过，否则就抛出一个异常。getStaticHelper() 的做法和getExistingHelper()一样，但如果还没有注册助手堆栈，它将尝试初始化助手，为获取你要配置的的助手，getStaticHelper()是一个好的选择.

两个方法都带一个参数，$name，它是助手的短名称（去掉前缀）.

?
1
2
3
4
5
6
7
8
9
10
// Check if 'redirector' helper is registered with the broker, and fetch:
if (Zend_Controller_Action_HelperBroker::hasHelper( 'redirector' )) {
   $redirector =
     Zend_Controller_Action_HelperBroker::getExistingHelper( 'redirector' );
}
// Or, simply retrieve it, not worrying about whether or not it was
// previously registered:
$redirector =
   Zend_Controller_Action_HelperBroker::getStaticHelper( 'redirector' );
}

3、removeHelper($name)删除助手经纪人中的某个助手，$name是助手的短名称.

?
1
2
3
4
// Conditionally remove the 'redirector' helper from the broker:
if (Zend_Controller_Action_HelperBroker::hasHelper( 'redirector' )) {
   Zend_Controller_Action_HelperBroker::removeHelper( 'redirector' )
}

希望本文所述对大家PHP程序设计有所帮助.

最后此篇关于Zend Framework动作助手(Zend_Controller_Action_Helper)用法详解的文章就讲到这里了,如果你想了解更多关于Zend Framework动作助手(Zend_Controller_Action_Helper)用法详解的内容请搜索CFSDN的文章或继续浏览相关文章，希望大家以后支持我的博客！ 。

26 4 0
文章推荐： XenServer 6.5 安装配置图文教程
文章推荐： 使用Python脚本来控制Windows Azure的简单教程
文章推荐： XenServer 安装及虚拟机部署详细指南
文章推荐： Zend Framework实现Zend_View集成Smarty模板系统的方法
qq735679552
个人简介

我是一名优秀的程序员,十分优秀！

滴滴打车优惠券免费领取
滴滴打车优惠券
全站热门文章
Copyright 2021 - 2024 cfsdn All Rights Reserved 蜀ICP备2022000587号
广告合作:1813099741@qq.com 6ren.com