Class Date

Responsibility: Validate submitted date format, min., max., step and remove dangerous characters.

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

Extended by

MvcCore\Ext\Forms\Validators\Date implements MvcCore\Ext\Forms\Fields\IMinMaxStepDates uses MvcCore\Ext\Forms\Field\Props\Format, MvcCore\Ext\Forms\Field\Props\MinMaxStepDates

Direct known subclasses

MvcCore\Ext\Forms\Validators\DateTime, MvcCore\Ext\Forms\Validators\Month, MvcCore\Ext\Forms\Validators\Time, MvcCore\Ext\Forms\Validators\Week

Namespace: MvcCore\Ext\Forms\Validators
Located at ext-form-field-date/src/MvcCore/Ext/Forms/Validators/Date.php

Methods summary
`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` Overrides `MvcCore\Ext\Forms\Validator::SetField()`
`public string\|array\|null`	# `Validate( string\|array $rawSubmittedValue )` Validate submitted date format, min., max., step and remove dangerous characters. Validate submitted date format, min., max., step and remove dangerous characters. Parameters `$rawSubmittedValue` $submitValue Raw user input. Returns string\|array\|null Safe submitted value or `NULL` if not possible to return safe value.
`protected DateTimeInterface`	# `checkMinMax( DateTimeInterface $date )` Validate submitted date min. and max. if necessary. Validate submitted date min. and max. if necessary. Parameters `$date` Returns DateTimeInterface
`protected DateTimeInterface`	# `checkStep( DateTimeInterface $date )` Validate submitted date step if necessary. Validate submitted date step if necessary. Parameters `$date` Returns DateTimeInterface

Methods inherited from MvcCore\Ext\Forms\Validator
`CreateInstance(), GetErrorMessage(), SetForm(), __construct(), setUpFieldProps(), throwNewInvalidArgumentException()`

Methods inherited from MvcCore\Ext\Forms\Fields\IMinMaxStepDates
`GetMax(), GetMin(), GetStep(), SetMax(), SetMin(), SetStep()`

Methods used from MvcCore\Ext\Forms\Field\Props\Format
`GetFormat(), SetFormat()`

Methods used from MvcCore\Ext\Forms\Field\Props\MinMaxStepDates
`GetMax(), GetMin(), GetStep(), SetMax(), SetMin(), SetStep(), createDateTimeFromInput()`

Constants summary
`integer`	`ERROR_DATE_INVALID` Error message index(es). Error message index(es).	# `0`
`integer`	`ERROR_DATE_TO_LOW`	# `1`
`integer`	`ERROR_DATE_TO_HIGH`	# `2`
`integer`	`ERROR_DATE_STEP`	# `3`

Properties summary
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# `[ self::ERROR_DATE_INVALID => "Field '{0}' requires a valid date format: '{1}'.", self::ERROR_DATE_TO_LOW => "Field '{0}' requires date higher or equal to '{1}'.", self::ERROR_DATE_TO_HIGH => "Field '{0}' requires date lower or equal to '{1}'.", self::ERROR_DATE_STEP => "Field '{0}' requires date in predefined days interval '{1}' from start point '{2}'.", ]`
`protected static array`	`$fieldSpecificProperties` Field specific values (camel case) and their validator default values. Field specific values (camel case) and their validator default values.	# `[ 'min' => NULL, 'max' => NULL, 'step' => NULL, 'format' => NULL, ]`
`protected string`	`$format` String format mask to format given values in `Intl` extension `\DateTimeInterface` type or string format mask to format given values in `integer` type by PHP `date()` function. Example: `"Y-m-d" \| "Y/m/d"` String format mask to format given values in `Intl` extension `\DateTimeInterface` type or string format mask to format given values in `integer` type by PHP `date()` function. Example: `"Y-m-d" \| "Y/m/d"` See http://php.net/manual/en/datetime.createfromformat.php http://php.net/manual/en/function.date.php	# `NULL`
`protected static array`	`$errorMessagesFormatReplacements` Error messages replacements. How to get more human form shortcuts from PHP `date()` special chars to more human shortcuts. Error messages replacements. How to get more human form shortcuts from PHP `date()` special chars to more human shortcuts.	# `[ 'd' => 'DD', 'j' => 'D', 'D' => 'Mon-Sun', 'l' => 'Monday-Sunday', 'm' => 'MM', 'n' => 'M', 'M' => 'Jan-Dec', 'F' => 'January-December', 'Y' => 'YYYY', 'y' => 'YY', 'a' => 'am/pm', 'A' => 'AM/PM', 'g' => '1-12', 'h' => '01-12', 'G' => '01-12', 'H' => '00-23', 'i' => '00-59', 's' => '00-59', 'u' => '0-999999', ]`

Properties inherited from MvcCore\Ext\Forms\Validator
`$field, $form, $toolClass`

Properties used from MvcCore\Ext\Forms\Field\Props\MinMaxStepDates
`$max, $min, $step`