[TOC]
* * * * *
# 1 Hook注册
>> Hook，在tp5中用来进行行为扩展。作为实现切面编程(AOP)的实现方法。
>可以将Hook看做js的事件机制。
>注册事件名称对应的处理函数。在代码运行过程中插入事件监听。
>与js事件监听不同。js事件监听在dom元素，而tp事件监听在代码运行过程中。
>等代码运行到插入的Hook监听处，即可自动运行注册的事件处理函数。
# 2 Hook操作
## 2-1 注册Hook信息
### Hook::add()
>>注册tag对应的事件处理函数
public static function add($tag, $behavior, $first = false)
{
isset(self::$tags[$tag]) || self::$tags[$tag] = [];
if (is_array($behavior) && !is_callable($behavior)) {
if (!array_key_exists('_overlay', $behavior) || !$behavior['_overlay']) {
unset($behavior['_overlay']);
self::$tags[$tag] = array_merge(self::$tags[$tag], $behavior);
} else {
unset($behavior['_overlay']);
self::$tags[$tag] = $behavior;
}
} elseif ($first) {
array_unshift(self::$tags[$tag], $behavior);
} else {
self::$tags[$tag][] = $behavior;
}
}
### Hook::import()
>>事件批量注册
public static function import(array $tags, $recursive = true)
{
if ($recursive) {
foreach ($tags as $tag => $behavior) {
self::add($tag, $behavior);
}
} else {
self::$tags = $tags + self::$tags;
}
}
## 2-2 获取Hook注册信息
### Hook::get()
>>获取注册的Hook的tag注册的事件函数
public static function get($tag = '')
{
if (empty($tag)) {//获取全部的插件信息
return self::$tags;
} else {
return array_key_exists($tag, self::$tags) ? self::$tags[$tag] : [];
}
}
## 3 注册事件监听
### Hook::listen()
>>在代码运行过程中注册事件监听。
public static function listen($tag, &$params = null, $extra = null, $once = false)
{
$results = [];
$tags = static::get($tag);
foreach ($tags as $key => $name) {
$results[$key] = self::exec($name, $tag, $params, $extra);
if (false === $results[$key]) {// 如果返回false 则中断行为执行
break;
} elseif (!is_null($results[$key]) && $once) {
break;
}
}
return $once ? end($results) : $results;
}
## 4 事件函数运行
### Hook::exec()
>>代码运行到注册的事件监听处，自动运行tag对应的事件处理函数
public static function exec($class, $tag = '', &$params = null, $extra = null)
{
App::$debug && Debug::remark('behavior_start', 'time');
if (is_callable($class)) {
$result = call_user_func_array($class, [ & $params, $extra]);
$class = 'Closure';
} elseif (is_object($class)) {
$result = call_user_func_array([$class, $tag], [ & $params, $extra]);
$class = get_class($class);
} else {
$obj = new $class();
$result = ($tag && is_callable([$obj, $tag])) ? $obj->$tag($params, $extra) : $obj->run($params, $extra);
}
if (App::$debug) {
Debug::remark('behavior_end', 'time');
Log::record('[ BEHAVIOR ] Run ' . $class . ' @' . $tag . ' [ RunTime:' . Debug::getRangeTime('behavior_start', 'behavior_end') . 's ]', 'info');
}
return $result;
}
