Completed
Pull Request — master (#67)
by
unknown
03:29
created

Select::required()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
cc 1
eloc 2
nc 1
nop 0
dl 0
loc 4
rs 10
c 0
b 0
f 0
1
<?php
2
3
namespace Spatie\Html\Elements;
4
5
use Illuminate\Support\Str;
6
use Spatie\Html\Selectable;
7
use Spatie\Html\BaseElement;
8
use Illuminate\Support\Collection;
9
10
class Select extends BaseElement
11
{
12
    /** @var string */
13
    protected $tag = 'select';
14
15
    /** @var array */
16
    protected $options = [];
17
18
    /** @var string|iterable */
19
    protected $value = '';
20
21
    /**
22
     * @return static
23
     */
24
    public function multiple()
25
    {
26
        $element = clone $this;
27
28
        $element = $element->attribute('multiple');
29
30
        $name = $element->getAttribute('name');
31
32
        if ($name && ! Str::endsWith($name, '[]')) {
33
            $element = $element->name($name.'[]');
34
        }
35
36
        $element->applyValueToOptions();
37
38
        return $element;
39
    }
40
41
    /**
42
     * @param string|null $name
43
     *
44
     * @return static
45
     */
46
    public function name($name)
47
    {
48
        return $this->attribute('name', $name);
49
    }
50
51
    /**
52
     * @param iterable $options
53
     *
54
     * @return static
55
     */
56 View Code Duplication
    public function options($options)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
57
    {
58
        return $this->addChildren($options, function ($text, $value) {
59
            if (is_array($text)) {
60
                return $this->optgroup($value, $text);
0 ignored issues
show
Documentation introduced by
$text is of type array, but the function expects a object<Spatie\Html\Elements\iterable>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
61
            }
62
63
            return Option::create()
64
                ->value($value)
65
                ->text($text)
66
                ->selectedIf($value === $this->value);
67
        });
68
    }
69
70
    /**
71
     * @param string $label
72
     * @param iterable $options
73
     *
74
     * @return static
75
     */
76 View Code Duplication
    public function optgroup($label, $options)
0 ignored issues
show
Duplication introduced by
This method seems to be duplicated in your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
77
    {
78
        return Optgroup::create()
79
            ->label($label)
80
            ->addChildren($options, function ($text, $value) {
81
                return Option::create()
82
                    ->value($value)
83
                    ->text($text)
84
                    ->selectedIf($value === $this->value);
85
            });
86
87
        return $this->addChild($optgroup);
0 ignored issues
show
Unused Code introduced by
return $this->addChild($optgroup); does not seem to be reachable.

This check looks for unreachable code. It uses sophisticated control flow analysis techniques to find statements which will never be executed.

Unreachable code is most often the result of return, die or exit statements that have been added for debug purposes.

function fx() {
    try {
        doSomething();
        return true;
    }
    catch (\Exception $e) {
        return false;
    }

    return false;
}

In the above example, the last return false will never be executed, because a return statement has already been met in every possible execution path.

Loading history...
88
    }
89
90
    /**
91
     * @param string|null $text
92
     *
93
     * @return static
94
     */
95
    public function placeholder($text)
96
    {
97
        return $this->prependChild(
98
            Option::create()
99
                ->value('')
100
                ->text($text)
101
                ->selectedIf(! $this->hasSelection())
102
        );
103
    }
104
105
    /**
106
     * @return static
107
     */
108
    public function required()
109
    {
110
        return $this->attribute('required');
111
    }
112
113
    /**
114
     * @param string|iterable $value
115
     *
116
     * @return static
117
     */
118
    public function value($value = null)
119
    {
120
        $element = clone $this;
121
122
        $element->value = $value;
123
124
        $element->applyValueToOptions();
125
126
        return $element;
127
    }
128
129
    protected function hasSelection()
130
    {
131
        return $this->children->contains->hasAttribute('selected');
132
    }
133
134
    protected function applyValueToOptions()
135
    {
136
        $value = Collection::make($this->value);
137
138
        if (! $this->hasAttribute('multiple')) {
139
            $value = $value->take(1);
140
        }
141
142
        $this->children = $this->applyValueToElements($value, $this->children);
143
    }
144
145
    protected function applyValueToElements($value, Collection $children)
146
    {
147
        return $children->map(function ($child) use ($value) {
148
            if ($child instanceof Optgroup) {
149
                return $child->setChildren($this->applyValueToElements($value, $child->children));
0 ignored issues
show
Bug introduced by
The property children cannot be accessed from this context as it is declared protected in class Spatie\Html\BaseElement.

This check looks for access to properties that are not accessible from the current context.

If you need to make a property accessible to another context you can either raise its visibility level or provide an accessible getter in the defining class.

Loading history...
Documentation introduced by
$this->applyValueToEleme...alue, $child->children) is of type object<Illuminate\Support\Collection>, but the function expects a array<integer,object<Spatie\Html\HtmlElement>>.

It seems like the type of the argument is not accepted by the function/method which you are calling.

In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug.

We suggest to add an explicit type cast like in the following example:

function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
Loading history...
150
            }
151
152
            if ($child instanceof Selectable) {
153
                return $child->selectedIf($value->contains($child->getAttribute('value')));
154
            }
155
156
            return $child;
157
        });
158
    }
159
}
160