Hint::run() - Code Metrics - Inspection of "Big refactoring (v. 2)" - yiisoft/form - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#192)

by Alexander

created 2022-05-16 14:56 UTC

Hint::run() A

↳ Parent: Hint

Complexity

Conditions	3
Paths	4

Size

Total Lines	11
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	9
CRAP Score	3

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

namespace Yiisoft\Form\Field\Part;

use InvalidArgumentException;
use Stringable;
use Yiisoft\Form\Field\Base\FormAttributeTrait;
use Yiisoft\Html\Html;
use Yiisoft\Widget\Widget;

/**
 * Represents hint for a form field.
 */
final class Hint extends Widget
{
    use FormAttributeTrait;

    /**
     * @psalm-var non-empty-string
     */
    private string $tag = 'div';
    private array $tagAttributes = [];

    private string|Stringable|null $content = null;

    private bool $encode = true;

    /**
     * Set the container tag name for the hint.
     *
     * @param string $tag Container tag name.
     */
    public function tag(string $tag): self
    {
        if ($tag === '') {
            throw new InvalidArgumentException('Tag name cannot be empty.');
        }

        $new = clone $this;
        $new->tag = $tag;
        return $new;
    }

    public function tagAttributes(array $attributes): self
    {
        $new = clone $this;
        $new->tagAttributes = $attributes;
        return $new;
    }

    public function content(string|Stringable|null $content): self
    {
        $new = clone $this;
        $new->content = $content;
        return $new;
    }

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

    protected function run(): string
    {
        $content = $this->hasFormModelAndAttribute()
            ? $this->content ?? $this->getAttributeHint()
            : (string) $this->content;

        return $content === ''
            ? ''
            : Html::tag($this->tag, $content, $this->tagAttributes)
                ->encode($this->encode)
                ->render();
    }
}


1		<?php
2
3		declare(strict_types=1);
4
5		namespace Yiisoft\Form\Field\Part;
6
7		use InvalidArgumentException;
8		use Stringable;
9		use Yiisoft\Form\Field\Base\FormAttributeTrait;
10		use Yiisoft\Html\Html;
11		use Yiisoft\Widget\Widget;
12
13		/**
14		* Represents hint for a form field.
15		*/
16		final class Hint extends Widget
17		{
18		use FormAttributeTrait;
19
20		/**
21		* @psalm-var non-empty-string
22		*/
23		private string $tag = 'div';
24		private array $tagAttributes = [];
25
26		private string\|Stringable\|null $content = null;
27
28		private bool $encode = true;
29
30		/**
31		* Set the container tag name for the hint.
32		*
33		* @param string $tag Container tag name.
34		*/
35	5	public function tag(string $tag): self
36		{
37	5	if ($tag === '') {
38	1	throw new InvalidArgumentException('Tag name cannot be empty.');
39		}
40
41	4	$new = clone $this;
42	4	$new->tag = $tag;
43	4	return $new;
44		}
45
46	4	public function tagAttributes(array $attributes): self
47		{
48	4	$new = clone $this;
49	4	$new->tagAttributes = $attributes;
50	4	return $new;
51		}
52
53	7	public function content(string\|Stringable\|null $content): self
54		{
55	7	$new = clone $this;
56	7	$new->content = $content;
57	7	return $new;
58		}
59
60		/**
61		* Whether content should be HTML-encoded.
62		*
63		* @param bool $value
64		*/
65	2	public function encode(bool $value): self
66		{
67	2	$new = clone $this;
68	2	$new->encode = $value;
69	2	return $new;
70		}
71
72	422	protected function run(): string
73		{
74	422	$content = $this->hasFormModelAndAttribute()
75	342	? $this->content ?? $this->getAttributeHint()
76	82	: (string) $this->content;
77
78	422	return $content === ''
79	367	? ''
80	55	: Html::tag($this->tag, $content, $this->tagAttributes)
81	55	->encode($this->encode)
82	422	->render();
83		}
84		}
85

yiisoft / form

Pull Request — master (#192)

Hint::run() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like