Download the PHP package wscore/validator without Composer

Validation

A validation component for,

• a single value as well as arrays,
• nested form inputs,
• one-to-many form inputs, and
• multi-byte support (i.e. Japanese),

License

MIT License

Installation

t.b.w.

Simple Usage

Validating a Value

Create a ValidationBuilder instance, then create a validator;

• To create a validation, do: $vb->{type}($option_array).
  • type: type of validation, as defined in the subsequent section.
  • option_array: array of options. StringLength is a filter (also called validator).
  • multiple: boolean. optional. to validate against a multiple (i.e. array) value.
  • type: string. optional. can specify type in the option as well.
  • filters: array. deprecated way to specify filters.
  • all other options are considered as filters.

The $result contains the validation status and validated value.

Validating a Form Input

Another way to create a validation, do: $vb($option_array), where the type maybe specified in $option_array.

The $result contains child result for each element in the form.

Nested Form

Simply add another form object in a form object.

A valid input may look like;

One-To-Many Forms

use addRepeatedForm method to add a one-to-many form in another form.

A valid input may look like:

Validating an Array

To validate an array input, specify multiple when constructing a chain, as;

The filters, such as StringLength in the example above, will be applied to each of the value in the array.

To apply filters on to the whole array, specify filters as such;

Locale

specify locale (i.e. 'en', 'ja', etc.) when building the ValidationBuilder:

Or specify the folder in which the builder can find the message and type definition files:

The folder must contain: validation.message.php and validation.types.php files.

validation.message.php

A php file that returns an array of error messages,

validation.types.php

A php file that returns an array of filters for each type,

Predefined Types

t.b.w.

Text

• Validates a valid UTF-8 string, maximum 1MB of string.
• predefined filters:
  • ValidateUtf8String
  • DefaultValue: empty string

email

• Validates a valid UTF-8 string, maximum 1MB of input, and a valid email string.
• predefined filters:
  • ValidateUtf8String
  • DefaultValue: empty string
  • Match: EMAIL

integer

• Validates a valid UTF-8 numeric string, and casted to an integer.
• predefined filters:
  • ValidateInteger
  • DefaultValue: NULL

float

• Validates a valid UTF-8 numeric string, and casted to a float.
• predefined filters:
  • ValidateFloat
  • DefaultValue: NULL

date

• Validates a valid UTF-8 date format string, and convert to a \DateTimeImmutable object.
• predefined filters:
  • ValidateDateTime
  • DefaultValue: NULL

datetime

• Validates a valid UTF-8 date format string, and convert to a \DateTimeImmutable object.
• predefined filters:
  • ValidateDateTime
  • DefaultValue: NULL

month

• Validates a valid UTF-8 date format string, and convert to a \DateTimeImmutable object.
• predefined filters:
  • ValidateDateTime
  • DefaultValue: NULL

digits

• Validates a valid UTF-8 string with digits only, and casted to a string.
• predefined filters:
  • ValidateDateTime
  • DefaultValue: empty string

time

timeHi

dateYMD

Predefined Filters

FilterArrayToValue

• convert array input to a single text value.
• arguments: ['fields' => ['y', 'm'], 'format' => '%d.%d', 'implode' => '...']
  • fields: required. specify list of array key names.
  • format: optional. spritnf format for the array values.
  • implode: optional. if format is not defined, implode values with the character (default is '-').

sample code:

ValidateMbString

• convert Japanese kana style.
• arguments: ['type' => 'convert']
  • type: required. conversion option for mb_convert_kana. default is MB_ZEN_KANA.
• available type values:
  • FilterMbString::MB_ZEN_KANA: convert han-kaku-kana to zen-kaku-kana.
  • FilterMbString::MB_HANKAKU: convert zen-kaku-alphabets and digits to han-kaku.
  • FilterMbString::MB_MB_ZENKAKU: convert all characters to zen-kaku.
  • FilterMbString::MB_HAN_KANA: convert all characters to han-kaku, if possible.
  • FilterMbString::MB_HIRAGANA: convert all kana to zen-kaku-hiragana.
  • FilterMbString::MB_KATAKANA: convert all kana to zen-kaku-katakana.
• [ ] not tested, yet.

ValidateValidUtf8

