thinkphp的钩子的两种配置和两种调用方法

2532022-03-20 23:21:51

这篇文章主要介绍了thinkphp的钩子的两种配置和两种调用方法,实例讲解的很清晰，有不懂的同学可以学习下

thinkphp的钩子行为类是一个比较难以理解的问题，网上有很多写thinkphp钩子类的文章，我也是根据网上的文章来设置thinkphp的钩子行为的，但根据这些网上的文章，我在设置的过程中，尝试了十几次都没有成功，不过，我还是没有放弃，最后还是在一边调节细节，一边试验的过程中实现了钩子行为的设置。下面是我个人的设置经验，在这里跟大家分享一下。

个人做了两种设置，都试验成功了，一个简单点，在thinkphp的核心文件中模仿核心行为类添加了另一个行为类，下面是截图：

我的虚拟主机配置文件夹是D:/think

Thinkphp是tp框架文件夹，配置过tp框架应该都知道Library是tp放核心文件的文件夹，Behavior文件夹则是tp的钩子行为类文件的核心文件夹，里面放置着很多行为类文件，我只是模仿这些钩子行为类文件在里面建了一个钩子行为类文件adBehavior.class.php,内容如下：

<?php
namespace Behavior;
class adBehavior{
    function run($arg){
        //在此介绍下，run必须的 ，细心的会在Think核心找到Behavior.class.php里面有这样一句话 abstract public function run(&$params); 
        echo '我是一条'.$arg['name'].'广告,'.$arg['value'].'代言';
    }
}

设置好了自定义的钩子行为类之后，我们接下来就要利用这个钩子行为类促发钩子的行为了，```钩子的行为```说白了其实就是促发钩子行为类的run方法里面的代码执行，我这里只是简单的输出run方法参数的内容，在应用中的，大家可以自由发挥。

下面是促发行为的操作：

解释一下：我这里是Home模块下面的IndexController控制器的登录方法

namespace Home\Controller;
use Think\Controller;
use Think\Hook;//引进促发钩子行为的类，是为下面的Hook::add()调用做伏笔的

