MODx Evolutionのウィジェットを拡張する方法

ウィジェットファイルの作成

ウィジェット名.class.inc.phpという名前でファイルを作成します。ウィジェット名は、以降で作成するウィジェットクラスのクラス名の一部になります。

ウィジェットクラスの作成

MODxWidgetクラスを継承したクラスを作成します。

クラス名はMODxWidgetウィジェット名(先頭1文字を大文字化)とします。ウィジェット名は、ファイルのウィジェット名と一致していなければなりません。

<?php
class MODxWidgetDelim extends MODxWidget
{
}

ウィジェットの設定

ウィジェットクラスにプロパティを追加して、ウィジェットのカテゴリー、表示名、プロパティを定義します。

<?php
class MODxWidgetDelim extends MODxWidget
{
    var $category = 'Formats';  // カテゴリー
    var $name = 'Delimited List';  // 表示名
    var $properties = '&format=Delimiter;string;,';  // プロパティ
}

ここで定義したカテゴリーと表示名はテンプレート変数の編集画面に表示されます。また、ウィジェットのプロパティはテンプレート変数の編集画面で展開され、ウィジェットの設定用フォームとして表示されます。

フォームによるウィジェットの設定が不要な場合はvar $properties = null;とするか、$properties自体を省略できます。

ウィジェットの処理

ウィジェットの処理をgetTVDisplayFormatメソッドに記述します。

<?php
class MODxWidgetDelim extends MODxWidget
{
    var $category = 'Formats';  // カテゴリー
    var $name = 'Delimited List';  // 表示名
    var $properties = '&format=Delimiter;string;,';  // プロパティ

    function getTVDisplayFormat($name, $value, $params = array(), $tvtype = '', $docid = '', $sep ='')
    {
        $value = $this->parseInput($value, '||');
        $p = $params['format'] ? $params['format'] : ',';
        if ($p == "\\n") $p = "\n";
        $o = str_replace('||', $p, $value);

        return $o;
    }
}

$nameにテンプレート変数名、$valueにテンプレート変数の値、$paramsにウィジェットの設定(連想配列)、$tvtypeにテンプレート変数の入力タイプ、$docidにドキュメントID、$seqにセパレーター文字列が渡されます。

処理の流れとしては、(必要であれば)parseInputメソッドでテンプレート変数の値をパースし、整形・出力結果を戻り値として返すだけです。

ウィジェットファイルの転送

作成したウィジェットファイルを/assets/widgets/に転送します。テンプレート変数の編集画面を開くと、追加したウィジェットが表示されます。