1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="function.sapi-windows-vt100-support" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>sapi_windows_vt100_support</refname>
<refpurpose>Get or set VT100 support for the specified stream associated to an output buffer of a Windows console.</refpurpose>
</refnamediv>
<refsect1 role="description"><!-- {{{ -->
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>sapi_windows_vt100_support</methodname>
<methodparam><type>resource</type><parameter>stream</parameter></methodparam>
<methodparam choice="opt"><type class="union"><type>bool</type><type>null</type></type><parameter>enable</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<para>
If <parameter>enable</parameter> is &null;, the function returns &true; if the stream <parameter>stream</parameter> has VT100 control codes enabled, &false; otherwise.
</para>
<para>
If <parameter>enable</parameter> is a <type>bool</type>, the function will try to enable or disable the VT100 features of the stream <parameter>stream</parameter>.
If the feature has been successfully enabled (or disabled), the function will return &true;, or &false; otherwise.
</para>
<para>
At startup, PHP tries to enable the VT100 feature of the <constant>STDOUT</constant>/<constant>STDERR</constant> streams. By the way, if those streams are redirected to a file, the VT100 features may not be enabled.
</para>
<para>
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.
</para>
<warning>
<simpara>
This function uses the <constant>ENABLE_VIRTUAL_TERMINAL_PROCESSING</constant> flag implemented in the Windows 10 API, so the VT100 feature may not be available on older Windows versions.
</simpara>
</warning>
</refsect1><!-- }}} -->
<refsect1 role="parameters"><!-- {{{ -->
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>stream</parameter></term>
<listitem>
<para>
The stream on which the function will operate.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>enable</parameter></term>
<listitem>
<para>
If <type>bool</type>, the VT100 feature will be enabled (if &true;) or disabled (if &false;).
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1><!-- }}} -->
<refsect1 role="returnvalues"><!-- {{{ -->
&reftitle.returnvalues;
<para>
If <parameter>enable</parameter> is &null;: returns &true; if the VT100 feature is enabled, &false; otherwise.
</para>
<para>
If <parameter>enable</parameter> is a <type>bool</type>: &return.success;
</para>
</refsect1><!-- }}} -->
<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.0.0</entry>
<entry>
<parameter>enable</parameter> is now nullable.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>
<refsect1 role="examples"><!-- {{{ -->
&reftitle.examples;
<example>
<title><function>sapi_windows_vt100_support</function> default state</title>
<para>
By default, <constant>STDOUT</constant> and <constant>STDERR</constant> have the VT100 feature enabled.
</para>
<programlisting role="sh">
php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));"
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
true true
]]>
</screen>
<para>
By the way, if a stream is redirected, the VT100 feature will not be enabled:
</para>
<programlisting role="sh">
php -r "var_export(sapi_windows_vt100_support(STDOUT));echo ' ';var_export(sapi_windows_vt100_support(STDERR));" 2>NUL
</programlisting>
&example.outputs.similar;
<screen>
true false
</screen>
</example>
<example>
<title><function>sapi_windows_vt100_support</function> changing state</title>
<para>
You won't be able to enable the VT100 feature of <constant>STDOUT</constant> or <constant>STDERR</constant> if the stream is redirected.
</para>
<programlisting role="sh">
php -r "var_export(sapi_windows_vt100_support(STDOUT, true));echo ' ';var_export(sapi_windows_vt100_support(STDERR, true));" 2>NUL
</programlisting>
&example.outputs.similar;
<screen>
<![CDATA[
true false
]]>
</screen>
</example>
<example>
<title>Example usage of VT100 support enabled</title>
<programlisting role="php">
<![CDATA[
<?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');
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
Just forgot a letter.
]]>
</screen>
</example>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
|
