CI框架源码解析5钩子类文件Hooks.php

       CI框架可以实现在不改变框架核心文件的基础上修改或者添加核心运行功能（比如重写缓存 输出等），这就是Hooks。主要作用是CI框架下扩展base_system，它的主要作用是在CI启动时运行一些开发者定义的一些方法，来实现一些特定的功能。钩子是什么呢？我们可以这样理解：

 

1、钩子是一种事件驱动模式，它的核心自然是事件（CI框架中pre_system，pre_controller等都是特定的事件）。

2、既然是事件驱动，那么必然要包含最重要的两个步骤: (1)、事件注册。对于Hook而言，就是指Hook钩子的挂载。(2).事件触发。在特定的时间点call特定的钩子，执行相应的钩子程序。

3、既然是事件驱动，那么也应该支持统一挂钩点的多个注册事件。

4、启动Hook钩子之后，程序的流程可能会发生变化，且钩子之间可能有相互调用的可能性，如果处理不当，会有死循环的可能性。同时，钩子的启用使得程序在一定程度上变得复杂，难以调试。

 

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、钩子初始化

/*
	 * 构造函数
	 */
	public function __construct()
	{
	    // 初始化 获取 hooks配置
		$CFG =& load_class('Config', 'core');
		log_message('info', 'Hooks Class Initialized');

		// 检测配置是否开启钩子
        // 如果配置文件中设置了不允许hooks 则直接返回退出本函数
		if ($CFG->item('enable_hooks') === FALSE)
		{
			return;
		}

		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');
		}

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

		// 把钩子信息都保存到Hook组件中
		$this->hooks =& $hook;
		$this->enabled = TRUE;
	}

加载配置文件，检测钩子是否开启

加载钩子文件保存钩子信息

 

2、call指定的钩子

/*
	 * 外部其实就是调用call_hook函数进行调用钩子程序
	 */
	public function call_hook($which = '')
	{
		if ( ! $this->enabled OR ! isset($this->hooks[$which]))
		{
			return FALSE;
		}

		if (is_array($this->hooks[$which]) && ! isset($this->hooks[$which]['function']))
		{
			foreach ($this->hooks[$which] as $val)
			{
				$this->_run_hook($val);
			}
		}
		else
		{
			$this->_run_hook($this->hooks[$which]);
		}

		return TRUE;
	}

3、run执行特定的钩子程序

 

 // 执行特定的钩子程序
	protected function _run_hook($data)
	{
		// 这个$data会有 类名 方法名 参数 类文件
		if (is_callable($data))
		{
			is_array($data)
				? $data[0]->{$data[1]}()
				: $data();

			return TRUE;
		}
		elseif ( ! is_array($data))
		{
			return FALSE;
		}


		// 防止死循环 因为钩子程序里面可能还有钩子 进入死循环
        // in_progress 的存在阻止这种情况
		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;
		}

		// 确定类和函数
		$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;
		}

		// 开始正式执行钩子之前 先把当前的hook的状态设为正在运行中
		$this->_in_progress = TRUE;

		// 类+方法
		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;
	}