スニペットとその呼び出し

ここでは、テンプレートで利用できるスニペットの機能について説明します。

スニペットとは

スニペットとは、テンプレートコードの断片のことです。頻繁に利用するテンプレートの部分については、スニペットとして使い回すことが可能です。これにより、読みやすいテンプレートになります。

特に、スニペット特有の書き方はなく、テンプレートと同様の記述をしていきます。

スニペットの作成と削除

スニペットは、flamingo IDEで作成と削除することができます。また、スニペットの名前ですが、新規スニペットの作成時に決めることができます。

スニペットの呼び出し

スニペットを呼び出すには、テンプレートで次のように書きます。

<!--{ call hello_world() }-->

ここで、hello_worldというのがスニペットの名前です。さらに、スニペットの内容が次のようなものだとします。

<p>Hello, world.</p>

すると、スニペットを呼び出すごとに、“Hello, world.”が表示されます。

なお、スニペットの挿入はflamingo IDE上からも行えます。

引数をともなったスニペットの呼び出し

スニペットでは、引数をとることもできます。受け取った引数はスニペット内で、arguments[0]という形でアクセスします。

例えば、次のようなスニペットを考えます。

<p>Hello, <!--{= argument[0] }-->.</p>

この場合、以下のようにスニペットを呼び出すと、“Hello, world.”が表示されます。

<!--{ call hello("world") }-->

なお、引数は複数個とることもできます。

<!--{ call snippet(VALUE1, VALUE2, ...) }-->

この場合、スニペットでは、argument[n]という形で引数にアクセスします。ここで、nは0から引数の数だけ有効な整数です。