1. class
  2. Hypervel
  3. \
  4. Prompts
  5. \
  6. SuggestPrompt

SuggestPrompt

class SuggestPrompt extends Prompt

Traits

HasInfo
Scrolling
Truncation
TypedValue
Colors
Cursor
Erase
Events
FakesInputOutput
Fallback
Interactivity
Themes

Constants

protected OUTPUT_CONTEXT_KEY

Context key for the output instance override.
protected VALIDATE_USING_CONTEXT_KEY

Context key for the custom validation callback override.

Properties

static protected bool $cursorHidden

Indicates if the cursor has been hidden.

 from  Cursor
protected Closure>> $listeners

The registered event listeners.

 from  Events
static protected bool $shouldFallback

Whether to fallback to a custom implementation.

 from  Fallback
static protected array<class-string, Closure(static): mixed> $fallbacks

The fallback implementations.

 from  Fallback
static protected bool|null $interactive

Whether to render the prompt interactively.

 from  Interactivity
static protected string $theme

The name of the active theme.

 from  Themes
static protected Prompt>, class-string<callable&object>>> $themes

The available themes.

 from  Themes
string $state

The current state of the prompt.

 from  Prompt
string $error

The error message from the validator.

 from  Prompt
string $cancelMessage

The cancel message displayed when this prompt is cancelled.

 from  Prompt
protected string $prevFrame

The previously rendered frame.

 from  Prompt
protected int $newLinesWritten

How many new lines were written by the last output.

 from  Prompt
bool|string $required

Whether user input is required.

 from  Prompt
Closure|null $transform

The transformation callback.

 from  Prompt
mixed $validate

The validator callback or rules.

 from  Prompt
static protected Closure|null $cancelUsing

The cancellation callback.

 from  Prompt
protected bool $validated

Indicates if the prompt has been validated.

 from  Prompt
static protected Closure|null $validateUsing

The custom validation callback.

 from  Prompt
static protected Closure|null $revertUsing

The revert handler from the StepBuilder.

 from  Prompt
static protected OutputInterface $output

The output instance.

 from  Prompt
static protected Terminal $terminal

The terminal instance.

 from  Prompt
int $scroll

The number of items to display before scrolling.

 from  Scrolling
int|null $highlighted

The index of the highlighted option.

 from  Scrolling
int $firstVisible

The index of the first visible option.

 from  Scrolling
protected string $typedValue

The value that has been typed.

 from  TypedValue
protected int $cursorPosition

The position of the virtual cursor.

 from  TypedValue
string[]|Closure(string): string[]|Collection<int, string> $options

The options for the suggest prompt.
protected null|string[] $matches

The cache of matches.

Methods

string
reset(string $text)

Reset all colors and styles.

from  Colors
string
bold(string $text)

Make the text bold.

from  Colors
string
dim(string $text)

Make the text dim.

from  Colors
string
italic(string $text)

Make the text italic.

from  Colors
string
underline(string $text)

Underline the text.

from  Colors
string
inverse(string $text)

Invert the text and background colors.

from  Colors
string
hidden(string $text)

Hide the text.

from  Colors
string
strikethrough(string $text)

Strike through the text.

from  Colors
string
black(string $text)

Set the text color to black.

from  Colors
string
red(string $text)

Set the text color to red.

from  Colors
string
green(string $text)

Set the text color to green.

from  Colors
string
yellow(string $text)

Set the text color to yellow.

from  Colors
string
blue(string $text)

Set the text color to blue.

from  Colors
string
magenta(string $text)

Set the text color to magenta.

from  Colors
string
cyan(string $text)

Set the text color to cyan.

from  Colors
string
white(string $text)

Set the text color to white.

from  Colors
string
bgBlack(string $text)

Set the text background to black.

from  Colors
string
bgRed(string $text)

Set the text background to red.

from  Colors
string
bgGreen(string $text)

Set the text background to green.

from  Colors
string
bgYellow(string $text)

Set the text background to yellow.

from  Colors
string
bgBlue(string $text)

Set the text background to blue.

from  Colors
string
bgMagenta(string $text)

Set the text background to magenta.

from  Colors
string
bgCyan(string $text)

