ホーム>PHPソースコード>その他のカテゴリー
ダウンロード

verum php

verum php (ファイル サポートを使用して) 配列を簡単に検証できるようにする PHP のサーバー側検証ライブラリです。カスタム エラー メッセージ、ルール、組み込みの翻訳が付属しており、依存関係はありません。

PHP 用のサーバー側検証ライブラリ

  • 配列の検証 (ファイルサポートあり)
  • カスタムエラーメッセージ
  • カスタムルール
  • 組み込みの翻訳
  • 依存関係ゼロ

目次

  1. はじめる
  2. 使用法
  3. カスタム検証
  4. 利用可能なルール
  5. 貢献する
  6. 質問
  7. ライセンス

はじめる

インストール

Composer を使用してverum phpインストールする

composer require sandromiguel/verum-php

使用法

簡単な使用例

簡単な登録フォーム (名前、電子メール、年齢) を検証します。 

 use Verum  Validator ;

$ rules = [
    ' name ' => [
        ' rules ' => [
            ' required ' ,
        ],
    ],
    ' email ' => [
        ' rules ' => [
            ' required ' ,
            ' email ' ,
        ],
    ],
    ' age ' => [
        ' rules ' => [
            ' numeric ' ,
        ],
    ],
];

$ validator = new Validator ( $ _POST , $ rules );

echo json_encode (
    [
        ' valid '  => $ validator -> validate (),
        ' errors ' => $ validator -> getErrors (),
    ]
);
有効なフォームの例

入力： 

[
    'name' => 'John Doe',
    'email' => '[email protected]',
    'age' => '20',
]

出力： 

{
    "valid" : true ,
    "errors" : []
}
無効なフォームの例

入力： 

[
    'name' => '',
    'email' => 'some text',
    'age' => 'some text',
]

出力： 

{
    "valid" : false ,
    "errors" : {
        "name" : {
            "label" : null ,
            "rules" : {
                "required" : " This field is required. "
            }
        },
        "email" : {
            "label" : null ,
            "rules" : {
                "email" : " This field must be a valid email address. "
            }
        },
        "age" : {
            "label" : null ,
            "rules" : {
                "numeric" : " This field must be numeric. "
            }
        }
    }
}

RuleEnumクラスを使用する

RuleEnumクラスを使用して、すべてのルール名にアクセスできます。 

 use Verum  Validator ;
use Verum  Enum  RuleEnum ;

$ rules = [
    ' name ' => [
        ' rules ' => [
            RuleEnum:: REQUIRED ,
        ],
    ],
    ...
];

フィールドのラベルを指定します (入力の名前付け) 

 $ rules = [
    ' name ' => [
        ' label ' => ' Name ' ,
        ' rules ' => [
            RuleEnum:: REQUIRED ,
        ],
    ],
    ...
];

出力： 

{
    ...
    "errors" : {
        "name" : {
            "label" : " Name " ,
            "rules" : {
                "required" : 'The "Name" field is required.'
            }
        },
        ...
    }
}

言語ごとにフィールドラベルを指定する

 $ rules = [
    ' name ' => [
        ' label ' => [
            ' en ' => ' Name ' ,
            ' pt-pt ' => ' Nome ' ,
        ],
        ' rules ' => [
            RuleEnum:: REQUIRED ,
        ],
    ],
    ...
];

出力 (pt-pt): 

{
    ...
    "errors" : {
        "name" : {
            "label" : " Nome " ,
            "rules" : {
                "required" : 'O campo "Nome" é obrigatório.'
            }
        },
        ...
    }
}

メッセージ言語を指定する

いくつかの組み込みの翻訳を使用できます。

  • 'en' -> 英語 (デフォルト)
  • 'nl-nl' -> オランダ語
  • 'pt-pt' -> ポルトガル語-ポルトガル語
  • 'pt-br' -> ポルトガル語-ブラジル
 $ validator = new Validator ( $ _POST , $ rules , ' pt-pt ' );

LangEnumクラスを使用してメッセージ言語を指定する

 use Verum  Validator ;
use Verum  Enum  LangEnum ;

. . .

$ validator = new Validator ( $ _POST , $ rules , LangEnum:: PT_PT );

カスタム エラー メッセージを指定する

  • デフォルトのエラー メッセージをオーバーライドするのに役立ちます。
  • ローカライゼーションに役立ちます。 
 . . .
$ validator = new Validator ( $ _POST , $ rules );
$ validator -> addSimpleCustomMessage ( ' min_length ' , ' Min Length rule custom error message ' );
. . .

出力例: 

