Yiisoft\Validator\Rule\MatchRegularExpression

Complexity

Total Complexity

11

Size/Duplication

Total Lines	63
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

5 Methods

Rating	Name	Duplication	Size	Complexity
A	not()	0	5	1
A	__construct()	0	3	1
A	validateValue()	0	13	6
A	getOptions()	0	7	2
A	getName()	0	3	1

<?php

declare(strict_types=1);

namespace Yiisoft\Validator\Rule;

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

/**
 * 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
{
    use HasValidationErrorMessage;

    /**
     * @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;
    }

    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->translateMessage($this->message));
        }

        return $result;
    }

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

    /**
     * @inheritDoc
     * @return string
     */
    public function getName(): string
    {
        return 'matchRegularExpression';
    }

    /**
     * @inheritDoc
     * @return array
     */
    public function getOptions(): array
    {
        return array_merge(
            ['message' => $this->translateMessage($this->message)],
            $this->not ? ['not' => true] : [],
            ['pattern' => $this->pattern],
            parent::getOptions()
        );
    }
}