Yiisoft\Validator\Result

Complexity

Total Complexity

8

Size/Duplication

Total Lines	45
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	1	Features	1

4 Methods

Rating	Name	Duplication	Size	Complexity
A	isValid()	0	3	1
A	getErrors()	0	3	1
A	getNestedErrors()	0	8	2
A	addError()	0	6	4

<?php

declare(strict_types=1);

namespace Yiisoft\Validator;

use Yiisoft\Arrays\ArrayHelper;

final class Result
{
    /**
     * @psalm-var array<int|string, string>
     */
    private array $errors = [];

    public function isValid(): bool
    {
        return $this->errors === [];
    }

    /**
     * Add an error.
     *
     * @param string $message Error message.
     * @param int|string|null $key For simple rules the key is null meaning error will be appended to the end of the
     * array. Otherwise, it's a path to a current error value in the input data concatenated using dot notation. For
     * example: "charts.0.points.0.coordinates.x".
     */
    public function addError(string $message, $key = null): void
    {
        if ($key !== null && $key !== 0 && !isset($this->errors[$key])) {
            $this->errors[$key] = $message;
        } else {
            $this->errors[] = $message;
        }
    }

    /**
     * @psalm-return array<int|string, string>
     */
    public function getErrors(): array
    {
        return $this->errors;
    }

    public function getNestedErrors(): array
    {
        $errors = [];
        foreach ($this->errors as $key => $message) {
            ArrayHelper::setValueByPath($errors, $key, $message);
        }

        return $errors;
    }
}