PHP code example of xianrenqh / think-addons

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

    

xianrenqh / think-addons example snippets

php think addons:config 

'addons' => [
    // 是否自动读取取插件钩子配置信息（默认是开启）
    'autoload' => true,
    // 当关闭自动获取配置时需要手动配置hooks信息
    'hooks' => [
	    // 可以定义多个钩子
        'testhook'=>'test' // 键为钩子名称，用于在业务中自定义钩子处理，值为实现该钩子的插件，
					// 多个插件可以用数组也可以用逗号分割
	],
    'route' => [],
    'service' => [],
];

return [
	// 是否自动读取取插件钩子配置信息
    'autoload' => false,
    // 当关闭自动获取配置时需要手动配置hooks信息
    'hooks' => [
        // 可以定义多个钩子
        'testhook'=>'test' // 键为钩子名称，用于在业务中自定义钩子处理，值为实现该钩子的插件，
                    // 多个插件可以用数组也可以用逗号分割
    ],
    'route' => [],
    'service' => [],
];

namespace addons\test;

use think\App;
use think\Addons;

class Test extends Addons
{

    //后台菜单
    public $admin_list = [
        [
            //方法名称
            "action" => "index",
            //菜单标题
            'title'  => '测试添加插件菜单',
            //icon图标，默认为 fa-list
            'icon'   => '',
            //附加参数 例如：a=12&id=777
            "params" => "",
            //默认排序
            'sort'   => 0,
            //状态，1是显示，0是不显示
            'status' => 1
        ],
        [
            //方法名称
            "action" => "index2",
            //菜单标题
            'title'  => '测试添加插件菜单',
            //icon图标，默认为 fa-list
            'icon'   => '',
            //附加参数 例如：a=12&id=777
            "params" => "",
            //默认排序
            'sort'   => 0,
            //状态，1是显示，0是不显示
            'status' => 1
        ]
    ];

    // 该插件的基础信息
    /*public $info = [
        'name'        => 'test',    // 插件标识
        'title'       => '插件测试',    // 插件名称
        'description' => 'thinkph6插件测试',    // 插件简介
        'status'      => 1,    // 状态
        '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)
    {
        // 调用钩子时候的参数信息
        dump($param);
        // 当前插件的配置信息，配置信息存在当前目录的config.php文件中，见下方
        dump($this->getConfig());

        // 可以返回模板，模板文件默认读取的为插件目录中的文件。模板名不能为空！
        return $this->fetch('info');
    }
}

return array(
    'display'  => array(
        'name'    => 'display',
        'title'   => '是否显示:',
        'type'    => 'radio',
        'options' => array(
            1 => '显示',
            0 => '不显示',
        ),
        'value'   => '0',
    ),
    'appid'    => array(
        'name'  => 'appid',
        'title' => '熊掌号appid',
        'type'  => 'text',
        'value' => '1111',
        'tip'   => '熊掌号请前往<a href="https://ziyuan.baidu.com/xzh/home/index" target="_blank">熊掌号平台</a>获取Appid和Token',
    ),
    'type'     => array(
        'name'    => 'type',
        'title'   => '开启同步登陆：',
        'type'    => 'checkbox',
        'options' => array(
            'qq'     => 'qq',
            'sian'   => 'sian',
            'weixin' => 'weixin',
        ),
        'value'   => 'sian,weixin',
    ),
    'textarea' => array(
        'name'  => 'textarea',
        'title' => '测试textarea：',
        'type'  => 'textarea',
        'value' => 'testdddddd',
        'tip'   => '测试textarea提示',
    ),
    'compress' => array(
        'name'    => 'compress',
        'title'   => '是否启用压缩',
        'type'    => 'select',
        'options' => array(
            1 => '启用压缩',
            0 => '不启用',
        ),
        'value'   => '0',
        'tip'     => '压缩备份文件需要PHP环境支持gzopen,gzwrite函数',
    ),
    'pic'      => array(
        'name'  => 'pic',
        'title' => '固定图片',
        'type'  => 'image',
        'value' => '',
        'tip'   => '选择固定则需要上传此图片',
    ),
);

namespace addons\test\controller;
class Index
{
    public function link()
    {
        echo 'hello link';
    }
}

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);

/**
 * 获取完整配置信息
* @param $name 插件名
* @return void
 */
function get_addons_fullconfig($name)

/**
 * 写入配置文件.
 * @param string $name  插件名
 * @param array  $array 配置数据
 * @return bool
 * @throws Exception
 */
function set_addons_fullconfig($name, $array)


/**
* 获取插件列表
 */
function get_plugins_list()