{
    ...
    "errors" : {
        "name" : {
            "label" : " Name " ,
            "rules" : {
                "min_length" : " Min Length rule custom error message "
            }
        },
        ...
    }
}

プレースホルダーを使用してカスタム エラー メッセージを指定する

 . . .
$ validator = new Validator ( $ _POST , $ rules );
$ validator -> addSimpleCustomMessage ( ' min_length ' , ' Number of characters detected: {param:1}. Field name: "{param:2}". ' );
. . .

出力例: 

{
    ...
    "errors" : {
        "name" : {
            "label" : " Name " ,
            "rules" : {
                "min_length" : 'Number of characters detected: 5. Field name: "Name".'
            }
        },
        ...
    }
}

ラベルの有無にかかわらずフィールドにカスタム エラー メッセージを指定する

 . . .
$ validator = new Validator ( $ _POST , $ rules );
$ validator -> addCustomMessage (
    ' required ' ,
    ' Custom error message with label for required rule. Label: {param:1}. ' ,
    ' Custom error message without label for required rule. '
);
. . .

出力 - ラベルのあるフィールド: 

{
    ...
    "errors" : {
        "name" : {
            "label" : " Name " ,
            "rules" : {
                "required" : 'Custom error message with label for required rule. Label: Name.'
            }
        },
        ...
    }
}

出力 - ラベルのないフィールド: 

{
    ...
    "errors" : {
        "name" : {
            "label" : null ,
            "rules" : {
                "required" : " Custom error message without label for required rule. "
            }
        },
        ...
    }
}

複数のカスタム エラー メッセージを一度に指定する

 . . .
$ validator = new Validator ( $ _POST , $ rules );
$ validator -> addCustomMessages (
    [
        ' min_length ' => ' Custom message for the "min_length" rule. ' ,
        ' required ' => ' Custom message for the "required" rule. ' ,
        // other messages ...
    ]
);
. . .

ラベルの有無にかかわらずフィールドに複数のカスタム エラー メッセージを一度に指定する

 . . .
$ validator = new Validator ( $ _POST , $ rules );
$ validator -> addCustomMessages (
    [
        ' numeric ' => [
            ' withLabel ' => ' Custom message with label for "numeric" rule. Label: {param:1}. ' ,
            ' withoutLabel ' => ' Custom message without label for "numeric" rule. ' ,
        ],
        ' min_length ' => [
            ' withLabel ' => ' Custom message with label for "min_length" rule. Label: {param:2}, value: {param:1}. ' ,
            ' withoutLabel ' => ' Custom message without label for "min_length" rule. Value: {param:1}. ' ,
        ],
        // other messages ...
    ]
);
. . .

複数の名前フィールドの処理

verum phpを使用すると、複数名のフィールドをより効率的に処理できます。これらは、言語識別子または名前のその他のバリエーションを含むフィールドです。たとえば、 title.en 、 title.pt 、 description.en 、 description.ptなどのフィールドがある場合、ワイルドカードを使用してそれらのルールを指定できます。 

 $ rules = [
    ' title.* ' => [
        ' rules ' => [
            RuleEnum:: REQUIRED ,
        ],
    ],
    ' description.* ' => [
        ' rules ' => [
            RuleEnum:: REQUIRED ,
            RuleEnum:: MIN_LENGTH => 10 ,
        ],
    ],
];

$ validator = new Validator ( $ _POST , $ rules );
// ...

出力例: 

{
    "valid" : false ,
    "errors" : {
        "title.en" : {
            "label" : null ,
            "rules" : {
                "required" : " This field is required. "
            }
        },
        "title.pt" : {
            "label" : null ,
            "rules" : {
                "required" : " This field is required. "
            }
        },
        "description.en" : {
            "label" : null ,
            "rules" : {
                "required" : " This field is required. " ,
                "min_length" : " This field must be at least 10 characters long. "
            }
        },
        "description.pt" : {
            "label" : null ,
            "rules" : {
                "required" : " This field is required. " ,
                "min_length" : " This field must be at least 10 characters long. "
            }
        }
    }
}

カスタム検証

カスタム検証を使用して、エラー メッセージを挿入できます。 

 if ( $ myCustomValidationFail ) {
    $ validator -> addError (
        ' someFieldName ' ,
        ' Some field name ' ,
        [ ' no_duplicate ' => ' A user already exists with that username ' )]
    );
    // ...
}

