Yiisoft\Validator\Error

Complexity

Total Complexity

5

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	1	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	getParameters()	0	3	1
A	getMessage()	0	3	1
A	__construct()	0	13	1
A	getValuePath()	0	9	2

<?php

declare(strict_types=1);

namespace Yiisoft\Validator;

final class Error
{
    /**
     * @psalm-param list<int|string> $valuePath
     */
    public function __construct(
        private string $message,

        /**
         * @psalm-var array<string,scalar|null>
         */
        private array $parameters = [],

        /**
         * @psalm-var list<int|string>
         */
        private array $valuePath = [],
    ) {
    }

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

    /**
     * @psalm-return array<string,scalar|null>
     */
    public function getParameters(): array
    {
        return $this->parameters;
    }

    /**
     * @psalm-return list<int|string>
     */
    public function getValuePath(bool $escape = false): array
    {
        if ($escape === false) {
            return $this->valuePath;
        }

        return array_map(
            static fn ($key): string => str_replace(['.', '*'], ['\\' . '.', '\\' . '*'], (string) $key),
            $this->valuePath
        );
    }
}