PHP Класс PhpSchool\CliMenu\CliMenu

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

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

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

Свойство	Тип	Описание
$items	PhpSchool\CliMenu\MenuItem\MenuItemInterface[]
$open	boolean
$parent	CliMenu \| null
$selectedItem	integer
$style	MenuStyle
$terminal	PhpSchool\CliMenu\Terminal\TerminalInterface
$title	string

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

Метод	Описание
__construct ( string $title, array $items, PhpSchool\CliMenu\Terminal\TerminalInterface $terminal = null, MenuStyle $style = null )
addItem ( PhpSchool\CliMenu\MenuItem\MenuItemInterface $item )	Add a new Item to the listing
close ( )	Close the menu
closeThis ( )
confirm ( string $text ) : Confirm
flash ( string $text ) : Flash
getCurrentFrame ( )
getItems ( ) : PhpSchool\CliMenu\MenuItem\MenuItemInterface[]
getParent ( ) : CliMenu \| null
getSelectedItem ( ) : PhpSchool\CliMenu\MenuItem\MenuItemInterface
getStyle ( ) : MenuStyle
getTerminal ( ) : PhpSchool\CliMenu\Terminal\TerminalInterface
isOpen ( ) : boolean
open ( )
redraw ( )	Redraw the menu
removeItem ( PhpSchool\CliMenu\MenuItem\MenuItemInterface $item )
setParent ( CliMenu $parent )

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

Метод	Описание
configureTerminal ( )	Configure the terminal to work with CliMenu
draw ( )	Draw the menu to STDOUT
drawMenuItem ( PhpSchool\CliMenu\MenuItem\MenuItemInterface $item, boolean \| false $selected = false ) : array	Draw a menu item
executeCurrentItem ( )	Execute the current item
moveSelection ( $direction )	Move the selection in a given direction, up / down
tearDownTerminal ( )	Revert changes made to the terminal

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

Метод	Описание
assertTerminalIsValidTTY ( )
display ( )	Display menu and capture input
selectFirstItem ( )	Set the selected pointer to the first selectable item

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

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

public __construct ( string $title, array $items, PhpSchool\CliMenu\Terminal\TerminalInterface $terminal = null, MenuStyle $style = null )
$title	string
$items	array
$terminal	PhpSchool\CliMenu\Terminal\TerminalInterface
$style	MenuStyle

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

Add a new Item to the listing

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

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

Close the menu

public close ( )

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

public closeThis ( )

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

Configure the terminal to work with CliMenu

protected configureTerminal ( )

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

public confirm ( string $text ) : Confirm
$text	string
Результат	PhpSchool\CliMenu\Dialogue\Confirm

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

Draw the menu to STDOUT

protected draw ( )

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

Draw a menu item

protected drawMenuItem ( PhpSchool\CliMenu\MenuItem\MenuItemInterface $item, boolean \| false $selected = false ) : array
$item	PhpSchool\CliMenu\MenuItem\MenuItemInterface
$selected	boolean \| false
Результат	array

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

Execute the current item

protected executeCurrentItem ( )

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

public flash ( string $text ) : Flash
$text	string
Результат	PhpSchool\CliMenu\Dialogue\Flash

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

public getCurrentFrame ( )

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

public getItems ( ) : PhpSchool\CliMenu\MenuItem\MenuItemInterface[]
Результат	PhpSchool\CliMenu\MenuItem\MenuItemInterface[]

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

public getParent ( ) : CliMenu \| null
Результат	CliMenu \| null

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

public getSelectedItem ( ) : PhpSchool\CliMenu\MenuItem\MenuItemInterface
Результат	PhpSchool\CliMenu\MenuItem\MenuItemInterface

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

public getStyle ( ) : MenuStyle
Результат	MenuStyle

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

public getTerminal ( ) : PhpSchool\CliMenu\Terminal\TerminalInterface
Результат	PhpSchool\CliMenu\Terminal\TerminalInterface

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

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

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

Move the selection in a given direction, up / down

protected moveSelection ( $direction )
$direction

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

public open ( )

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

Redraw the menu

public redraw ( )

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

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

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

public setParent ( CliMenu $parent )
$parent	CliMenu

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

Revert changes made to the terminal

protected tearDownTerminal ( )

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

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

protected MenuItemInterface[],PhpSchool\CliMenu\MenuItem $items
Результат	PhpSchool\CliMenu\MenuItem\MenuItemInterface[]

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

protected bool $open
Результат	boolean

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

protected CliMenu,PhpSchool\CliMenu\|null $parent
Результат	CliMenu \| null

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

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

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

protected MenuStyle,PhpSchool\CliMenu $style
Результат	MenuStyle

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

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

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

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