MenuStyle::getFg() - Code Metrics - Inspection of "Checkbox + Radio item-level styling (3rd try)" - php-school/cli-menu - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#211)

unknown

created 2019-12-20 07:18 UTC

MenuStyle::getFg() A

↳ Parent: MenuStyle

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	1
eloc	1
nc	1
nop	0
dl	0
loc	3
rs	10
c	0
b	0
f	0

<?php

namespace PhpSchool\CliMenu;

use PhpSchool\CliMenu\Terminal\TerminalFactory;
use PhpSchool\CliMenu\Util\ColourUtil;
use PhpSchool\Terminal\Terminal;
use Assert\Assertion;

//TODO: B/W fallback

/**
 * @author Michael Woodward <[email protected]>
 */
class MenuStyle
{
    /**
     * @var Terminal
     */
    protected $terminal;

    /**
     * @var string
     */
    protected $fg;

    /**
     * @var string
     */
    protected $bg;

    /**
     * @var int
     */
    protected $width;

    /**
     * @var int
     */
    protected $margin;

    /**
     * @var int
     */
    protected $paddingTopBottom;

    /**
     * @var int
     */
    protected $paddingLeftRight;

    /**
     * @var array
     */
    private $paddingTopBottomRows = [];

    /**
     * @var int
     */
    protected $contentWidth;

    /**
     * @var string
     */
    private $selectedMarker;

    /**
     * @var string
     */
    private $unselectedMarker;

    /**
     * @var string
     */
    private $itemExtra;

    /**
     * @var bool
     */
    private $displaysExtra;

    /**
     * @var string
     */
    private $titleSeparator;

    /**
     * @var string
     */
    private $coloursSetCode;

    /**
     * @var string
     */
    private $invertedColoursSetCode = "\033[7m";

    /**
     * @var string
     */
    private $invertedColoursUnsetCode = "\033[27m";

    /**
     * @var string
     */
    private $coloursResetCode = "\033[0m";

    /**
     * @var int
     */
    private $borderTopWidth;

    /**
     * @var int
     */
    private $borderRightWidth;

    /**
     * @var int
     */
    private $borderBottomWidth;

    /**
     * @var int
     */
    private $borderLeftWidth;

    /**
     * @var string
     */
    private $borderColour = 'white';

    /**
     * @var array
     */
    private $borderTopRows = [];

    /**
     * @var array
     */
    private $borderBottomRows = [];

    /**
     * @var bool
     */
    private $marginAuto = false;

    /**
     * Default Values
     *
     * @var array
     */
    private static $defaultStyleValues = [
        'fg' => 'white',
        'bg' => 'blue',
        'width' => 100,
        'paddingTopBottom' => 1,
        'paddingLeftRight' => 2,
        'margin' => 2,
        'selectedMarker' => '● ',
        'unselectedMarker' => '○ ',
        'itemExtra' => '✔',
        'displaysExtra' => false,
        'titleSeparator' => '=',
        'borderTopWidth' => 0,
        'borderRightWidth' => 0,
        'borderBottomWidth' => 0,
        'borderLeftWidth' => 0,
        'borderColour' => 'white',
        'marginAuto' => false,
    ];

    /**
     * @var array
     */
    private static $availableForegroundColors = [
        'black'   => 30,
        'red'     => 31,
        'green'   => 32,
        'yellow'  => 33,
        'blue'    => 34,
        'magenta' => 35,
        'cyan'    => 36,
        'white'   => 37,
        'default' => 39,
    ];

    /**
     * @var array
     */
    private static $availableBackgroundColors = [
        'black'   => 40,
        'red'     => 41,
        'green'   => 42,
        'yellow'  => 43,
        'blue'    => 44,
        'magenta' => 45,
        'cyan'    => 46,
        'white'   => 47,
        'default' => 49,
    ];

    /**
     * @var array
     */
    private static $availableOptions = [
        'bold'       => ['set' => 1, 'unset' => 22],
        'dim'        => ['set' => 2, 'unset' => 22],
        'underscore' => ['set' => 4, 'unset' => 24],
        'blink'      => ['set' => 5, 'unset' => 25],
        'reverse'    => ['set' => 7, 'unset' => 27],
        'conceal'    => ['set' => 8, 'unset' => 28]
    ];

