Zend Frameworkの標準バリデータ

Zend Framework 1.5.1に標準で実装されているバリデータについてまとめてみました。

1. Zend_Validate_Alnum
2. Zend_Validate_Alpha
3. Zend_Validate_Barcode
4. Zend_Validate_Between
5. Zend_Validate_Ccnum
6. Zend_Validate_Date
7. Zend_Validate_EmailAddress
8. Zend_Validate_Float
9. Zend_Validate_GreaterThan
10. Zend_Validate_Hex
11. Zend_Validate_Hostname
12. Zend_Validate_Identical
13. Zend_Validate_InArray
14. Zend_Validate_Int
15. Zend_Validate_Ip
16. Zend_Validate_LessThan
17. Zend_Validate_NotEmpty
18. Zend_Validate_Regex
19. Zend_Validate_StringLength
20. メッセージファイルの例(TXT形式)

値がアルファベットあるいは数字であることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets default option values for this instance
     *
     * @param  boolean $allowWhiteSpace
     * @return void
     */
    public function __construct($allowWhiteSpace = false)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notAlnum	'%value%' has not only alphabetic and digit characters
stringEmpty	'%value%' is an empty string

値がアルファベットであることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets default option values for this instance
     *
     * @param  boolean $allowWhiteSpace
     * @return void
     */
    public function __construct($allowWhiteSpace = false)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notAlpha	'%value%' has not only alphabetic characters
stringEmpty	'%value%' is an empty string

値が指定された形式のバーコードであることをチェックします。
コンストラクタは以下のとおりです。
1.5.1では$barcodeTypeには'upc'または'ean13'を指定できます。

    /**
     * Generates the standard validator object
     *
     * @param  string $barcodeType - Barcode validator to use
     * @return void
     * @throws Zend_Validate_Exception
     */
    public function __construct($barcodeType)

$barcodeTypeに'upc'を指定した場合のエラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
invalid	'%value%' is an invalid UPC-A barcode
invalidLength	'%value%' is an invalid UPC-A barcode

$barcodeTypeに'ean13'を指定した場合のエラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
invalid	'%value%' is an invalid EAN-13 barcode
invalidLength	'%value%' should be 13 characters

値がある範囲であることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  mixed   $min
     * @param  mixed   $max
     * @param  boolean $inclusive
     * @return void
     */
    public function __construct($min, $max, $inclusive = true)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notBetween	'%value%' is not between '%min%' and '%max%', inclusively
notBetweenStrict	'%value%' is not strictly between '%min%' and '%max%'

値がLuhnアルゴリズム(10の剰余のチェックサム)を満たすクレジットカード番号(13-19桁の数値)であることをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
ccnumLength	'%value%' must contain between 13 and 19 digits
ccnumChecksum	Luhn algorithm (mod-10 checksum) failed on '%value%'

値が指定されたフォーマット(デフォルトはYYYY-MM-DD)の日付であることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  string             $format OPTIONAL
     * @param  string|Zend_Locale $locale OPTIONAL
     * @return void
     */
    public function __construct($format = null, $locale = null)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
dateNotYYYY-MM-DD	'%value%' is not of the format YYYY-MM-DD
dateInvalid	'%value%' does not appear to be a valid date
dateFalseFormat	'%value%' does not fit given date format

値が数字であることをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notDigits	'%value%' contains not only digit characters
stringEmpty	'%value%' is an empty string

値がメールアドレスであることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Instantiates hostname validator for local use
     *
     * You can pass a bitfield to determine what types of hostnames are allowed.
     * These bitfields are defined by the ALLOW_* constants in
 Zend_Validate_Hostname
     * The default is to allow DNS hostnames only
     *
     * @param integer                $allow             OPTIONAL
     * @param bool                   $validateMx        OPTIONAL
     * @param Zend_Validate_Hostname $hostnameValidator OPTIONAL
     * @return void
     */
    public function __construct($allow = Zend_Validate_Hostname::ALLOW_DNS,
        $validateMx = false, Zend_Validate_Hostname $hostnameValidator = null)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
emailAddressInvalid	'%value%' is not a valid email address in the basic format local-part@hostname
emailAddressInvalidHostname	'%hostname%' is not a valid hostname for email address '%value%'
emailAddressInvalidMxRecord	'%hostname%' does not appear to have a valid MX record for the email address '%value%'
emailAddressDotAtom	'%localPart%' not matched against dot-atom format
emailAddressQuotedString	'%localPart%' not matched against quoted-string format
emailAddressInvalidLocalPart	'%localPart%' is not a valid local part for email address '%value%'

値がfloat値であることをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notFloat	'%value%' does not appear to be a float

値が指定された値より大きいことをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  mixed $min
     * @return void
     */
    public function __construct($min)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notGreaterThan	'%value%' is not greater than '%min%'

値が16進数であることをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notHex	'%value%' has not only hexadecimal digit characters

値がホスト名であることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param integer          $allow       OPTIONAL Set what types of hostname
 to allow (default ALLOW_DNS)
     * @param boolean          $validateIdn OPTIONAL Set whether IDN domains are
 validated (default true)
     * @param boolean          $validateTld OPTIONAL Set whether the TLD element
 of a hostname is validated (default true)
     * @param Zend_Validate_Ip $ipValidator OPTIONAL
     * @return void
     * @see http://www.iana.org/cctld/specifications-policies-cctlds-01apr02.htm
  Technical Specifications for ccTLDs
     */
    public function __construct($allow = self::ALLOW_DNS, $validateIdn = true,
         $validateTld = true, Zend_Validate_Ip $ipValidator = null)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
