PhpSchool\CliMenu\MenuStyle

Complexity

Total Complexity

48

Size/Duplication

Total Lines	483
Duplicated Lines	8.28 %

Coupling/Cohesion

Components	3
Dependencies	1

Importance

Changes	1
Bugs	0	Features	0

44 Methods

Rating	Name	Duplication	Size	Complexity
A	getFg()	0	4	1
A	getDefaultStyleValues()	0	4	1
A	__construct()	0	21	2
A	getAvailableColours()	0	4	1
A	getDisabledItemText()	0	9	1
A	getSelectedSetCode()	10	10	1
A	getSelectedUnsetCode()	10	10	1
A	getUnselectedSetCode()	10	10	1
A	getUnselectedUnsetCode()	10	10	1
A	calculateContentWidth()	0	4	1
A	setFg()	0	6	1
A	getBg()	0	4	1
A	setBg()	0	6	1
A	getWidth()	0	4	1
A	setWidth()	0	13	2
A	getPadding()	0	4	1
A	setPadding()	0	8	1
A	getMargin()	0	4	1
A	setMargin()	0	8	1
A	getContentWidth()	0	4	1
A	getRightHandPadding()	0	4	1
A	getSelectedMarker()	0	4	1
A	setSelectedMarker()	0	6	1
A	getUnselectedMarker()	0	4	1
A	setUnselectedMarker()	0	6	1
A	getMarker()	0	4	2
A	setItemExtra()	0	6	1
A	getItemExtra()	0	4	1
A	getDisplaysExtra()	0	4	1
A	setDisplaysExtra()	0	6	1
A	getTitleSeparator()	0	4	1
A	setTitleSeparator()	0	6	1
A	setBorder()	0	12	2
A	setBorderTopWidth()	0	6	1
A	setBorderRightWidth()	0	6	1
A	setBorderBottomWidth()	0	6	1
A	setBorderLeftWidth()	0	6	1
A	setBorderColour()	0	6	1
A	getBorderTopWidth()	0	4	1
A	getBorderRightWidth()	0	4	1
A	getBorderBottomWidth()	0	4	1
A	getBorderLeftWidth()	0	4	1
A	getBorderColour()	0	4	1
A	getBorderColourCode()	0	4	1

<?php

namespace PhpSchool\CliMenu;

use PhpSchool\CliMenu\Exception\InvalidInstantiationException;
use PhpSchool\CliMenu\Terminal\TerminalFactory;
use PhpSchool\Terminal\Terminal;

//TODO: B/W fallback

/**
 * @author Michael Woodward <mikeymike.mw@gmail.com>
 */
class MenuStyle
{
    /**
     * @var Terminal
     */
    protected $terminal;

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

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

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

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

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

    /**
     * @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 int
     */
    private $borderTopWidth;

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

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

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

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

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

    public static function getDefaultStyleValues() : array
    {
        return static::$defaultStyleValues;

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

    }

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

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

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

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

