Class DialogHelper

The Dialog class provides helpers to interact with the user.

Symfony\Component\Console\Helper\Helper implements Symfony\Component\Console\Helper\HelperInterface

Extended by

Symfony\Component\Console\Helper\DialogHelper

Namespace: Symfony\Component\Console\Helper
Author: Fabien Potencier <fabien@symfony.com>
Located at laravel/vendor/Symfony/Component/Console/Helper/DialogHelper.php

Methods summary
`public string`	# `ask( Symfony\Component\Console\Output\OutputInterface $output, string\|array $question, string $default = null )` Asks a question to the user. Asks a question to the user. Parameters `$output` `Symfony\Component\Console\Output\OutputInterface` $output An Output instance `$question` `string\|array` $question The question to ask `$default` `string` $default The default answer if none is given by the user Returns `string` The user answer Throws `RuntimeException` If there is no data to read in the input stream
`public Boolean`	# `askConfirmation( Symfony\Component\Console\Output\OutputInterface $output, string\|array $question, Boolean $default = true )` Asks a confirmation to the user. Asks a confirmation to the user. The question will be asked until the user answers by nothing, yes, or no. Parameters `$output` `Symfony\Component\Console\Output\OutputInterface` $output An Output instance `$question` `string\|array` $question The question to ask `$default` `Boolean` $default The default answer if the user enters nothing Returns `Boolean` true if the user has confirmed, false otherwise
`public mixed`	# `askAndValidate( Symfony\Component\Console\Output\OutputInterface $output, string\|array $question, callable $validator, integer $attempts = false, string $default = null )` Asks for a value and validates the response. Asks for a value and validates the response. The validator receives the data to validate. It must return the validated data when the data is valid and throw an exception otherwise. Parameters `$output` `Symfony\Component\Console\Output\OutputInterface` $output An Output instance `$question` `string\|array` $question The question to ask `$validator` `callable` $validator A PHP callback `$attempts` `integer` $attempts Max number of times to ask before giving up (false by default, which means infinite) `$default` `string` $default The default answer if none is given by the user Returns `mixed` Throws `Exception` When any of the validators return an error
`public`	# `setInputStream( resource $stream )` Sets the input stream to read from when interacting with the user. Sets the input stream to read from when interacting with the user. This is mainly useful for testing purpose. Parameters `$stream` `resource` $stream The input stream
`public string`	# `getInputStream( )` Returns the helper's input stream Returns the helper's input stream Returns `string`
`public string`	# `getName( )` Returns the helper's canonical name. Returns the helper's canonical name. Returns `string` The canonical name

Methods inherited from Symfony\Component\Console\Helper\Helper
`getHelperSet(), setHelperSet()`

Properties summary
`private mixed`	`$inputStream`		#

Properties inherited from Symfony\Component\Console\Helper\Helper
`$helperSet`