我欲封天耳根小说零,小说阅读网,天域苍穹

云業(yè)務(wù)管理系統(tǒng)（國內(nèi)版）

開發(fā)說明

最后更新時間：2021-09-17 16:57:00

### 【一】插件定義

插件是獨立于系統(tǒng)內(nèi)置功能以外的擴展功能，可圍繞云引擎系統(tǒng)使用插件完成各種個性化需求。

云引擎后臺帶有插件管理，通過在系統(tǒng)中預(yù)設(shè)的各類鉤子HOOK，實現(xiàn)插件與系統(tǒng)的對接，包括插件的安裝、卸載、開啟停用、設(shè)置等。

### 【二】插件目錄

每一個應(yīng)用插件都是一個獨立的插件目錄，所有的應(yīng)用插件都是存放在app\Plugin目錄下。

以下為一個短信發(fā)送示例插件 MySmsDemo（ 插件code標識為 MySmsDemo ）。

以下示例是一個插件的目錄結(jié)構(gòu)：

```
├── app

│ ├── Plugin [所有插件總目錄]

│ │ ├── MySmsDemo[插件目錄]

│ │ │ ├── Contracts [接口目錄，可選]

│ │ │ │  ├── MessageInterface.class.php [短信內(nèi)容接口類]

│ │ │ │  ├── PhoneNumberInterface.class.php[手機號接口類]

│ │ │ │  ├── SmsInterface.class.php[短信發(fā)送接口類 規(guī)范必須實現(xiàn)send 方法]

│ │ │ ├── Controller [控制器目錄，需要提供外部URL訪問的時候才需要，可選]

│ │ │ ├── Service [服務(wù)目錄]

│ │ │ │  ├── Sms.class.php [短信發(fā)送實現(xiàn)類，對外開放的方法send，其中send會調(diào)用插件的send方法]

│ │ │ │  ├── MySmsDemo.class.php [具體的實現(xiàn)發(fā)送短信類 implements SmsInterface ]

│ │ │ ├── Support [公共目錄]

│ │ │ │  ├── Message.class.php [Message implements MessageInterface接口]

│ │ │ │  ├── PhoneNumber.class.php [PhoneNumber implements PhoneNumberInterface接口]

│ │ │ ├── View [視圖目錄]

│ │ │ │  └── config.html[插件自定義后臺設(shè)置頁，可選]

│ │ │ └── MySmsDemoPlugin.class.php [插件定義和實現(xiàn)的文件，必須實現(xiàn)]

│ │ │ └── config.php [配置文件, 有配置項的話，可選]

```

### 【三】插件命名

1. 插件最外層文件夾和插件標識一致，使用大駝峰命名方式，插件標識唯一；

2. 插件code標識必須在應(yīng)用市場唯一，在阿帕云首次提交應(yīng)用時，系統(tǒng)會自動提示是否重復(fù)；

### 【四】入口文件說明

如上例，MySmsDemoPlugin.class.php文件為插件的入口文件，命名格式為：插件標識+Plugin.class.php；

入口文件必須繼承 Plugin.class.php 文件中的 Plugin 類；

類型	名稱	名稱

類屬性	$code	插件標識，需和發(fā)布插件填寫的標識一致

類屬性	$hooks	插件調(diào)用鉤子，數(shù)組格式，至少需要實現(xiàn)一個鉤子

類屬性	$custom_config	自定義插件設(shè)置頁模板，默認值：config.html

方法	install()	插件安裝程序，返回值必須是bool類型。

方法	uninstall()	插件卸載程序，返回值必須是bool類型。

方法	hook_name(&$params)	如果定義了插件調(diào)用鉤子，則需實現(xiàn)對應(yīng)鉤子方法，方法名稱同鉤子名稱

代碼示例

```
<?php
namespace Plugin\MySmsDemo;
use Plugin\MySmsDemo\Service\Sms;
use Plugin\Plugin;
class MySmsDemoPlugin extends Plugin
{
    /**
     * 插件標識
     * @var string
     */
    public $code = 'MySmsDemo';
    /**
     * 插件信息
     * @var string
     */
    public $info
        = array(
            'name'        => 'MySmsDemo',
            'title'       => '我的短信接口',
            'description' => '這是一個短信插件示例',
        );
    /**
     * 插件掛載鉤子
     * @var array
     */
    public $hooks = ['sms_instance', 'plugin_config'];
    /**
     * @var string 自定義設(shè)置模板
     */
    public $custom_config = 'View/config.html';
    /**
     * 安裝程序
     * @return bool|mixed
     */
    public function install()
    {
        $smsConfig = require ROOT_CONFIG_PATH . 'smsConfig.php';
        $smsConfig[$this->code] = [
            'className'   => $this->code,
            'channelName' => '我的短信(插件)',
        ];
        $this->updateConfig($smsConfig);
        return true;
    }
    /**
     * 卸載程序
     * @return bool|mixed
     */
    public function uninstall()
    {
        $smsConfig = require ROOT_CONFIG_PATH . 'smsConfig.php';
        if (isset($smsConfig[$this->code])) {
            unset($smsConfig[$this->code]);
        }
        $this->updateConfig($smsConfig);
        return true;
    }
    private function updateConfig($config)
    {
        $smsConfigFile    = ROOT_CONFIG_PATH . 'smsConfig.php';
        $smsConfigContent = "<?php\nreturn [\n";
        foreach ($config as $key => $item) {
            $key              = is_int($key) ? $key : "'$key'";
            $smsConfigContent .= $key . "=> [\r";
            $smsConfigContent .= "'className'   => '{$item['className']}',\r";
            $smsConfigContent .= "'channelName'   => '{$item['channelName']}',\r";
            $smsConfigContent .= "],\r";
        }
        $smsConfigContent .= "];";
        // 覆蓋配置文件
        file_put_contents($smsConfigFile, $smsConfigContent);
    }
    /**
     * 插件業(yè)務(wù)程序
     * @param mixed $params
     */
    public function sms_instance(&$params)
    {
        if ($params == $this->code && $this->verify()) {
            $config = $this->getConfig();
            $params = new Sms($config);
        }
    }
    /**
     * 插件業(yè)務(wù)程序
     * @param mixed $params
     */
    public function plugin_config(&$params)
    {
        if ($params['code'] == $this->code && $this->verify()) {
            $template   = M('template')->where([
                'type' => [
                    'in',
                    '1,2',
                ],
            ])->field('id, code, title')->order('sortId asc, id asc')->select();
            $templateDb = [];
            foreach ($template as $item) {
                $templateDb[$item['id']] = [
                    'code'  => $item['code'],
                    'title' => $item['title'],
                ];
            }
            if (!empty($params['config']['TemplateCode']['value'])) {
                // 這里因為索引是數(shù)字，不能用 array_merge
                $params['config']['TemplateCode']['value'] = $params['config']['TemplateCode']['value'] + $templateDb;
            } else {
                $params['config']['TemplateCode']['value'] = $templateDb;
            }
            $params['title'] = '我的短信';
        }
    }
}
```

### 【五】后臺設(shè)置頁面

插件不一定有設(shè)置頁面。必須插件目錄里有一個config.php并且返回一個非空的數(shù)組才會顯示。設(shè)置頁里有顯示。以示例插件的配置文件舉列：

```
<?php
return [
    'apiId'      => [
        'title' => 'ApiId:',
        'type'  => 'text',
        'value' => '',
    ],
    'apiKey'  => [
        'title' => '密鑰(ApiKey)',
        'type'  => 'textarea',
        'value' => '',
    ],
    'signature'  => [
        'title' => '簽名(Signature)',
        'type'  => 'text',
        'value' => '',
    ],
    'TemplateCode'  => [
        'title' => '模板編號',
        'type'  => 'text',
        'value' => '',
    ],
];

```

如果插件配置比較復(fù)雜需要自定義頁面,則Demo插件的定義類需要掛載plugin_config鉤子和定義$custom_config屬性，詳見上方 入口文件-》代碼示例

控制器

插件控制器是根據(jù)前后臺模塊繼承不同的controller, 如用戶后臺繼承UserController等, 當URL中傳入插件控制器變量的時候，會自動定位到插件控制器中的操作方法。例如我們在URL中傳入：http://serverName/User/Payment/index/plugin/Demo

調(diào)用Demo插件（位于app/Plugin目錄下面）的PaymentController控制器，文件位于app/Plugin/Demo/Controller/PaymentController.class.php,插件控制器本身的定義和普通的訪問控制器一樣，例如：

```
namespace Plugin\Demo\Controller;
use Common\Controller\UserController;
class PaymentController extends UserController
{
    public function index(){
        echo 'Plugin Demo';
    }
```
}

阿帕云引擎

云引擎受控端

云引擎控制器

云引擎開放API

文檔首頁

云業(yè)務(wù)管理系統(tǒng)（國內(nèi)版）

開發(fā)說明

18+

1000+

30+

5+