Set the text background to cyan.

from  Colors
string
bgWhite(string $text)

Set the text background to white.

from  Colors
string
gray(string $text)

Set the text color to gray.

from  Colors
void
hideCursor()

Hide the cursor.

from  Cursor
void
showCursor()

Show the cursor.

from  Cursor
void
restoreCursor()

Restore the cursor if it was hidden.

from  Cursor
void
moveCursor(int $x, int $y = 0)

Move the cursor.

from  Cursor
void
moveCursorToColumn(int $column)

Move the cursor to the given column.

from  Cursor
void
moveCursorUp(int $lines)

Move the cursor up by the given number of lines.

from  Cursor
static void
resetCursor()

Reset cursor state to defaults.

from  Cursor
void
eraseLines(int $count)

Erase the given number of lines downwards from the cursor position.

from  Erase
void
eraseDown()

Erase from cursor until end of screen.

from  Erase
void
on(string $event, Closure $callback)

Register an event listener.

from  Events
void
emit(string $event, mixed ...$data)

Emit an event.

from  Events
void
clearListeners()

Clean the event listeners.

from  Events
static void
fake(array $keys = [])

Fake the terminal and queue key presses to be simulated.

from  FakesInputOutput
static void
fakeKeyPresses(array $keys, callable $callable)

Implementation of the looping mechanism for simulating key presses.

from  FakesInputOutput
static void
assertOutputContains(string $string)

Assert that the output contains the given string.

from  FakesInputOutput
static void
assertOutputDoesntContain(string $string)

Assert that the output doesn't contain the given string.

from  FakesInputOutput
static void
assertStrippedOutputContains(string $string)

Assert that the stripped output contains the given string.

from  FakesInputOutput
static void
assertStrippedOutputDoesntContain(string $string)

Assert that the stripped output doesn't contain the given string.

from  FakesInputOutput
static string
content()

Get the buffered console output.

from  FakesInputOutput
static string
strippedContent()

Get the buffered console output, stripped of escape sequences.

from  FakesInputOutput
static void
fallbackWhen(bool $condition)

Enable the fallback implementation.

from  Fallback
static bool
shouldFallback()

Whether the prompt should fallback to a custom implementation.

from  Fallback
static void
fallbackUsing(Closure $fallback)

Set the fallback implementation.

from  Fallback
mixed
fallback()

Call the registered fallback implementation.

from  Fallback
static void
resetFallback()

Reset fallback state to defaults.

from  Fallback
static void
interactive(bool $interactive = true)

Set interactive mode.

from  Interactivity
static bool|null
isInteractive()

Determine if the prompt is interactive.

from  Interactivity
static void
resetInteractivity()

Reset interactivity state to defaults.

from  Interactivity
mixed
default()

Return the default value if it passes validation.

from  Interactivity
static string
theme(string|null $name = null)

Get or set the active theme.

from  Themes
static void
addTheme(string $name, array $renderers)

Add a new theme.

from  Themes
callable
getRenderer()

Get the renderer for the current prompt.

from  Themes
string
renderTheme()

Render the prompt using the active theme.

from  Themes
static void
resetTheme()

Reset theme state to defaults.

from  Themes
string
value()

Get the value of the prompt.

from  TypedValue
mixed
prompt()

Render the prompt and listen for input.

from  Prompt
mixed
runLoop(callable $callable)

Implementation of the prompt looping mechanism.

from  Prompt
static void
cancelUsing(Closure|null $callback)

Register a callback to be invoked when a user cancels a prompt.

from  Prompt
int
newLinesWritten()

How many new lines were written by the last output.

from  Prompt
void
capturePreviousNewLines()

Capture the number of new lines written by the last output.

from  Prompt
static void
setOutput(OutputInterface $output)

Set the output instance.

from  Prompt
static OutputInterface
output()

Get the current output instance.

from  Prompt
static void
writeDirectly(string $message)

Write output directly, bypassing newline capture.

from  Prompt
static Terminal
terminal()

Get the terminal instance.

from  Prompt
static void
validateUsing(Closure $callback)

Set the custom validation callback.

from  Prompt
static Closure|null
getValidateUsing()

Get the custom validation callback.

