1. class
  2. Hypervel
  3. \
  4. Prompts
  5. \
  6. Themes
  7. \
  8. Default
  9. \
  10. Renderer

Renderer

abstract class Renderer implements Stringable

Traits

Colors
InteractsWithAnsi

Properties

protected string $output

The output to be rendered.

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
string
mbWordwrap(string $string, int $width = 75, string $break = "\n", bool $cut_long_words = false)

Multi-byte version of wordwrap.

from  InteractsWithAnsi
array
ansiWordwrap(string $text, int $width, bool $cutLongWords = false)

Word wrap text while preserving ANSI escape sequences.

from  InteractsWithAnsi
string
truncateAnsi(string $text, int $width)

Truncate visible ANSI text without cutting a control sequence.

from  InteractsWithAnsi
array
parseAnsiText(string $text)

Parse text into segments with their associated ANSI codes.

from  InteractsWithAnsi
void
updateSgrState(array $activeSgr, string $escape)

Update the bounded set of active SGR attributes.

from  InteractsWithAnsi
__construct(Prompt $prompt, OutputFormatterInterface|null $formatter = null)

Create a new renderer instance.

OutputFormatterInterface
formatter()

Get the renderer-owned formatter without changing application output settings.

string
formatText(string $text, bool $decorated = true)

Format an independent value using the configured console styles.

string
visibleText(string $text)

Get the visible text used to measure a formatted value.

string
truncate(string $string, int $width)

Truncate a formatted value without cutting its markup or terminal controls.

Renderer
line(string $message)

Render a line of output.

Renderer
newLine(int $count = 1)

Render a new line.

Renderer
warning(string $message)

Render a warning message.

Renderer
error(string $message)

Render an error message.

Renderer
hint(string $message)

Render an hint message.

Renderer
when(mixed $value, callable $callback, callable|null $default = null)

Apply the callback if the given "value" is truthy.

string
__toString()

Render the output with a blank line above and below.

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 InteractsWithAnsi at line 16
protected string mbWordwrap(string $string, int $width = 75, string $break = "\n", bool $cut_long_words = false)

Multi-byte version of wordwrap.

Parameters

string $string
int $width
string $break
bool $cut_long_words

Return Value

string

in InteractsWithAnsi at line 109
protected array ansiWordwrap(string $text, int $width, bool $cutLongWords = false)

Word wrap text while preserving ANSI escape sequences.

Parameters

string $text
int $width
bool $cutLongWords

Return Value

array

in InteractsWithAnsi at line 134
protected string truncateAnsi(string $text, int $width)

Truncate visible ANSI text without cutting a control sequence.

Parameters

string $text
int $width

Return Value

string

in InteractsWithAnsi at line 246
protected array parseAnsiText(string $text)

Parse text into segments with their associated ANSI codes.

Parameters

string $text

Return Value

array

in InteractsWithAnsi at line 358
protected void updateSgrState(array $activeSgr, string $escape)

Update the bounded set of active SGR attributes.

Parameters

array $activeSgr
string $escape

Return Value

void

at line 30
__construct(Prompt $prompt, OutputFormatterInterface|null $formatter = null)

Create a new renderer instance.

Parameters

Prompt $prompt
OutputFormatterInterface|null $formatter

at line 37
protected OutputFormatterInterface formatter()

Get the renderer-owned formatter without changing application output settings.

Return Value

OutputFormatterInterface

at line 52
protected string formatText(string $text, bool $decorated = true)

Format an independent value using the configured console styles.

Parameters

string $text
bool $decorated

Return Value

string

at line 67
protected string visibleText(string $text)

Get the visible text used to measure a formatted value.

Parameters

string $text

Return Value

string

at line 75
protected string truncate(string $string, int $width)

Truncate a formatted value without cutting its markup or terminal controls.

Parameters

string $string
int $width

Return Value

string

at line 91
protected Renderer line(string $message)

Render a line of output.

Parameters

string $message

Return Value

Renderer

at line 101
protected Renderer newLine(int $count = 1)

Render a new line.

Parameters

int $count

Return Value

Renderer

at line 111
protected Renderer warning(string $message)

Render a warning message.

Parameters

string $message

Return Value

Renderer

at line 119
protected Renderer error(string $message)

Render an error message.

Parameters

string $message

Return Value

Renderer

at line 127
protected Renderer hint(string $message)

Render an hint message.

Parameters

string $message

Return Value

Renderer

at line 143
protected Renderer when(mixed $value, callable $callback, callable|null $default = null)

Apply the callback if the given "value" is truthy.

Parameters

mixed $value
callable $callback
callable|null $default

Return Value

Renderer

at line 157
string __toString()

Render the output with a blank line above and below.

Return Value

string