Yiisoft\Validator\ResultSet

Complexity

Total Complexity

17

Size/Duplication

Total Lines	88
Duplicated Lines	0 %

Test Coverage

Coverage

91.89%

Importance

Changes	5
Bugs	0	Features	0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	getIterator()	0	3	1
A	getErrors()	0	3	1
A	getErrorObjects()	0	3	1
A	isValid()	0	3	1
A	getErrorsIndexedByPath()	0	10	3
A	addResult()	0	17	5
A	getResult()	0	7	2
A	getErrorsMap()	0	10	3

<?php

declare(strict_types=1);

namespace Yiisoft\Validator;

use ArrayIterator;
use Closure;
use InvalidArgumentException;
use IteratorAggregate;

/**
 * ResultSet stores validation result of each attribute from {@link DataSetInterface}.
 * It is typically obtained by validating data set with {@link Validator}.
 */
final class ResultSet implements IteratorAggregate
{
    /**
     * @var Result[]
     * @psalm-var array<string, Result>
     */
    private array $results = [];
    private bool $isValid = true;

    public function getIterator(): ArrayIterator
    {
        return new ArrayIterator($this->results);
    }

    public function isValid(): bool
    {
        return $this->isValid;
    }

    /**
     * @psalm-return array<string, Error>
     */
    public function getErrorObjects(): array
    {
        return $this->getErrorsMap(static fn (string $attribute, Result $result): array => $result->getErrorObjects());
    }

    /**
     * @return string[][]
     * @psalm-return array<string, array<int|string, string>>
     */
    public function getErrors(): array
    {
        return $this->getErrorsMap(static fn (string $attribute, Result $result): array => $result->getErrors());
    }

    public function getErrorsIndexedByPath(string $separator = '.'): array
    {
        return $this->getErrorsMap(static function (string $attribute, Result $result) use ($separator): array {
            $errors = [];
            foreach ($result->getErrorsIndexedByPath($separator) as $path => $error) {
                $path = !$path ? $attribute : "$attribute.$path";
                $errors[$path] = $error;
            }

            return $errors;
        });
    }

    private function getErrorsMap(Closure $getErrorsClosure): array
    {
        $errors = [];
        foreach ($this->results as $attribute => $result) {
            if (!$result->isValid()) {
                $errors[$attribute] = $getErrorsClosure($attribute, $result);
            }
        }

        return $errors;
    }

    public function addResult(string $attribute, Result $result): void
    {
        if (!$result->isValid()) {
            $this->isValid = false;
        }

        if (!isset($this->results[$attribute])) {
            $this->results[$attribute] = $result;
            return;
        }

        if ($result->isValid()) {
            return;
        }

        foreach ($result->getErrors() as $error) {
            $this->results[$attribute]->addError($error);
        }
    }

    public function getResult(string $attribute): Result
    {
        if (!isset($this->results[$attribute])) {
            throw new InvalidArgumentException("There is no result for attribute \"$attribute\"");
        }

        return $this->results[$attribute];
    }
}