from  Prompt
static void
revertUsing(Closure $callback)

Revert the prompt using the given callback.

from  Prompt
static void
preventReverting()

Clear any previous revert callback.

from  Prompt
void
render()

Render the prompt.

from  Prompt
void
submit()

Submit the prompt.

from  Prompt
mixed
transformedValue()

Get the transformed value of the prompt.

from  Prompt
bool
isInvalidWhenRequired(mixed $value)

Determine whether the given value is invalid when the prompt is required.

from  Prompt
static void
flushState()

Flush all static state.

from  Prompt
__destruct()

Restore the cursor and terminal state.

from  Prompt
string
infoText()

Get the resolved info text.

from  HasInfo
void
initializeScrolling(int|null $highlighted = null)

Initialize scrolling.

from  Scrolling
void
reduceScrollingToFitTerminal()

Reduce the scroll property to fit the terminal height.

from  Scrolling
void
highlight(int|null $index)

Highlight the given index.

from  Scrolling
void
highlightPrevious(int $total, bool $allowNull = false)

Highlight the previous entry, or wrap around to the last entry.

from  Scrolling
void
highlightNext(int $total, bool $allowNull = false)

Highlight the next entry, or wrap around to the first entry.

from  Scrolling
void
scrollToHighlighted(int $total)

Center the highlighted option.

from  Scrolling
string
truncate(string $string, int $width)

Truncate a value with an ellipsis if it exceeds the given width.

from  Truncation
void
trackTypedValue(string $default = '', bool $submit = true, callable|null $ignore = null, bool $allowNewLine = false)

Track the value as the user types.

from  TypedValue
string
addCursor(string $value, int $cursorPosition, int|null $maxWidth = null)

Add a virtual cursor to the value and truncate if necessary.

from  TypedValue
void
deleteWordBackward()

Delete from the start of the current word (before cursor) through the cursor.

from  TypedValue
int
findWordStartBeforeCursor()

Character offset of the word boundary immediately before the cursor (Intl + punctuation).

from  TypedValue
int
findLastWordStartByLettersAndNumbers(string $before)

Start (character offset) of the last run of letters/numbers in string (punctuation breaks words).

from  TypedValue
__construct(string $label, array|Closure|Collection $options, string $placeholder = '', string $default = '', int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null, string|Closure $info = '')

Create a new SuggestPrompt instance.

string|null
highlightedValue()

Get the value of the highlighted option.

string
valueWithCursor(int $maxWidth)

Get the entered value with a virtual cursor.

array
matches()

Get options that match the input.

array
visible()

The current visible matches.

void
selectHighlighted()

Select the highlighted entry.

Details

in Colors at line 12
string reset(string $text)

Reset all colors and styles.

Parameters

string $text

Return Value

string

in Colors at line 20
string bold(string $text)

Make the text bold.

Parameters

string $text

Return Value

string

in Colors at line 28
string dim(string $text)

Make the text dim.

Parameters

string $text

Return Value

string

in Colors at line 36
string italic(string $text)

Make the text italic.

Parameters

string $text

Return Value

string

in Colors at line 44
string underline(string $text)

Underline the text.

Parameters

string $text

Return Value

string

in Colors at line 52
string inverse(string $text)

Invert the text and background colors.

Parameters

string $text

Return Value

string

in Colors at line 60
string hidden(string $text)

Hide the text.

Parameters

string $text

Return Value

string

in Colors at line 68
string strikethrough(string $text)

Strike through the text.

Parameters

string $text

Return Value

string

in Colors at line 76
string black(string $text)

Set the text color to black.

Parameters

string $text

Return Value

string

in Colors at line 84
string red(string $text)

Set the text color to red.

Parameters

string $text

Return Value

string

in Colors at line 92
string green(string $text)

Set the text color to green.

Parameters

string $text

Return Value

string

in Colors at line 100
string yellow(string $text)

Set the text color to yellow.

Parameters

string $text

Return Value

string

in Colors at line 108
string blue(string $text)

Set the text color to blue.

Parameters

string $text

Return Value

string

in Colors at line 116
string magenta(string $text)

Set the text color to magenta.

Parameters

string $text

Return Value

string

