1. class
  2. Windwalker
  3. Console
  4. Prompter
  5. ValidatePrompter

ValidatePrompter

class ValidatePrompter extends CallbackPrompter (View source)

A text prompter but we can set an array to validate input value.

Methods

__construct(string $question = null, array $options = array(), $default = null, IOInterface $io = null)

Constructor.

string
ask(string $msg = '', string $default = null)

Show prompt to ask user.

from CallbackPrompter
string
in(string $question = null)

Get a value from standard input.

from AbstractPrompter
string
__invoke(string $msg = null, string $default = null)

Proxy to ask method.

from AbstractPrompter
IOInterface
getIO()

Method to get property Io

from AbstractPrompter
AbstractPrompter
setIO(IOInterface $io)

Method to set property io

from AbstractPrompter
ValidatePrompter
setHandler(callable $handler)

Set a callable handler, can be a Closure.

from CallbackPrompter
callable
getHandler()

Get callable handler.

ValidatePrompter
setAttemptTimes(int $attempt)

Set attempt number.

from CallbackPrompter
ValidatePrompter
setNoValidMessage(string $noValidMessage)

Set message when validate fail.

from CallbackPrompter
ValidatePrompter
failToClose(boolean $failToClose = null, string $message = '')

If validate fail, whether close application or not.

from CallbackPrompter
ValidatePrompter
addOption(string $description, string $option = null)

Add an option.

ValidatePrompter
removeOption(mixed $key)

Remove an option by key.

ValidatePrompter
setOptions(array $options)

Set option list.

Details

at line line 39
__construct(string $question = null, array $options = array(), $default = null, IOInterface $io = null)

Constructor.

Parameters

string $question The question you want to ask.
array $options The option list to validate input.
$default $default The default value.
IOInterface $io The input object.

in CallbackPrompter at line line 99
string ask(string $msg = '', string $default = null)

Show prompt to ask user.

Parameters

string $msg Question.
string $default Default value.

Return Value

string The value that use input.

Exceptions

LogicException

in AbstractPrompter at line line 107
string in(string $question = null)

Get a value from standard input.

Parameters

string $question The question you want to ask user.

Return Value

string The input string from standard input.

in AbstractPrompter at line line 131
string __invoke(string $msg = null, string $default = null)

Proxy to ask method.

Parameters

string $msg Question.
string $default Default value.

Return Value

string The value that use input.

in AbstractPrompter at line line 141
IOInterface getIO()

Method to get property Io

Return Value

IOInterface

in AbstractPrompter at line line 153
AbstractPrompter setIO(IOInterface $io)

Method to set property io

Parameters

IOInterface $io

Return Value

AbstractPrompter Return self to support chaining.

in CallbackPrompter at line line 144
ValidatePrompter setHandler(callable $handler)

Set a callable handler, can be a Closure.

This function should contain a param that is the value which from user input, and must return TRUE or FALSE means validate success or fail.

Parameters

callable $handler The validate callback.

Return Value

ValidatePrompter Return self to support chaining.

at line line 53
callable getHandler()

Get callable handler.

Return Value

callable The validate callback.

in CallbackPrompter at line line 172
ValidatePrompter setAttemptTimes(int $attempt)

Set attempt number.

Parameters

int $attempt Retry times.

Return Value

ValidatePrompter Return self to support chaining.

in CallbackPrompter at line line 188
ValidatePrompter setNoValidMessage(string $noValidMessage)

Set message when validate fail.

Parameters

string $noValidMessage Validate fail message.

Return Value

ValidatePrompter Return self to support chaining.

in CallbackPrompter at line line 205
ValidatePrompter failToClose(boolean $failToClose = null, string $message = '')

If validate fail, whether close application or not.

Parameters

boolean $failToClose TRUE or FALSE, if is NULL, will be getter of $failToClose property.
string $message Message when close.

Return Value

ValidatePrompter Return self to support chaining.

at line line 83
ValidatePrompter addOption(string $description, string $option = null)

Add an option.

Parameters

string $description Option description.
string $option Option key, if this param is NULL, will use int as option key.

Return Value

ValidatePrompter Return self to support chaining.

at line line 106
ValidatePrompter removeOption(mixed $key)

Remove an option by key.

Parameters

mixed $key The option key you want to remove.

Return Value

ValidatePrompter Return self to support chaining.

at line line 125
ValidatePrompter setOptions(array $options)

Set option list.

Parameters

array $options The option list.

Return Value

ValidatePrompter Return self to support chaining.