ErrorSummary::getFormModel() - Code Metrics - Inspection of "More clean-up." - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#191)

by Wilmer

created 2022-04-01 17:32 UTC

ErrorSummary::getFormModel() A

↳ Parent: ErrorSummary

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	3
nc	1
nop	0
dl	0
loc	5
ccs	4
cts	4
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Widget;

use InvalidArgumentException;
use Yiisoft\Form\Exception\FormModelNotSetException;
use Yiisoft\Form\FormModelInterface;
use Yiisoft\Form\Helper\HtmlFormErrors;
use Yiisoft\Html\Html;
use Yiisoft\Html\Tag\CustomTag;
use Yiisoft\Html\Tag\P;
use Yiisoft\Html\Tag\Ul;
use Yiisoft\Widget\Widget;

use function array_flip;
use function array_intersect_key;
use function array_unique;
use function array_values;

/**
 * The error summary widget displays a summary of the errors in a form.
 */
final class ErrorSummary extends Widget
{
    private array $attributes = [];
    private bool $encode = true;
    private array $onlyAttributes = [];
    private ?FormModelInterface $formModel = null;
    private string $footer = '';
    private array $footerAttributes = [];
    private string $header = 'Please fix the following errors:';
    private array $headerAttributes = [];
    private bool $showAllErrors = false;
    /** @psalm-param non-empty-string */
    private string $tag = 'div';

    /**
     * The HTML attributes. The following special options are recognized.
     *
     * @param array $value
     *
     * @return self
     *
     * See {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
     */
    public function attributes(array $value): self
    {
        $new = clone $this;
        $new->attributes = $value;
        return $new;
    }

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

