https://github.com/twelvet-projects/think-addons
thinkphp5.1插件扩展
https://github.com/twelvet-projects/think-addons
Last synced: over 1 year ago
JSON representation
thinkphp5.1插件扩展
- Host: GitHub
- URL: https://github.com/twelvet-projects/think-addons
- Owner: twelvet-projects
- License: apache-2.0
- Created: 2019-09-05T09:05:11.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2020-01-04T09:00:55.000Z (over 6 years ago)
- Last Synced: 2025-02-02T11:33:51.052Z (over 1 year ago)
- Language: PHP
- Homepage:
- Size: 30.3 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# think-addons
The ThinkPHP 5.1 Addons Package
# 起源
> https://github.com/zz-studio/think-addons
#
感谢以上项目带给TwelveT的开源支持
## 安装
> composer require 12tla/think-addons
## 配置
### 公共配置
```
'addons'=>[
// 是否自动读取取插件钩子配置信息（默认是关闭）
'autoload' => false,
// 当关闭自动获取配置时需要手动配置hooks信息
'hooks' => [
// 可以定义多个钩子
'testhook'=>'test' // 键为钩子名称，用于在业务中自定义钩子处理，值为实现该钩子的插件，
// 多个插件可以用数组也可以用逗号分割
]
]
```
或者在\config目录中新建`addons.php`,内容为：
```
false,
// 当关闭自动获取配置时需要手动配置hooks信息
'hooks' => [
// 可以定义多个钩子
'testhook'=>'test' // 键为钩子名称，用于在业务中自定义钩子处理，值为实现该钩子的插件，
// 多个插件可以用数组也可以用逗号分割
]
];
```
## 创建插件
> 创建的插件可以在view视图中使用，也可以在php业务中使用
安装完成后访问系统时会在项目根目录生成名为`addons`的目录，在该目录中创建需要的插件。
下面写一个例子：
### 创建test插件
> 在addons目录中创建test目录
### 创建钩子实现类
> 在test目录中创建 Widget.php 类文件。注意：类文件首字母需大写
```
'test', // 插件标识
'title' => '插件测试', // 插件名称
'description' => 'thinkph5.1插件测试', // 插件简介
'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类文件，插件配置文件可以省略。
```
[
'title' => '是否显示:',
'type' => 'radio',
'options' => [
'1' => '显示',
'0' => '不显示'
],
'value' => '1'
]
];
```
### 创建钩子模板文件
> 在test目录中创建info.html模板文件，钩子在使用fetch方法时对应的模板文件。
```
hello tpl
如果插件中需要有链接或提交数据的业务，可以在插件中创建controller业务文件，
要访问插件中的controller时使用addon_url生成url链接。
如下：
link test
格式为：
test为插件名，Action为controller中的类名[多级控制器可以用.分割]，link为controller中的方法
```
### 创建插件的controller文件
> 在test目录中创建controller目录，在controller目录中创建Index.php文件
> controller类的用法与tp5.1中的controller一致
```
如果需要使用view模板则需要继承`\think\addons\Controller`类
> 模板文件所在位置为插件目录的view中，规则与模块中的view规则一致
```
fetch();
}
}
```
## 使用钩子
> 创建好插件后就可以在正常业务中使用该插件中的钩子了
> 使用钩子的时候第二个参数可以省略
### 模板中使用钩子
```
{:hook('testhook', ['id'=>1])}
```
### php业务中使用
> 只要是thinkphp5.1正常流程中的任意位置均可以使用
```
hook('testhook', ['id'=>1])
```
## 插件目录结构
### 最终生成的目录结构为
```
tp5
- addons
-- test
--- controller
---- Action.php
--- view
---- action
----- link.html
--- config.php
--- info.html
--- Test.php
- application
- config
- thinkphp
- extend
- vendor
- public
```