Tripletail::Validator - 値の検証の一括処理

# NAME

Tripletail::Validator - 値の検証の一括処理

# SYNOPSIS

      my $validator = $TL->newValidator;
      $validator->addFilter(
        {
          name  => 'NotBlank',
          email => 'Email',
          optionemail => 'Blank;Email',  # 入力しなくてもOKとする
          password => 'CharLen(4,8);Password',
        }
      );
      my $error = $validator->check($form);

# DESCRIPTION

Formオブジェクト値の検証の一括処理を行う。

# METHODS

$TL->newValidator

        $validator = $TL->newValidator

  Tripletail::Validator オブジェクトを作成。

addFilter

        $validator->addFilter(
          {
            name  => 'NotBlank',
            email => 'Email',
            optionemail => 'Empty;Email',  # 入力しなくてもOKとする
            password => 'CharLen(4,8);Password',
          }
        )

  バリデータにフィルタを設定する。 検証対象となるフォームのキーに対し、フィルタリストを指定する。

  フィルタ指定形式としては、

        FilterName(args)[message]

  を、「;」区切りとする。 「(args)」や、「[message]」は省略可能。 「(args)」を省略した場合は、それぞれのフィルタによりデフォルトのチェックを行う。 「[message]」を省略した場合は、checkの戻り時にフィルタ名を返す。

check

        $error = $validator->check($form)

  設定したフィルタを利用して、フォームの値を検証する。

  それぞれのフォームのキーに対してエラーがあれば、「[message]」、もしくは指定がない場合はフィルタ名を値としたハッシュリファレンスを返す。 エラーがなければ、そのキーは含まれない。

getKeys

        @keys = $validator->getKeys

  現在設定されているフィルタのキー一覧を返す。

## フィルタ一覧

### 組み込みフィルタ

Empty

  値が空（存在しないか0文字）であることをチェックし、そうであれば以降の判定を中止し、検証OKとする。

  Email等の形式である必要があるが、入力が任意であるような項目のチェックに使用する。

NotEmpty

  値が空（存在しないか0文字）でないことをチェックする。

  値の形式を問わないが、入力必須としたい場合に使用する。

NotWhitespace

  半角/全角スペース、タブのみでないことをチェックする。 値が空（存在しないか0文字）の場合は検証NGとなる。

Blank

  値が空（存在しないか0文字）、半角/全角スペース、タブのみであることをチェックし、そうであれば以降の判定を中止し、検証OKとする。

  Email等の形式である必要があるが、入力が任意であるような項目のチェックに使用する。空白のみなら入力無しとみなす。

NotBlank

  値が空（存在しないか0文字）、半角/全角スペース、タブのみでないことをチェックする。

  値の形式を問わないが、入力必須としたい場合に使用する。空白のみなら入力無しとみなす。

PrintableAscii

  文字列が制御コードを除くASCII文字のみで構成されているかチェックする。 値が空（存在しないか0文字）なら検証NGとなる。

Wide

  文字列が全角文字のみで構成されているかチェックする。 値が空（存在しないか0文字）なら検証NGとなる。

Password

  文字列が半角の数字、アルファベット大文字、小文字、記号を 全て最低1ずつ含んでいるかチェックする。 値が空（存在しないか0文字）なら検証NGとなる。

ZipCode

  7桁の郵便番号（XXX-XXXX形式）かチェックする。

  実在する郵便番号かどうかは確認しない。

TelNumber

  電話番号（/^\d[\d-]+\d$/）かチェックする。

  数字で始まり、数字で終わり、その間が数字とハイフン(-)のみで構成されていれば電話番号とみなす。

Email

  メールアドレスとして正しい形式かチェックする。

MobileEmail

  メールアドレスとして正しい形式かチェックする。

  但し携帯電話のメールアドレスでは、アカウント名の末尾にピリオドを含んでいる場合がある為、これも正しい形式であるとみなす。

  携帯電話キャリアのドメイン名を判別するわけではないため、通常のメールアドレスも正しい形式であるとみなす。

Integer($min,$max)

  整数で、かつ$min以上$max以下かチェックする。指定値は省略可能。

  デフォルトでは、最大最小のチェックは行わなず整数であれば正しい形式であるとみなす。

  値が空（存在しないか0文字）なら検証NGとなる。

Real($min,$max)

  整数もしくは小数で、かつ$min以上$max以下かチェックする。指定値は省略可能。

  デフォルトでは、最大最小のチェックは行わなず、整数もしくは小数であれば正しい形式であるとみなす。

  値が空（存在しないか0文字）なら検証NGとなる。

Hira

  平仮名だけが含まれているかチェックする。

  値が空（存在しないか0文字）なら検証NGとなる。

Kata

  片仮名だけが含まれているかチェックする。

  値が空（存在しないか0文字）なら検証NGとなる。

