Class Validator

Responsibility: Base validator class with base methods implementations. This class is not possible to instantiate, you need to extend this class and define custom validation rules.

MvcCore\Ext\Forms\Validator implements MvcCore\Ext\Forms\IValidator

Direct known subclasses

Indirect known subclasses

MvcCore\Ext\Forms\Validators\DateTime, MvcCore\Ext\Forms\Validators\FloatNumber, MvcCore\Ext\Forms\Validators\IntNumber, MvcCore\Ext\Forms\Validators\MinMaxOptions, MvcCore\Ext\Forms\Validators\Month, MvcCore\Ext\Forms\Validators\Range, MvcCore\Ext\Forms\Validators\Time, MvcCore\Ext\Forms\Validators\Week

Abstract
Namespace: MvcCore\Ext\Forms
Located at ext-form/src/MvcCore/Ext/Forms/Validator.php

Methods summary
`public static MvcCore\Ext\Forms\Validator`	# `CreateInstance( array $constructorConfig = [] )` Create every time new validator instance with configured form instance. No singleton. Create every time new validator instance with configured form instance. No singleton. Parameters `$constructorConfig` Configuration arguments for constructor, validator's constructor first param. Returns `MvcCore\Ext\Forms\Validator` Implementation of `MvcCore\Ext\Forms\IValidator::CreateInstance()`
`public`	# `__construct( array $cfg = [] )` Create new form field validator instance. Create new form field validator instance. Parameters `$cfg` Config array with protected properties and it's values which you want to configure, presented in camel case properties names syntax.
`public MvcCore\Ext\Forms\Validator`	# `SetForm( MvcCore\Ext\IForm $form )` Set up form instance, where is validator created during submit. Set up form instance, where is validator created during submit. Parameters `$form` Returns `MvcCore\Ext\Forms\Validator` Implementation of `MvcCore\Ext\Forms\IValidator::SetForm()`
`public MvcCore\Ext\Forms\Validator`	# `SetField( MvcCore\Ext\Forms\IField $field )` Set up field instance, where is validated value by this validator during submit before every `Validate()` method call. This method is also called once, when validator instance is separately added into already created field instance to process any field checking. Set up field instance, where is validated value by this validator during submit before every `Validate()` method call. This method is also called once, when validator instance is separately added into already created field instance to process any field checking. Parameters `$field` Returns `MvcCore\Ext\Forms\Validator` Implementation of `MvcCore\Ext\Forms\IValidator::SetField()`
`public static string`	# `GetErrorMessage( integer $errorMsgIndex )` Return predefined validator custom error message strings (not translated) with replacements for field names and more specific info to tell the user what happened or what to do more. Return predefined validator custom error message strings (not translated) with replacements for field names and more specific info to tell the user what happened or what to do more. Parameters `$errorMsgIndex` Integer index for `static::$errorMessages` array. Returns string Implementation of `MvcCore\Ext\Forms\IValidator::GetErrorMessage()`
`abstract public string\|array\|null`	# `Validate( string\|array $rawSubmittedValue )` Validation method. Check submitted value by validator specific rules and if there is any error, call: `$this->field->AddValidationError($errorMsg, $errorMsgArgs, $replacingCallable);` with not translated error message. Return safe submitted value as result or `NULL` if there is not possible to return safe valid value. Validation method. Check submitted value by validator specific rules and if there is any error, call: `$this->field->AddValidationError($errorMsg, $errorMsgArgs, $replacingCallable);` with not translated error message. Return safe submitted value as result or `NULL` if there is not possible to return safe valid value. Parameters `$rawSubmittedValue` $submitValue Raw submitted value, string or array of strings. Returns string\|array\|null Safe submitted value or `NULL` if not possible to return safe value. Implementation of `MvcCore\Ext\Forms\IValidator::Validate()`
`protected`	# `throwNewInvalidArgumentException( string $errorMsg )` Throw new `\InvalidArgumentException` with given error message and append automatically current class, field name, form id, field class name and form class name. Throw new `\InvalidArgumentException` with given error message and append automatically current class, field name, form id, field class name and form class name. Parameters `$errorMsg` Throws InvalidArgumentException
`protected`	# `setUpFieldProps( array $fieldPropsDefaultValidValues = [] )` Set up field specific properties. If field returns it's specific value (`array_key_exists()`), use it for validator. If field doesn't return any specific value and validator has this specific value defined, try to set up this specific value to field. If there is no specific value in field and not even in validator, set into validator default value. Set up field specific properties. If field returns it's specific value (`array_key_exists()`), use it for validator. If field doesn't return any specific value and validator has this specific value defined, try to set up this specific value to field. If there is no specific value in field and not even in validator, set into validator default value. Parameters `$fieldPropsDefaultValidValues` Array with key as property name and value as default validator value, if there is nothing in field and nothing even in validator itself.

Properties summary
`protected MvcCore\Ext\Form`	`$form` Form instance where was validator created. Every validator instance belongs to only one form instance. Form instance where was validator created. Every validator instance belongs to only one form instance.	# `NULL`
`protected MvcCore\Ext\Forms\Field`	`$field` Currently validated form field instance. Before every `Validate()` method call, there is called `$validator->SetField($field);` to work with proper field instance during validation. Currently validated form field instance. Before every `Validate()` method call, there is called `$validator->SetField($field);` to work with proper field instance during validation.	# `NULL`
`protected static string[]`	`$errorMessages` Validator custom error message strings (not translated) with replacements for field names and more specific info to tell the user what happened or what to do more. Validator custom error message strings (not translated) with replacements for field names and more specific info to tell the user what happened or what to do more.	# `[]`
`protected static array`	`$fieldSpecificProperties` An associative array for extended classes, where you could define in camel case field specific properties to get before validation into local context with values from field instance, given in method local `SetField()`. All keys defined in this array are field names to transfer from field instance into local context. Values in this array is good practise to define with `NULL`, but values also could be used as default values, if there is `NULL` value for defined property in field instance. Then value from this array is used in local context and is also set into field by field setter method. An associative array for extended classes, where you could define in camel case field specific properties to get before validation into local context with values from field instance, given in method local `SetField()`. All keys defined in this array are field names to transfer from field instance into local context. Values in this array is good practise to define with `NULL`, but values also could be used as default values, if there is `NULL` value for defined property in field instance. Then value from this array is used in local context and is also set into field by field setter method.	# `[]`
`protected static string`	`$toolClass` Remembered value from `\MvcCore\Application::GetInstance()->GetToolClass();` Remembered value from `\MvcCore\Application::GetInstance()->GetToolClass();`	# `''`

Classes

Interfaces

Traits

Exceptions

Functions

Class Validator

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Implementation of

Parameters

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Throws

Parameters