基于thinkphp6的addons插件扩展

浏览:4943 发布日期:2019/11/06 分类:功能实现 关键字: thinkphp6 插件 hook addons
基于thinkphp6的addons插件扩展
安装
composer require zzstudio/think-addons

公共配置'addons'=>[
    // 是否自动读取取插件钩子配置信息(默认是开启)
    'autoload' => true,
    // 当关闭自动获取配置时需要手动配置hooks信息
    'hooks' => [
        // 可以定义多个钩子
        'testhook'=>'test' // 键为钩子名称,用于在业务中自定义钩子处理,值为实现该钩子的插件,
                    // 多个插件可以用数组也可以用逗号分割
    ],
    'route' => [],
    'service' => [],
]
或者在\config目录中新建`addons.php`,内容为:

安装完成后访问系统时会在项目根目录生成名为`addons`的目录,在该目录中创建需要的插件。

下面写一个例子:

创建test插件
在addons目录中创建test目录

创建钩子实现类
在test目录中创建 Plugin.php 类文件。注意:类文件首字母需大写<?php
namespace addons\test;    // 注意命名空间规范

use think\Addons;

/**
 * 插件测试
 * @author byron sampson
 */
class Plugin extends Addons    // 需继承think\Addons类
{
    // 该插件的基础信息
    public $info = [
        'name' => 'test',    // 插件标识
        'title' => '插件测试',    // 插件名称
        'description' => 'thinkph6插件测试',    // 插件简介
        'status' => 0,    // 状态
        'author' => 'byron sampson',
        'version' => '0.1'
    ];

    /**
     * 插件安装方法
     * @return bool
     */
    public function install()
    {
        return true;
    }

    /**
     * 插件卸载方法
     * @return bool
     */
    public function uninstall()
    {
        return true;
    }

    /**
     * 实现的testhook钩子方法
     * @return mixed
     */
    public function testhook($param)
    {
        // 调用钩子时候的参数信息
        print_r($param);
        // 当前插件的配置信息,配置信息存在当前目录的config.php文件中,见下方
        print_r($this->getConfig());
        // 可以返回模板,模板文件默认读取的为插件目录中的文件。模板名不能为空!
        return $this->fetch('info');
    }

}
```

### 创建插件配置文件
> 在test目录中创建config.php类文件,插件配置文件可以省略。
<?php
return [
    'display' => [
        'title' => '是否显示:',
        'type' => 'radio',
        'options' => [
            '1' => '显示',
            '0' => '不显示'
        ],
        'value' => '1'
    ]
];
创建钩子模板文件
在test->view目录中创建info.html模板文件,钩子在使用fetch方法时对应的模板文件。<h1>hello tpl</h1>

如果插件中需要有链接或提交数据的业务,可以在插件中创建controller业务文件,
要访问插件中的controller时使用addon_url生成url链接。
如下:
<a href="{:addons_url('Action/link')}">link test</a>

<a href="{:addons_url('test://Action/link')}">link test</a>
格式为:
test为插件名,Action为controller中的类名[多级控制器可以用.分割],link为controller中的方法
创建插件的controller文件
在test目录中创建controller目录,在controller目录中创建Index.php文件
controller类的用法与tp6中的controller一致<?php
namespace addons\test\controller;

class Index
{
    public function link()
    {
        echo 'hello link';
    }
}
使用钩子
创建好插件后就可以在正常业务中使用该插件中的钩子了
使用钩子的时候第二个参数可以省略

模板中使用钩子<div>{:hook('testhook', ['id'=>1])}</div>php业务中使用
只要是thinkphp6正常流程中的任意位置均可以使用hook('testhook', ['id'=>1])附件已更新为完整插件演示案例,解压后请使用 composer install 进行初始化

有问题可加QQ群:438811382 进行讨论
评论( 相关
后面还有条评论,点击查看>>