PHP Класс PhpSchool\CliMenu\MenuStyle

Автор: Michael Woodward ([email protected])
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$bg string
$contentWidth integer
$fg string
$margin integer
$padding integer
$terminal PhpSchool\CliMenu\Terminal\TerminalInterface
$width integer

Открытые методы

Метод Описание
__construct ( PhpSchool\CliMenu\Terminal\TerminalInterface $terminal = null ) Initialise style
getAvailableColours ( ) : array
getBg ( ) : string
getContentWidth ( ) : integer
getDefaultStyleValues ( ) : array
getDisabledItemText ( string $text ) : string
getDisplaysExtra ( ) : boolean
getFg ( ) : string
getItemExtra ( ) : string
getMargin ( ) : integer
getMarker ( boolean $selected ) : string Get the correct marker for the item
getPadding ( ) : integer
getRightHandPadding ( $contentLength ) : integer Get padding for right had side of content
getSelectedMarker ( ) : string
getSelectedSetCode ( ) : string Get the colour code set for Bg and Fg
getSelectedUnsetCode ( ) : string Get the colour unset code for Bg and Fg
getTitleSeparator ( ) : string
getUnselectedMarker ( ) : string
getUnselectedSetCode ( ) : string Get the inverted colour code
getUnselectedUnsetCode ( ) : string Get the inverted colour unset code
getWidth ( ) : integer
setBg ( string $bg ) : MenuStyle
setDisplaysExtra ( boolean $displaysExtra )
setFg ( string $fg ) : MenuStyle
setItemExtra ( string $itemExtra )
setMargin ( integer $margin ) : MenuStyle
setPadding ( integer $padding ) : MenuStyle
setSelectedMarker ( string $marker )
setTitleSeparator ( string $actionSeparator )
setUnselectedMarker ( string $marker )
setWidth ( integer $width ) : MenuStyle

Защищенные методы

Метод Описание
calculateContentWidth ( ) Calculate the contents width

Описание методов

__construct() публичный Метод

Initialise style
public __construct ( PhpSchool\CliMenu\Terminal\TerminalInterface $terminal = null )
$terminal PhpSchool\CliMenu\Terminal\TerminalInterface

calculateContentWidth() защищенный Метод

Calculate the contents width
protected calculateContentWidth ( )

getAvailableColours() публичный статический Метод

public static getAvailableColours ( ) : array
Результат array

getBg() публичный Метод

public getBg ( ) : string
Результат string

getContentWidth() публичный Метод

public getContentWidth ( ) : integer
Результат integer

getDefaultStyleValues() публичный статический Метод

public static getDefaultStyleValues ( ) : array
Результат array

getDisabledItemText() публичный Метод

public getDisabledItemText ( string $text ) : string
$text string
Результат string

getDisplaysExtra() публичный Метод

public getDisplaysExtra ( ) : boolean
Результат boolean

getFg() публичный Метод

public getFg ( ) : string
Результат string

getItemExtra() публичный Метод

public getItemExtra ( ) : string
Результат string

getMargin() публичный Метод

public getMargin ( ) : integer
Результат integer

getMarker() публичный Метод

Get the correct marker for the item
public getMarker ( boolean $selected ) : string
$selected boolean
Результат string

getPadding() публичный Метод

public getPadding ( ) : integer
Результат integer

getRightHandPadding() публичный Метод

Get padding for right had side of content
public getRightHandPadding ( $contentLength ) : integer
$contentLength
Результат integer

getSelectedMarker() публичный Метод

public getSelectedMarker ( ) : string
Результат string

getSelectedSetCode() публичный Метод

Get the colour code set for Bg and Fg
public getSelectedSetCode ( ) : string
Результат string

getSelectedUnsetCode() публичный Метод

Get the colour unset code for Bg and Fg
public getSelectedUnsetCode ( ) : string
Результат string

getTitleSeparator() публичный Метод

public getTitleSeparator ( ) : string
Результат string

getUnselectedMarker() публичный Метод

public getUnselectedMarker ( ) : string
Результат string

getUnselectedSetCode() публичный Метод

Get the inverted colour code
public getUnselectedSetCode ( ) : string
Результат string

getUnselectedUnsetCode() публичный Метод

Get the inverted colour unset code
public getUnselectedUnsetCode ( ) : string
Результат string

getWidth() публичный Метод

public getWidth ( ) : integer
Результат integer

setBg() публичный Метод

public setBg ( string $bg ) : MenuStyle
$bg string
Результат MenuStyle

setDisplaysExtra() публичный Метод

public setDisplaysExtra ( boolean $displaysExtra )
$displaysExtra boolean

setFg() публичный Метод

public setFg ( string $fg ) : MenuStyle
$fg string
Результат MenuStyle

setItemExtra() публичный Метод

public setItemExtra ( string $itemExtra )
$itemExtra string

setMargin() публичный Метод

public setMargin ( integer $margin ) : MenuStyle
$margin integer
Результат MenuStyle

setPadding() публичный Метод

public setPadding ( integer $padding ) : MenuStyle
$padding integer
Результат MenuStyle

setSelectedMarker() публичный Метод

public setSelectedMarker ( string $marker )
$marker string

setTitleSeparator() публичный Метод

public setTitleSeparator ( string $actionSeparator )
$actionSeparator string

setUnselectedMarker() публичный Метод

public setUnselectedMarker ( string $marker )
$marker string

setWidth() публичный Метод

public setWidth ( integer $width ) : MenuStyle
$width integer
Результат MenuStyle

Описание свойств

$bg защищенное свойство

protected string $bg
Результат string

$contentWidth защищенное свойство

protected int $contentWidth
Результат integer

$fg защищенное свойство

protected string $fg
Результат string

$margin защищенное свойство

protected int $margin
Результат integer

$padding защищенное свойство

protected int $padding
Результат integer

$terminal защищенное свойство

protected TerminalInterface,PhpSchool\CliMenu\Terminal $terminal
Результат PhpSchool\CliMenu\Terminal\TerminalInterface

$width защищенное свойство

protected int $width
Результат integer