class IndexController extends Controller {
    public function login(){
    //这里我设置一个ad行为的标签，也就是给我自定义的adBehavior钩子行为类添加一个促发行为的标识
    Hook::add('ad','Behavior\\adBehavior');
    //第一个是执行标签的名称，第二个参数是行为的类的地址
    Hook::add('test', "Home\\Behaviors\\testBehavior");
    //Hook::add('test2', "Home\\Behaviors\\testBehavior");
    $param=array('name'=>'testBehavior');
    $param2=array('LIS'=>'LLISTION');
    $param3=array('music'=>'cangjingshikong');
    $this->assign('param',$param);
    $this->assign('param',$param2);
    $this->assign('param',$param3);
    $this->display();
 }

下面是login模板内容：

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
    <title>ThinkPHP 行为(Behavior)扩展以及插件(Plug or Hook)详解(含实例)
    </title>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    <meta name="description" content="Hook使用方法" />
</head>
<body>
    <h1>How to used?</h1>
    {:hook('ad', array('name'=>'AV','value'=>'*老师'))}
    <div>————————————————分割线1——————————————————</div>
    <div style="font-weight: bold ;color: #00ff00">{:hook('ad', array('name'=>'MV','value'=>'苍井空老师'))}</div>
    <div>————————————————分割线2——————————————————</div>
     <!--hook函数第一个参数是标签的名称，第二个参数随意-->
     <!--tag函数第一个参数是标签的名称，第二个一定是变量，因为tag函数是引址传递的参数-->
    <div>hook函数：{:hook('test', array('name'=>'World'))}<hr/></div>
    <div>tag函数：{:tag('mv',$param)}<hr/></div>
    <hr/>
    <div>tag函数：{:tag('action_begin',$param)}</div>
</body>
</html>

这里的路径我就不写了吧，一般对tp框架了解的人都知道，这个模板login.html放在哪里。

关于这个模板的内容，我已经提前把下面要讲述的另一种设置钩子行为类方法的内容也放在这里了，大家可以自行测试一下调用这个模板，如果你跟着我的思路设置了，我想它应该会输出。

废话不多说，下面是第二种自己设置行为类的方法，这里我是根据tp框架的手册以及诸位网友的网文自己测试成功了的，大家按照我的思路设置就行了。只有你配置对了，我想应该不会出现太多问题。　　

首先在你的模块下面建一个文件夹Behaviors，再在Behaviors里面创建自定义的钩子行为类，钩子行为类必须是xxxBehaviors.class.php的格式。　　
其次在你的模块下面的Conf文件夹中新增一个文件tags.php。　　为什么要这样，这是tp的语法，你照做就行了，当然你自己也可以探究一下。　　这样子说或许还不够形象，下面我还是上代码吧，本人描述比较差。　　先截个图显示路径吧，免得有的同学还是摸不着头脑。

thinkphp的钩子的两种配置和两种调用方法

解释一下上面的文件夹，Conf文件夹有的tp会自动生成，有的可能要你新建，Behaviors文件夹则是要你新建的，下面还是上代码：在Behaviors文件夹里面（完整路径D:\think\application\Home\Behaviors\testBehavior.class.php）我自定义的钩子行为类的内容：

<?php
/**
 * Created by PhpStorm.
 * User: Administrator
 * Date: 2016/7/17
 * Time: 11:02
 */
namespace Home\Behaviors;
/*
 * 注册钩子行为类，要触发的行为写在run函数里
 **/
class testBehavior extends \Think\Behavior{
    public function run(&$arg){
        echo 'test behavior=====下一行是参数<br/>'.$arg['name'];
    }
}

在Conf文件夹里面（完整路径D:\think\application\Home\Conf\tags.php，当然这是我的情况）tags.php的内容：

<?php
/**
 * User: Administrator
 * Date: 2016/7/17
 * Time: 10:56
 */
return array(
    //'action_begin'=>array('Home\\Behaviors\\test','Home\\Behaviors\\test'),
    //一个标签位可以有多个行为，使用数组即可。 
    // 如果是3.2.1版本 则需要改成 
    'action_begin'=>array('Home\\Behaviors\\testBehavior','Home\\Behaviors\\testBehavior'),
    'mv'=>array('Home\\Behaviors\\mvBehavior','Home\\Behaviors\\mvBehavior')
);

解释一下，上面tags.php文件的内容，我配置了两个行为标识，``action_begin``，``mv``，是跟login.html那里相对应的，你可以回去仔细查看一下，login.html模板的内容，必定包含有``action_begin``，``mv``，这里也是tp框架在tags.php设置行为标识的语法，要是想问为什么可以自行探究，这里不多说。

还有请注意：上面那个被我注释掉的‘action_begin'，其实是我的版本不适合这个语法，这是其他版本在tags.php配置行为标识的语法，这里tp里面的文档说的比较清楚，我就不多说了。如果，你的版本和我不同，那么请用上面的语法尝试一下，如果用上面的语法配置还是没办法配置成功，那么可能是你配置错了。

配置好了，那么请你再尝试调用模板login.html。我相信你一定能获得你想要的配置结果的。

这里提醒一句，请认真看我所做的注释，那里可以说也包含了很多信息。

接下来，我要讲讲设置监听钩子行为类的两个方法hook(),tag()：

这两个函数都是tp内置监听钩子行为类的内置函数，可以在tp框架的函数库functions.php文件中找得到。这里只讲他们的调用区别，其实已经在login.html模板文件中提到了，这里就再次说明一下：

两个函数在functions.php的代码：

/**
 * 获取和设置配置参数 支持批量定义
 * @param string|array $name 配置变量
 * @param mixed $value 配置值
 * @param mixed $default 默认值
 * @return mixed
 */
function hook($hook,$params=array()){
    \Think\Hook::listen($hook,$params); //监听一个钩子
}

/**
 * 处理标签扩展
 * @param string $tag 标签名称
 * @param mixed $params 传入参数
 * @return void
 */
function tag($tag, &$params=NULL) {
    \Think\Hook::listen($tag,$params);
}

之所以在这里展示一下这两个函数的内容，是为了解释它们的区别：

细心的你应该发现tag函数的$param参数值里前面带了一个···&···符号，没有错：这个符号就是引用变量的地址符号，所以tag函数的$param参数只能是变量，请不要怀疑，你可以测试一下不是变量的情况，呵呵。

它们的区别也在于此，hook可以引用任何参数，tag只能引用变量的参数

上面那个tags.php文件里面我在每个标签行为的后面都重复配置了testBehavior自定义类，是为了证明，一个标签也可以对应多个行为类，如果你配置成功了，那么你运行login.html的时候，肯定发现login根据testBehavior设置的执行了两次。

最后，总结一下：

tp框架的钩子行为类无非就是为了在某个特定地点，特定时间促发某种行为，这个是应用很广的，本人姑且这么认为。比如，你想要在某个模板植入广告，可以向我这样子简单的设置。然后，简单的介绍tp行为的引用步骤：

首先第一步，你要先配置好自己的行为类，这是毋庸置疑的。

其次是促发的行为，你必须在你自定义的行为类的run里面设置，在这里实现你的任何行为，run方法就是你配置行为的地方。

然后，就是配置tags.php的行为标识了

这里你可以按照上面格式配置，当然，你有没有细心的发现上面的IndexController.class.php里面我多写了几行代码：

//第一个是执行标签的名称，第二个参数是行为的类的地址
Hook::add('test', "Home\\Behaviors\\testBehavior");

其实这里是动态添加行为标识的代码，也就是说，钩子行为的标签行为，也就是标识也可以动态添加的，你可以试试。

最后，就是监听行为了，监听行为就是引用tag方法或者hook方法了，在这里你可以传入参数，也可不传，看你想怎么做了。监听行为你可以在模板上监听，也可以在其他地方监听，比如控制器的方法中，这里就不举例了，你可以自己试试，我之所以在模板中举例，完全是为了看到效果，毕竟做实验看不到你要的结果，是证明不了你的实验是个成功的实验的。