    /**
     * Set the footer text for the error summary
     *
     * @param string $value
     *
     * @return self
     */
    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.
     *
     * @return self
     *
     * See {@see \Yiisoft\Html\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
     *
     * @param string $value
     *
     * @return self
     */
    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.
     *
     * @return self
     *
     * See {@see \Yiisoft\Html\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 the model for the error summary.
     *
     * @param FormModelInterface $formModel
     *
     * @return self
     */
    public function model(FormModelInterface $formModel): self
    {
        $new = clone $this;
        $new->formModel = $formModel;
        return $new;
    }

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

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

    /**
     * Set the container tag name for the error summary.
     *
     * Empty to render error messages without container {@see Html::tag()}.
     *
     * @param string $value
     *
     * @return self
     */
    public function tag(string $value): self
    {
        $new = clone $this;
        $new->tag = $value;
        return $new;
    }

    /**
     * Return array of the validation errors.
     *
     * @return array of the validation errors.
     */
    private function collectErrors(): array
    {
        $errors = HtmlFormErrors::getErrorSummaryFirstErrors($this->getFormModel());
        $errorMessages = [];

        if ($this->showAllErrors) {
            $errors = HtmlFormErrors::getErrorSummary($this->getFormModel(), $this->onlyAttributes);
        } elseif ($this->onlyAttributes !== []) {
            $errors = array_intersect_key($errors, array_flip($this->onlyAttributes));
        }

        /**
         * If there are the same error messages for different attributes, array_unique will leave gaps between
         * sequential keys. Applying array_values to reorder array keys.
         */
        $lines = array_values(array_unique($errors));

        if ($this->encode) {
            /** @var string $line */
            foreach ($lines as $line) {
                if (!empty($line)) {
                    $errorMessages[] = Html::encode($line);
                }
            }
        }

        return $errorMessages;
    }

    /**
     * Generates a summary of the validation errors.
     *
     * @return string the generated error summary
     */
    protected function run(): string
    {
        $attributes = $this->attributes;
        $content = '';

        if ($this->tag === '') {
            throw new InvalidArgumentException('Tag name cannot be empty.');
        }

        $content .=  P::tag()->attributes($this->headerAttributes)->content($this->header)->render() . PHP_EOL;

        /** @var array<string, string> */
        $lines = $this->collectErrors();
        $content .= Ul::tag()->strings($lines)->render();

        if ($this->footer !== '') {
            $content .= PHP_EOL . P::tag()->attributes($this->footerAttributes)->content($this->footer)->render();
        }

        return match (empty($lines)) {
            true => '',
            false => CustomTag::name($this->tag)
                ->attributes($attributes)
                ->encode(false)
                ->content(PHP_EOL . $content . PHP_EOL)
                ->render(),
        };
    }

    /**
     * Return FormModelInterface object.
     *
     * @return FormModelInterface
     */
    private function getFormModel(): FormModelInterface
    {
        return match (empty($this->formModel)) {
            true => throw new FormModelNotSetException(),
            false => $this->formModel,
        };
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Form\Widget;
6
7		use InvalidArgumentException;
8		use Yiisoft\Form\Exception\FormModelNotSetException;
9		use Yiisoft\Form\FormModelInterface;
10		use Yiisoft\Form\Helper\HtmlFormErrors;
11		use Yiisoft\Html\Html;
12		use Yiisoft\Html\Tag\CustomTag;
13		use Yiisoft\Html\Tag\P;
14		use Yiisoft\Html\Tag\Ul;
15		use Yiisoft\Widget\Widget;
16
17		use function array_flip;
18		use function array_intersect_key;
19		use function array_unique;
20		use function array_values;
21
22		/**
23		* The error summary widget displays a summary of the errors in a form.
24		*/
25		final class ErrorSummary extends Widget
26		{
27		private array $attributes = [];
28		private bool $encode = true;
29		private array $onlyAttributes = [];
30		private ?FormModelInterface $formModel = null;
31		private string $footer = '';
32		private array $footerAttributes = [];
33		private string $header = 'Please fix the following errors:';
34		private array $headerAttributes = [];
35		private bool $showAllErrors = false;
36		/** @psalm-param non-empty-string */
37		private string $tag = 'div';
38
39		/**
40		* The HTML attributes. The following special options are recognized.
41		*
42		* @param array $value
43		*
44		* @return self
45		*
46		* See {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
47		*/
48	5	public function attributes(array $value): self
49		{
50	5	$new = clone $this;
51	5	$new->attributes = $value;
52	5	return $new;
53		}
54
55		/**
56		* Whether content should be HTML-encoded.
57		*
58		* @param bool $value
59		*
60		* @return self
61		*/
62	1	public function encode(bool $value): self
63		{
64	1	$new = clone $this;
65	1	$new->encode = $value;
66	1	return $new;
67		}
68
69		/**
70		* Set the footer text for the error summary
71		*
72		* @param string $value
73		*
74		* @return self
75		*/
76	5	public function footer(string $value): self
77		{
78	5	$new = clone $this;
79	5	$new->footer = $value;
80	5	return $new;
81		}
82
83		/**
84		* Set footer attributes for the error summary.
85		*
86		* @param array $values Attribute values indexed by attribute names.
87		*
88		* @return self
89		*
90		* See {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
91		*/
92	4	public function footerAttributes(array $values): self
93		{
94	4	$new = clone $this;
95	4	$new->footerAttributes = $values;
96	4	return $new;
97		}
98
99		/**
100		* Set the header text for the error summary
101		*
102		* @param string $value
103		*
104		* @return self
105		*/
106	2	public function header(string $value): self
107		{
108	2	$new = clone $this;
109	2	$new->header = $value;
110	2	return $new;
111		}
112
113		/**
114		* Set header attributes for the error summary.
115		*
116		* @param array $values Attribute values indexed by attribute names.
117		*
118		* @return self
119		*
120		* See {@see \Yiisoft\Html\Html::renderTagAttributes()} for details on how attributes are being rendered.
121		*/
122	4	public function headerAttributes(array $values): self
123		{
124	4	$new = clone $this;
125	4	$new->headerAttributes = $values;
126	4	return $new;
127		}
128
129		/**
130		* Set the model for the error summary.
131		*
132		* @param FormModelInterface $formModel
133		*
134		* @return self
135		*/
136	7	public function model(FormModelInterface $formModel): self
137		{
138	7	$new = clone $this;
139	7	$new->formModel = $formModel;
140	7	return $new;
141		}
142
143		/**
144		* Whether to show all errors.
145		*
146		* @param bool $value
147		*
148		* @return self
149		*/
150	5	public function showAllErrors(bool $value): self
151		{
152	5	$new = clone $this;
153	5	$new->showAllErrors = $value;
154	5	return $new;
155		}
156
157		/**
158		* Specific attributes to be filtered out when rendering the error summary.
159		*
160		* @param array $values The attributes to be included in error summary.
161		*
162		* @return self
163		*/
164	5	public function onlyAttributes(string ...$values): self
165		{
166	5	$new = clone $this;
167	5	$new->onlyAttributes = $values;
168	5	return $new;
169		}
170
171		/**
172		* Set the container tag name for the error summary.
173		*
174		* Empty to render error messages without container {@see Html::tag()}.
175		*
176		* @param string $value
177		*
178		* @return self
179		*/
180	2	public function tag(string $value): self
181		{
182	2	$new = clone $this;
183	2	$new->tag = $value;
184	2	return $new;
185		}
186
187		/**
188		* Return array of the validation errors.
189		*
190		* @return array of the validation errors.
191		*/
192	6	private function collectErrors(): array
193		{
194	6	$errors = HtmlFormErrors::getErrorSummaryFirstErrors($this->getFormModel());
195	6	$errorMessages = [];
196
197	6	if ($this->showAllErrors) {
198	3	$errors = HtmlFormErrors::getErrorSummary($this->getFormModel(), $this->onlyAttributes);
199	3	} elseif ($this->onlyAttributes !== []) {
200	1	$errors = array_intersect_key($errors, array_flip($this->onlyAttributes));
201		}
202
203		/**
204		* If there are the same error messages for different attributes, array_unique will leave gaps between
205		* sequential keys. Applying array_values to reorder array keys.
206		*/
207	6	$lines = array_values(array_unique($errors));
208
209	6	if ($this->encode) {
210		/** @var string $line */
211	6	foreach ($lines as $line) {
212	5	if (!empty($line)) {
213	5	$errorMessages[] = Html::encode($line);
214		}
215		}
216		}
217
218	6	return $errorMessages;
219		}
220
221		/**
222		* Generates a summary of the validation errors.
223		*
224		* @return string the generated error summary
225		*/
226	7	protected function run(): string
227		{
228	7	$attributes = $this->attributes;
229	7	$content = '';
230
231	7	if ($this->tag === '') {
232	1	throw new InvalidArgumentException('Tag name cannot be empty.');
233		}
234
235	6	$content .= P::tag()->attributes($this->headerAttributes)->content($this->header)->render() . PHP_EOL;
236
237		/** @var array<string, string> */
238	6	$lines = $this->collectErrors();
239	6	$content .= Ul::tag()->strings($lines)->render();
240
241	6	if ($this->footer !== '') {
242	1	$content .= PHP_EOL . P::tag()->attributes($this->footerAttributes)->content($this->footer)->render();
243		}
244
245	6	return match (empty($lines)) {
246	1	true => '',
247	5	false => CustomTag::name($this->tag)
248	5	->attributes($attributes)
249	5	->encode(false)
250	5	->content(PHP_EOL . $content . PHP_EOL)
251	6	->render(),
252		};
253		}
254
255		/**
256		* Return FormModelInterface object.
257		*
258		* @return FormModelInterface
259		*/
260	7	private function getFormModel(): FormModelInterface
261		{
262	7	return match (empty($this->formModel)) {
263	1	true => throw new FormModelNotSetException(),
264	6	false => $this->formModel,
265		};
266		}
267		}
268

yiisoft / form

Pull Request — master (#191)

ErrorSummary::getFormModel() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like