開発(PHP):リソースに設定してあるテンプレート変数の情報を取得
リソースに設定してあるテンプレート変数の情報を取得するには、$modx->getTemplateVarメソッドを使用します。
構文
戻り値 = $modx->getTemplateVar(変数IDまたは変数名, 取得する情報, リソースID, 公開/非公開);
| 引数名 | 型 | 初期値 | 説明 | |
|---|---|---|---|---|
| 第一引数 必須 |
変数IDまたは変数名 | string | 取得したいテンプレート変数またはリソース変数のIDまたは名前。 | |
| 第二引数 | 取得する情報 | string | '*' | 取得する情報のキー。 ' *'を指定すると全てを取得する。valueは必ず返すのでそれ以外を指定する。
|
| 第三引数 | リソースID | integer | テンプレート変数の情報を取得する対象のリソース。 空を指定すると現在のリソースを対象とする。 |
|
| 第四引数 | 公開/非公開 | integer | 1 | 対象のリソースが公開か非公開のどちらかの場合のみ取得する。 指定可能な値は次の通り。 0 ... 非公開1 ... 公開 |
戻り値
取得に成功した場合は連想配列、失敗した場合はfalseを返します。
テンプレート変数とリソース変数で取得可能な情報が違います。
| キー | 説明 |
|---|---|
| id | テンプレート変数のID。 |
| type | "入力フォーム"で選択した値。 |
| name | テンプレート変数の名称。 |
| caption | "投稿画面内の見出し"のテキスト。 |
| description | 説明文章。 |
| editor_type | ※ 不明 |
| category | 選択したカテゴリーのインデックス番号。 |
| locked | ロックしているかどうか。 0 ... ロックしていない 1 ... ロック中 |
| elements | 選択フィールドの全選択肢。 |
| rank | 並び順。 |
| display | "プロセッサ"で選択した値。 |
| display_params | "プロセッサ"のURLパラメータ。 |
| default_text | 既定値。 |
| value | リソースに設定されている値。 |
| キー | 説明 |
|---|---|
| name | リソース変数の名称。 |
| value | リソースに設定されている値。 |
サンプルコード
$result = $modx->getTemplateVar('tel');
if (preg_match('/^[\d\-]+$/', $result['value'])) {
...
}