插件开发规范

0x01、插件官方维护地址

https://github.com/blogdaren/PHPCreeper-Plugin

0x02、插件版本号约定

建议插件版本号和爬山虎引擎大版本号保持一致,如:v1.0.0

0x03、插件类命名约定

类名必须遵守格式: PHPCreeper-Plugin-首字母大写的英文插件名称
比如:PHPCreeper-Plugin-Search

0x04、插件类实现约定
  • 所有的插件类必须实现PHPCreeper\Kernel\Slot\PluginInterface接口
  • 所有的插件类必须定义一个静态的install()接口,目的是让引擎自动调用inject()接口
0x05、关于私有插件

毫无疑问,我们鼓励开发开源插件并将其打包发布到packagist,以便分享给他人使用,
然而有时我们可能需要编写项目内部的私有插件,这里我们尽量也需要遵守如下规范:
那就是将插件编写在/path/to/PHPCreeper-Application//Application/Plugin目录下

results matching ""

    No results matching ""