Pickles 2

GUI編集エンジンの種類と切り替え方法

[注意] 旧GUI編集エンジン legacy は、 Pickles 2 2.0.0-beta.17 で廃止された古い機能です。

GUI編集機能はもともと、Pickles 2 アプリケーション に固く組み込まれた特有の機能として開発されました。しかし、機能拡張を重ね、複雑化するにつれて、このことは開発上の負担になるようになってきました。

こうした背景から、GUI編集機能を単一のパッケージとして Pickles 2 アプリケーション から分離し、 broccoli-html-editor というライブラリとして独立させ、エンジンの実装もゼロから刷新されました。

GUI編集エンジンの種類

GUIエンジンは、次の種類があります。

  • legacy - 従来のエンジン (このオプションは Pickles 2 v2.0.0-beta.17 で廃止されました)
  • broccoli-html-editor - 刷新された新しいエンジン
  • broccoli-html-editor-php - broccoli-html-editor は 0.3.0 以降、バックエンド処理をPHPの実装に移行します。この設定は、新しいPHP版のエンジンに切り替えます。 (このオプションは Pickles 2 v2.0.0-beta.20 で追加されました)

エンジンの切り替え設定

GUI編集エンジンは、Pickles 2 プロジェクトの config.php の項目 $conf->plugins->px2dt->guiEngine に設定します。

設定できる値は、broccoli-html-editor (デフォルト) 、 broccoli-html-editor-php、または legacy のいずれかです。

<?php
return call_user_func( function(){

    // initialize
    $conf = new stdClass;

    /* 中略 */

    // config for Plugins.
    $conf->plugins = new stdClass;

    // config for Pickles2 Desktop Tool.
    $conf->plugins->px2dt = new stdClass;

    /* 中略 */

    /**
     * GUIエディタのエンジンの種類
     * - `legacy` = 旧GUI編集ツール。(廃止)
     * - `broccoli-html-editor` = NodeJSで実装された broccoli-html-editor を使用。
     * - `broccoli-html-editor-php` = PHPで実装された broccoli-html-editor を使用。
     */
    $conf->plugins->px2dt->guiEngine = 'broccoli-html-editor-php';

    return $conf;
} );

config.php に設定するということはつまり、個人のデスクトップツール毎ではなく、プロジェクト別の設定になります。