PHP Класс PhpSchool\CliMenu\CliMenuBuilder

Автор: Michael Woodward ([email protected])

Автор: Aydin Hassan ([email protected])

Показать файл Открыть проект Примеры использования класса

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

Метод	Описание
__construct ( CliMenuBuilder $parent = null )
addAsciiArt ( string $art, string $position = AsciiArtItem::POSITION_CENTER )
addItem ( string $text, callable $itemCallable, boolean $showItemExtra = false, boolean $disabled = false )
addItems ( array $items )
addLineBreak ( string $breakChar = ' ', integer $lines = 1 )
addMenuItem ( PhpSchool\CliMenu\MenuItem\MenuItemInterface $item )
addStaticItem ( string $text )
addSubMenu ( string $id ) : CliMenuBuilder
build ( ) : CliMenu
disableDefaultItems ( )
disableMenu ( )	Disable a submenu
end ( ) : CliMenuBuilder	Return to parent builder
getSubMenu ( string $id ) : CliMenu
isMenuDisabled ( ) : boolean
setBackgroundColour ( string $colour )
setExitButtonText ( string $exitButtonText )
setForegroundColour ( string $colour )
setGoBackButtonText ( string $goBackButtonTest )
setItemExtra ( string $extra )
setMargin ( integer $margin )
setPadding ( integer $padding )
setSelectedMarker ( string $marker )
setTerminal ( PhpSchool\CliMenu\Terminal\TerminalInterface $terminal )
setTitle ( string $title )
setTitleSeparator ( string $separator )
setUnselectedMarker ( string $marker )
setWidth ( integer $width )

Приватные методы

Метод	Описание
buildStyle ( ) : MenuStyle
buildSubMenus ( array $items ) : array
getDefaultItems ( ) : array
getMenuStyle ( ) : MenuStyle	Recursively drop back to the parents menu style when the current menu has a parent and has no changes
itemsHaveExtra ( array $items ) : boolean

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

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

public __construct ( CliMenuBuilder $parent = null )
$parent	CliMenuBuilder

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

public addAsciiArt ( string $art, string $position = AsciiArtItem::POSITION_CENTER )
$art	string
$position	string

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

public addItem ( string $text, callable $itemCallable, boolean $showItemExtra = false, boolean $disabled = false )
$text	string
$itemCallable	callable
$showItemExtra	boolean
$disabled	boolean

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

public addItems ( array $items )
$items	array

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

public addLineBreak ( string $breakChar = ' ', integer $lines = 1 )
$breakChar	string
$lines	integer

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

public addMenuItem ( PhpSchool\CliMenu\MenuItem\MenuItemInterface $item )
$item	PhpSchool\CliMenu\MenuItem\MenuItemInterface

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

public addStaticItem ( string $text )
$text	string

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

public addSubMenu ( string $id ) : CliMenuBuilder
$id	string	ID to reference and retrieve sub-menu
Результат	CliMenuBuilder

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

public build ( ) : CliMenu
Результат	CliMenu

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

public disableDefaultItems ( )

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

Disable a submenu

public disableMenu ( )

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

Return to parent builder

public end ( ) : CliMenuBuilder
Результат	CliMenuBuilder

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

public getSubMenu ( string $id ) : CliMenu
$id	string
Результат	CliMenu

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

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

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

public setBackgroundColour ( string $colour )
$colour	string

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

public setExitButtonText ( string $exitButtonText )
$exitButtonText	string

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

public setForegroundColour ( string $colour )
$colour	string

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

public setGoBackButtonText ( string $goBackButtonTest )
$goBackButtonTest	string

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

public setItemExtra ( string $extra )
$extra	string

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

public setMargin ( integer $margin )
$margin	integer

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

public setPadding ( integer $padding )
$padding	integer

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

public setSelectedMarker ( string $marker )
$marker	string

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

public setTerminal ( PhpSchool\CliMenu\Terminal\TerminalInterface $terminal )
$terminal	PhpSchool\CliMenu\Terminal\TerminalInterface

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

public setTitle ( string $title )
$title	string

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

public setTitleSeparator ( string $separator )
$separator	string

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

public setUnselectedMarker ( string $marker )
$marker	string

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

public setWidth ( integer $width )
$width	integer