插件入口文件

每个插件都有一个入口文件,命名方式为插件名称.php,这里以HelloWorld为例。

plugins目录下建立一个新插件目录HelloWorld,再新建一个HelloWorld.php的入口文件。

  1. plugins
  2. ├─HelloWorld
  3. HelloWorld.php

插件有一个独立的顶级命名空间”plugins“,所有插件入口文件必须继承\app\common\controller\Plugin,并且必须实现两个方法:install()uninstall()

比如:

  1. <?php
  2. namespace plugins\HelloWorld;
  3. use app\common\controller\Plugin;
  4. /**
  5. * 演示插件
  6. */
  7. class HelloWorld extends Plugin
  8. {
  9. /**
  10. * 安装方法必须实现
  11. */
  12. public function install(){
  13. return true;
  14. }
  15. /**
  16. * 卸载方法必须实现
  17. */
  18. public function uninstall(){
  19. return true;
  20. }
  21. }

然后还需要定义插件的相关信息$info参数。

  1. <?php
  2. namespace plugins\HelloWorld;
  3. use app\common\controller\Plugin;
  4. /**
  5. * 演示插件
  6. */
  7. class HelloWorld extends Plugin
  8. {
  9. /**
  10. * @var array 插件信息
  11. */
  12. public $info = [
  13. // 插件名[必填]
  14. 'name' => 'HelloWorld',
  15. // 插件标题[必填]
  16. 'title' => '你好,世界',
  17. // 插件唯一标识[必填],格式:插件名.开发者标识.plugin
  18. 'identifier' => 'helloworld.ming.plugin',
  19. // 插件作者[必填]
  20. 'author' => 'CaiWeiMing',
  21. // 插件版本[必填],格式采用三段式:主版本号.次版本号.修订版本号
  22. 'version' => '1.0.0'
  23. ];
  24. /**
  25. * 安装方法必须实现
  26. */
  27. public function install(){
  28. return true;
  29. }
  30. /**
  31. * 卸载方法必须实现
  32. */
  33. public function uninstall(){
  34. return true;
  35. }
  36. }

定义好之后,就可以进入后台->系统->扩展中心->插件管理,进行安装了。

插件入口文件可以定义以下几类参数: