プラグイン（拡張アプリ）開発の基本

プラグイン（拡張アプリ）として拡張機能を作ることにより、様々な拡張を１パッケージにして、ブログ単位でインストール出来るようになります。

拡張できる機能

• 校正オプションの拡張
• フック処理の拡張
• Validatorの拡張
• 独自GETモジュールの追加
• 独自POSTモジュールの追加
• テンプレートの挿入（テンプレートの拡張）

最低限必要なファイル

プラグイン（拡張アプリ）を作るためには、以下のファイルが最低限必要になります。

• extension/plugins/プラグイン（拡張アプリ）のディレクトリ/ServiceProvider.php

ディレクトリ名は、名前空間 Acms\Plugins\{ディレクトリ名} の最後の部分と同じにしてください（例: extension/plugins/SamplePlugin/ → Acms\Plugins\SamplePlugin）。ハイフンなど、PHP の名前空間に使えない文字はディレクトリ名に使えません。ディレクトリ名と名前空間が一致しないと、アプリ管理画面に表示されません。

このファイルがあれば、最小限のプラグイン（拡張アプリ）として成立し、管理画面からインストールもできるようになります。このファイルは、アプリのバージョンや説明やインストール・アップデート時の処理や起動の初期処理を記述できるファイルになっています。詳しく見ていきましょう。

ServiceProvider.php

下のコードは、 ServiceProvider.php の 基本的なコードになります。

<?php

namespace Acms\Plugins\SamplePlugin;

use ACMS_App;

class ServiceProvider extends ACMS_App
{
    /**
     * @var string
     */
    public $version = '1.0.0';

    /**
     * @var string
     */
    public $name = 'SamplePlugin';

    /**
     * @var string
     */
    public $author = 'com.appleple';

    /**
     * @var bool
     */
    public $module = false;

    /**
     * @var bool|string
     */
    public $menu = false;

    /**
     * @var string
     */
    public $desc = 'サンプルのプラグインです。';

    /**
     * サービスの初期処理
     */
    public function init()
    {

    }

    /**
     * インストールする前の環境チェック処理
     *
     * @return bool
     */
    public function checkRequirements()
    {
        return true;
    }

    /**
     * インストールするときの処理
     * データベーステーブルの初期化など
     *
     * @return void
     */
    public function install()
    {

    }

    /**
     * アンインストールするときの処理
     * データベーステーブルの始末など
     *
     * @return void
     */
    public function uninstall()
    {

    }

    /**
     * アップデートするときの処理
     *
     * @return bool
     */
    public function update()
    {
        return true;
    }

    /**
     * 有効化するときの処理
     *
     * @return bool
     */
    public function activate()
    {
        return true;
    }

    /**
     * 無効化するときの処理
     *
     * @return bool
     */
    public function deactivate()
    {
        return true;
    }
}

プロパティ

メソッド

activate / deactivate / update の戻り値は使われません。インストールを止められるのは、checkRequirements が false を返したときだけです。install / uninstall / update / activate / deactivate の中で処理を失敗として扱いたいときは、例外（Exception）を投げてください。install が例外を投げた場合は activate は実行されず、アプリは登録されません。uninstall が例外を投げた場合は、アプリの登録は削除されません。

ポイント

• extension/plugins/ の名前空間は 「Acms\Plugins」 です。
• \ACMS_App を継承します。

これでプラグイン（拡張アプリ）開発の基本は終了です。次から実際の拡張方法について見ていきます。