Summary

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

Description

Methods

Name	Description	Defined By
__construct()	Ask the user for a single key stroke	Confirm
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
getNoChar()		Confirm
getPromptText()		Char
getYesChar()		Confirm
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
setNoChar()		Confirm
setPromptText()		Char
setYesChar()		Confirm
show()	Show the confirmation message and return result.	Confirm

Method Details

__construct()

Ask the user for a single key stroke

Parameter Name	Type	Description
$promptText	string	The
$yesChar	string	The
$noChar	string	The

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

getNoChar()

Returns: string

getPromptText()

Returns: string

getYesChar()

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:

setNoChar()

Parameter Name	Type	Description
$noChar	string

Returns:

setPromptText()

Parameter Name	Type	Description
$promptText	string

Returns:

setYesChar()

Parameter Name	Type	Description
$yesChar	string

Returns:

show()

Show the confirmation message and return result.

Returns: bool