Checkbox::__toString() - Code Metrics - thephpleague/climate - Measure and Improve Code Quality continuously with Scrutinizer

Checkbox::__toString() A
last analyzed 2021-01-10 21:21 UTC

↳ Parent: Checkbox

Complexity

Conditions	3
Paths	3

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	4
CRAP Score	3

Importance

Changes

Metric	Value
dl	0
loc	12
ccs	4
cts	4
cp	1
rs	9.8666
c	0
b	0
f	0
cc	3
nc	3
nop	0
crap	3

<?php

namespace League\CLImate\TerminalObject\Dynamic\Checkbox;

use League\CLImate\Decorator\Parser\ParserImporter;
use League\CLImate\TerminalObject\Helper\StringLength;
use League\CLImate\Util\UtilImporter;

class Checkbox
{
    use StringLength, ParserImporter, UtilImporter;

    /**
     * The value of the checkbox
     *
     * @var string|int|bool $value
     */
    protected $value;

    /**
     * The label for the checkbox
     *
     * @var string|int $label
     */
    protected $label;

    /**
     * Whether the checkbox is checked
     *
     * @var bool $checked
     */
    protected $checked = false;

    /**
     * Whether pointer is currently pointing at the checkbox
     *
     * @var bool $current
     */
    protected $current = false;

    /**
     * Whether the checkbox is the first in the group
     *
     * @var bool $first
     */
    protected $first = false;

    /**
     * Whether the checkbox is the last in the group
     *
     * @var bool $last
     */
    protected $last = false;

    public function __construct($label, $value)
    {
        $this->value = (!is_int($value)) ? $value : $label;
        $this->label = $label;
    }

    /**
     * @return bool
     */
    public function isCurrent()
    {
        return $this->current;
    }

    /**
     * @return bool
     */
    public function isChecked()
    {
        return $this->checked;
    }

    /**
     * @return bool
     */
    public function isFirst()
    {
        return $this->first;
    }

    /**
     * @return bool
     */
    public function isLast()
    {
        return $this->last;
    }

    /**
     * Set whether the pointer is currently pointing at this checkbox
     *
     * @param bool $current
     *
     * @return Checkbox
     */
    public function setCurrent($current = true)
    {
        $this->current = $current;

        return $this;
    }

    /**
     * Set whether the checkbox is currently checked
     *
     * @param bool $checked
     *
     * @return Checkbox
     */
    public function setChecked($checked = true)
    {
        $this->checked = $checked;

        return $this;
    }

    /**
     * @return Checkbox
     */
    public function setFirst()
    {
        $this->first = true;

        return $this;
    }

    /**
     * @return Checkbox
     */
    public function setLast()
    {
        $this->last = true;

        return $this;
    }

    /**
     * @return string|int|bool
     */
    public function getValue()
    {
        return $this->value;
    }

    /**
     * Build out basic checkbox string based on current options
     *
     * @return string
     */
    protected function buildCheckboxString()
    {
        $parts = [
            ($this->isCurrent()) ? $this->pointer() : ' ',
            $this->checkbox($this->isChecked()),
            $this->label,
        ];

        $line = implode(' ', $parts);

        return $line . $this->getPaddingString($line);
    }

    /**
     * Get the padding string based on the length of the terminal/line
     *
     * @param string $line
     *
     * @return string
     */
    protected function getPaddingString($line)
    {
        $length = $this->util->width() - $this->lengthWithoutTags($line);
        if ($length < 1) {
            return '';
        }

        return str_repeat(' ', $length);
    }

    /**
     * Get the checkbox symbol
     *
     * @param bool $checked
     *
     * @return string
     */
    protected function checkbox($checked)
    {
        if ($checked) {
            return html_entity_decode("&#x25CF;");
        }

        return html_entity_decode("&#x25CB;");
    }

    /**
     * Get the pointer symbol
     *
     * @return string
     */
    protected function pointer()
    {
        return html_entity_decode("&#x276F;");
    }

    public function __toString()
    {
        if ($this->isFirst()) {
            return $this->buildCheckboxString();
        }

        if ($this->isLast()) {
            return $this->buildCheckboxString() . $this->util->cursor->left(10) . '<hidden>';
        }

        return $this->buildCheckboxString();
    }
}


