れぶろぐ

2007-11-30 (金)

■ Piece Framework のバリデーションテンプレート機能

Piece_Right 1.8.0 以降では、バリデーションテンプレートという機能が追加され、バリデーションのルールがこんな風に書けるようになった。

Common.yaml

- name: String
  required:
    message: %_description% is required
  validator:
    - name: Length
      rule:
        min: 1
        max: 255
      message: The length of %_description% must be less than %max% characters

Registration.yaml

- name: firstName
  description: First Name
  basedOn: String

- name: lastName
  description: Last Name
  basedOn: String

ここでふと感じた疑問。 String のところに required という条件があるけれど、これは String フィールドの入力が必須、という意味になってしまったりしないのだろうか？ということで実験をしてみた。

Common.yaml をテンプレートとして使った場合
Common.yaml の内容を Registration.yaml にコピーし、１つのバリデーション定義ファイルとして使った場合

それぞれの場合について、getFieldNames() メソッドでフィールド名のリストを見てみると、１番の場合は firstName と lastName だけだが、２番の場合は String というフィールドも存在してしまっている。

つまり、バリデーションテンプレートの機能を使いたければ、その分のルールは、必ず Common.yaml のような別ファイルに保存しておかなければいけないということか。

ついでにもう１つ別の実験。

- name: fullName
  description: Full Name
  basedOn: String
  validator:
    - name: Length
      rule:
        min: 1
        max: 1000
      message: The length of %_description% must be less than %max% characters

こう書いた場合、テンプレートの Length の条件が上書きされるわけではなく、 Length の条件をもう１つ追加するという意味になるようだ。つまり、このフィールドに対して 500 文字入力すると、 1～255 文字というテンプレートの方の条件に引っかかってエラーになる。

Tags: Piece |