Yiisoft\Form\YiisoftFormModel\Field\ErrorSummary

Complexity

Total Complexity

27

Size/Duplication

Total Lines	226
Duplicated Lines	0 %

Test Coverage

Coverage

98.82%

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	headerAttributes()	0	5	1
A	footer()	0	5	1
A	listClass()	0	5	1
A	onlyCommonErrors()	0	5	1
A	encode()	0	5	1
A	footerAttributes()	0	5	1
A	getAllErrors()	0	14	4
A	showAllErrors()	0	5	1
A	validationResult()	0	5	1
A	getFirstErrors()	0	9	3
A	header()	0	5	1
A	collectErrors()	0	21	4
A	listAttributes()	0	5	1
A	addListClass()	0	5	1
A	generateContent()	0	23	4
A	onlyProperties()	0	5	1

<?php

declare(strict_types=1);

namespace Yiisoft\Form\YiisoftFormModel\Field;

use Yiisoft\Form\Field\Base\BaseField;
use Yiisoft\Html\Html;
use Yiisoft\Validator\Result;

/**
 * Displays a summary of the form validation errors. If there is no validation error, field will be hidden.
 */
final class ErrorSummary extends BaseField
{
    private ?Result $validationResult = null;
    private bool $encode = true;
    private bool $showAllErrors = false;
    private array $onlyProperties = [];

    private string $footer = '';
    private array $footerAttributes = [];
    private string $header = 'Please fix the following errors:';
    private array $headerAttributes = [];
    private array $listAttributes = [];

    public function validationResult(?Result $result): self
    {
        $new = clone $this;
        $new->validationResult = $result;
        return $new;
    }

    /**
     * Whether error content should be HTML-encoded.
     */
    public function encode(bool $value): self
    {
        $new = clone $this;
        $new->encode = $value;
        return $new;
    }

    /**
     * Whether to show all errors.
     */
    public function showAllErrors(bool $value = true): self
    {
        $new = clone $this;
        $new->showAllErrors = $value;
        return $new;
    }

    /**
     * Specific properties to be filtered out when rendering the error summary.
     *
     * @param array $names The property names to be included in error summary.
     */
    public function onlyProperties(string ...$names): self
    {
        $new = clone $this;
        $new->onlyProperties = $names;
        return $new;
    }

    /**
     * Use only common errors when rendering the error summary.
     */
    public function onlyCommonErrors(): self
    {
        $new = clone $this;
        $new->onlyProperties = [''];
        return $new;
    }

    /**
     * Set the footer text for the error summary
     */
    public function footer(string $value): self
    {
        $new = clone $this;
        $new->footer = $value;
        return $new;
    }

    /**
     * Set footer attributes for the error summary.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * See {@see Html::renderTagAttributes} for details on how attributes are being rendered.
     */
    public function footerAttributes(array $values): self
    {
        $new = clone $this;
        $new->footerAttributes = $values;
        return $new;
    }

    /**
     * Set the header text for the error summary
     */
    public function header(string $value): self
    {
        $new = clone $this;
        $new->header = $value;
        return $new;
    }

    /**
     * Set header attributes for the error summary.
     *
     * @param array $values Attribute values indexed by attribute names.
     *
     * See {@see Html::renderTagAttributes} for details on how attributes are being rendered.
     */
    public function headerAttributes(array $values): self
    {
        $new = clone $this;
        $new->headerAttributes = $values;
        return $new;
    }

    /**
     * Set errors list container attributes.
     *
     * @param array $attributes Attribute values indexed by attribute names.
     *
     * See {@see Html::renderTagAttributes} for details on how attributes are being rendered.
     */
    public function listAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->listAttributes = $attributes;
        return $new;
    }

    /**
     * Add one or more CSS classes to the list container tag.
     *
     * @param string|null ...$class One or many CSS classes.
     */
    public function addListClass(?string ...$class): self
    {
        $new = clone $this;
        Html::addCssClass($new->listAttributes, $class);
        return $new;
    }

    /**
     * Replace current list container tag CSS classes with a new set of classes.
     *
     * @param string|null ...$class One or many CSS classes.
     */
    public function listClass(?string ...$class): static
    {
        $new = clone $this;
        $new->listAttributes['class'] = array_filter($class, static fn ($c) => $c !== null);
        return $new;
    }

    protected function generateContent(): ?string
    {
        $messages = $this->collectErrors();
        if (empty($messages)) {
            return null;
        }

        $content = [];

        if ($this->header !== '') {
            $content[] = Html::p($this->header, $this->headerAttributes)->render();
        }

        $content[] = Html::ul()
            ->attributes($this->listAttributes)
            ->strings($messages, [], $this->encode)
            ->render();

        if ($this->footer !== '') {
            $content[] = Html::p($this->footer, $this->footerAttributes)->render();
        }

        return implode("\n", $content);
    }

    /**
     * Return array of the validation errors.
     *
     * @return string[] Array of the validation errors.
     */
    private function collectErrors(): array
    {
        if ($this->validationResult === null) {
            return [];
        }

        if ($this->showAllErrors) {
            $errors = $this->getAllErrors();
        } elseif ($this->onlyProperties !== []) {
            $errors = array_intersect_key($this->getFirstErrors(), array_flip($this->onlyProperties));
        } else {
            $errors = $this->getFirstErrors();
        }

        /**
         * If there are the same error messages for different properties, array_unique will leave gaps between
         * sequential keys. Applying array_values to reorder array keys.
         *
         * @var string[]
         */
        return array_values(array_unique($errors));
    }

    private function getAllErrors(): array
    {
        if ($this->onlyProperties === []) {
            return $this->validationResult?->getErrorMessages() ?? [];
        }

        $result = [];
        foreach ($this->validationResult?->getErrorMessagesIndexedByPath() ?? [] as $property => $messages) {
            if (in_array($property, $this->onlyProperties, true)) {
                $result[] = $messages;
            }
        }

        return array_merge(...$result);
    }

    private function getFirstErrors(): array
    {
        $result = [];
        foreach ($this->validationResult?->getErrorMessagesIndexedByPath() ?? [] as $property => $messages) {
            if (isset($messages[0])) {
                $result[$property] = $messages[0];
            }
        }
        return $result;
    }
}