1		<?php
2
3		namespace League\CLImate\TerminalObject\Dynamic\Checkbox;
4
5		use League\CLImate\Decorator\Parser\ParserImporter;
6		use League\CLImate\TerminalObject\Helper\StringLength;
7		use League\CLImate\Util\UtilImporter;
8
9		class Checkbox
10		{
11		use StringLength, ParserImporter, UtilImporter;
12
13		/**
14		* The value of the checkbox
15		*
16		* @var string\|int\|bool $value
17		*/
18		protected $value;
19
20		/**
21		* The label for the checkbox
22		*
23		* @var string\|int $label
24		*/
25		protected $label;
26
27		/**
28		* Whether the checkbox is checked
29		*
30		* @var bool $checked
31		*/
32		protected $checked = false;
33
34		/**
35		* Whether pointer is currently pointing at the checkbox
36		*
37		* @var bool $current
38		*/
39		protected $current = false;
40
41		/**
42		* Whether the checkbox is the first in the group
43		*
44		* @var bool $first
45		*/
46		protected $first = false;
47
48		/**
49		* Whether the checkbox is the last in the group
50		*
51		* @var bool $last
52		*/
53		protected $last = false;
54
55	16	public function __construct($label, $value)
56		{
57	16	$this->value = (!is_int($value)) ? $value : $label;
58	16	$this->label = $label;
59	16	}
60
61		/**
62		* @return bool
63		*/
64	16	public function isCurrent()
65		{
66	16	return $this->current;
67		}
68
69		/**
70		* @return bool
71		*/
72	16	public function isChecked()
73		{
74	16	return $this->checked;
75		}
76
77		/**
78		* @return bool
79		*/
80	16	public function isFirst()
81		{
82	16	return $this->first;
83		}
84
85		/**
86		* @return bool
87		*/
88	16	public function isLast()
89		{
90	16	return $this->last;
91		}
92
93		/**
94		* Set whether the pointer is currently pointing at this checkbox
95		*
96		* @param bool $current
97		*
98		* @return Checkbox
99		*/
100	16	public function setCurrent($current = true)
101		{
102	16	$this->current = $current;
103
104	16	return $this;
105		}
106
107		/**
108		* Set whether the checkbox is currently checked
109		*
110		* @param bool $checked
111		*
112		* @return Checkbox
113		*/
114	16	public function setChecked($checked = true)
115		{
116	16	$this->checked = $checked;
117
118	16	return $this;
119		}
120
121		/**
122		* @return Checkbox
123		*/
124	16	public function setFirst()
125		{
126	16	$this->first = true;
127
128	16	return $this;
129		}
130
131		/**
132		* @return Checkbox
133		*/
134	16	public function setLast()
135		{
136	16	$this->last = true;
137
138	16	return $this;
139		}
140
141		/**
142		* @return string\|int\|bool
143		*/
144	12	public function getValue()
145		{
146	12	return $this->value;
147		}
148
149		/**
150		* Build out basic checkbox string based on current options
151		*
152		* @return string
153		*/
154	16	protected function buildCheckboxString()
155		{
156		$parts = [
157	16	($this->isCurrent()) ? $this->pointer() : ' ',
158	16	$this->checkbox($this->isChecked()),
159	16	$this->label,
160	16	];
161
162	16	$line = implode(' ', $parts);
163
164	16	return $line . $this->getPaddingString($line);
165		}
166
167		/**
168		* Get the padding string based on the length of the terminal/line
169		*
170		* @param string $line
171		*
172		* @return string
173		*/
174	16	protected function getPaddingString($line)
175		{
176	16	$length = $this->util->width() - $this->lengthWithoutTags($line);
177		if ($length < 1) {
178	16	return '';
179		}
180
181		return str_repeat(' ', $length);
182		}
183
184		/**
185		* Get the checkbox symbol
186		*
187		* @param bool $checked
188	16	*
189		* @return string
190	16	*/
191	16	protected function checkbox($checked)
192		{
193		if ($checked) {
194	16	return html_entity_decode("●");
195		}
196
197		return html_entity_decode("○");
198		}
199
200		/**
201		* Get the pointer symbol
202	16	*
203		* @return string
204	16	*/
205		protected function pointer()
206		{
207	16	return html_entity_decode("❯");
208		}
209	16
210	16	public function __toString()
211		{
212		if ($this->isFirst()) {
213	16	return $this->buildCheckboxString();
214	16	}
215
216		if ($this->isLast()) {
217	16	return $this->buildCheckboxString() . $this->util->cursor->left(10) . '<hidden>';
218		}
219
220		return $this->buildCheckboxString();
221		}
222		}
223

thephpleague / climate

Checkbox::__toString() A last analyzed 2021-01-10 21:21 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

Checkbox::__toString() A
last analyzed 2021-01-10 21:21 UTC