プラグインのスケルトンの作成 (PluginStarterプラグイン)

PluginStarterプラグインを利用すると、PowerCMS Xのプラグインのスケルトンが管理画面から簡単に作成できるようになります。

プラグイン開発に関するドキュメント

設置とインストール

  • pluginsディレクトリに PluginStarterディレクトリを設置します。
  • システムのプラグインの管理画面で、PluginStarterにチェックを入れて有効化します。
  • スキーマ管理画面から「plugin_skeleton」モデルを選択してアップグレードします。

プラグインひな形の作成

プラグインひな形の作成(スクリーンショット)

  • システムオブジェクトメニューから「プラグインひな形」を選択し、一覧画面に遷移します。
  • 「新しいプラグインひな形」をクリックして作成画面に遷移します。

入力内容と指定可能な項目

  • 名前 : 必須です。ここに入力された値がプラグインフォルダ・PHPのクラス名となります。既存のプラグイン名や PHPのクラス名として利用されている名前は指定できません。
  • バージョン : 必須です。
  • 作成者 / 作成者URL : プラグイン管理画面の一覧に表示されます。
  • 説明 : プラグイン管理画面の一覧に表示されます。ユーザー言語が英語でない時、日本語の説明欄が表示されます。
  • 環境変数 : config.json ファイル内の「config_settings」に指定する値を複数設定できます。プラグイン名を小文字(lowercase)にしたものにアンダーバー(_)を加えたものをプレフィックスとして指定します。
  • プラグイン設定 : プラグイン管理画面の一覧に「設定」ボタンを追加して、管理画面で設定可能な値を複数設定できます。プラグイン名を小文字(lowercase)にしたものにアンダーバー(_)を加えたものをプレフィックスとして指定します。この設定がある時、エクスポートファイルに tmplディレクトリが生成され、config_settings.tmplが生成されます。
  • メソッド : __modeパラメタに指定して、管理画面から呼び出せるメソッドを指定します。メニューに表示させるかどうかを選択できます。
  • テンプレート・タグ : 「ブロックタグ」「条件タグ」「ファンクションタグ」「グローバルモディファイア」を作成します。説明欄に入力することで、エクスポートファイルに docsディレクトリが生成され、tag_reference.jsonが生成されます。
  • フック : アプリケーション実行時の各処理のタイミングに処理を割り込ませる「フック」を作成します。
  • タスク : worker.php 実行時に実行する「スケジュール・タスク」を作成します。
  • カスタム編集タイプ : オブジェクトの作成・編集画面のカラムごとのビューを指定する「編集タイプ」を追加します。この項目を指定すると、エクスポートファイルに alt-tmpl/include/editディレクトリが作成され、キー.tmpl ファイルが生成されます。
  • バリデーション : 管理画面、フォームそれぞれの項目ごとのバリデーションを作成します。
  • コールバック : 特定のモデルのオブジェクトや管理画面のビューの処理に対応するコールバック処理を追加します。「オブジェクト」「公開(再構築)」「ログイン・ログアウト」「その他(メール送信やプラグインで独自に追加しているコールバックに対応する処理)」が指定できます。
  • モデル : 管理画面で作成したモデルをします。モデルを指定すると、エクスポートファイルに modelsディレクトリが生成され、モデル定義の JSONファイルを含められます。

一時保存とエクスポート

作成・編集画面の下部のボタンクリックで、保存やエクスポート(ZIPファイル)を行うことができます。

保存・削除・リビジョンとして保存・エクスポートボタン