ExistentDay

  YYYY-MM-DDで設定された日付が実在するかチェックする。

Gif
Jpeg
Png

  それぞれの形式の画像かチェックする。

  画像として厳密に正しい形式であるかどうかは確認しない。

HttpUrl($mode)

  "http://" で始まる文字列かチェックする。

  $modeにs を指定した場合、"https://" で始まる文字列も正しい形式とみなす。

HttpsUrl

  "https://" で始まる文字列かチェックする。

Len($min,$max)

  バイト数の範囲が指定値以内かチェックする。 指定がない場合はチェックを行わない。

SjisLen($min,$max)

  Shift-Jisでのバイト数の範囲が指定値以内かチェックする。指定がない場合はチェックを行わない。

CharLen($min,$max)

  文字数の範囲が指定値以内かチェックする。 指定値がない場合はチェックを行わない。

Portable

  機種依存文字以外を含んでいないかチェックする。

  値が空（存在しないか0文字）なら検証OKとなる。

IpAddress

        IpAddress($checkmask)

  $checkmaskに対して、設定されたIPアドレスが一致すれば1。そうでなければundef。

  $checkmaskは空白で区切って複数個指定する事が可能。

  例：'10.0.0.0/8 172.16.0.0/12 192.168.0.0/16 127.0.0.1 fe80::/10 ::1'。

Enum($a,$b,$c)

  値が指定値のいずれかであることをチェックする。指定値がない場合にはいずれにも該当しないとみなす。

Or($filter1|$filter2|$filter3)

  指定のフィルタのいずれかに該当するかをチェックする。指定値がない場合にはいずれにも該当しないとみなす。

RegExp($regexp)

  指定の正規表現に該当するかをチェックする。指定値がない場合には、エラー。

### ユーザー定義フィルタについて

組み込みフィルタに含まれないフィルタを、ユーザーで実装し、組み込むことができる。

#### フィルタの構築

Tripletail::Validator::Filterクラスを継承し、doFilterメソッドをオーバーライドする。

doFilterメソッドに渡される引数は、以下の通り。

$this

  フィルタオブジェクト自身

$values

  チェック対象となる値の配列の参照。

$args

  フィルタに与えられる引数。

doFilterメソッドの戻り値をスカラで評価し、その復帰値が真で且つ リファレンスでなければ検証NGと判断する。 偽であれば、そのフィルタは通過して次のフィルタに。 リファレンスであればそのキーは検証OKとして、そのキーの検証を終了する。

#### フィルタの組み込み

IniパラメータのValidatorグループに、

      フィルタ名 = フィルタクラス名

として指定する。

#### 例

チェック対象となる値の配列に、'Test'以外の文字列が含まれていればエラー。

TestFilter.pm

        package TestFilter;
        use Tripletail;

        use base qw{Tripletail::Validator::Filter};

        sub doFilter {
          my $this   = shift;
          my $values = shift;
          my $args   = shift;

          return grep { $_ ne 'Test' } @$values > 0;
        }

Iniファイル

        [Validator]
        Test = TestFilter

使い方

        $validator->addFilter(
          {
            test => 'Test',
          }
        )

# SEE ALSO

Tripletail
Tripletail::Value

# AUTHOR INFORMATION

Copyright 2006 YMIRLINK Inc. All Rights Reserved.

This framework is free software; you can redistribute it and/or modify it under the same terms as Perl itself

このフレームワークはフリーソフトウェアです。あなたは Perl と同じライセンスの 元で再配布及び変更を行うことが出来ます。

Address bug reports and comments to: tl@tripletail.jp

HP : http://tripletail.jp/

Tripletail::Validator - 値の検証の一括処理

# INDEX

- $TL->newValidator
- $args
- $this
- $values
- AUTHOR INFORMATION
- Blank
- CharLen($min,$max)
- DESCRIPTION
- Email
- Empty
- Enum($a,$b,$c)
- ExistentDay
- Gif
- Hira
- HttpUrl($mode)
- HttpsUrl
- Iniファイル
- Integer($min,$max)
- IpAddress
- Jpeg
- Kata
- Len($min,$max)
- METHODS
- MobileEmail
- NAME
- NotBlank
- NotEmpty
- NotWhitespace
- Or($filter1|$filter2|$filter3)
- Password
- Png
- Portable
- PrintableAscii
- Real($min,$max)
- RegExp($regexp)
- SEE ALSO
- SYNOPSIS
- SjisLen($min,$max)
- TelNumber
- TestFilter.pm
- Tripletail
- Tripletail::Value
- Wide
- ZipCode
- addFilter
- check
- getKeys
- フィルタの構築
- フィルタの組み込み
- フィルタ一覧
- ユーザー定義フィルタについて
- 使い方
- 例
- 組み込みフィルタ

Tripletail::Validator - 値の検証の一括処理