hostnameIpAddressNotAllowed	'%value%' appears to be an IP address, but IP addresses are not allowed
hostnameUnknownTld	'%value%' appears to be a DNS hostname but cannot match TLD against known list
hostnameDashCharacter	'%value%' appears to be a DNS hostname but contains a dash (-) in an invalid position
hostnameInvalidHostnameSchema	'%value%' appears to be a DNS hostname but cannot match against hostname schema for TLD '%tld%'
hostnameUndecipherableTld	'%value%' appears to be a DNS hostname but cannot extract TLD part
hostnameInvalidHostname	'%value%' does not match the expected structure for a DNS hostname
hostnameInvalidLocalName	'%value%' does not appear to be a valid local network name
hostnameLocalNameNotAllowed	'%value%' appears to be a local network name but local network names are not allowed

値が指定された値と同一であることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  string $token
     * @return void
     */
    public function __construct($token = null)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notSame	Tokens do not match
missingToken	No token was provided to match against

値が指定された配列に含まれることをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  array   $haystack
     * @param  boolean $strict
     * @return void
     */
    public function __construct(array $haystack, $strict = false)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notInArray	'%value%' was not found in the haystack

値がint型であることをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notInt	'%value%' does not appear to be an integer

値がIPアドレスであることをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notIpAddress	'%value%' does not appear to be a valid IP address

値が指定された値より小さいことをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  mixed $max
     * @return void
     */
    public function __construct($max)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
notLessThan	'%value%' is not less than '%max%'

値が空でないことをチェックします。
コンストラクタのパラメータはありません。
エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
isEmpty	Value is empty, but a non-empty value is required

値が正規表現に合致することをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  string $pattern
     * @return void
     */
    public function __construct($pattern)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
regexNotMatch	'%value%' does not match against pattern '%pattern%'

文字列の長さをチェックします。
コンストラクタは以下のとおりです。

    /**
     * Sets validator options
     *
     * @param  integer $min
     * @param  integer $max
     * @return void
     */
    public function __construct($min = 0, $max = null)

エラーメッセージの種類は以下のとおりです。

エラーメッセージキー	初期エラーメッセージ
stringLengthTooShort	'%value%' is less than %min% characters long
stringLengthTooLong	'%value%' is greater than %max% characters long

翻訳が悪いですが日本語版のサンプルです。チェックはしてません。こちらからダウンロードできます。

notAlnum;'%value%'に英数字以外の文字が含まれます
stringEmpty;'%value%'が空文字です
notAlpha;'%value%'に英字以外の文字が含まれます
invalid;'%value%'が無効なUPC-A形式のバーコードです
invalidLength;'%value%'が無効なUPC-A形式のバーコードです
notBetween;'%value%'が'%min%'から'%max%'の範囲にありません
notBetweenStrict;'%value%'が'%min%'以上'%max%'以下ではありません
ccnumLength;'%value%'は13桁から19桁ではありません
ccnumChecksum;'%value%'はLuhnアルゴリズム(10の剰余のチェックサム)に失敗しました
dateNotYYYY-MM-DD;'%value%'がYYYY-MM-DD形式ではありません
dateInvalid;'%value%'が有効な日付ではありません
dateFalseFormat;'%value%'が指定された日付の形式に合致しません
notDigits;'%value%'に数字以外の文字が含まれます
emailAddressInvalid;'%value%'がlocal-part@hostname形式のメールアドレスではありません
emailAddressInvalidHostname;メールアドレス('%value%')のホスト名('%hostname%')が有効なホスト名ではありません
emailAddressInvalidMxRecord ;メールアドレス('%value%')のホスト名('%hostname%')はDNS上にMXレコードがありません
emailAddressDotAtom;'%localPart%'はdot-atom形式ではありません
emailAddressQuotedString;'%localPart%'はquoted-string形式ではありません
emailAddressInvalidLocalPart;メールアドレス('%value%')のローカル部('%localPart%')が有効な形式ではありません
notFloat;'%value%'が小数ではありません
notGreaterThan;'%value%'が'%min%'以下です
notHex;'%value%'に16進数文字列以外の文字が含まれます
hostnameIpAddressNotAllowed;'%value%'はIPアドレスのようですが、IPアドレスは指定できません
hostnameUnknownTld;ホスト名('%value%')がTLDに合致しません
hostnameDashCharacter;ホスト名('%value%')に記述されたダッシュ'-'の位置が無効です
hostnameInvalidHostnameSchema;('%tld%')が無効な形式です
hostnameUndecipherableTld;ホスト名('%value%')にTLDがありません
hostnameInvalidHostname;'%value%'は無効な形式のDNSホスト名です
hostnameInvalidLocalName;'%value%'は無効な形式のローカルネットワーク名です
hostnameLocalNameNotAllowed;'%value%'はローカルネットワーク名ですが、ローカルネットワーク名は記述できません
notSame;トークンと合致しません
missingToken;検証するトークンが指定されていません
notInArray;'%value%'がリスト中にありませんでした
notInt;'%value%'が整数ではありません
notIpAddress;'%value%'が有効なIPアドレスではありません
notLessThan;'%value%'が'%max%'以上です
isEmpty;値は空ですが必須項目です
regexNotMatch;'%value%'がパターン('%pattern%')に合致しません
stringLengthTooShort;'%value%'が%min%文字未満です
stringLengthTooLong;'%value%'が%max%文字を超えています