Summary

Fully Qualified Name:	Laminas\Console\Prompt\Char
Extends:	AbstractPrompt

Description

Methods

Name	Description	Defined By
__construct()	Ask the user for a single key stroke	Char
getAllowEmpty()		Char
getAllowedChars()		Char
getConsole()	Return console adapter to use when showing prompt.	AbstractPrompt
getEcho()		Char
getIgnoreCase()		Char
getLastResponse()	Return last answer to this prompt.	AbstractPrompt
getPromptText()		Char
prompt()	Create an instance of this prompt, show it and return response.	AbstractPrompt
setAllowEmpty()		Char
setAllowedChars()		Char
setConsole()	Set console adapter to use when showing prompt.	AbstractPrompt
setEcho()		Char
setIgnoreCase()		Char
setPromptText()		Char
show()	Show the prompt to user and return a single char.	Char

Method Details

__construct()

Ask the user for a single key stroke

Parameter Name	Type	Description
$promptText	string	The
$allowedChars	string	A
$ignoreCase	bool	If
$allowEmpty	bool	Is
$echo	bool	Display

Returns:

getAllowEmpty()

Returns: bool

getAllowedChars()

Returns: string

getConsole()

Return console adapter to use when showing prompt.

Returns: \ConsoleAdapter

getEcho()

Returns: bool

getIgnoreCase()

Returns: bool

getLastResponse()

Return last answer to this prompt.

Returns: mixed

getPromptText()

Returns: string

prompt()

Create an instance of this prompt, show it and return response.

This is a convenience method for creating statically creating prompts, i.e.:

$name = Laminas\Console\Prompt\Line::prompt("Enter your name: ");

Returns: mixed

setAllowEmpty()

Parameter Name	Type	Description
$allowEmpty	bool

Returns:

setAllowedChars()

Parameter Name	Type	Description
$allowedChars	string

Returns:

setConsole()

Set console adapter to use when showing prompt.

Parameter Name	Type	Description
$adapter	\ConsoleAdapter

Returns:

setEcho()

Parameter Name	Type	Description
$echo	bool

Returns:

setIgnoreCase()

Parameter Name	Type	Description
$ignoreCase	bool

Returns:

setPromptText()

Parameter Name	Type	Description
$promptText	string

Returns:

show()

Show the prompt to user and return a single char.

Returns: string