PHP 클래스 PhpSchool\CliMenu\CliMenu

저자: Michael Woodward ([email protected])

파일 보기 프로젝트 열기: php-school/cli-menu 1 사용 예제들

보호된 프로퍼티들

프로퍼티	타입	설명
$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