実装編6 - エラークラス

本ページでは、エラークラスについて解説します。

espar form では、バリデーション で解説した入力エラー以外に、サーバエラーなど環境要因で発生する各種エラーを補足する仕組みも備えています。エラー発生時に特定のクラス名を含むhtml要素を指定していると、そのエラーに対応した文言が表示されるようになります。

全てのエラーに対応する必要はありませんが、以下に推奨される設定とエラークラス全仕様を示します。

 

推奨のエラークラス設定

以下のエラークラスの設定は最低限推奨されます。

<p class="[フォームID]-m-token-expire">フォームの有効期限が切れました。一度最初からお試し下さい。</p>
<p class="[フォームID]-m-mail-error [フォームID]-m-token-error">未定義のエラーが発生しました。申し訳ございませんが info [at] example.com に直接メールをお送り頂くか、0120-12-3456 までお電話下さい。</p>

例えば管理画面上でのフォームIDが espfEsparFormMonitor である場合、以下のようになります。

<p class="espfEsparFormMonitor-m-token-expire">フォームの有効期限が切れました。一度最初からお試し下さい。</p>
<p class="espfEsparFormMonitor-m-mail-error espfEsparFormMonitor-m-token-error">未定義のエラーが発生しました。申し訳ございませんが info [at] example.com に直接メールをお送り頂くか、0120-12-3456 までお電話下さい。</p>

<p>タグである必要はありません。

 

エラークラス一覧

以下に espar form が備える全エラークラスの一覧を示します。本内容は、特段詳細を理解する必要はありません。よく分からない場合は上記の「推奨のエラークラス設定」に記載の内容のみ指定して下さい。

クラス	必須	説明
[フォームID]-m-token-expire	◯	トークンの期限切れエラー文言
[フォームID]-m-token-error	◯	トークンが発行できない（サーバの応答がない場合も含む）のエラー文言
[フォームID]-m-mail-error	◯	メール送信失敗のエラー文言
[フォームID]-m-token-invalid		APIキーまたはフォームIDのエラー文言
[フォームID]-m-token-forbidden		リファラが許可されていないエラー文言
[フォームID]-m-rate-limit		連続送信制限エラーによるメール送信失敗のエラー文言
[フォームID]-m-unknown-error		未定義のエラー文言