安装与使用think-addons · 梧桐树tp6备忘录

## 安装[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%AE%89%E8%A3%85) > composer require zzstudio/think-addons ## [](https://github.com/zz-studio/think-addons#%E9%85%8D%E7%BD%AE)配置[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E9%85%8D%E7%BD%AE) ### [](https://github.com/zz-studio/think-addons#%E7%94%9F%E6%88%90%E9%85%8D%E7%BD%AE)生成配置[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E7%94%9F%E6%88%90%E9%85%8D%E7%BD%AE) 系统安装后会自动在 config 目录中生成 addons.php 的配置文件，如果系统未生成可在命令行执行 ~~~html php think addons:config ~~~ 快速生成配置文件 ### [](https://github.com/zz-studio/think-addons#%E5%85%AC%E5%85%B1%E9%85%8D%E7%BD%AE)公共配置[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%85%AC%E5%85%B1%E9%85%8D%E7%BD%AE) ``` 'addons' => [ // 是否自动读取取插件钩子配置信息（默认是开启） 'autoload' => true, // 当关闭自动获取配置时需要手动配置hooks信息 'hooks' => [ // 可以定义多个钩子 'testhook'\=>'test' // 键为钩子名称，用于在业务中自定义钩子处理，值为实现该钩子的插件， // 多个插件可以用数组也可以用逗号分割 ], 'route' => [], 'service' => [], ]; ``` 或者在\\config目录中新建`addons.php`,内容为： ``` <?php return [ // 是否自动读取取插件钩子配置信息 'autoload' => false, // 当关闭自动获取配置时需要手动配置hooks信息 'hooks' => [ // 可以定义多个钩子 'testhook'\=>'test' // 键为钩子名称，用于在业务中自定义钩子处理，值为实现该钩子的插件，// 多个插件可以用数组也可以用逗号分割 ], 'route' => [], 'service' => [], ] ?> ``` ## 创建插件[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%88%9B%E5%BB%BA%E6%8F%92%E4%BB%B6) > 创建的插件可以在view视图中使用，也可以在php业务中使用安装完成后访问系统时会在项目根目录生成名为`addons`的目录，在该目录中创建需要的插件。下面写一个例子： ### [](https://github.com/zz-studio/think-addons#%E5%88%9B%E5%BB%BAtest%E6%8F%92%E4%BB%B6)创建test插件[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%88%9B%E5%BB%BAtest%E6%8F%92%E4%BB%B6) > 在addons目录中创建test目录 ### [](https://github.com/zz-studio/think-addons#%E5%88%9B%E5%BB%BA%E9%92%A9%E5%AD%90%E5%AE%9E%E7%8E%B0%E7%B1%BB)创建钩子实现类[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%88%9B%E5%BB%BA%E9%92%A9%E5%AD%90%E5%AE%9E%E7%8E%B0%E7%B1%BB) > 在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' \=> 1, // 状态 'author' \=> 'yms', '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'); } } ``` ### 创建插件配置文件[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%88%9B%E5%BB%BA%E6%8F%92%E4%BB%B6%E9%85%8D%E7%BD%AE%E6%96%87%E4%BB%B6) > 在test目录中创建config.php类文件，插件配置文件可以省略。 ``` <?php return \[ 'display' \=> \[ 'title' \=> '是否显示:', 'type' \=> 'radio', 'options' \=> \[ '1' \=> '显示', '0' \=> '不显示' \], 'value' \=> '1' \] \]; ``` ### 创建钩子模板文件[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%88%9B%E5%BB%BA%E9%92%A9%E5%AD%90%E6%A8%A1%E6%9D%BF%E6%96%87%E4%BB%B6) > 在test->view目录中创建info.html模板文件，钩子在使用fetch方法时对应的模板文件。 ``` hello tpl 如果插件中需要有链接或提交数据的业务，可以在插件中创建controller业务文件，要访问插件中的controller时使用addon\_url生成url链接。如下： link test 或 link test 格式为： test为插件名，Action为controller中的类名\[多级控制器可以用.分割\]，link为controller中的方法 ``` ### 创建插件的controller文件[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E5%88%9B%E5%BB%BA%E6%8F%92%E4%BB%B6%E7%9A%84controller%E6%96%87%E4%BB%B6) > 在test目录中创建controller目录，在controller目录中创建Index.php文件 controller类的用法与tp6中的controller一致 ``` <?php namespace addons\\test\\controller; class Index { public function link() { echo 'hello link'; } } ``` ## 使用钩子[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#%E4%BD%BF%E7%94%A8%E9%92%A9%E5%AD%90) > 创建好插件后就可以在正常业务中使用该插件中的钩子了使用钩子的时候第二个参数可以省略 ### [](https://github.com/zz-studio/think-addons#%E6%A8%A1%E6%9D%BF%E4%B8%AD%E4%BD%BF%E7%94%A8%E9%92%A9%E5%AD%90)模板中使用钩子 ``` {:hook('testhook', \['id'\=>1\])} ``` ### php业务中使用[#](https://www.cnblogs.com/zhangxilong/p/15958978.html#php%E4%B8%9A%E5%8A%A1%E4%B8%AD%E4%BD%BF%E7%94%A8) > 只要是thinkphp6正常流程中的任意位置均可以使用 ``` hook('testhook', \['id'=>1\]) ``` ### 插件公共方法 ``` /\*\* \* 处理插件钩子 \* @param string $event 钩子名称 \* @param array|null $params 传入参数 \* @param bool $once 是否只返回一个结果 \* @return mixed \*/ function hook($event, $params = null, bool $once = false); /\*\* \* 读取插件的基础信息 \* @param string $name 插件名 \* @return array \*/ function get\_addons\_info($name); /\*\* \* 获取插件Plugin的单例 \* @param string $name 插件名 \* @return mixed|null \*/ function get\_addons\_instance($name); /\*\* \* 插件显示内容里生成访问插件的url \* @param $url 在插件控制器中可忽略插件名，在非插件中生成时需指定插件名。例：插件名://控制器/方法 \* @param array $param \* @param bool|string $suffix 生成的URL后缀 \* @param bool|string $domain 域名 \* @return bool|string \*/ function addons\_url($url = '', $param = \[\], $suffix = true, $domain = false); ```