        $this->setFg(static::$defaultStyleValues['fg']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setBg(static::$defaultStyleValues['bg']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setWidth(static::$defaultStyleValues['width']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setPadding(static::$defaultStyleValues['padding']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setMargin(static::$defaultStyleValues['margin']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setSelectedMarker(static::$defaultStyleValues['selectedMarker']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setUnselectedMarker(static::$defaultStyleValues['unselectedMarker']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setItemExtra(static::$defaultStyleValues['itemExtra']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setDisplaysExtra(static::$defaultStyleValues['displaysExtra']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setTitleSeparator(static::$defaultStyleValues['titleSeparator']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setBorderTopWidth(static::$defaultStyleValues['borderTopWidth']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setBorderRightWidth(static::$defaultStyleValues['borderRightWidth']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setBorderBottomWidth(static::$defaultStyleValues['borderBottomWidth']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setBorderLeftWidth(static::$defaultStyleValues['borderLeftWidth']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

        $this->setBorderColour(static::$defaultStyleValues['borderColour']);

Since $defaultStyleValues is declared private, accessing it with static will lead to errors in possible sub-classes; consider using self, or increasing the visibility of $defaultStyleValues to at least protected.

    }

    public static function getAvailableColours() : array
    {
        return array_keys(self::$availableBackgroundColors);
    }

    public function getDisabledItemText(string $text) : string
    {
        return sprintf(
            "\033[%sm%s\033[%sm",
            self::$availableOptions['dim']['set'],
            $text,
            self::$availableOptions['dim']['unset']
        );
    }
    
    /**
     * Get the colour code set for Bg and Fg
     */
    public function getSelectedSetCode() : string

This method seems to be duplicated in your project.

    {
        return sprintf(
            "\033[%sm",
            implode(';', [
                self::$availableBackgroundColors[$this->getFg()]['set'],
                self::$availableForegroundColors[$this->getBg()]['set'],
            ])
        );
    }

    /**
     * Get the colour unset code for Bg and Fg
     */
    public function getSelectedUnsetCode() : string

This method seems to be duplicated in your project.

    {
        return sprintf(
            "\033[%sm",
            implode(';', [
                self::$availableBackgroundColors[$this->getBg()]['unset'],
                self::$availableForegroundColors[$this->getFg()]['unset'],
            ])
        );
    }

    /**
     * Get the inverted colour code
     */
    public function getUnselectedSetCode() : string

This method seems to be duplicated in your project.

    {
        return sprintf(
            "\033[%sm",
            implode(';', [
                self::$availableBackgroundColors[$this->getBg()]['set'],
                self::$availableForegroundColors[$this->getFg()]['set'],
            ])
        );
    }

    /**
     * Get the inverted colour unset code
     */
    public function getUnselectedUnsetCode() : string

This method seems to be duplicated in your project.

    {
        return sprintf(
            "\033[%sm",
            implode(';', [
                self::$availableBackgroundColors[$this->getBg()]['unset'],
                self::$availableForegroundColors[$this->getFg()]['unset'],
            ])
        );
    }

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

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

    public function setFg(string $fg) : self
    {
        $this->fg = $fg;

        return $this;
    }

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

    public function setBg(string $bg) : self
    {
        $this->bg = $bg;

        return $this;
    }

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

    public function setWidth(int $width) : self
    {
        $availableWidth = $this->terminal->getWidth() - ($this->margin * 2) - ($this->padding * 2) - ($this->borderRightWidth + $this->borderLeftWidth);

        if ($width >= $availableWidth) {
            $width = $availableWidth;
        }

        $this->width = $width;

It seems like $width can also be of type double. However, the property $width is declared as type integer. Maybe add an additional type check?

        $this->calculateContentWidth();

        return $this;
    }

    public function getPadding() : int
    {
        return $this->padding;
    }

    public function setPadding(int $padding) : self
    {
        $this->padding = $padding;

        $this->calculateContentWidth();

        return $this;
    }

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

    public function setMargin(int $margin) : self
    {
        $this->margin = $margin;

        $this->calculateContentWidth();

        return $this;
    }

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

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

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

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

        return $this;
    }

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

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

        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;
    }
    
    /**
     * Shorthand function to set all borders values at once
     */
    public function setBorder(int $topWidth, int $rightWidth = null, int $bottomWidth = null, int $leftWidth = null, string $colour = null) : self
    {
        $this->borderTopWidth = $topWidth;
        $this->borderRightWidth = $rightWidth ?? $topWidth;
        $this->borderBottomWidth = $bottomWidth ?? $topWidth;
        $this->borderLeftWidth = $leftWidth ?? $rightWidth ?? $topWidth;
        if ($colour !== null) {
            $this->borderColour = $colour;
        }

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

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

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

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

        return $this;
    }
    public function setBorderColour(string $colour) : self
    {
        $this->borderColour = $colour;

        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
    {
        return sprintf("\033[%sm", self::$availableBackgroundColors[$this->getBorderColour()]['set']);
    }
}