バリデーションルール リファレンス¶
項目
required¶
値が入力されているかを検証します。パラメータが存在しないまたは空文字の場合はエラーとなります。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
required: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} is required. |
| ja | {0}は必須です。 |
| zh_CN | {0}为必须项目。 |
alpha¶
値がアルファベットであるかを検証します。アルファベット以外の文字が含まれている場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
alpha: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should be in alphabets. |
| ja | {0}は英字である必要があります。 |
| zh_CN | {0}必须为英文字母。 |
alphanumeric¶
値がアルファベットまたは数字であるかを検証します。アルファベットと数字以外の文字が含まれている場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
alphanumeric: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should be in alphanumeric. |
| ja | {0}は英数字である必要があります。 |
| zh_CN | {0}必须为英文字母和数字。 |
numeric¶
値が数字であるかを検証します。数字以外の文字が含まれている場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
numeric: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should be a number. |
| ja | {0}を複数指定することはできません。 |
| zh_CN | {0}必须为数字。 |
digits¶
数値の整数部、小数部の桁数を検証します。指定した桁数より大きい場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定例¶
digits: [3, 2]
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should be between integer of digit {1} and decimal of digit {2}. |
| ja | {0}は{1}桁の整数、及び{2}桁の小数の範囲である必要があります。 |
| zh_CN | {0}必须在{1}位整数、{2}位小数的范围内。 |
lowercase¶
値がアルファベット小文字であるかを検証します。アルファベット小文字以外の文字が含まれている場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
lowercase: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should contain lower case alphabets. |
| ja | {0}には英字かつ小文字である必要があります。 |
| zh_CN | {0}必须为英文小写字母。 |
uppercase¶
値がアルファベット大文字であるかを検証します。アルファベット大文字以外の文字が含まれている場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
uppercase: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should contain upper case alphabet. |
| ja | {0}には英字かつ大文字である必要があります。 |
| zh_CN | {0}必须为英文大写字母。 |
integer¶
値が整数型の数字であるかを検証します。整数型の数字ではない場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
integer: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
|---|---|
| en | {0} should be an integer. |
| ja | {0}は整数でなければなりません。 |
| zh_CN | {0}必须为整数。 |
decimal¶
値が実数型の数字であるかを検証します。実数型の数字ではない場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
decimal: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} must be a number. |
| ja | {0}は数値でなければなりません。 |
| zh_CN | {0}必须为数值。 |
minlength¶
値の最小文字数を検証します。指定した長さより文字数が小さい場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値¶
数値
設定例¶
minlength: 6
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be more than {1} character. |
| ja | {0}は{1}文字以上でなければなりません。 |
| zh_CN | {0}必须为{1}个字符以上。 |
maxlength¶
値の最大文字数を検証します。指定した長さより文字数が大きい場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値¶
数値
設定例¶
maxlength: 50
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be less than {1} character. |
| ja | {0}は{1}文字以内でなければなりません。 |
| zh_CN | {0}必须在{1}个字符以内。 |
min¶
数字の最小値を検証します。設定値より値が小さい場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値¶
数値
設定例¶
min: 6
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be a number greater than {1}. |
| ja | {0}は{1}以上の数値である必要があります。 |
| zh_CN | {0}必须为{1}以上的数值。 |
max¶
数字の最大値を検証します。設定値より値が大きい場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値¶
数値
設定例¶
max: 6
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be a number less than {1}. |
| ja | {0}は{1}以下の数値である必要があります。 |
| zh_CN | {0}必须为{1}以下的数值。 |
range¶
数字の範囲を検証します。設定値より値が大きい場合、または小さい場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定例¶
range: [0, 12]
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be between {1} and {2}. |
| ja | {0}は{1}から{2}までの範囲である必要があります。 |
| zh_CN | {0}必须在{1}至{2}的范围内。 |
email¶
値がe-mailアドレスのフォーマットであるかを検証します。e-mailアドレスのフォーマットではない場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
以下のような値をe-mailアドレスとして認識します。
foo@example.com
foo.bar@baz.org
aaa@bbb.ccc
ドットが連続していたり、@の直前にドットが存在する場合はe-mailアドレスとして認識されません。
foo..bar@baz.org
foo.@bar.org
設定値¶
trueまたはfalse
設定例¶
email: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be in the form of mail address. |
| ja | {0}はメールアドレス形式である必要があります。 |
| zh_CN | {0}必须为邮件地址形式。 |
url¶
値がURLのフォーマットであるかを検証します。URLのフォーマットではない場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
以下のような値をURLとして認識します。
http://example.com
https://foo.com
http://aaa.org:8080/bbb/ccc/
ftp://example.com
設定値¶
trueまたはfalse
設定例¶
url: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be in URL format. |
| ja | {0}はURL形式である必要があります。 |
| zh_CN | {0}必须为URL形式。 |
equals¶
値が設定値と同じ文字列であるかを検証します。設定値と同じ文字列ではない場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値¶
文字列
設定例¶
equals: 'foo'
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be equal to {1}. |
| ja | {0}は{1}と等しくなければなりません。 |
| zh_CN | {0}必须与{1}相等。 |
contains¶
値に設定値の文字列が含まれているかを検証します。設定値の文字列が含まれていない場合はエラーとなります。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値¶
文字列
設定例¶
contains: 'foo'
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should contain {1}. |
| ja | {0}には{1}が含まれている必要があります。 |
| zh_CN | {0}中必须包含{1}。 |
isIn¶
値が設定値の文字列に一致するものが有るかを検証します。設定値に一致するものが無い場合はエラーとなります。
パラメータが存在しない場合は検証を行いません。
設定値¶
[文字列1, 文字列2, ...]
設定例¶
isIn: ['foo', 'bar', 'baz']
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should have either of [{1}]. |
| ja | {0}には[{1}]のうちいずれかが含まれている必要があります。 |
| zh_CN | {0}中必须包含[{1}]中某一项目。 |
regex¶
値が正規表現に一致するかを検証します。正規表現に一致しない場合はエラーとなります。
パラメータが存在しない場合は検証を行いません。
設定値¶
正規表現オブジェクト
設定例¶
regex: /^[a-zA-Z0-9]+$/
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | Format of {0} is not correct. |
| ja | {0}の形式が正しくありません。 |
| zh_CN | {0}必须在{1}至{2}的范围内。 |
file¶
値がファイルアップロードであるかを検証します。ファイルアップロードではない場合はエラーとなります。
パラメータが存在しない場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
設定値¶
trueまたはfalse
設定例¶
file: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} is not a file. |
| ja | {0}がファイルではありません。 |
| zh_CN | {0}不是文件。 |
mimeType¶
ファイルの内容からMIME Type判別し、設定値に記述された条件に合致しているかを検証します。条件に合致しない場合はエラーとなります。
パラメータが存在しない場合は検証を行いません。
設定値¶
{
include: [文字列, 文字列, ...],
exclude: [文字列, 文字列, ...]
}
- include - 許可するMIME Type
- exclude - 除外するMIME Type
設定例¶
mimeType: {
include: ['text/html', 'application/msword'],
exclude: ['application/octet-stream']
}
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} has file format not allowed. |
| ja | {0}は許可されていないファイル形式です。 |
| zh_CN | {0}为未经许可的文件格式。 |
id¶
値がID、コード系であるかを検証します。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
ID、コード系は下記の文字で構成されている必要があります。これらの文字以外が含まれている場合エラーとなります。
- 半角英字（a-z）（A-Z）
- 半角数字（0-9）
- アンダースコア（_）
- ダッシュ（-）
- アットマーク（@）
- ドット（.）
- プラス（+）
- エクスクラメーション（!）
設定値¶
trueまたはfalse
設定例¶
id: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be in ID format. |
| ja | {0}はID形式である必要があります。 |
| zh_CN | {0}必须为ID形式。 |
userCd¶
値がユーザコードであるかを検証します。
パラメータが存在しないまたは値が空の場合は検証を行いません。
設定値がfalseの場合は検証を行いません。
ユーザコードは下記の文字で構成されている必要があります。これらの文字以外が含まれている場合エラーとなります。
- 半角英字（a-z）（A-Z）
- 半角数字（0-9）
- アンダースコア（_）
- ダッシュ（-）
- アットマーク（@）
- ドット（.）
- プラス（+）
- エクスクラメーション（!）
設定値¶
trueまたはfalse
設定例¶
userCd: true
エラーメッセージ¶
| ロケール | エラーメッセージ |
| en | {0} should be in user code format. |
| ja | {0}はユーザコード形式である必要があります。 |
| zh_CN | {0}必须为用户代码形式。 |