编写插件

编写插件

主文件

文件名必须为 .class.php 为后缀，文件名可以和目录同名，也由描述文件中的 class 项定义。如：

return array(
    'name'          => 'Hello', //插件名称, 推荐使用英文、数字、下划线
    'class'         => 'Hello', //类名称, 只能为英文、数字、下划线
    ...
);

实际文件名为 hello.class.php。该文件必须包含一个类，名称与文件名相同，类名应当注意是否重名。

示例代码

namespace extend\plugin\hello;
use ginkgo\Plugin;
if (!class_exists('extend\plugin\hello\Hello')) { // 防止类重复
    class Hello {
        public $config = array();
        public $opts = array();
        function __construct() {
            // 定义动作
            // 第一个参数是 钩子 的名称
            // 第二个参数是 对象名 必须为本类
            // 第三个是插件所执行的 方法（函数）
            Plugin::add('action_console_menu_plugin', $this, 'sayHello');
        }
        //参数由 listen 侦听方法所传递过来
        function sayHello($param) {
            //echo '<div>test</div>';
            $param = str_ireplace('__baigo__', 'BAIGO', $param);
            return $param;
        }
    }
}

定义动作

可以使用 ginkgo\Plugin 类的 add 方法向指定的钩子添加动作，此方法一般用于插件中，例如：

namespace extend\plugin\hello;
use ginkgo\Plugin;
class Hello {
    function __construct() {
        Plugin::add('action_console_menu_plugin', $this, 'sayHello'); // 单个定义
        Plugin::add('action_console_menu_plugin', $this, array('doHello', 'testHello')); // 批量定义
    }
    function sayHello($param) {
        return $param;
    }
    function doHello($param) {
        return $param;
    }
    function testHello($param) {
        return $param;
    }
}

插件属性

插件类中可以定义 config 与 opts 属性，必须声明为 public，系统在初始化插件时，会自动读取 config.inc.php 和 opts.json 文件，并将值定义为插件类的属性，如：

namespace extend\plugin\hello;
use ginkgo\Plugin;
class Hello {
    public $config;
    public $opts;
    function __construct() {
        Plugin::add('action_console_menu_plugin', $this, 'sayHello'); // 单个定义
    }
    function sayHello($param) {
        print_r($this->config);
    }
}

描述文件

文件名必须为 config.inc.php，此文件直接返回数组，如：

return array(
    'name'          => 'Hello', //插件名称, 推荐使用英文、数字、下划线
    'class'         => 'Hello', //类名称, 只能为英文、数字、下划线
    'version'       => '1.0', //版本
    'author'        => 'Baigo', //作者
    'plugin_url'    => 'http://www.baigo.net/cms/plugin/hello', //插件地址
    'detail'        => '本插件为一个开发示例', //说明
    'author_url'    => 'http://www.baigo.net', //作者地址
);

说明如下