钩子 - 扩展框架的核心

CodeIgniter 的钩子功能使得您可以在不修改系统核心文件的基础上来改变或增加系统的核心运行功能。 当 CodeIgniter 运行后，它会产生出一个特殊的进程，这个进程在 项目流程 页面中有说明。 当然，您可以自定义一些动作来替代程序运行过程中的某些阶段。例如，您可以在控制器刚刚载入前或刚刚载入后来运行特定的脚本，或者在其他时刻来触发您的脚本。

启用钩子

钩子功能可以在全局范围内打开或关闭，您可以在 application/config/config.php 文件中设定:

  1. $config['enable_hooks'] = TRUE;

定义钩子

钩子是在 application/config/hooks.php 文件中定义的。 每个钩子可以用以下格式的数组来定义:

  1. $hook['pre_controller'] = array(
  2.                                 'class'    => 'MyClass',
  3.                                 'function' => 'Myfunction',
  4.                                 'filename' => 'Myclass.php',
  5.                                 'filepath' => 'hooks',
  6.                                 'params'   => array('beer', 'wine', 'snacks')
  7.                                 );

说明：数组的索引与你使用的指定挂钩点名字相关.上面的例子中挂钩点是pre_controller. 挂钩点参数列表如下所示. 以下各项将定义在你的相关钩子数组里：

  • class 你希望调用的类名.如果你更喜欢使用过程函数代替类的话,此项保留为空.
  • function 你希望调用的函数名.
  • filename 包含有你的类/函数的文件名.
  • filepath 包含你的脚本的目录名. 注意: 你的脚本放在 application 文件夹下的目录里, 这样 filepath就以那个文件夹(application)为基准. 例如, 如果你的脚本放在application/hooks下, 你可以把hooks 作为你的filepath. 如果你的脚本放在application/hooks/utilities下你可以把 hooks/utilities作为filepath. 注意后面没有"/".如果不放在根目录下可以根据相对路径的配置，来完成调用。这样就可以完成，多个应用共享一个钩子。
  • params 你希望传递给脚本的任何参数. 此项是可选的.

同一挂钩点的多次引用

如果你想在同一个挂钩点引用多个脚本,最简单的方式就是把你的数组定义成二维的,像这样:

  1. $hook['pre_controller'][] = array(
  2.                                 'class'    => 'MyClass',
  3.                                 'function' => 'Myfunction',
  4.                                 'filename' => 'Myclass.php',
  5.                                 'filepath' => 'hooks',
  6.                                 'params'   => array('beer', 'wine', 'snacks')
  7.                                 );
  9. $hook['pre_controller'][] = array(
  10.                                 'class'    => 'MyOtherClass',
  11.                                 'function' => 'MyOtherfunction',
  12.                                 'filename' => 'Myotherclass.php',
  13.                                 'filepath' => 'hooks',
  14.                                 'params'   => array('red', 'yellow', 'blue')
  15.                                 );

注意在每个数组索引后面的中括号:

  1. $hook['pre_controller'][]

这允许你的多个脚本拥有相同的挂钩点。你定义数组的顺序将是程序执行的顺序.

挂勾点

以下是一组可用的挂钩点.

  • pre_system 系统执行的早期调用.仅仅在benchmark 和 hooks 类 加载完毕的时候. 没有执行路由或者其它的过程.
  • pre_controller 在调用你的任何控制器之前调用.此时所用的基础类,路由选择和安全性检查都已完成.
  • post_controller_constructor 在你的控制器实例化之后,任何方法调用之前调用.
  • post_controller 在你的控制器完全运行之后调用.
  • display_override 覆盖_display()函数, 用来在系统执行末尾向web浏览器发送最终页面.这允许你用自己的方法来显示.注意，你需要通过 $this->CI =& get_instance() 引用 CI 超级对象，然后这样的最终数据可以通过调用 $this->CI->output->get_output() 来获得。
  • cache_override 可以让你调用自己的函数来取代output类中的_display_cache() 函数.这可以让你使用自己的缓存显示方法
  • post_system 在最终渲染的页面发送到浏览器之后,浏览器接收完最终数据的系统执行末尾调用

翻译贡献者:anbutu, chouqiuqiu, dustin, elviscai, Hex, Jack, nardo, qixingyue, shishirui