0 follower

Interface Yiisoft\Validator\ValidatorInterface

All Classes | Methods

Implemented by	Yiisoft\Validator\Debug\ValidatorInterfaceProxy, Yiisoft\Validator\Validator

An interface allowing to validate the data according to the set of rules (Yiisoft\Validator\RuleInterface) and validation context (Yiisoft\Validator\ValidationContext). A class implementing it is called "validator".

Psalm Types

Name	Value
RawRulesList	iterable<integer, callable\|Yiisoft\Validator\RuleInterface>
RawRulesMap	iterable<integer\|string, Yiisoft\Validator\RuleInterface\|callable\|\Yiisoft\Validator\RawRulesList>
RawRules	class-string\|object\|callable\|\Yiisoft\Validator\RawRulesMap

Public Methods

Hide inherited methods

Method	Description	Defined By
validate()	Validates the data according to the set of rules (Yiisoft\Validator\RuleInterface) and validation context (Yiisoft\Validator\ValidationContext).	Yiisoft\Validator\ValidatorInterface

Method Details

Hide inherited methods

validate() public abstract method

Validates the data according to the set of rules (Yiisoft\Validator\RuleInterface) and validation context (Yiisoft\Validator\ValidationContext).

public abstract validate( Yiisoft\Validator\DataSetInterface\|mixed\|Yiisoft\Validator\RulesProviderInterface $data, callable\|iterable\|object\|string\|null $rules = null, Yiisoft\Validator\ValidationContext\|null $context = null ): Yiisoft\Validator\Result
$data	Yiisoft\Validator\DataSetInterface\|mixed\|Yiisoft\Validator\RulesProviderInterface	Data to validate: A data set (Yiisoft\Validator\DataSetInterface) is used as is. Implementing Yiisoft\Validator\RulesProviderInterface additionally can be used for providing rules via Yiisoft\Validator\RulesProviderInterface::getRules() (works only when `$rules` argument is not provided and ignored otherwise). Any other value is normalized to data set using Yiisoft\Validator\Helper\DataSetNormalizer.
$rules	callable\|iterable\|object\|string\|null	Rules to apply for validating data. If specified, this argument has higher priority over Yiisoft\Validator\RulesProviderInterface::getRules() provided in `$data` argument. A variety of types is supported. They are normalized before usage, please refer to Yiisoft\Validator\Helper\RulesNormalizer documentation to see what structures can be passed.
$context	Yiisoft\Validator\ValidationContext\|null	Validation context that may be taken into account when performing validation.
return	Yiisoft\Validator\Result	The result of validation.
throws	ReflectionException	If an object / \Yiisoft\Validator\ObjectDataSet providing rules or (and) data used in `$data` argument and there was a Reflection error during parsing them.

Source code

                public function validate(
    mixed $data,
    callable|iterable|object|string|null $rules = null,
    ?ValidationContext $context = null,
): Result;