Yiisoft\Form\FormErrors

Complexity

Total Complexity

19

Size/Duplication

Total Lines	92
Duplicated Lines	0 %

Test Coverage

Coverage

97.37%

Importance

Changes	1
Bugs	0	Features	0

11 Methods

Rating	Name	Duplication	Size	Complexity
A	getErrors()	0	3	1
A	addError()	0	3	1
A	getAllErrors()	0	3	1
A	__construct()	0	4	1
A	getFirstErrors()	0	15	4
A	renderErrorSummary()	0	10	2
A	getFirstError()	0	7	2
A	hasErrors()	0	3	2
A	getErrorSummary()	0	9	2
A	getErrorSummaryFirstErrors()	0	3	1
A	clear()	0	6	2

<?php

declare(strict_types=1);

namespace Yiisoft\Form;

/**
 * FormErrors represents a form validation errors collection.
 */
final class FormErrors implements FormErrorsInterface
{
    /** @psalm-var array<string, array<array-key, string>> */
    private array $attributesErrors;

    public function __construct(array $attributesErrors = [])
    {
        /** @psalm-var array<string, array<array-key, string>> */
        $this->attributesErrors = $attributesErrors;
    }

    public function addError(string $attribute, string $error): void
    {
        $this->attributesErrors[$attribute][] = $error;
    }

    public function getAllErrors(): array
    {
        return $this->attributesErrors;
    }

    public function getErrors(string $attribute): array
    {
        return $this->attributesErrors[$attribute] ?? [];
    }

    public function getErrorSummary(array $onlyAttributes = []): array
    {
        $errors = $this->getAllErrors();

        if ($onlyAttributes !== []) {
            $errors = array_intersect_key($errors, array_flip($onlyAttributes));
        }

        return $this->renderErrorSummary($errors);
    }

    public function getErrorSummaryFirstErrors(): array
    {
        return $this->renderErrorSummary([$this->getFirstErrors()]);
    }

    public function getFirstError(string $attribute): string
    {
        if (empty($this->attributesErrors[$attribute])) {
            return '';
        }

        return reset($this->attributesErrors[$attribute]);
    }

    public function getFirstErrors(): array
    {
        if (empty($this->attributesErrors)) {
            return [];
        }

        $errors = [];

        foreach ($this->attributesErrors as $name => $es) {
            if (!empty($es)) {
                $errors[$name] = reset($es);
            }
        }

        return $errors;
    }

    public function hasErrors(?string $attribute = null): bool
    {
        return $attribute === null ? !empty($this->attributesErrors) : isset($this->attributesErrors[$attribute]);
    }

    public function clear(?string $attribute = null): void
    {
        if ($attribute !== null) {
            unset($this->attributesErrors[$attribute]);
        } else {
            $this->attributesErrors = [];
        }
    }

    private function renderErrorSummary(array $errors): array
    {
        $lines = [];

        /** @var string[] errors */
        foreach ($errors as $error) {
            $lines = array_merge($lines, $error);
        }

        return $lines;
    }
}