(PHP 7 >= 7.2.0, PHP 8)
sapi_windows_vt100_support — Get or set VT100 support for the specified stream associated to an output buffer of a Windows console.
If enable
is null
, the function returns true
if the stream stream
has VT100 control codes enabled, false
otherwise.
If enable
is a bool, the function will try to enable or disable the VT100 features of the stream stream
.
If the feature has been successfully enabled (or disabled), the function will return true
, or false
otherwise.
At startup, PHP tries to enable the VT100 feature of the STDOUT
/STDERR
streams. By the way, if those streams are redirected to a file, the VT100 features may not be enabled.
If VT100 support is enabled, it is possible to use control sequences as they are known from the VT100 terminal. They allow the modification of the terminal's output. On Windows these sequences are called Console Virtual Terminal Sequences.
This function uses the ENABLE_VIRTUAL_TERMINAL_PROCESSING
flag implemented in the Windows 10 API, so the VT100 feature may not be available on older Windows versions.
If enable
is null
: returns true
if the VT100 feature is enabled, false
otherwise.
If enable
is a bool: Повертає true
у разі успіху або false
в разі помилки.
Версія | Опис |
---|---|
8.0.0 |
enable is now nullable.
|
Приклад #1 sapi_windows_vt100_support() default state
php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));"
Поданий вище приклад виведе щось схоже на:
true true
By the way, if a stream is redirected, the VT100 feature will not be enabled:
php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));" 2>NUL
Поданий вище приклад виведе щось схоже на:
Приклад #2 sapi_windows_vt100_support() changing state
php -r "var_export(sapi_windows_vt100_support(STDOUT, true));echo ' ';var_export(sapi_windows_vt100_support(STDERR, true));" 2>NUL
Поданий вище приклад виведе щось схоже на:
true false
Приклад #3 Example usage of VT100 support enabled
<?php
$out = fopen('php://stdout','w');
fwrite($out, 'Just forgot a lettr.');
// Moves the cursor two characters backwards
fwrite($out, "\033[2D");
// Inserts one blank, shifting existing text to the right -> Just forgot a lett r.
fwrite($out, "\033[1@");
fwrite($out, 'e');
?>
Поданий вище приклад виведе:
Just forgot a letter.