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

Terminal

class Terminal

Properties

protected string|null $initialTtyMode

The initial TTY mode.
static protected bool|null $trueColorSupport

Whether the terminal supports true color.
static protected null|array{int, int, int} $foregroundColor

The terminal's foreground color as an RGB array.
static protected null|array{int, int, int} $backgroundColor

The terminal's background color as an RGB array.
protected Terminal $terminal

The Symfony Terminal instance.

Methods

__construct()

Create a new Terminal instance.

string
read()

Read a line from the terminal.

void
setTty(string $mode)

Set the TTY mode.

void
restoreTty()

Restore the initial TTY mode.

int
cols()

Get the number of columns in the terminal.

int
lines()

Get the number of lines in the terminal.

void
initDimensions()

(Re)initialize the terminal dimensions.

void
exit()

Exit the interactive session.

string
exec(string $command)

Execute the given command and return the output.

string
execWithInput(string $command, null|resource $input = null)

Execute the given command with an optional input stream.

bool
supportsTrueColor()

Determine if the terminal supports true color (24-bit).

array
foregroundColor()

Get the terminal's foreground color as an RGB array.

array
backgroundColor()

Get the terminal's background color as an RGB array.

void
queryColors()

Query the terminal for foreground and background colors in a single shot.

false|resource
openTty()

Open the controlling terminal.

static void
flushState()

Flush all static state.

Details

at line 45
__construct()

Create a new Terminal instance.

at line 53
string read()

Read a line from the terminal.

Return Value

string

at line 71
void setTty(string $mode)

Set the TTY mode.

Parameters

string $mode

Return Value

void

at line 81
void restoreTty()

Restore the initial TTY mode.

Return Value

void

at line 93
int cols()

Get the number of columns in the terminal.

Return Value

int

at line 101
int lines()

Get the number of lines in the terminal.

Return Value

int

at line 109
void initDimensions()

(Re)initialize the terminal dimensions.

Return Value

void

at line 119
void exit()

Exit the interactive session.

Return Value

void

at line 127
protected string exec(string $command)

Execute the given command and return the output.

Parameters

string $command

Return Value

string

at line 137
protected string execWithInput(string $command, null|resource $input = null)

Execute the given command with an optional input stream.

Parameters

string $command
null|resource $input

Return Value

string

at line 170
bool supportsTrueColor()

Determine if the terminal supports true color (24-bit).

Return Value

bool

at line 180
array foregroundColor()

Get the terminal's foreground color as an RGB array.

Return Value

array

at line 194
array backgroundColor()

Get the terminal's background color as an RGB array.

Return Value

array

at line 206
protected void queryColors()

Query the terminal for foreground and background colors in a single shot.

Return Value

void

at line 263
protected false|resource openTty()

Open the controlling terminal.

Return Value

false|resource

at line 271
static void flushState()

Flush all static state.

Return Value

void