in Colors at line 124
string cyan(string $text)

Set the text color to cyan.

Parameters

string $text

Return Value

string

in Colors at line 132
string white(string $text)

Set the text color to white.

Parameters

string $text

Return Value

string

in Colors at line 140
string bgBlack(string $text)

Set the text background to black.

Parameters

string $text

Return Value

string

in Colors at line 148
string bgRed(string $text)

Set the text background to red.

Parameters

string $text

Return Value

string

in Colors at line 156
string bgGreen(string $text)

Set the text background to green.

Parameters

string $text

Return Value

string

in Colors at line 164
string bgYellow(string $text)

Set the text background to yellow.

Parameters

string $text

Return Value

string

in Colors at line 172
string bgBlue(string $text)

Set the text background to blue.

Parameters

string $text

Return Value

string

in Colors at line 180
string bgMagenta(string $text)

Set the text background to magenta.

Parameters

string $text

Return Value

string

in Colors at line 188
string bgCyan(string $text)

Set the text background to cyan.

Parameters

string $text

Return Value

string

in Colors at line 196
string bgWhite(string $text)

Set the text background to white.

Parameters

string $text

Return Value

string

in Colors at line 204
string gray(string $text)

Set the text color to gray.

Parameters

string $text

Return Value

string

in Cursor at line 17
void hideCursor()

Hide the cursor.

Return Value

void

in Cursor at line 27
void showCursor()

Show the cursor.

Return Value

void

in Cursor at line 37
void restoreCursor()

Restore the cursor if it was hidden.

Return Value

void

in Cursor at line 47
void moveCursor(int $x, int $y = 0)

Move the cursor.

Parameters

int $x
int $y

Return Value

void

in Cursor at line 69
void moveCursorToColumn(int $column)

Move the cursor to the given column.

Parameters

int $column

Return Value

void

in Cursor at line 77
void moveCursorUp(int $lines)

Move the cursor up by the given number of lines.

Parameters

int $lines

Return Value

void

in Cursor at line 89
static void resetCursor()

Reset cursor state to defaults.

Boot or tests only. Clears worker-wide cursor visibility tracking; concurrent prompts may restore cursor state differently depending on timing.

Return Value

void

in Erase at line 12
void eraseLines(int $count)

Erase the given number of lines downwards from the cursor position.

Parameters

int $count

Return Value

void

in Erase at line 29
void eraseDown()

Erase from cursor until end of screen.

Return Value

void

in Events at line 21
void on(string $event, Closure $callback)

Register an event listener.

Parameters

string $event
Closure $callback

Return Value

void

in Events at line 29
void emit(string $event, mixed ...$data)

Emit an event.

Parameters

string $event
mixed ...$data

Return Value

void

in Events at line 39
void clearListeners()

Clean the event listeners.

Return Value

void

in FakesInputOutput at line 23
static void fake(array $keys = [])

Fake the terminal and queue key presses to be simulated.

Tests only. Swaps prompt terminal and output state for the worker lifetime.

Parameters

array $keys

Return Value

void

in FakesInputOutput at line 60
static void fakeKeyPresses(array $keys, callable $callable)

Implementation of the looping mechanism for simulating key presses.

By ignoring the $callable parameter which contains the default logic for simulating fake key presses, we can use a custom implementation to emit key presses instead, allowing us to use different inputs.

Parameters

array $keys
callable $callable

Return Value

void

in FakesInputOutput at line 70
static void assertOutputContains(string $string)

Assert that the output contains the given string.

Parameters

string $string

Return Value

void

in FakesInputOutput at line 78
static void assertOutputDoesntContain(string $string)

Assert that the output doesn't contain the given string.

Parameters

string $string

Return Value

void

in FakesInputOutput at line 86
static void assertStrippedOutputContains(string $string)

Assert that the stripped output contains the given string.

Parameters

string $string

Return Value

void

in FakesInputOutput at line 94
static void assertStrippedOutputDoesntContain(string $string)

Assert that the stripped output doesn't contain the given string.

Parameters

string $string

Return Value

void

in FakesInputOutput at line 102
static string content()

Get the buffered console output.

Return Value

string

in FakesInputOutput at line 114
static string strippedContent()