    /**
     * Initialise style
     */
    public function __construct(Terminal $terminal = null)
    {
        $this->terminal = $terminal ?: TerminalFactory::fromSystem();

        $this->fg = self::$defaultStyleValues['fg'];
        $this->bg = self::$defaultStyleValues['bg'];

        $this->generateColoursSetCode();

        $this->setWidth(self::$defaultStyleValues['width']);
        $this->setPaddingTopBottom(self::$defaultStyleValues['paddingTopBottom']);
        $this->setPaddingLeftRight(self::$defaultStyleValues['paddingLeftRight']);
        $this->setMargin(self::$defaultStyleValues['margin']);
        $this->setSelectedMarker(self::$defaultStyleValues['selectedMarker']);
        $this->setUnselectedMarker(self::$defaultStyleValues['unselectedMarker']);
        $this->setItemExtra(self::$defaultStyleValues['itemExtra']);
        $this->setDisplaysExtra(self::$defaultStyleValues['displaysExtra']);
        $this->setTitleSeparator(self::$defaultStyleValues['titleSeparator']);
        $this->setBorderTopWidth(self::$defaultStyleValues['borderTopWidth']);
        $this->setBorderRightWidth(self::$defaultStyleValues['borderRightWidth']);
        $this->setBorderBottomWidth(self::$defaultStyleValues['borderBottomWidth']);
        $this->setBorderLeftWidth(self::$defaultStyleValues['borderLeftWidth']);
        $this->setBorderColour(self::$defaultStyleValues['borderColour']);
    }

    public function hasChangedFromDefaults() : bool
    {
        $currentValues = [
            $this->fg,
            $this->bg,
            $this->width,
            $this->paddingTopBottom,
            $this->paddingLeftRight,
            $this->margin,
            $this->selectedMarker,
            $this->unselectedMarker,
            $this->itemExtra,
            $this->displaysExtra,
            $this->titleSeparator,
            $this->borderTopWidth,
            $this->borderRightWidth,
            $this->borderBottomWidth,
            $this->borderLeftWidth,
            $this->borderColour,
            $this->marginAuto,
        ];
                
        return $currentValues !== array_values(self::$defaultStyleValues);
    }

    public function getDisabledItemText(string $text) : string
    {
        return sprintf(
            "\033[%sm%s\033[%sm",
            self::$availableOptions['dim']['set'],
            $text,
            self::$availableOptions['dim']['unset']
        );
    }

    /**
     * Generates the ansi escape sequence to set the colours
     */
    private function generateColoursSetCode() : void
    {
        if (!ctype_digit($this->fg)) {
            $fgCode = self::$availableForegroundColors[$this->fg];
        } else {
            $fgCode = sprintf("38;5;%s", $this->fg);
        }

        if (!ctype_digit($this->bg)) {
            $bgCode = self::$availableBackgroundColors[$this->bg];
        } else {
            $bgCode = sprintf("48;5;%s", $this->bg);
        }

        $this->coloursSetCode = sprintf("\033[%s;%sm", $fgCode, $bgCode);
    }

    /**
     * Get the colour code for Bg and Fg
     */
    public function getColoursSetCode() : string
    {
        return $this->coloursSetCode;
    }

    /**
     * Get the inverted escape sequence (used for selected elements)
     */
    public function getInvertedColoursSetCode() : string
    {
        return $this->invertedColoursSetCode;
    }

    /**
     * Get the inverted escape sequence (used for selected elements)
     */
    public function getInvertedColoursUnsetCode() : string
    {
        return $this->invertedColoursUnsetCode;
    }

    /**
     * Get the escape sequence used to reset colours to default
     */
    public function getColoursResetCode() : string
    {
        return $this->coloursResetCode;
    }

    /**
     * Calculate the contents width
     */
    protected function calculateContentWidth() : void
    {
        $this->contentWidth = $this->width
            - ($this->paddingLeftRight * 2)
            - ($this->borderRightWidth + $this->borderLeftWidth);

        if ($this->contentWidth < 0) {
            $this->contentWidth = 0;
        }
    }

    public function getFg()
    {
        return $this->fg;
    }

    public function setFg(string $fg, string $fallback = null) : self
    {
        $this->fg = ColourUtil::validateColour(
            $this->terminal,
            $fg,
            $fallback
        );
        $this->generateColoursSetCode();

        return $this;
    }

    public function getBg()
    {
        return $this->bg;
    }

