Pickles 2

Custom Console Extensions

Custom Console Extensions は、 Pickles 2 アプリケーションの管理画面を拡張するAPIです。

プロジェクト側に追加することで、 プロジェクト独自のカスタマイズされた管理画面拡張機能を追加することができます。

カスタマイズされた管理画面拡張機能は、Composerパッケージから読み込むことができるので、複数のプロジェクトで共有したり、配布したり、アイデアを再利用することも容易です。

Custom Console Extensions は、Pickles 2 v2.0.0-beta.28 および pickles2/px2-px2dthelper v2.0.17 で追加されました。

構成

Custom Console Extensions は、バックエンド処理のためのPHPスクリプトと、画面を表現するJavaScript、およびスタイルシートや画像などのリソースファイル群で構成されます。

プロジェクト側に実装し、 コンフィグ $conf->plugins->px2dt->custom_console_extensions に設定します。

アプリケーションには、PXコマンドを通じてロードされます。

ファイルの構成の例を示します。

/
├ front/
│    ├ sample.css
│    ├ sample.js
│    └ images/
│        └ imageN.png
└ php/
    └ sample.php

ディレクトリ名やファイル名は任意(後述するPHP内のメソッドでファイル名を知らせます)ですが、画面を構成するフロントエンドの資材は1つのディレクトリ内にまとめて格納するようにしてください。

php/sample.php には、バックエンド処理を記述するクラスを実装します。次のコードは、任意のnamespase内に実装したクラスの命名例です。 namespaseにもクラス名にも、命名規則は特にないので、他と重複しない任意の名前を与えてください。

<?php
namespace yourVendorName\customConsoleExtensions\sample;
class main{

    /* 実装については後に詳しく説明します */

}

Composerパッケージとして配布する場合は、このクラスがロードされるように設定してください。

クラスをプロジェクトにロードしたら、Pickles 2 プロジェクトのコンフィグに次のように追記します。

<?php

return call_user_func( function(){

    // initialize
    $conf = new stdClass;

    /* 中略 */

    /**
     * CMS画面に追加するカスタム管理画面を登録する
     */
    $conf->plugins->px2dt->custom_console_extensions = array(
        'sample' => 'yourVendorName\customConsoleExtensions\sample\main',
    );

}

$conf->plugins->px2dt->custom_console_extensions に、キーと値のセットを設定します。 キーは、拡張機能のIDとして利用されます。 値には、PHPに与えたクラス名を指定します。

JavaScript関数の実装

クライアント側の初期化時には、任意のJavaScript関数名を与え、実行されます。 この関数名は任意で、後述する PHPメソッド get_client_initialize_function() から通知します。

初期化関数には、ヘルパーオブジェクト cceAgent が第1引数に与えられます。

window.yourVendorNameCustomConsoleExtensionsSample = function(cceAgent){
    const $ = require('jquery');
    let $elm = $(cceAgent.elm());

    $elm
        .append($('<p>')
            .text('管理画面拡張を読み込みました。')
        )
        .append($('<p>')
            .append($('<button class="px2-btn">')
                .text('GPIを呼び出すテスト')
                .on('click', function(){
                    alert('呼び出します。');
                    cceAgent.gpi({
                        'command': 'test-gpi-call'
                    }, function(res){
                        console.log('---- res:', res);
                    });
                })
            )
        )
    ;
}

cceAgent の機能

cceAgent.elm()

画面を描画する対象のDOM要素を取得します。

cceAgent.gpi(options, callback)

バックエンド側PHPのGPIをコールします。

第1引数の options が、PHP側では gpi() の引数として受け取ることができます。 callback には、 PHP側 gpi() の返却値が渡されます。

cceAgent.gpi({
    'command': 'test-gpi-call'
}, function(res){
    console.log('---- res:', res);
});

cceAgent.onBroadcast(callback)

PHP側 $cceAgent.broadcast() に対するコールバック関数を登録します。 バックエンドで $cceAgent.broadcast() がコールされたとき、非同期のメッセージを callback の引数として受け取ることができます。

PHPクラスの実装

PHPクラスには、予め決められたメソッドが実装されている必要があります。

<?php
namespace yourVendorName\customConsoleExtensions\sample;
class main{

    /** $px */
    private $px;

    /** $json */
    private $json;

    /** $cceAgent */
    private $cceAgent;

    /**
     * コンストラクタ
     */
    public function __construct($px, $json, $cceAgent){
        $this->px = $px;
        $this->json = $json;
        $this->cceAgent = $cceAgent;
    }

    /**
     * 管理機能名を取得する
     */
    public function get_label(){
        return 'サンプル機能拡張';
    }

    /**
     * フロントエンド資材の格納ディレクトリを取得する
     */
    public function get_client_resource_base_dir(){
        return __DIR__.'/../front/';
    }

    /**
     * 管理画面にロードするフロント資材のファイル名を取得する
     */
    public function get_client_resource_list(){
        $rtn = array();
        $rtn['css'] = array();
        array_push($rtn['css'], 'sample.css');
        $rtn['js'] = array();
        array_push($rtn['js'], 'sample.js');
        return $rtn;
    }

    /**
     * 管理画面を初期化するためのJavaScript関数名を取得する
     */
    public function get_client_initialize_function(){
        return 'window.yourVendorNameCustomConsoleExtensionsSample';
    }

    /**
     * General Purpose Interface (汎用API)
     */
    public function gpi($request){
        switch($request->command){
            case 'test-gpi-call':
                $this->cceAgent->async(array(
                    'type'=>'gpi',
                    'request' => array(
                        'command' => 'test-async',
                    ),
                ));
                return 'Test GPI Call Successful.';
        }
        return false;
    }
}

$cceAgent の機能

$cceAgent->async($commandSettings)

非同期の処理を実行します。

例えば Pickles 2 のパブリッシュなどの、1つの処理に長い時間がかかる処理を実行したい場合に利用します。 処理は、クライアントからのリクエストに待たせることなく非同期的に実行されます。

$cceAgent->broadcast($message)

クライアント側のJavaScriptへ、非同期のメッセージを送信します。