プラグインのコメントアウトによる管理画面への自動代入

プラグインを管理画面から登録する際、先頭のコメントアウトに書式に従って記述することで、登録する際に必要な情報を自動的に代入してくれます。

例えば次のコメントアウトを管理画面のプラグインコードに入力したとします。

/**
 * プラグインABC
 *
 * これはリソース保存時に～を自動的に処理するプラグインです。
 *
 * @category plugins
 * @version  1.0.0
 * @license  GNU General Public License (GPL), https://www.gnu.org/licenses/gpl-3.0.html
 * @author   ShanaBrian
 * @internal @properties &ids=処理する対象のリソースID;text;123
 * @internal @modx_category Custom
 * @internal @events OnBeforeDocFormSave,OnDocFormSave
 */

こうすると、管理画面では次のように自動的に挿入されます。

メインタブにある"プラグイン名"項目は、"プラグインABC"を代入します。

設定タブにある"プラグイン設定"項目は、"@internal @properties"プロパティの値、"&ids=処理する対象のリソースID;text;123"を代入します。

システムイベントタブにある項目は、"@internal @events"プロパティの値、"OnBeforeDocFormSave"と"OnDocFormSave"に一致する項目にチェックが付きます。
@internal @eventsプロパティはカンマ区切りで指定することで、複数のイベントを指定することができます。

プロパティタブにある"カテゴリー"項目は、"@internal @modx_category"プロパティに一致する項目が選択されます。
IDではなく名称そのままの名前で指定します。

プロパティタブにある"説明"項目は、"@version"プロパティと説明文の"これはリソース保存時に～を自動的に処理するプラグインです。"を結合した値が代入されます。
バージョンはstrongタグに半角スペースを付けた値で代入されます。