PowerCMS ブログ

今回は PowerCMS のカスタムフォーム機能 (Contact Form アドオン) で、フォームやフォーム項目の情報を利用して HTML フォームを作成するテンプレートのヒントを紹介します。

ウェブページのアーカイブテンプレートでフォームの設定値を利用する

ウェブページに対して種類がフォームのカスタムフィールドを作成して紐付け、そのカスタムフィールドの名前を「ウェブページのフォーム」、テンプレートタグを「<$MTPageForm$>」とします。また、ウェブページやフォームの HTML はウェブページのアーカイブテンプレートで出力します。

このとき、ウェブページの編集画面で [ウェブページのフォーム] フィールドに選択されたフォームの名前を、ウェブページやフォームの HTML に出力するためのテンプレートについて考えてみます。

<MTIf tag="PageForm">
  <h1><$MTContactFormName encode_html="1"$></h1>
  <$MTPageForm$>
</MTIf>

フォームの名前を2行目のテンプレートタグ <$MTContactFormName$> で得ようとしましたが、ウェブページのアーカイブテンプレートで、フォームのブロックタグ内部ではなく、有効なコンテキストはウェブページのみなので、このタグは使用できず、再構築エラーになってしまいます。

テンプレートのコンテキストと使用できるテンプレートタグについては、Movable Type Q&A『「MTEntryTitleをコンテキスト外で利用しようとしています」とエラーが出て再構築できない。』を参照してください。

「フォームのブロックタグ」と前述しましたが、作成したフォームのカスタムフィールドのテンプレートタグ (<$MTPageForm$>) は、基本的にファンクションタグとして機能するもので、ブロックタグとして記述してもフォームのコンテキストを得ることはできません。ウェブページのアーカイブテンプレートでフォームのコンテキストを得たうえで、フォームの名前を出力するテンプレートは次のようになります。

<MTIf tag="PageForm">
  <MTPageCustomFields include="ウェブページのフォーム">
    <$MTPageCustomFieldValue setvar="page_form_id"$>
    <MTIf name="page_form_id">
      <MTContactForms id="$page_form_id">
        <MTIf name="__first__">
          <h1><$MTContactFormName encode_html="1"$></h1>
        </MTIf>
      </MTContactForms>
    </MTIf>
  </MTPageCustomFields>
  <$MTPageForm$>
</MTIf>

ブロックタグ <MTPageCustomFields> で ID の数値が得られるので、これをブロックタグ <MTContactForms> に渡し特定することで「フォームのブロックタグ」を実現することができました。

7行目のフォーム名を出力するところ (<$MTContactFormName$>) では、次のテンプレートタグを利用することができます。

例えばフォームの投稿数を得るには5行目から9行目を次のように置き換えます。

<MTIf tag="PageForm">
  <MTPageCustomFields include="ウェブページのフォーム">
    <$MTPageCustomFieldValue setvar="page_form_id"$>
    <MTIf name="page_form_id">
      <$MTPageID setvar="object_id"$>
      <$MTBlogID setvar="blog_id"$>
      <$MTFeedbackCount form_id="$page_form_id" model="page" object_id="$object_id"
                        blog_id="$blog_id" _default="0"$>
    </MTIf>
  </MTPageCustomFields>
  <$MTPageForm$>
</MTIf>

ちなみに通知メールのテンプレートでは暗黙でいくつかのテンプレート変数が定義されているので、次のようなテンプレートで投稿数を出力できます。

<$MTContactFormID setvar="form_id"$>
<$MTFeedbackCount form_id="$form_id" model="page" object_id="$object_id" blog_id="$blog_id"$>

フォームのみに一元管理すべき情報がウェブページのアーカイブテンプレートで利用可能となることで、「フォームにもウェブページにも同じ情報の2重入力を強いる設計」を防ぐとか、「1つのフォームが複数のウェブページから参照されている状況」でフォームの情報を有効活用するとかいった可能性が期待できます。

フォーム項目のテンプレートでフォーム項目の設定値を利用する

フォーム項目のテンプレートでは暗黙でいくつかのテンプレート変数が定義されています。

また、利用可能なテンプレートタグの一部は次の通りです。

暗黙で定義されていない設定値が必要なときは、テンプレートタグ <$MTFormElementColumn$> で取得することができます。よく使いそうな例として、フォーム項目の設定を利用して <input> 要素に maxlength 属性値や required 属性の出し分けをするテンプレートは次のようになります。

<$MTFormElementColumn column="check_length"    setvar="field_check_length"$>
<$MTFormElementColumn column="max_length"      setvar="field_max_length"$>
<$MTFormElementColumn column="count_multibyte" setvar="field_count_multibyte"$>
<p><$MTVar name="field_name" encode_html="1"$>:
<input
  name=<$MTVar name="field_basename"$>
  type=<$MTFormElementType setvar="field_type" _default="text"$>
<MTIfFormElementRequired>
  required
</MTIfFormElementRequired>
<MTIf name="field_check_length">
  <MTIf name="field_max_length" like="/\A[1-9]\d*\z/">
  maxlength=<$MTVar name="field_max_length"$>
  </MTIf>
</MTIf>
>

さあ帰ろう。