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

時間 2019-11-29

標籤框架核心文件 hooks.php hooks php 欄目 PHP 简体版

原文原文鏈接

鉤子 - 擴展框架核心

CodeIgniter 的鉤子特性提供了一種方法來修改框架的內部運做流程，而無需修改核心文件。CodeIgniter 的運行遵循着一個特定的流程，你能夠參考這個頁面的應用程序流程圖。可是，有些時候你可能但願在執行流程中的某些階段添加一些動做，例如在控制器加載以前或以後執行一段腳本，或者在其餘的某些位置觸發你的腳本。php

啓用鉤子

鉤子特性能夠在 application/config/config.php 文件中全局的啓用或禁用，設置下面這個參數: $config['enable_hooks'] = TRUE;html

掛鉤點

CI框架能夠實如今不修改系統核心文件的基礎上來改變或增長系統的核心運行功能，那就是Hook,看看CI有哪些鉤子：web

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
在最終着色頁面發送到瀏覽器以後,瀏覽器接收完最終數據的系統執行末尾調用

定義鉤子

1 $hook['pre_controller'] = array(
2                                 'class'    => 'TestHook', //調用的類名，若是你更喜歡使用過程式的函數的話，這一項能夠留空。
3                                 'function' => 'test', //調用的函數名
4                                 'filename' => 'TestHook.php', //包含你的類或函數的文件名
5                                 'filepath' => 'hooks', //包含你的腳本文件的目錄名。 注意： 你的腳本必須放在 application/ 目錄裏面，因此 filepath 是相對 application/ 目錄的路徑，舉例來講，若是你的腳本位於 application/hooks/ ，那麼 filepath 能夠簡單的設置爲 'hooks' ，若是你的腳本位於application/hooks/utilities/ ， 那麼 filepath 能夠設置爲 'hooks/utilities' ，路徑後面不用加斜線
6                                 'params'   => 'array()'//傳遞給腳本參數，可選
7                                 );

屢次調用同一個掛鉤點

若是你想在同一個掛鉤點處添加多個腳本，只須要將鉤子數組變成二維數組便可，像這樣:數組

 
   $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'][]瀏覽器

這可讓你在同一個掛鉤點處執行多個腳本，多個腳本執行順序就是你定義數組的順序。緩存

鉤子類分析

  1 /**
  2  * 鉤子嘛，就是在不修改系統核心文件的基礎上來改變或增長系統的核心運行功能
  3  */
  4 class CI_Hooks {
  5  
  6     /**
  7      * 檢測hook是否開啓
  8      */
  9     var $enabled        = FALSE;
 10     /**
 11      * config/hooks.php中的hooks配置信息
 12      */
 13     var $hooks            = array();
 14     //防止死循環，由於鉤子程序裏面可能還還有鉤子
 15     var $in_progress    = FALSE;
 16  
 17     //構造函數
 18     function __construct()
 19     {
 20         $this->_initialize();
 21         log_message('debug', "Hooks Class Initialized");
 22     }
 23  
 24     /**
 25      * 初始化，獲取hooks配合
 26      */
 27     function _initialize()
 28     {
 29         $CFG =& load_class('Config', 'core');
 30  
 31         // 檢測配置是否開啓鉤子
 32         if ($CFG->item('enable_hooks') == FALSE)
 33         {
 34             return;
 35         }
 36  
 37         // 檢測是否配置鉤子
 38         if (defined('ENVIRONMENT') AND is_file(APPPATH.'config/'.ENVIRONMENT.'/hooks.php'))
 39         {
 40             include(APPPATH.'config/'.ENVIRONMENT.'/hooks.php');
 41         }
 42         elseif (is_file(APPPATH.'config/hooks.php'))
 43         {
 44             include(APPPATH.'config/hooks.php');
 45         }
 46  
 47  
 48         if ( ! isset($hook) OR ! is_array($hook))
 49         {
 50             return;
 51         }
 52  
 53         $this->hooks =& $hook;
 54         $this->enabled = TRUE;
 55     }
 56  
 57     // --------------------------------------------------------------------
 58  
 59     /**
 60      * 運行鉤子程序，外部就是這樣調用：
 61          *     $EXT =& load_class('Hooks', 'core');
 62      *      $EXT->_call_hook('pre_system');
 63      */
 64     function _call_hook($which = '')
 65     {
 66         if ( ! $this->enabled OR ! isset($this->hooks[$which]))
 67         {
 68             return FALSE;
 69         }
 70                 //CI支持屢次鉤子，那麼就是二維數組
 71         if (isset($this->hooks[$which][0]) AND is_array($this->hooks[$which][0]))
 72         {
 73             foreach ($this->hooks[$which] as $val)
 74             {
 75                 $this->_run_hook($val);
 76             }
 77         }
 78         else
 79         {
 80                         //一個鉤子直接運行鉤子
 81             $this->_run_hook($this->hooks[$which]);
 82         }
 83  
 84         return TRUE;
 85     }
 86  
 87     // --------------------------------------------------------------------
 88  
 89     /**
 90      * Run Hook
 91      *
 92      * Runs a particular hook
 93      *
 94      * @access    private
 95      * @param    array    the hook details
 96      * @return    bool
 97      */
 98     function _run_hook($data)
 99     {
100         if ( ! is_array($data))
101         {
102             return FALSE;
103         }
104         
105                 //防止死循環，由於鉤子程序裏面可能還還有鉤子
106         if ($this->in_progress == TRUE)
107         {
108             return;
109         }
110  
111         //設置路徑
112                 //下面能夠filepathfilepath就以那個文件夾(application)爲基準，application/hooks下, 你能夠把hooks 做爲你的filepath
113                 
114         if ( ! isset($data['filepath']) OR ! isset($data['filename']))
115         {
116             return FALSE;
117         }
118  
119         $filepath = APPPATH.$data['filepath'].'/'.$data['filename'];
120  
121         if ( ! file_exists($filepath))
122         {
123             return FALSE;
124         }
125  
126         // -----------------------------------
127         // Set class/function name
128         // -----------------------------------
129  
130         $class        = FALSE;
131         $function    = FALSE;
132         $params        = '';
133  
134         if (isset($data['class']) AND $data['class'] != '')
135         {
136             $class = $data['class'];
137         }
138  
139         if (isset($data['function']))
140         {
141             $function = $data['function'];
142         }
143  
144         if (isset($data['params']))
145         {
146             $params = $data['params'];
147         }
148  
149         if ($class === FALSE AND $function === FALSE)
150         {
151             return FALSE;
152         }
153  
154         //不用多說了吧
155         $this->in_progress = TRUE;
156  
157         //獲取鉤子配置信息成功後，運行鉤子程序
158         if ($class !== FALSE)
159         {
160             if ( ! class_exists($class))
161             {
162                 require($filepath);
163             }
164  
165             $HOOK = new $class;
166             $HOOK->$function($params);
167         }
168         else
169         {
170             if ( ! function_exists($function))
171             {
172                 require($filepath);
173             }
174  
175             $function($params);
176         }
177                 // //執行相應程序完畢後，從新把當前hook的狀態改成非運行中，以讓它能夠再次被觸發。
178         $this->in_progress = FALSE;
179         return TRUE;
180     }
181  
182 }