Get the buffered console output, stripped of escape sequences.

Return Value

string

in Fallback at line 39
static void fallbackWhen(bool $condition)

Enable the fallback implementation.

Parameters

bool $condition

Return Value

void

in Fallback at line 52
static bool shouldFallback()

Whether the prompt should fallback to a custom implementation.

Return Value

bool

in Fallback at line 69
static void fallbackUsing(Closure $fallback)

Set the fallback implementation.

Parameters

Closure $fallback

Return Value

void

in Fallback at line 83
mixed fallback()

Call the registered fallback implementation.

Return Value

mixed

in Fallback at line 107
static void resetFallback()

Reset fallback state to defaults.

Boot or tests only. Clears worker-wide prompt fallback configuration; concurrent prompts may render with different fallback behavior depending on timing.

Return Value

void

in Interactivity at line 28
static void interactive(bool $interactive = true)

Set interactive mode.

Parameters

bool $interactive

Return Value

void

in Interactivity at line 40
static bool|null isInteractive()

Determine if the prompt is interactive.

Return Value

bool|null

in Interactivity at line 56
static void resetInteractivity()

Reset interactivity state to defaults.

Boot or tests only. Clears worker-wide prompt interactivity configuration; concurrent prompts may render with different interactivity depending on timing.

Return Value

void

in Interactivity at line 65
protected mixed default()

Return the default value if it passes validation.

Return Value

mixed

in Themes at line 112
static string theme(string|null $name = null)

Get or set the active theme.

Boot-only when setting. The active theme persists in a static property for the worker lifetime and applies to every subsequent prompt render.

Parameters

string|null $name

Return Value

string

Exceptions

InvalidArgumentException

in Themes at line 133
static void addTheme(string $name, array $renderers)

Add a new theme.

Boot-only. Themes persist in a static property for the worker lifetime and are available to every subsequent prompt render.

Parameters

string $name
array $renderers

Return Value

void

in Themes at line 145
protected callable getRenderer()

Get the renderer for the current prompt.

Return Value

callable

in Themes at line 155
protected string renderTheme()

Render the prompt using the active theme.

Return Value

string

in Themes at line 168
static void resetTheme()

Reset theme state to defaults.

Boot or tests only. Clears worker-wide prompt theme configuration; concurrent prompts may render with different themes depending on timing.

Return Value

void

in TypedValue at line 89
string value()

Get the value of the prompt.

Return Value

string

in Prompt at line 116
mixed prompt()

Render the prompt and listen for input.

Return Value

mixed

in Prompt at line 181
mixed runLoop(callable $callable)

Implementation of the prompt looping mechanism.

Parameters

callable $callable

Return Value

mixed

in Prompt at line 207
static void cancelUsing(Closure|null $callback)

Register a callback to be invoked when a user cancels a prompt.

Boot-only. The callback persists in a static property for the worker lifetime and runs on every subsequent prompt cancellation.

Parameters

Closure|null $callback

Return Value

void

in Prompt at line 215
int newLinesWritten()

How many new lines were written by the last output.

Return Value

int

in Prompt at line 223
protected void capturePreviousNewLines()

Capture the number of new lines written by the last output.

Return Value

void

in Prompt at line 233
static void setOutput(OutputInterface $output)

Set the output instance.

Parameters

OutputInterface $output

Return Value

void

in Prompt at line 245
static protected OutputInterface output()

Get the current output instance.

Return Value

OutputInterface

in Prompt at line 257
static protected void writeDirectly(string $message)

Write output directly, bypassing newline capture.

Parameters

string $message

Return Value

void

in Prompt at line 269
static Terminal terminal()

Get the terminal instance.

Return Value

Terminal

in Prompt at line 277
static void validateUsing(Closure $callback)

Set the custom validation callback.

Parameters

Closure $callback

Return Value

void

in Prompt at line 289
static protected Closure|null getValidateUsing()

Get the custom validation callback.

Return Value

Closure|null

in Prompt at line 306
static void revertUsing(Closure $callback)

internal  
 

Revert the prompt using the given callback.

Tests only. The callback persists in a static property for the worker lifetime and affects every subsequent prompt revert.

Parameters

