Yiisoft\Validator\Rule\GroupRule

Complexity

Total Complexity

3

Size/Duplication

Total Lines	26
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	validateValue()	0	8	2
A	getRawOptions()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

use Yiisoft\Validator\DataSetInterface;
use Yiisoft\Validator\ErrorMessage;
use Yiisoft\Validator\ErrorMessageFormatterInterface;
use Yiisoft\Validator\HasValidationErrorMessage;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;
use Yiisoft\Validator\Rules;

/**
 * GroupRule validates a single value for a set of custom rules
 */
abstract class GroupRule extends Rule
{
    use HasValidationErrorMessage;

    protected string $message = 'This value is not a valid.';

    protected function validateValue($value, DataSetInterface $dataSet = null): Result
    {
        $result = new Result();
        if (!$this->getRules()->validate($value, $dataSet)->isValid()) {
            $result->addError(new ErrorMessage($this->message));
        }

        return $result;
    }

    /**
     * Return custom rules set
     *
     * @return Rules
     */
    abstract protected function getRules(): Rules;

    public function getRawOptions(?ErrorMessageFormatterInterface $formatter = null): array
    {
        return $this->getRules()->asArray($formatter);
    }
}