PowerCMS™

MTSetVar

MTSetVar

変数を定義して値を設定します。変数を呼び出すときは、MTGetVar, MTVar ファンクションタグを利用します。

また設定した値は $name_foo として、モディファイアの値としても利用することができます。

変数の名前に、ハイフンを利用すると、$name_fooのような$を利用したモディファイアを正常に評価できません。このため、ハイフンの利用はお控え下さい。

使い方

<MTSetVar name="foo" value="bar">

モディファイア

name="name_foo"

変数の名前を指定します。

value="bar"

変数の値を指定します。

append="0 | 1"

値に 1 を設定すると、変数に代入されている値の後に、値を連結します。

prepend="0 | 1"

値に 1 を設定すると、変数に代入されている値の前に、値を連結します。

op
index

配列のインデックス(添え字)を指定します。

配列変数が存在しない場合は指定された名前の配列変数を新しく作成します。このとき index に 0 以外を指定すると、sparse array を作成します。

<MTSetVar name="foo" index="0" value="x">

このMTタグは、以下のようにも書くことができます。

<MTSetVar name="foo[0]" value="x">

名前[添え字] という記述が index モディファイアの代わりです。

key

ハッシュのキーを指定します。

ハッシュ変数が存在しない場合は指定された名前のハッシュ変数を新しく作成して、キーと値のペアを設定します。

<MTSetVar name="bar" key="a" value="x">

このMTタグは、以下のようにも書くことができます。

<MTSetVar name="bar{a}" value="x">

名前{キー} という記述が key モディファイアの代わりです。

function

配列やハッシュ変数に値を設定するときに実行する関数の名前を指定します。利用できる名前は以下のとおりです。

  • push - 配列変数の一番上(または一番最後)に新しい値を追加します。
  • unshift - 配列変数の一番下(または一番最初)に新しい値を追加します。
  • undef - 配列またはハッシュ変数をクリアします。
  • delete - key モディファイアで指定されたキーと値のペアをハッシュ変数から削除します。
<MTSetVar name="foo" function="push" value="x">

このMTタグは、以下のようにも書くことができます。

<MTSetVar name="push(foo)" value="x">

関数名(名前) という記述が function モディファイアの代わりです。

MTSetVar と関連のあるテンプレートタグ (8)