Closure $callback

Return Value

void

in Prompt at line 319
static void preventReverting()

internal  
 

Clear any previous revert callback.

Tests only. Clears the worker-wide revert callback; concurrent prompts may observe different behavior depending on timing.

Return Value

void

in Prompt at line 327
protected void render()

Render the prompt.

Return Value

void

in Prompt at line 361
protected void submit()

Submit the prompt.

Return Value

void

in Prompt at line 429
protected mixed transformedValue()

Get the transformed value of the prompt.

Return Value

mixed

in Prompt at line 473
protected bool isInvalidWhenRequired(mixed $value)

Determine whether the given value is invalid when the prompt is required.

Parameters

mixed $value

Return Value

bool

in Prompt at line 491
static void flushState()

Flush all static state.

Return Value

void

in Prompt at line 510
__destruct()

Restore the cursor and terminal state.

in HasInfo at line 14
string infoText()

Get the resolved info text.

Return Value

string

in Scrolling at line 29
protected void initializeScrolling(int|null $highlighted = null)

Initialize scrolling.

Parameters

int|null $highlighted

Return Value

void

in Scrolling at line 39
protected void reduceScrollingToFitTerminal()

Reduce the scroll property to fit the terminal height.

Return Value

void

in Scrolling at line 49
protected void highlight(int|null $index)

Highlight the given index.

Parameters

int|null $index

Return Value

void

in Scrolling at line 67
protected void highlightPrevious(int $total, bool $allowNull = false)

Highlight the previous entry, or wrap around to the last entry.

Parameters

int $total
bool $allowNull

Return Value

void

in Scrolling at line 85
protected void highlightNext(int $total, bool $allowNull = false)

Highlight the next entry, or wrap around to the first entry.

Parameters

int $total
bool $allowNull

Return Value

void

in Scrolling at line 101
protected void scrollToHighlighted(int $total)

Center the highlighted option.

Parameters

int $total

Return Value

void

in Truncation at line 14
protected string truncate(string $string, int $width)

Truncate a value with an ellipsis if it exceeds the given width.

Parameters

string $string
int $width

Return Value

string

in TypedValue at line 25
protected void trackTypedValue(string $default = '', bool $submit = true, callable|null $ignore = null, bool $allowNewLine = false)

Track the value as the user types.

Parameters

string $default
bool $submit
callable|null $ignore
bool $allowNewLine

Return Value

void

in TypedValue at line 97
protected string addCursor(string $value, int $cursorPosition, int|null $maxWidth = null)

Add a virtual cursor to the value and truncate if necessary.

Parameters

string $value
int $cursorPosition
int|null $maxWidth

Return Value

string

in TypedValue at line 138
protected void deleteWordBackward()

Delete from the start of the current word (before cursor) through the cursor.

Return Value

void

in TypedValue at line 153
protected int findWordStartBeforeCursor()

Character offset of the word boundary immediately before the cursor (Intl + punctuation).

Punctuation (e.g. . - _) is treated as a word boundary so "word.word" deletes in two steps.

Return Value

int

in TypedValue at line 184
protected int findLastWordStartByLettersAndNumbers(string $before)

Start (character offset) of the last run of letters/numbers in string (punctuation breaks words).

Parameters

string $before

Return Value

int

at line 36
__construct(string $label, array|Closure|Collection $options, string $placeholder = '', string $default = '', int $scroll = 5, bool|string $required = false, mixed $validate = null, string $hint = '', Closure|null $transform = null, string|Closure $info = '')

Create a new SuggestPrompt instance.

Parameters

string $label
array|Closure|Collection $options
string $placeholder
string $default
int $scroll
bool|string $required
mixed $validate
string $hint
Closure|null $transform
string|Closure $info

at line 72
string|null highlightedValue()

Get the value of the highlighted option.

Return Value

string|null

at line 84
string valueWithCursor(int $maxWidth)

Get the entered value with a virtual cursor.

Parameters

int $maxWidth

Return Value

string

at line 104
array matches()

Get options that match the input.

Return Value

array

at line 126
array visible()

The current visible matches.

Return Value

array

at line 134
protected void selectHighlighted()

Select the highlighted entry.

Return Value

void