利用可能なルール

  1. アルファ
  2. 英数字
  3. 間
  4. between_length
  5. ブール値
  6. 含まれています
  7. 日付
  8. 電子メール
  9. 等しい
  10. ファイルの最大サイズ
  11. ファイル_mime_type
  12. float_number
  13. 画像の最大高さ
  14. 画像の最大幅
  15. 画像の最小高さ
  16. 画像の最小幅
  17. 整数
  18. ip
  19. IPv4
  20. IPv6
  21. 最大
  22. 最大長
  23. 分
  24. min_length
  25. 数値
  26. 正規表現
  27. 必須
  28. ナメクジ
  29. URL

アルファ

値に英字のみが含まれているかどうかを確認します。 

 $ rules = [
    ' nickname ' => [
        ' label ' => ' Nickname ' ,
        ' rules ' => [
            RuleEnum:: ALPHA ,
        ],
    ],
];
価値アルファアルファ + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text' ✔️ ✔️
'text with spaces'

英数字

値に英数字のみが含まれているかどうかを確認します。 

 $ rules = [
    ' nickname ' => [
        ' label ' => ' Nickname ' ,
        ' rules ' => [
            RuleEnum:: ALPHA_NUMERIC ,
        ],
    ],
];
価値英数字英数字 + 必須
null ✔️
'' ✔️
'0' ✔️ ✔️
0 ✔️ ✔️
false
[]
-1
1 ✔️ ✔️
true
'text' ✔️ ✔️
'text with spaces'

間

値が 2 つの値の間にあるかどうかを確認します。 

 $ rules = [
    ' age ' => [
        ' label ' => ' Age ' ,
        ' rules ' => [
            RuleEnum:: BETWEEN => [ 12 , 29 ],
        ],
    ],
];
価値[1, 10] の間[1, 10] + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1 ✔️ ✔️
true
'some text'

between_length

値の文字数が最小値と最大値の間にあるかどうかを確認します。 

 $ rules = [
    ' nickname ' => [
        ' label ' => ' Nickname ' ,
        ' rules ' => [
            RuleEnum:: BETWEEN_LENGTH => [ 3 , 15 ],
        ],
    ],
];
価値between_length [5,25] between_length [5,25] + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
12345 ✔️ ✔️
true
'text'
'text with 23 characters' ✔️ ✔️

ブール値

値がブール値であるかどうかを確認します。 1/0、'1'/'0'、'on'/'off'、'yes'/'no'、true/false の場合は true を返します。 

 $ rules = [
    ' light ' => [
        ' label ' => ' Light ' ,
        ' rules ' => [
            RuleEnum:: BOOLEAN_VALUE ,
        ],
    ],
];
価値ブール値ブール値 + 必須
null ✔️
'' ✔️
'0' ✔️ ✔️
0 ✔️ ✔️
false ✔️ ✔️
[]
-1
'1' ✔️ ✔️
1 ✔️ ✔️
true ✔️ ✔️
'text'
'on' ✔️ ✔️
'off' ✔️ ✔️
'yes' ✔️ ✔️
'no' ✔️ ✔️

含まれています

値が配列内にあるかどうかを確認します。 

 $ rules = [
    ' priority ' => [
        ' label ' => ' Priority ' ,
        ' rules ' => [
            RuleEnum:: CONTAINS => [ ' low ' , ' high ' ],
        ],
    ],
];
価値['低','高'] を含む['low','high'] + 必須を含む
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'low' ✔️ ✔️
'high' ✔️ ✔️

日付

値が有効な日付 (Ymd) であるか、カスタム形式であるかを確認します。

デフォルト形式 (Ymd) 

 $ rules = [
    ' dob ' => [
        ' label ' => ' Date of birth ' ,
        ' rules ' => [
            RuleEnum:: DATE ,
        ],
    ],
];

カスタム形式 (egdmY) 

 $ rules = [
    ' dob ' => [
        ' label ' => ' Date of birth ' ,
        ' rules ' => [
            RuleEnum:: DATE => [ ' d.m.Y ' ],
        ],
    ],
];
価値日付[年]日付 [Ymd] + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'2020-09-30' ✔️ ✔️

電子メール

値が有効な電子メール形式であるかどうかを確認します。 

 $ rules = [
    ' email ' => [
        ' label ' => ' Email ' ,
        ' rules ' => [
            RuleEnum:: EMAIL ,
        ],
    ],
];
価値電子メールメールアドレス + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'[email protected]' ✔️ ✔️

等しい

値が他の値と等しいかどうかを確認します。 

 $ rules = [
    ' repeat_password ' => [
        ' label ' => ' Repeat Password ' ,
        ' rules ' => [
            RuleEnum:: EQUALS => [ ' password ' ],
        ],
    ],
];

'text'との比較

価値等しい等しい + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text' ✔️ ✔️
'another text'

