Yiisoft\Validator\Result

Complexity

Total Complexity

8

Size/Duplication

Total Lines	65
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	5
Bugs	1	Features	1

6 Methods

Rating	Name	Duplication	Size	Complexity
A	isValid()	0	3	1
A	getErrors()	0	5	1
A	getErrorObjects()	0	3	1
A	addError()	0	3	1
A	getNestedErrors()	0	15	2
A	getErrorsIndexedByPath()	0	9	2

<?php

declare(strict_types=1);

namespace Yiisoft\Validator;

use Yiisoft\Arrays\ArrayHelper;

final class Result
{
    /**
     * @var Error[]
     */
    private array $errors = [];

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

    /**
     * @psalm-param list<int|string>|null $valuePath
     */
    public function addError(string $message, array $valuePath = []): void
    {
        $this->errors[] = new Error($message, $valuePath);
    }

    /**
     * @return Error[]
     */
    public function getErrorObjects(): array
    {
        return $this->errors;
    }

    /**
     * @return string[]
     */
    public function getErrors(): array
    {
        return ArrayHelper::getColumn($this->errors, function ($error) {
            /** @var Error $error */
            return $error->getMessage();
        });
    }

    public function getNestedErrors(string $separator = '.'): array
    {
        $valuePathCountMap = [];
        $errors = [];
        foreach ($this->errors as $error) {
            $stringValuePath = implode($separator, $error->getValuePath());
            $valuePathCount = $valuePathCountMap[$stringValuePath] ?? 0;
            $errorValuePath = "$stringValuePath.$valuePathCount";

            ArrayHelper::setValueByPath($errors, $errorValuePath, $error->getMessage());
            $valuePathCount++;
            $valuePathCountMap[$stringValuePath] = $valuePathCount;
        }

        return $errors;
    }

    public function getErrorsIndexedByPath(string $separator = '.'): array
    {
        $errors = [];
        foreach ($this->errors as $error) {
            $stringValuePath = implode($separator, $error->getValuePath());
            $errors[$stringValuePath][] = $error->getMessage();
        }

        return $errors;
    }
}