エスケープ

エスケープとは？

モジュールや変数、ブロックはエスケープすることが可能です。 a-blog cms の「エスケープ」とは、モジュールや変数、ブロックを一時的に動かないようにして、処理を遅らせることを指します。エスケープする際に、処理を遅らせる単位はモジュール1回分になります。（モジュールの入れ子1回分）

これによりカスタムフィールドを動的に生成できたり、柔軟なテンプレートを作成できるようになります。

それでは、モジュール・変数・ブロックのエスケープの仕方を確認し、最後に利用方法の例とともに解説します。

モジュールのエスケープをする方法
変数のエスケープをする方法
ブロックのエスケープをする方法
エスケープを使った利用方法の解説

モジュールのエスケープをする方法

通常は内側から実行されますが、モジュールを入れ子する場合は「モジュールのエスケープ」を使うことにより、外側のモジュールから実行できるようになります。

この「モジュールのエスケープ」と「モジュールのコンテキスト指定」を組み合わせることで、例えば Blog_ChildList と Entry_List を組み合わせて、ブログ毎にエントリー一覧を出力するようなことが出来ます。サイトマップの動的作成などに便利です。

<!-- BEGIN_MODULE Blog_ChildList -->
<ul class="acms-list-group">
  <!-- BEGIN blog:loop -->
  <li>
    <a href="{url}" class="acms-list-group-item">ブログ: {name}</a>
    <!-- BEGIN_MODULE\ Entry_List ctx="bid/{id}" -->
    <div class="acms-margin-bottom-medium">
      <ul class="acms-list-group">
        <!-- BEGIN\ entry:loop -->
        <li><a href="\{url\}" class="acms-list-group-item">\{title\}</a></li>
        <!-- END\ entry:loop -->
      </ul>
    </div>
    <!-- END_MODULE\ Entry_List -->
  </li>
  <!-- END blog:loop -->
</ul>
<!-- END_MODULE Blog_ChildList -->

上記ソースコードの実装の解説

通常であればEntry_Listが実行されてからBlog_ChildListが実行されますが、モジュールのエスケープを使うことでBlog_ChildListが実行された後、Entry_Listが実行されます。Entry__Listを呼び出すモジュールの記述ではbid/{id}と外部コンテキストが指定されていますが、Entry_Listの実行順序をBlog_ChildListの後に実行することにより、Blog_ChildListの{id}が使用可能になることで、Blog_ChildListで一覧になっているブログの数の分だけEntry_Listが作成できます。

変数のエスケープをする方法

中かっこの前にバックスラッシュを挿入し、変数のエスケープができます。

実際の書き方は以下のソースコードを参考にしてください。

\{hoge\}

またバックスラッシュの数により、エスケープする数を指定できます。

\\{hoge\\} <!-- エスケープ 2回 -->

ブロックのエスケープをする方法

BEGINやENDの後にバックスラッシュを挿入し、ブロックのエスケープができます。※ブロックのエスケープは変数のエスケープと挿入位置が異なるのでご注意ください。

<!-- BEGIN\ hoge --> ... <!-- END\ hoge -->

またバックスラッシュの数により、エスケープする数を指定できます。

<!-- BEGIN\\hoge --> ... <!-- END\\ hoge --> <!-- エスケープ 2回 -->