ファイルの最大サイズ

ファイルサイズが指定された値を超えていないかどうかを確認します。

値をバイト単位で入力します。 

 $ rules = [
    ' profile_photo ' => [
        ' label ' => ' Profile Photo ' ,
        ' rules ' => [
            RuleEnum:: FILE_MAX_SIZE => [ 102400 ],
        ],
    ],
];

102400バイトとの比較

価値ファイルの最大サイズfile_max_size + 必須
null ✔️
50000 ✔️ ✔️
150000

ファイル_mime_type

ファイルの種類が許可されているかどうかを確認します。 

 $ rules = [
    ' profile_photo ' => [
        ' label ' => ' Profile Photo ' ,
        ' rules ' => [
            RuleEnum:: FILE_MIME_TYPE => [ ' image/png ' , ' image/jpeg ' ],
        ],
    ],
];
価値ファイル_mime_type file_mime_type + 必須
null ✔️
image/png ✔️ ✔️
text/plain

float_number

値が浮動小数点数であるかどうかを確認します。 

 $ rules = [
    ' price ' => [
        ' label ' => ' Price ' ,
        ' rules ' => [
            RuleEnum:: FLOAT_NUMBER ,
        ],
    ],
];
価値float_number float_number + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
12345
123.45 ✔️ ✔️
true
'text'
'text with spaces'

画像の最大高さ

画像の高さが指定された値を超えていないかどうかを確認します。 

 $ rules = [
    ' profile_photo ' => [
        ' label ' => ' Profile Photo ' ,
        ' rules ' => [
            RuleEnum:: IMAGE_MAX_HEIGHT => [ 600 ],
        ],
    ],
];
価値画像の最大高さimage_max_height + 必須
null ✔️
500ピクセル✔️ ✔️
1000ピクセル

画像の最大幅

画像の幅が指定された値を超えていないかどうかを確認します。 

 $ rules = [
    ' profile_photo ' => [
        ' label ' => ' Profile Photo ' ,
        ' rules ' => [
            RuleEnum:: IMAGE_MAX_WIDTH => [ 1000 ],
        ],
    ],
];
価値画像の最大幅image_max_width + 必須
null ✔️
500ピクセル✔️ ✔️
1500ピクセル

画像の最小高さ

画像の高さが指定された値以上かどうかを確認します。 

 $ rules = [
    ' profile_photo ' => [
        ' label ' => ' Profile Photo ' ,
        ' rules ' => [
            RuleEnum:: IMAGE_MIN_HEIGHT => [ 300 ],
        ],
    ],
];
価値画像の最小高さimage_min_height + 必須
null ✔️
100ピクセル
500ピクセル✔️ ✔️

画像の最小幅

画像の幅が指定された値以上かどうかを確認します。 

 $ rules = [
    ' profile_photo ' => [
        ' label ' => ' Profile Photo ' ,
        ' rules ' => [
            RuleEnum:: IMAGE_MIN_WIDTH => [ 500 ],
        ],
    ],
];
価値画像の最小幅image_min_width + 必須
null ✔️
400ピクセル
600ピクセル✔️ ✔️

整数

値が整数であるかどうかを確認します。 

 $ rules = [
    ' distance ' => [
        ' label ' => ' Distance ' ,
        ' rules ' => [
            RuleEnum:: INTEGER ,
        ],
    ],
];
価値数値数値 + 必須
null ✔️
'' ✔️
'0'
0 ✔️ ✔️
false
[]
-1 ✔️ ✔️
1 ✔️ ✔️
true
'text'

ip

値が有効な IP アドレスかどうかを確認します。 

 $ rules = [
    ' ip ' => [
        ' label ' => ' IP ' ,
        ' rules ' => [
            RuleEnum:: IP ,
        ],
    ],
];
価値ip IP + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'10.10.10.10' ✔️ ✔️
'2607:f0d0:1002:51::4' ✔️ ✔️

IPv4

値が有効な IPv4 アドレスであるかどうかを確認します。 

 $ rules = [
    ' ipv4 ' => [
        ' label ' => ' IPv4 ' ,
        ' rules ' => [
            RuleEnum:: IPV4 ,
        ],
    ],
];
価値IPv4 IPv4 + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'10.10.10.10' ✔️ ✔️
'2607:f0d0:1002:51::4'

IPv6

値が有効な IPv6 アドレスであるかどうかを確認します。 

 $ rules = [
    ' ipv6 ' => [
        ' label ' => ' IPv6 ' ,
        ' rules ' => [
            RuleEnum:: IPV6 ,
        ],
    ],
];
価値IPv6 IPv6 + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'10.10.10.10'
'2607:f0d0:1002:51::4' ✔️ ✔️

