Overview

Classes

Interfaces

Traits

Exceptions

Functions

Class ValueInOptions

Responsibility: Validate if submitted string(s) are presented in options keys.

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

Extended by

MvcCore\Ext\Forms\Validators\ValueInOptions implements MvcCore\Ext\Forms\Fields\IMultiple, MvcCore\Ext\Forms\Fields\IOptions uses MvcCore\Ext\Forms\Field\Props\Multiple, MvcCore\Ext\Forms\Field\Props\Options

Direct known subclasses

MvcCore\Ext\Forms\Validators\MinMaxOptions

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

Methods summary
`public string\|string[]\|null`	# `Validate( string\|array $rawSubmittedValue )` Return array with only submitted values from options keys or return string which exists as key in options or `NULL` if submitted value is `NULL`. Add error if submitted value is not the same as value after existence check. Return array with only submitted values from options keys or return string which exists as key in options or `NULL` if submitted value is `NULL`. Add error if submitted value is not the same as value after existence check. Parameters `$rawSubmittedValue` $submitValue Returns string\|string[]\|null Safe submitted value or `NULL` if not possible to return safe value.
`protected array`	# `completeSafeValueByOptions( string\|string[] $submittedValue )` Return safe value(s), which exist(s) in field options and return boolean (`TRUE`) if result is array or not. Example: `list($safeValue, $multiple) = $this->completeSafeValueByOptions($submittedValue);`; Return safe value(s), which exist(s) in field options and return boolean (`TRUE`) if result is array or not. Example: `list($safeValue, $multiple) = $this->completeSafeValueByOptions($submittedValue);`; Parameters `$submittedValue` Returns array
`protected string\|string[]\|null`	# `getSubmittedValueCorrectType( string\|string[]\|null $rawSubmittedValue )` Parameters `$rawSubmittedValue` Returns string\|string[]\|null

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

Methods inherited from MvcCore\Ext\Forms\Fields\IMultiple
`GetMultiple(), SetMultiple()`

Methods inherited from MvcCore\Ext\Forms\Fields\IOptions
`AddOptions(), GetFlattenOptions(), GetOptions(), GetTranslateOptions(), SetOptions(), SetTranslateOptions()`

Methods used from MvcCore\Ext\Forms\Field\Props\Multiple
`GetMultiple(), SetMultiple()`

Methods used from MvcCore\Ext\Forms\Field\Props\Options
`AddOptions(), GetFlattenOptions(), GetOptions(), GetTranslateOptions(), SetOptions(), SetTranslateOptions()`

Constants summary
`integer`	`ERROR_VALID_OPTION` Error message index(es). Error message index(es).	# `0`

Properties summary
`protected static array`	`$errorMessages` Validation failure message template definitions. Validation failure message template definitions.	# `[ self::ERROR_VALID_OPTION => "Field '{0}' requires a valid option.", ]`
`protected static array`	`$fieldSpecificProperties` Field specific values (camel case) and their validator default values. Field specific values (camel case) and their validator default values.	# `[ 'multiple' => NULL, 'options' => NULL, ]`

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

Properties used from MvcCore\Ext\Forms\Field\Props\Multiple
`$multiple`

Properties used from MvcCore\Ext\Forms\Field\Props\Options
`$flattenOptions, $options, $translateOptions`