1.2. Liquid の使用方法

3scale のデベロッパーポータルでは、以下の 3 種類の Liquid マークアップを使用することができます。

Liquid ドロップ、タグ、およびフィルターは Liquid の使用方法 に記載のロジックタグおよびアウトプットタグに類似しています。

Liquid ドロップは最も基本的な構造で、ほとんどのケースで使用されます。これを使用して、ユーザー名やアプリケーション ID などの、システムに保管されている特定の値にアクセスすることができます。インタープリターは、他のアウトプットタグと同様にこのマークアップを処理します。

一方、Liquid タグはロジックタグの一種で、より高度なカスタマイズのためにシステムの特定部分をレンダリングしたり、アクセスしたりするのに使用されます (例: レイアウト内のコンテンツのレンダリング、メールテンプレートのカスタマイズ)。

フィルターは、ドロップからの結果の見直し、値の変換、および特定のキーによるグルーピングのオプションを有効にします。標準 Liquid フィルターのグループ (Shopify の Web サイト を参照) および特殊な 3scale 内部フィルターのグループ (Liquid リファレンス セクションに記載) があります。

コンテキストは、現在のページで使用可能な変数 (ドロップ) を記述します。基本セットには以下の変数が含まれます。

これらの変数は、メールテンプレートを除きデベロッパーポータル全体を通じてすべてのページで利用可能です。ただし、ほとんどの組み込みページでは、いくつかの追加変数を利用することができます。たとえば、ユーザーの編集フォームでは user 変数が利用可能です (current_user ではなく。ユーザーの編集ページでは、ユーザーの ID は既知の情報です)。現在のページで利用可能な変数を確認するために、特別なタグ {% debug:help %} が用意されています。使用することのできるすべての最上位変数のリストが、ページソースのコメントとして追加されます。

コンテキストの結果として、Liquid ドロップは階層構造で整理されます。使用可能な変数のセットは、使用できる最上位ドロップのリストを示します。これらを使用して、階層内のより深い位置にある要素にアクセスすることができます。たとえば、ログインしているユーザーのユーザー名を表示する場合は、{{ current_user.username }} と記述します。

より下層のドロップを表示するのは、これより若干複雑です。ユーザーのアプリケーションの名前だけを表示すると仮定します。リファレンスガイドを見ると、メソッド アプリケーション がアカウントドロップの一部であることが分かります。つまり、アプリケーションは単一アプリケーションのタグの配列です。ユーザーに複数のアプリケーションが許可されている場合は、ロジックタグを使用してそれぞれのアプリケーションについて処理を繰り返す必要があります。そうでなければ、アカウントの最初の (そして唯一の) アプリケーションを参照することができます。これを表示するコードは {{ current_account.applications.first.name }} のようになります。