最大

値が指定された値を超えていないかどうかを確認します。 

 $ rules = [
    ' people ' => [
        ' label ' => ' People ' ,
        ' rules ' => [
            RuleEnum:: MAX => [ 5 ],
        ],
    ],
];
価値最大最大 + 必須
null ✔️
'' ✔️
'0' ✔️ ✔️
0 ✔️ ✔️
false
[]
-1 ✔️ ✔️
1 ✔️ ✔️
true
'text'
12345
'12345'

最大長

値の文字数が指定された値を超えていないかどうかを確認します。 

 $ rules = [
    ' nickname ' => [
        ' label ' => ' Nickname ' ,
        ' rules ' => [
            RuleEnum:: MAX_LENGTH => [ 2 ],
        ],
    ],
];
価値最大長max_length + 必須
null ✔️
'' ✔️
'0' ✔️ ✔️
0 ✔️ ✔️
false ✔️ ✔️
[]
-1 ✔️ ✔️
1 ✔️ ✔️
true ✔️ ✔️
'text'
12345
'12345'

分

値が指定された値以上かどうかを確認します。 

 $ rules = [
    ' people ' => [
        ' label ' => ' People ' ,
        ' rules ' => [
            RuleEnum:: MIN => [ 2 ],
        ],
    ],
];
価値分最小 + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
12345 ✔️ ✔️
'12345' ✔️ ✔️

min_length

値の文字数が指定された値以上かどうかを確認します。 

 $ rules = [
    ' nickname ' => [
        ' label ' => ' Nickname ' ,
        ' rules ' => [
            RuleEnum:: MIN_LENGTH => [ 2 ],
        ],
    ],
];
価値最大長max_length + 必須
null ✔️
''
'0'
0
false
[]
-1 ✔️ ✔️
1
true
'text' ✔️ ✔️
12345 ✔️ ✔️
'12345' ✔️ ✔️

数値

値が数値かどうかを確認します。 

 $ rules = [
    ' age ' => [
        ' label ' => ' Age ' ,
        ' rules ' => [
            RuleEnum:: NUMERIC ,
        ],
    ],
];
価値数値数値 + 必須
null ✔️
'' ✔️
'0' ✔️ ✔️
0 ✔️ ✔️
false
[]
-1 ✔️ ✔️
1 ✔️ ✔️
true
'text'

正規表現

値が指定された正規表現と一致するかどうかを確認します。 

 $ rules = [
    ' path ' => [
        ' label ' => ' Path ' ,
        ' rules ' => [
            RuleEnum:: REGEX => [ ' //client/[0-9a-f]+$/ ' ],
        ],
    ],
];

'//client/[0-9a-f]+$/'パターンによる検証

価値正規表現正規表現 + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'/client/77c9e105d1f548b29958f0512967de87' ✔️ ✔️
'/client/invalid-uuid'

必須

値が空でないかどうかを確認します。 

 $ rules = [
    ' name ' => [
        ' label ' => ' Name ' ,
        ' rules ' => [
            RuleEnum:: REQUIRED ,
        ],
    ],
];
価値必須
null
''
'0' ✔️
0 ✔️
false ✔️
[]
-1 ✔️
1 ✔️
true ✔️
'some text' ✔️

ナメクジ

値が有効なスラッグ (例: hello-world_123) かどうかを確認します。 

 $ rules = [
    ' slug ' => [
        ' label ' => ' Slug ' ,
        ' rules ' => [
            RuleEnum:: SLUG ,
        ],
    ],
];
価値ナメクジナメクジ + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text' ✔️ ✔️
'text with spaces'
'hello-world_123' ✔️ ✔️

URL

値が有効な URL かどうかを確認します。 

 $ rules = [
    ' url ' => [
        ' label ' => ' URL ' ,
        ' rules ' => [
            RuleEnum:: URL ,
        ],
    ],
];
価値URL URL + 必須
null ✔️
'' ✔️
'0'
0
false
[]
-1
1
true
'text'
'http://www.some-domain.com' ✔️ ✔️

貢献する

貢献したいですか？すべての貢献を歓迎します。貢献ガイドをお読みください。

質問

質問がある場合は、@sandro_m_m までツイートしていただくか、問題を開いてください。

ライセンス

このプロジェクトは MIT ライセンスに基づいてライセンスされています - 詳細については LICENSE ファイルを参照してください

**~ 共有することは思いやりです ~**

拡大する
追加情報
関連アプリ
おすすめ
関連情報 すべて