CodeIgniter源码阅读笔记5之Hooks.php
CI提供了钩子这种特性,可以在不修改核心文件的情况下用来修改框架内部执行流程。
全局来看,是否开启钩子可以在APPPATH/config/config.php中进行修改,而hooks的配置则在APPPATH/config/hooks.php中进行定义,具体如何实现可以参考官方文档:http://codeigniter.org.cn/user_guide/general/hooks.html?highlight=hooks
这里简单讲一下hooks的定义方式,有助于后面的源码理解。
第一种定义方式,使用数组定义的形式:
$hook['pre_controller'] = array(
'class' => 'MyClass',
'function' => 'Myfunction',
'filename' => 'Myclass.php',
'filepath' => 'hooks',
'params' => array('beer', 'wine', 'snacks')
);
另一种出现在PHP5.3以后,可以使用lambda的闭包或是匿名函数作为钩子:
$hook['post_controller'] = function()
{
/* do something here */
};
如果想在同一个挂钩点添加多个钩子,将其改为二维数组即可。看一下Hooks.php的精简版代码,具体的解析写在了代码的注释中。
<?php
defined('BASEPATH') OR exit('No direct script access allowed');
class CI_Hooks {
// 钩子是否启用
public $enabled = FALSE;
// 所有的hook数组
public $hooks = array();
// 存储hooks的类
protected $_objects = array();
// 运行标志,防止死循环
protected $_in_progress = FALSE;
public function __construct()
{
// 加载配置文件
$CFG =& load_class('Config', 'core');
log_message('info', 'Hooks Class Initialized');
// 检测配置文件中是否存在enable_hooks选项,没有的话直接返回
if ($CFG->item('enable_hooks') === FALSE)
{
return;
}
// 查找hooks文件
if (file_exists(APPPATH.'config/hooks.php'))
{
include(APPPATH.'config/hooks.php');
}
if (file_exists(APPPATH.'config/'.ENVIRONMENT.'/hooks.php'))
{
include(APPPATH.'config/'.ENVIRONMENT.'/hooks.php');
}
// 没有hooks,结束。
if ( ! isset($hook) OR ! is_array($hook))
{
return;
}
// 更改相关状态
$this->hooks =& $hook;
$this->enabled = TRUE;
}
public function call_hook($which = '')
{
// 如果hooks没有启用,或没有传入合法的hooks,返回FALSE
if ( ! $this->enabled OR ! isset($this->hooks[$which]))
{
return FALSE;
}
// 如果hooks的定义方式为数组,并且没有指定function的时候,依次运行
if (is_array($this->hooks[$which]) && ! isset($this->hooks[$which]['function']))
{
foreach ($this->hooks[$which] as $val)
{
$this->_run_hook($val);
}
}
else // 对于PHP5.3以上,采用匿名函数的时候进入else分支
{
$this->_run_hook($this->hooks[$which]);
}
return TRUE;
}
protected function _run_hook($data)
{
// 检测参数是否可调用
if (is_callable($data))
{
is_array($data)
? $data[0]->{$data[1]}()
: $data();
return TRUE;
}
elseif ( ! is_array($data))
{
// 如果不可调用、也不是数组,返回FALSE
return FALSE;
}
// 如果正在运行,则返回
if ($this->_in_progress === TRUE)
{
return;
}
// 检查是否设置了相关文件名和路径
if ( ! isset($data['filepath'], $data['filename']))
{
return FALSE;
}
// 连接路径
$filepath = APPPATH.$data['filepath'].'/'.$data['filename'];
// 检测文件合法性
if ( ! file_exists($filepath))
{
return FALSE;
}
// Determine and class and/or function names
$class = empty($data['class']) ? FALSE : $data['class'];
$function = empty($data['function']) ? FALSE : $data['function'];
$params = isset($data['params']) ? $data['params'] : '';
if (empty($function))
{
return FALSE;
}
// Set the _in_progress flag
$this->_in_progress = TRUE;
// Call the requested class and/or function
if ($class !== FALSE)
{
// The object is stored?
if (isset($this->_objects[$class]))
{
if (method_exists($this->_objects[$class], $function))
{
$this->_objects[$class]->$function($params);
}
else
{
return $this->_in_progress = FALSE;
}
}
else
{
class_exists($class, FALSE) OR require_once($filepath);
if ( ! class_exists($class, FALSE) OR ! method_exists($class, $function))
{
return $this->_in_progress = FALSE;
}
// Store the object and execute the method
$this->_objects[$class] = new $class();
$this->_objects[$class]->$function($params);
}
}
else
{
function_exists($function) OR require_once($filepath);
if ( ! function_exists($function))
{
return $this->_in_progress = FALSE;
}
$function($params);
}
$this->_in_progress = FALSE;
return TRUE;
}
}
结合注释来看,整体比较简单。