Yiisoft\Validator\Rule\MatchRegularExpression

Complexity

Total Complexity

9

Size/Duplication

Total Lines	44
Duplicated Lines	0 %

Test Coverage

Coverage

81.25%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	not()	0	4	1
A	message()	0	4	1
A	__construct()	0	3	1
A	validateValue()	0	13	6

<?php

namespace Yiisoft\Validator\Rule;

use yii\helpers\Yii;

The type yii\helpers\Yii was not found. Maybe you did not declare it correctly or list all dependencies?

use yii\exceptions\InvalidConfigException;

The type yii\exceptions\InvalidConfigException was not found. Maybe you did not declare it correctly or list all dependencies?

use Yiisoft\Validator\DataSetInterface;
use Yiisoft\Validator\Result;
use Yiisoft\Validator\Rule;

/**
 * RegularExpressionValidator validates that the attribute value matches the specified [[pattern]].
 *
 * If the [[not]] property is set true, the validator will ensure the attribute value do NOT match the [[pattern]].
 */
class MatchRegularExpression extends Rule
{
    /**
     * @var string the regular expression to be matched with
     */
    private string $pattern;
    /**
     * @var bool whether to invert the validation logic. Defaults to false. If set to true,
     * the regular expression defined via [[pattern]] should NOT match the attribute value.
     */
    private bool $not = false;

    private string $message = 'Value is invalid.';

    public function __construct(string $pattern)
    {
        $this->pattern = $pattern;
    }

    public function not(): self
    {
        $this->not = true;
        return $this;
    }

    public function message(string $message): self
    {
        $this->message = $message;
        return $this;
    }

    protected function validateValue($value, DataSetInterface $dataSet = null): Result
    {
        $result = new Result();

        $valid = !is_array($value) &&
            ((!$this->not && preg_match($this->pattern, $value))
            || ($this->not && !preg_match($this->pattern, $value)));

        if (!$valid) {
            $result->addError($this->formatMessage($this->message));
        }

        return $result;
    }
}