MODxモジュールを作る際に参照する変数メモ
2010-11-1213:01
ただいま、cfFormMailerと連携するちょっとしたモジュールを作成中なのですが、
それの制作の際に必要となった変数を、今後のために備忘録としてメモっておきます。
$content
モジュールの情報が格納されている連想配列です。参照時にはglobal $content;としてグローバル宣言しておきます。
なお、"enable_resource"はモジュール管理画面のHTMLソースではCSSにより非表示となっています。
$modx->event->params
「モジュール設定」の情報が展開された連想配列です。
じつは設定情報はモジュールが実行される前にexract()関数により変数として展開されており、
モジュールコードからは、そのまま変数として使えますが、
モジュール本体を外部ファイルにしている場合などは、いちいち変数を引き継ぐのが面倒なので(笑)
この変数を参照するようにしています。
$_style
管理画面テーマで使用しているアイコンなどのファイルパス、またはコードが格納されている連想配列です。
こちらも参照の際はグローバル宣言が必要です。
全部は多いのでよく使う(と思う)ものだけ抜粋します。
この変数が定義されているのは/manager/media/style/テーマ名/style.php なので、他の値はこのファイルを参照してください。
それの制作の際に必要となった変数を、今後のために備忘録としてメモっておきます。
$content
モジュールの情報が格納されている連想配列です。参照時にはglobal $content;としてグローバル宣言しておきます。
- id: モジュールID
- name: モジュール名
- description: モジュールの説明
- editor_type: 未使用?
- disabled: モジュールを停止(1・・・停止)
- category: カテゴリ
- wrap: 行の折り返し
- locked: Administrator(ロールID1)のみ編集可能
- icon: アイコンファイルパス
- enable_resource: 外部ファイルを有効に(未使用?)
- resource_file: 未使用?
- createdon: 作成日時(UNIXタイム)
- editedon: 更新日時(UNIXタイム)
- guid: Globally Unique ID
- enable_sharedparams: 共有パラメータを使用
- properties: モジュール設定
- modulecode: モジュールコード
なお、"enable_resource"はモジュール管理画面のHTMLソースではCSSにより非表示となっています。
$modx->event->params
「モジュール設定」の情報が展開された連想配列です。
じつは設定情報はモジュールが実行される前にexract()関数により変数として展開されており、
モジュールコードからは、そのまま変数として使えますが、
モジュール本体を外部ファイルにしている場合などは、いちいち変数を引き継ぐのが面倒なので(笑)
この変数を参照するようにしています。
$_style
管理画面テーマで使用しているアイコンなどのファイルパス、またはコードが格納されている連想配列です。
こちらも参照の際はグローバル宣言が必要です。
全部は多いのでよく使う(と思う)ものだけ抜粋します。
この変数が定義されているのは/manager/media/style/テーマ名/style.php なので、他の値はこのファイルを参照してください。
- icons_save: 保存やOKなど (※MODxCarbonテーマでは、save以外にaddやedit_documentでも同一です。)
- icons_refresh: 再読込アイコン
- icons_cancel: キャンセルアイコン
- icons_delete: 削除アイコン
- icons_close: 閉じるアイコン (※MODxCarbonテーマではcancelと同一です)
- icons_working: 注意アイコン
- icons_preview_resource: 表示アイコン
- ajax_loader: ローディングアイコン
カテゴリ:MODx | トラックバック (0)