    public function setBg(string $bg, string $fallback = null) : self
    {
        $this->bg = ColourUtil::validateColour(
            $this->terminal,
            $bg,
            $fallback
        );

        $this->generateColoursSetCode();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function getWidth() : int
    {
        return $this->width;
    }

    public function setWidth(int $width) : self
    {
        Assertion::greaterOrEqualThan($width, 0);

        if ($width >= $this->terminal->getWidth()) {
            $width = $this->terminal->getWidth();
        }

        $this->width = $width;
        if ($this->marginAuto) {
            $this->setMarginAuto();
        }

        $this->calculateContentWidth();
        $this->generateBorderRows();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function getPaddingTopBottom() : int
    {
        return $this->paddingTopBottom;
    }

    public function getPaddingLeftRight() : int
    {
        return $this->paddingLeftRight;
    }

    private function generatePaddingTopBottomRows() : void
    {
        if ($this->borderLeftWidth || $this->borderRightWidth) {
            $borderColour = $this->getBorderColourCode();
        } else {
            $borderColour = '';
        }

        $paddingRow = sprintf(
            "%s%s%s%s%s%s%s%s%s%s\n",
            str_repeat(' ', $this->margin),
            $borderColour,
            str_repeat(' ', $this->borderLeftWidth),
            $this->getColoursSetCode(),
            str_repeat(' ', $this->paddingLeftRight),
            str_repeat(' ', $this->contentWidth),
            str_repeat(' ', $this->paddingLeftRight),
            $borderColour,
            str_repeat(' ', $this->borderRightWidth),
            $this->coloursResetCode
        );

        $this->paddingTopBottomRows = array_fill(0, $this->paddingTopBottom, $paddingRow);
    }

    public function getPaddingTopBottomRows() : array
    {
        return $this->paddingTopBottomRows;
    }

    public function setPadding(int $topBottom, int $leftRight = null) : self
    {
        if ($leftRight === null) {
            $leftRight = $topBottom;
        }

        $this->setPaddingTopBottom($topBottom);
        $this->setPaddingLeftRight($leftRight);

        $this->calculateContentWidth();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function setPaddingTopBottom(int $topBottom) : self
    {
        Assertion::greaterOrEqualThan($topBottom, 0);
        $this->paddingTopBottom = $topBottom;

        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function setPaddingLeftRight(int $leftRight) : self
    {
        Assertion::greaterOrEqualThan($leftRight, 0);
        $this->paddingLeftRight = $leftRight;

        $this->calculateContentWidth();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function getMargin() : int
    {
        return $this->margin;
    }

    public function setMarginAuto() : self
    {
        $this->marginAuto = true;
        $this->margin = (int) floor(($this->terminal->getWidth() - $this->width) / 2);

        $this->generateBorderRows();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function setMargin(int $margin) : self
    {
        Assertion::greaterOrEqualThan($margin, 0);

        $this->marginAuto = false;
        $this->margin = $margin;

        $this->generateBorderRows();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function getContentWidth() : int
    {
        return $this->contentWidth;
    }

    /**
     * Get padding for right had side of content
     */
    public function getRightHandPadding(int $contentLength) : int
    {
        $rightPadding = $this->getContentWidth() - $contentLength + $this->getPaddingLeftRight();

        if ($rightPadding < 0) {
            $rightPadding = 0;
        }

        return $rightPadding;
    }

    public function getSelectedMarker() : string
    {
        return $this->selectedMarker;
    }

    public function setSelectedMarker(string $marker) : self
    {
        $this->selectedMarker = $marker;

        return $this;
    }

    public function getUnselectedMarker() : string
    {
        return $this->unselectedMarker;
    }

    public function setUnselectedMarker(string $marker) : self
    {
        $this->unselectedMarker = $marker;

        return $this;
    }

    /**
     * Get the correct marker for the item
     */
    public function getMarker(bool $selected) : string
    {
        return $selected ? $this->selectedMarker : $this->unselectedMarker;
    }

    public function setItemExtra(string $itemExtra) : self
    {
        $this->itemExtra = $itemExtra;

        return $this;
    }

    public function getItemExtra() : string
    {
        return $this->itemExtra;
    }

    public function getDisplaysExtra() : bool
    {
        return $this->displaysExtra;
    }

    public function setDisplaysExtra(bool $displaysExtra) : self
    {
        $this->displaysExtra = $displaysExtra;

        return $this;
    }

    public function getTitleSeparator() : string
    {
        return $this->titleSeparator;
    }

    public function setTitleSeparator(string $actionSeparator) : self
    {
        $this->titleSeparator = $actionSeparator;

        return $this;
    }

    private function generateBorderRows() : void
    {
        $borderRow = sprintf(
            "%s%s%s%s\n",
            str_repeat(' ', $this->margin),
            $this->getBorderColourCode(),
            str_repeat(' ', $this->width),
            $this->coloursResetCode
        );

        $this->borderTopRows = array_fill(0, $this->borderTopWidth, $borderRow);
        $this->borderBottomRows = array_fill(0, $this->borderBottomWidth, $borderRow);
    }

    public function getBorderTopRows() : array
    {
        return $this->borderTopRows;
    }

    public function getBorderBottomRows() : array
    {
        return $this->borderBottomRows;
    }

    /**
     * Shorthand function to set all borders values at once
     */
    public function setBorder(
        int $topWidth,
        $rightWidth = null,
        $bottomWidth = null,
        $leftWidth = null,
        string $colour = null
    ) : self {
        if (!is_int($rightWidth)) {
            $colour = $rightWidth;
            $rightWidth = $bottomWidth = $leftWidth = $topWidth;
        } elseif (!is_int($bottomWidth)) {
            $colour = $bottomWidth;
            $bottomWidth = $topWidth;
            $leftWidth = $rightWidth;
        } elseif (!is_int($leftWidth)) {
            $colour = $leftWidth;
            $leftWidth = $rightWidth;
        }

        $this->borderTopWidth = $topWidth;
        $this->borderRightWidth = $rightWidth;
        $this->borderBottomWidth = $bottomWidth;
        $this->borderLeftWidth = $leftWidth;

        if (is_string($colour)) {
            $this->setBorderColour($colour);
        } elseif ($colour !== null) {
            throw new \InvalidArgumentException('Invalid colour');
        }

        $this->calculateContentWidth();
        $this->generateBorderRows();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function setBorderTopWidth(int $width) : self
    {
        $this->borderTopWidth = $width;

        $this->generateBorderRows();

        return $this;
    }

    public function setBorderRightWidth(int $width) : self
    {
        $this->borderRightWidth = $width;
        $this->calculateContentWidth();

        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function setBorderBottomWidth(int $width) : self
    {
        $this->borderBottomWidth = $width;

        $this->generateBorderRows();

        return $this;
    }

    public function setBorderLeftWidth(int $width) : self
    {
        $this->borderLeftWidth = $width;
        $this->calculateContentWidth();

        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function setBorderColour(string $colour, $fallback = null) : self
    {
        $this->borderColour = ColourUtil::validateColour(
            $this->terminal,
            $colour,
            $fallback
        );

        $this->generateBorderRows();
        $this->generatePaddingTopBottomRows();

        return $this;
    }

    public function getBorderTopWidth() : int
    {
        return $this->borderTopWidth;
    }

    public function getBorderRightWidth() : int
    {
        return $this->borderRightWidth;
    }

    public function getBorderBottomWidth() : int
    {
        return $this->borderBottomWidth;
    }

    public function getBorderLeftWidth() : int
    {
        return $this->borderLeftWidth;
    }

    public function getBorderColour() : string
    {
        return $this->borderColour;
    }

    public function getBorderColourCode() : string
    {
        if (!ctype_digit($this->borderColour)) {
            $borderColourCode = self::$availableBackgroundColors[$this->borderColour];
        } else {
            $borderColourCode = sprintf("48;5;%s", $this->borderColour);
        }

        return sprintf("\033[%sm", $borderColourCode);
    }
}


1			<?php
2
3			namespace PhpSchool\CliMenu;
4
5			use PhpSchool\CliMenu\Terminal\TerminalFactory;
6			use PhpSchool\CliMenu\Util\ColourUtil;
7			use PhpSchool\Terminal\Terminal;
8			use Assert\Assertion;
9
10			//TODO: B/W fallback
11
12			/**
13			* @author Michael Woodward <[email protected]>
14			*/
15			class MenuStyle
16			{
17			/**
18			* @var Terminal
19			*/
20			protected $terminal;
21
22			/**
23			* @var string
24			*/
25			protected $fg;
26
27			/**
28			* @var string
29			*/
30			protected $bg;
31
32			/**
33			* @var int
34			*/
35			protected $width;
36
37			/**
38			* @var int
39			*/
40			protected $margin;
41
42			/**
43			* @var int
44			*/
45			protected $paddingTopBottom;
46
47			/**
48			* @var int
49			*/
50			protected $paddingLeftRight;
51
52			/**
53			* @var array
54			*/
55			private $paddingTopBottomRows = [];
56
57			/**
58			* @var int
59			*/
60			protected $contentWidth;
61
62			/**
63			* @var string
64			*/
65			private $selectedMarker;
66
67			/**
68			* @var string
69			*/
70			private $unselectedMarker;
71
72			/**
73			* @var string
74			*/
75			private $itemExtra;
76
77			/**
78			* @var bool
79			*/
80			private $displaysExtra;
81
82			/**
83			* @var string
84			*/
85			private $titleSeparator;
86
87			/**
88			* @var string
89			*/
90			private $coloursSetCode;
91
92			/**
93			* @var string
94			*/
95			private $invertedColoursSetCode = "\033[7m";
96
97			/**
98			* @var string
99			*/
100			private $invertedColoursUnsetCode = "\033[27m";
101
102			/**
103			* @var string
104			*/
105			private $coloursResetCode = "\033[0m";
106
107			/**
108			* @var int
109			*/
110			private $borderTopWidth;
111
112			/**
113			* @var int
114			*/
115			private $borderRightWidth;
116
117			/**
118			* @var int
119			*/
120			private $borderBottomWidth;
121
122			/**
123			* @var int
124			*/
125			private $borderLeftWidth;
126
127			/**
128			* @var string
129			*/
130			private $borderColour = 'white';
131
132			/**
133			* @var array
134			*/
135			private $borderTopRows = [];
136
137			/**
138			* @var array
139			*/
140			private $borderBottomRows = [];
141
142			/**
143			* @var bool
144			*/
145			private $marginAuto = false;
146
147			/**
148			* Default Values
149			*
150			* @var array
151			*/
152			private static $defaultStyleValues = [
153			'fg' => 'white',
154			'bg' => 'blue',
155			'width' => 100,
156			'paddingTopBottom' => 1,
157			'paddingLeftRight' => 2,
158			'margin' => 2,
159			'selectedMarker' => '● ',
160			'unselectedMarker' => '○ ',
161			'itemExtra' => '✔',
162			'displaysExtra' => false,
163			'titleSeparator' => '=',
164			'borderTopWidth' => 0,
165			'borderRightWidth' => 0,
166			'borderBottomWidth' => 0,
167			'borderLeftWidth' => 0,
168			'borderColour' => 'white',
169			'marginAuto' => false,
170			];
171
172			/**
173			* @var array
174			*/
175			private static $availableForegroundColors = [
176			'black' => 30,
177			'red' => 31,
178			'green' => 32,
179			'yellow' => 33,
180			'blue' => 34,
181			'magenta' => 35,
182			'cyan' => 36,
183			'white' => 37,
184			'default' => 39,
185			];
186
187			/**
188			* @var array
189			*/
190			private static $availableBackgroundColors = [
191			'black' => 40,
192			'red' => 41,
193			'green' => 42,
194			'yellow' => 43,
195			'blue' => 44,
196			'magenta' => 45,
197			'cyan' => 46,
198			'white' => 47,
199			'default' => 49,
200			];
201
202			/**
203			* @var array
204			*/
205			private static $availableOptions = [
206			'bold' => ['set' => 1, 'unset' => 22],
207			'dim' => ['set' => 2, 'unset' => 22],
208			'underscore' => ['set' => 4, 'unset' => 24],
209			'blink' => ['set' => 5, 'unset' => 25],
210			'reverse' => ['set' => 7, 'unset' => 27],
211			'conceal' => ['set' => 8, 'unset' => 28]
212			];
213
214			/**
215			* Initialise style
216			*/
217			public function __construct(Terminal $terminal = null)
218			{
219			$this->terminal = $terminal ?: TerminalFactory::fromSystem();
220
221			$this->fg = self::$defaultStyleValues['fg'];
222			$this->bg = self::$defaultStyleValues['bg'];
223
224			$this->generateColoursSetCode();
225
226			$this->setWidth(self::$defaultStyleValues['width']);
227			$this->setPaddingTopBottom(self::$defaultStyleValues['paddingTopBottom']);
228			$this->setPaddingLeftRight(self::$defaultStyleValues['paddingLeftRight']);
229			$this->setMargin(self::$defaultStyleValues['margin']);
230			$this->setSelectedMarker(self::$defaultStyleValues['selectedMarker']);
231			$this->setUnselectedMarker(self::$defaultStyleValues['unselectedMarker']);
232			$this->setItemExtra(self::$defaultStyleValues['itemExtra']);
233			$this->setDisplaysExtra(self::$defaultStyleValues['displaysExtra']);
234			$this->setTitleSeparator(self::$defaultStyleValues['titleSeparator']);
235			$this->setBorderTopWidth(self::$defaultStyleValues['borderTopWidth']);
236			$this->setBorderRightWidth(self::$defaultStyleValues['borderRightWidth']);
237			$this->setBorderBottomWidth(self::$defaultStyleValues['borderBottomWidth']);
238			$this->setBorderLeftWidth(self::$defaultStyleValues['borderLeftWidth']);
239			$this->setBorderColour(self::$defaultStyleValues['borderColour']);
240			}
241
242			public function hasChangedFromDefaults() : bool
243			{
244			$currentValues = [
245			$this->fg,
246			$this->bg,
247			$this->width,
248			$this->paddingTopBottom,
249			$this->paddingLeftRight,
250			$this->margin,
251			$this->selectedMarker,
252			$this->unselectedMarker,
253			$this->itemExtra,
254			$this->displaysExtra,
255			$this->titleSeparator,
256			$this->borderTopWidth,
257			$this->borderRightWidth,
258			$this->borderBottomWidth,
259			$this->borderLeftWidth,
260			$this->borderColour,
261			$this->marginAuto,
262			];
263
264			return $currentValues !== array_values(self::$defaultStyleValues);
265			}
266
267			public function getDisabledItemText(string $text) : string
268			{
269			return sprintf(
270			"\033[%sm%s\033[%sm",
271			self::$availableOptions['dim']['set'],
272			$text,
273			self::$availableOptions['dim']['unset']
274			);
275			}
276
277			/**
278			* Generates the ansi escape sequence to set the colours
279			*/
280			private function generateColoursSetCode() : void
281			{
282			if (!ctype_digit($this->fg)) {
283			$fgCode = self::$availableForegroundColors[$this->fg];
284			} else {
285			$fgCode = sprintf("38;5;%s", $this->fg);
286			}
287
288			if (!ctype_digit($this->bg)) {
289			$bgCode = self::$availableBackgroundColors[$this->bg];
290			} else {
291			$bgCode = sprintf("48;5;%s", $this->bg);
292			}
293
294			$this->coloursSetCode = sprintf("\033[%s;%sm", $fgCode, $bgCode);
295			}
296
297			/**
298			* Get the colour code for Bg and Fg
299			*/
300			public function getColoursSetCode() : string
301			{
302			return $this->coloursSetCode;
303			}
304
305			/**
306			* Get the inverted escape sequence (used for selected elements)
307			*/
308			public function getInvertedColoursSetCode() : string
309			{
310			return $this->invertedColoursSetCode;
311			}
312
313			/**
314			* Get the inverted escape sequence (used for selected elements)
315			*/
316			public function getInvertedColoursUnsetCode() : string
317			{
318			return $this->invertedColoursUnsetCode;
319			}
320
321			/**
322			* Get the escape sequence used to reset colours to default
323			*/
324			public function getColoursResetCode() : string
325			{
326			return $this->coloursResetCode;
327			}
328
329			/**
330			* Calculate the contents width
331			*/
332			protected function calculateContentWidth() : void
333			{
334			$this->contentWidth = $this->width
335			- ($this->paddingLeftRight * 2)
336			- ($this->borderRightWidth + $this->borderLeftWidth);
337
338			if ($this->contentWidth < 0) {
339			$this->contentWidth = 0;
340			}
341			}
342
343			public function getFg()
344			{
345			return $this->fg;
346			}
347
348			public function setFg(string $fg, string $fallback = null) : self
349			{
350			$this->fg = ColourUtil::validateColour(
351			$this->terminal,
352			$fg,
353			$fallback
354			);
355			$this->generateColoursSetCode();
356
357			return $this;
358			}
359
360			public function getBg()
361			{
362			return $this->bg;
363			}
364
365			public function setBg(string $bg, string $fallback = null) : self
366			{
367			$this->bg = ColourUtil::validateColour(
368			$this->terminal,
369			$bg,
370			$fallback
371			);
372
373			$this->generateColoursSetCode();
374			$this->generatePaddingTopBottomRows();
375
376			return $this;
377			}
378
379			public function getWidth() : int
380			{
381			return $this->width;
382			}
383
384			public function setWidth(int $width) : self
385			{
386			Assertion::greaterOrEqualThan($width, 0);
387
388			if ($width >= $this->terminal->getWidth()) {
389			$width = $this->terminal->getWidth();
390			}
391
392			$this->width = $width;
393			if ($this->marginAuto) {
394			$this->setMarginAuto();
395			}
396
397			$this->calculateContentWidth();
398			$this->generateBorderRows();
399			$this->generatePaddingTopBottomRows();
400
401			return $this;
402			}
403
404			public function getPaddingTopBottom() : int
405			{
406			return $this->paddingTopBottom;
407			}
408
409			public function getPaddingLeftRight() : int
410			{
411			return $this->paddingLeftRight;
412			}
413
414			private function generatePaddingTopBottomRows() : void
415			{
416			if ($this->borderLeftWidth \|\| $this->borderRightWidth) {
417			$borderColour = $this->getBorderColourCode();
418			} else {
419			$borderColour = '';
420			}
421
422			$paddingRow = sprintf(
423			"%s%s%s%s%s%s%s%s%s%s\n",
424			str_repeat(' ', $this->margin),
425			$borderColour,
426			str_repeat(' ', $this->borderLeftWidth),
427			$this->getColoursSetCode(),
428			str_repeat(' ', $this->paddingLeftRight),
429			str_repeat(' ', $this->contentWidth),
430			str_repeat(' ', $this->paddingLeftRight),
431			$borderColour,
432			str_repeat(' ', $this->borderRightWidth),
433			$this->coloursResetCode
434			);
435
436			$this->paddingTopBottomRows = array_fill(0, $this->paddingTopBottom, $paddingRow);
437			}
438
439			public function getPaddingTopBottomRows() : array
440			{
441			return $this->paddingTopBottomRows;
442			}
443
444			public function setPadding(int $topBottom, int $leftRight = null) : self
445			{
446			if ($leftRight === null) {
447			$leftRight = $topBottom;
448			}
449
450			$this->setPaddingTopBottom($topBottom);
451			$this->setPaddingLeftRight($leftRight);
452
453			$this->calculateContentWidth();
454			$this->generatePaddingTopBottomRows();
455
456			return $this;
457			}
458
459			public function setPaddingTopBottom(int $topBottom) : self
460			{
461			Assertion::greaterOrEqualThan($topBottom, 0);
462			$this->paddingTopBottom = $topBottom;
463
464			$this->generatePaddingTopBottomRows();
465
466			return $this;
467			}
468
469			public function setPaddingLeftRight(int $leftRight) : self
470			{
471			Assertion::greaterOrEqualThan($leftRight, 0);
472			$this->paddingLeftRight = $leftRight;
473
474			$this->calculateContentWidth();
475			$this->generatePaddingTopBottomRows();
476
477			return $this;
478			}
479
480			public function getMargin() : int
481			{
482			return $this->margin;
483			}
484
485			public function setMarginAuto() : self
486			{
487			$this->marginAuto = true;
488			$this->margin = (int) floor(($this->terminal->getWidth() - $this->width) / 2);
489
490			$this->generateBorderRows();
491			$this->generatePaddingTopBottomRows();
492
493			return $this;
494			}
495
496			public function setMargin(int $margin) : self
497			{
498			Assertion::greaterOrEqualThan($margin, 0);
499
500			$this->marginAuto = false;
501			$this->margin = $margin;
502
503			$this->generateBorderRows();
504			$this->generatePaddingTopBottomRows();
505
506			return $this;
507			}
508
509			public function getContentWidth() : int
510			{
511			return $this->contentWidth;
512			}
513
514			/**
515			* Get padding for right had side of content
516			*/
517			public function getRightHandPadding(int $contentLength) : int
518			{
519			$rightPadding = $this->getContentWidth() - $contentLength + $this->getPaddingLeftRight();
520
521			if ($rightPadding < 0) {
522			$rightPadding = 0;
523			}
524
525			return $rightPadding;
526			}
527
528			public function getSelectedMarker() : string
529			{
530			return $this->selectedMarker;
531			}
532
533			public function setSelectedMarker(string $marker) : self
534			{
535			$this->selectedMarker = $marker;
536
537			return $this;
538			}
539
540			public function getUnselectedMarker() : string
541			{
542			return $this->unselectedMarker;
543			}
544
545			public function setUnselectedMarker(string $marker) : self
546			{
547			$this->unselectedMarker = $marker;
548
549			return $this;
550			}
551
552			/**
553			* Get the correct marker for the item
554			*/
555			public function getMarker(bool $selected) : string
556			{
557			return $selected ? $this->selectedMarker : $this->unselectedMarker;
558			}
559
560			public function setItemExtra(string $itemExtra) : self
561			{
562			$this->itemExtra = $itemExtra;
563
564			return $this;
565			}
566
567			public function getItemExtra() : string
568			{
569			return $this->itemExtra;
570			}
571
572			public function getDisplaysExtra() : bool
573			{
574			return $this->displaysExtra;
575			}
576
577			public function setDisplaysExtra(bool $displaysExtra) : self
578			{
579			$this->displaysExtra = $displaysExtra;
580
581			return $this;
582			}
583
584			public function getTitleSeparator() : string
585			{
586			return $this->titleSeparator;
587			}
588
589			public function setTitleSeparator(string $actionSeparator) : self
590			{
591			$this->titleSeparator = $actionSeparator;
592
593			return $this;
594			}
595
596			private function generateBorderRows() : void
597			{
598			$borderRow = sprintf(
599			"%s%s%s%s\n",
600			str_repeat(' ', $this->margin),
601			$this->getBorderColourCode(),
602			str_repeat(' ', $this->width),
603			$this->coloursResetCode
604			);
605
606			$this->borderTopRows = array_fill(0, $this->borderTopWidth, $borderRow);
607			$this->borderBottomRows = array_fill(0, $this->borderBottomWidth, $borderRow);
608			}
609
610			public function getBorderTopRows() : array
611			{
612			return $this->borderTopRows;
613			}
614
615			public function getBorderBottomRows() : array
616			{
617			return $this->borderBottomRows;
618			}
619
620			/**
621			* Shorthand function to set all borders values at once
622			*/
623			public function setBorder(
624			int $topWidth,
625			$rightWidth = null,
626			$bottomWidth = null,
627			$leftWidth = null,
628			string $colour = null
629			) : self {
630			if (!is_int($rightWidth)) {
631			$colour = $rightWidth;
632			$rightWidth = $bottomWidth = $leftWidth = $topWidth;
633			} elseif (!is_int($bottomWidth)) {
634			$colour = $bottomWidth;
635			$bottomWidth = $topWidth;
636			$leftWidth = $rightWidth;
637			} elseif (!is_int($leftWidth)) {
638			$colour = $leftWidth;
639			$leftWidth = $rightWidth;
640			}
641
642			$this->borderTopWidth = $topWidth;
643			$this->borderRightWidth = $rightWidth;
644			$this->borderBottomWidth = $bottomWidth;
645			$this->borderLeftWidth = $leftWidth;
646
647			if (is_string($colour)) {
648			$this->setBorderColour($colour);
649			} elseif ($colour !== null) {
650			throw new \InvalidArgumentException('Invalid colour');
651			}
652
653			$this->calculateContentWidth();
654			$this->generateBorderRows();
655			$this->generatePaddingTopBottomRows();
656
657			return $this;
658			}
659
660			public function setBorderTopWidth(int $width) : self
661			{
662			$this->borderTopWidth = $width;
663
664			$this->generateBorderRows();
665
666			return $this;
667			}
668
669			public function setBorderRightWidth(int $width) : self
670			{
671			$this->borderRightWidth = $width;
672			$this->calculateContentWidth();
673
674			$this->generatePaddingTopBottomRows();
675
676			return $this;
677			}
678
679			public function setBorderBottomWidth(int $width) : self
680			{
681			$this->borderBottomWidth = $width;
682
683			$this->generateBorderRows();
684
685			return $this;
686			}
687
688			public function setBorderLeftWidth(int $width) : self
689			{
690			$this->borderLeftWidth = $width;
691			$this->calculateContentWidth();
692
693			$this->generatePaddingTopBottomRows();
694
695			return $this;
696			}
697
698			public function setBorderColour(string $colour, $fallback = null) : self
699			{
700			$this->borderColour = ColourUtil::validateColour(
701			$this->terminal,
702			$colour,
703			$fallback
704			);
705
706			$this->generateBorderRows();
707			$this->generatePaddingTopBottomRows();
708
709			return $this;
710			}
711
712			public function getBorderTopWidth() : int
713			{
714			return $this->borderTopWidth;
715			}
716
717			public function getBorderRightWidth() : int
718			{
719			return $this->borderRightWidth;
720			}
721
722			public function getBorderBottomWidth() : int
723			{
724			return $this->borderBottomWidth;
725			}
726
727			public function getBorderLeftWidth() : int
728			{
729			return $this->borderLeftWidth;
730			}
731
732			public function getBorderColour() : string
733			{
734			return $this->borderColour;
735			}
736
737			public function getBorderColourCode() : string
738			{
739			if (!ctype_digit($this->borderColour)) {
740			$borderColourCode = self::$availableBackgroundColors[$this->borderColour];
741			} else {
742			$borderColourCode = sprintf("48;5;%s", $this->borderColour);
743			}
744
745			return sprintf("\033[%sm", $borderColourCode);
746			}
747			}
748

php-school / cli-menu

Pull Request — master (#211)

MenuStyle::getFg() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like