CI框架 -- 核心文件 之 Hooks.php

钩子 - 扩展框架核心

CodeIgniter 的钩子特性提供了一种方法来修改框架的内部运作流程，而无需修改 核心文件。CodeIgniter 的运行遵循着一个特定的流程，你可以参考这个页面的 应用程序流程图 。但是，有些时候你可能希望在 执行流程中的某些阶段添加一些动作，例如在控制器加载之前或之后执行一段脚本， 或者在其他的某些位置触发你的脚本。

启用钩子

钩子特性可以在 application/config/config.php 文件中全局的启用或禁用， 设置下面这个参数: $config['enable_hooks'] = TRUE;

挂钩点

CI框架可以实现在不修改系统核心文件的基础上来改变或增加系统的核心运行功能，那就是Hook,看看CI有哪些钩子：

• 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
  在最终着色页面发送到浏览器之后,浏览器接收完最终数据的系统执行末尾调用

定义钩子

 $hook['pre_controller'] = array(
                                 'class'    => 'TestHook', //调用的类名，如果你更喜欢使用过程式的函数的话，这一项可以留空。
                                 'function' => 'test', //调用的函数名
                                 'filename' => 'TestHook.php', //包含你的类或函数的文件名
                                 'filepath' => 'hooks', //包含你的脚本文件的目录名。 注意： 你的脚本必须放在 application/ 目录里面，所以 filepath 是相对 application/ 目录的路径，举例来说，如果你的脚本位于 application/hooks/ ，那么 filepath 可以简单的设置为 'hooks' ，如果你的脚本位于application/hooks/utilities/ ， 那么 filepath 可以设置为 'hooks/utilities' ，路径后面不用加斜线
                                 'params'   => 'array()'//传递给脚本参数，可选
                                 );

多次调用同一个挂钩点

如果你想在同一个挂钩点处添加多个脚本，只需要将钩子数组变成二维数组即可，像这样:

$hook['pre_controller'][] = array(
    'class'    => 'MyClass',
    'function' => 'MyMethod',
    'filename' => 'Myclass.php',
    'filepath' => 'hooks',
    'params'   => array('beer', 'wine', 'snacks')
);

$hook['pre_controller'][] = array(
    'class'    => 'MyOtherClass',
    'function' => 'MyOtherMethod',
    'filename' => 'Myotherclass.php',
    'filepath' => 'hooks',
    'params'   => array('red', 'yellow', 'blue')
);

注意数组索引后面多了个中括号:$hook['pre_controller'][]

这可以让你在同一个挂钩点处执行多个脚本，多个脚本执行顺序就是你定义数组的顺序。

钩子类分析

 /**
  * 钩子嘛，就是在不修改系统核心文件的基础上来改变或增加系统的核心运行功能
  */
 class CI_Hooks {

     /**
      * 检测hook是否开启
      */
     var $enabled        = FALSE;
     /**
      * config/hooks.php中的hooks配置信息
      */
     var $hooks            = array();
     //防止死循环，因为钩子程序里面可能还还有钩子
     var $in_progress    = FALSE;

     //构造函数
     function __construct()
     {
         $this->_initialize();
         log_message('debug', "Hooks Class Initialized");
     }

     /**
      * 初始化，获取hooks配合
      */
     function _initialize()
     {
         $CFG =& load_class('Config', 'core');

         // 检测配置是否开启钩子
         if ($CFG->item('enable_hooks') == FALSE)
         {
             return;
         }

         // 检测是否配置钩子
         if (defined('ENVIRONMENT') AND is_file(APPPATH.'config/'.ENVIRONMENT.'/hooks.php'))
         {
             include(APPPATH.'config/'.ENVIRONMENT.'/hooks.php');
         }
         elseif (is_file(APPPATH.'config/hooks.php'))
         {
             include(APPPATH.'config/hooks.php');
         }

         if ( ! isset($hook) OR ! is_array($hook))
         {
             return;
         }

         $this->hooks =& $hook;
         $this->enabled = TRUE;
     }

     // --------------------------------------------------------------------

     /**
      * 运行钩子程序，外部就是这样调用：
          *     $EXT =& load_class('Hooks', 'core');
      *      $EXT->_call_hook('pre_system');
      */
     function _call_hook($which = '')
     {
         if ( ! $this->enabled OR ! isset($this->hooks[$which]))
         {
             return FALSE;
         }
                 //CI支持多次钩子，那么就是二维数组
         if (isset($this->hooks[$which][0]) AND is_array($this->hooks[$which][0]))
         {
             foreach ($this->hooks[$which] as $val)
             {
                 $this->_run_hook($val);
             }
         }
         else
         {
                         //一个钩子直接运行钩子
             $this->_run_hook($this->hooks[$which]);
         }

         return TRUE;
     }

     // --------------------------------------------------------------------

     /**
      * Run Hook
      *
      * Runs a particular hook
      *
      * @access    private
      * @param    array    the hook details
      * @return    bool
      */
     function _run_hook($data)
     {
         if ( ! is_array($data))
         {
             return FALSE;
         }

                 //防止死循环，因为钩子程序里面可能还还有钩子
         if ($this->in_progress == TRUE)
         {
             return;
         }

         //设置路径
                 //下面可以filepathfilepath就以那个文件夹(application)为基准，application/hooks下, 你可以把hooks 作为你的filepath

         if ( ! isset($data['filepath']) OR ! isset($data['filename']))
         {
             return FALSE;
         }

         $filepath = APPPATH.$data['filepath'].'/'.$data['filename'];

         if ( ! file_exists($filepath))
         {
             return FALSE;
         }

         // -----------------------------------
         // Set class/function name
         // -----------------------------------

         $class        = FALSE;
         $function    = FALSE;
         $params        = '';

         if (isset($data['class']) AND $data['class'] != '')
         {
             $class = $data['class'];
         }

         if (isset($data['function']))
         {
             $function = $data['function'];
         }

         if (isset($data['params']))
         {
             $params = $data['params'];
         }

         if ($class === FALSE AND $function === FALSE)
         {
             return FALSE;
         }

         //不用多说了吧
         $this->in_progress = TRUE;

         //获取钩子配置信息成功后，运行钩子程序
         if ($class !== FALSE)
         {
             if ( ! class_exists($class))
             {
                 require($filepath);
             }

             $HOOK = new $class;
             $HOOK->$function($params);
         }
         else
         {
             if ( ! function_exists($function))
             {
                 require($filepath);
             }

             $function($params);
         }
                 // //执行相应程序完毕后，重新把当前hook的状态改为非运行中，以让它可以再次被触发。
         $this->in_progress = FALSE;
         return TRUE;
     }

 }