• checks if the input value is a valid UTF-8 characters.
• priority: FilterInterface::PRIORITY_SECURITY_FILTERS
• errors: on error, replaces the input value with an empty string ('').
  • FilterValidUtf8::INVALID_CHAR : invalid UTF-8 characters.
  • FilterValidUtf8::ARRAY_INPUT : input is an array.

ValidateDateTime

• converts string input into \DateTimeImmutable object.
• arguments: ['format' => 'YY.m.d'].
  • format: optional. if set uses \DateTimeImmutable::createFromFormat

ValidateInteger

• checks the input value is numeric, and converts the value to an integer.
• errors: if the value is not numeric, or the value is an array.
• arguments: none.

ValidateFloat

• checks the input value is numeric, and converts the value to a float.
• errors: if the value is not numeric, or the value is an array.
• arguments: none.

ValidateLetterType

• sanitize the input value consisted of certain type of letters.
  • arguments: [ValidateLetterType::TYPE => ValidateLetterType::DIGITS_ONLY]
  • ValidateLetterType::TYPE: required. specify types from the following.
    • ValidateLetterType::DIGITS_ONLY: only numbers (0-9).
    • ValidateLetterType::AL_NUM_ONLY: only alpha numeric characters (0-9a-zA-Z).
    • ValidateLetterType::CODE_ONLY: only some codes (-_0-9a-zA-Z).

DefaultValue

• set value to a default $default if the input is null or empty.
• arguments: ['default' => 'some value']
  • default: optional. if not set uses empty string ('').

Required

• validates the input value is not null nor empty string.
• aborts further validations if failed.
• arguments: [Required::NULLABLE => true].
  • Required::NULLABLE: deprecated. use Nullable instead. default false. breaks validation chain if the value is empty (i.e. either null, empty string, or empty array).

RequiredIf

• validates the input value is not null nor empty string, if the name field is set, or if field value is value.
• aborts further validations if failed.
• arguments: [RequiredIf::FIELD => 'other', RequiredIf::VALUE => 'val']
  • RequiredIf::FIELD: string. required. set other field name to refer to.
  • RequiredIf::VALUE: string, integer, float, or array. optional. set value (or values in array) if the other field has the specified value.
  • Required::NULLABLE: deprecated. use Nullable instead. default false. breaks validation chain if the value is empty (i.e. either null, empty string, or empty array).

Nullable

• breaks validation chain/loop if the input value is empty. stops further validations which may fail if the input is an empty value. thus, this filter allows NULLABLE value, regardless of the subsequent filter.
• use it for non-required field but have certain filters (RegEx) which may fail if the input is empty.
• arguments: none.

StringLength

• checks the input value's character length. set any of the arguments, length, max, or min, but probably does not make sense to set all options.
• arguments: ['length' => 5, 'max' => 6, 'min' => 7, 'message' => 'error message']
  • length: optional. specify the exact length of the input string.
  • max: optional. set the maximum length of the input string.
  • min: optional. set the minimum length of the input string.
  • message: optional. set error message.

ConfirmWith

• confirm the input value by comparing with another input value.
• arguments: ['with' => 'field_name_to_confirm_with']
  • with: optional. if not set, uses {name}_confirmation
• [ ] not tested, yet.

InArray

• checks the input value is defined in the given arrays.
• arguments: ['choices' => ['A', 'B',...] or ['replace' => ['a' => 'A', 'b' => 'B']]. must specify either choices or replace option.
  • choices: optional array. specify the available choices as an array.
  • replace: optional hashed array. replace the value.
  • strict: optional. strict option when checking the value. default true.

RegEx

• checks for regular expression.
• arguments: [RegEx::PATTERN => '[A-D][0-9]{1}', RegEx::MESSAGE => 'error message']
  • RegEx::PATTERN: required. set regular expression pattern. the pattern is valuated as /\A{$pattern}\z/us.
  • RegEx::MESSAGE: optional. set error message.
• [ ] not tested, yet.

ValidateMatch

• validates input string for valid UTF-8 and predefined types using filter_var.
• as a default, error message is selected based on the type.
• arguments: [Match::TYPE=> 'filter_var_filter']
  • Match::TYPE: required. string from available type below:
    • Match::IP: validates IP address.
    • Match::EMAIL: validates email address.
    • Match::URL: validates URL.
    • Match::MAC: validates MAC address.
• [ ] not tested, yet.

StringCases

StringTrim