-
Notifications
You must be signed in to change notification settings - Fork 50
/
stream-filter-register.xml
234 lines (208 loc) · 6.23 KB
/
stream-filter-register.xml
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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 48e5dd1b7e9920436dd3b40e192d27c670e9679a Maintainer: seros Status: ready -->
<refentry xml:id="function.stream-filter-register" xmlns="http://docbook.org/ns/docbook">
<refnamediv>
<refname>stream_filter_register</refname>
<refpurpose>Registrar un filtro de flujo definido por el usuario</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<type>bool</type><methodname>stream_filter_register</methodname>
<methodparam><type>string</type><parameter>filtername</parameter></methodparam>
<methodparam><type>string</type><parameter>classname</parameter></methodparam>
</methodsynopsis>
<para>
<function>stream_filter_register</function> permite implementar
un filtro propio sobre cualquier flujo registrado usado con las demás funciones
de sistema de archivos (como <function>fopen</function>,
<function>fread</function> etc.).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<para>
<variablelist>
<varlistentry>
<term><parameter>filtername</parameter></term>
<listitem>
<para>
El nombre del filtro que va a ser registrado.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>classname</parameter></term>
<listitem>
<para>
Para implementar un filtro se necesita definir una clase como una extensión de
<classname>php_user_filter</classname> con un número de funciones
miembro. Cuando se lleva a cabo operaciones de lectura/escritura en el flujo
al cuál el filtro está enlazado, PHP pasará la información a través de este
filtro (y cualquier otro filtro enlazado a ese flujo) por lo que la
información puede ser modificada como se desee. Se deben implementar los métodos
exactamente como se describe en <classname>php_user_filter</classname> - hacerlo
de otro modo conducirá a un comportamiento indefinido.
</para>
</listitem>
</varlistentry>
</variablelist>
</para>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
&return.success;
</para>
<para>
<function>stream_filter_register</function> devolverá &false; si
<parameter>filtername</parameter> ya está definido.
</para>
</refsect1>
<refsect1 role="examples">
&reftitle.examples;
<para>
<example>
<title>Filtro para poner en mayúsculas caracteres en el flujo <filename>foo-bar.txt</filename></title>
<para>
El ejemplo de abajo implementa un filtro llamado <literal>strtoupper</literal>
en el flujo <filename>foo-bar.txt</filename> que pondrá en mayúsculas
todos los caracteres de letras escritos en/leídos desde este flujo.
</para>
<programlisting role="php">
<![CDATA[
<?php
/* Definir nuestra clase de filtro */
class strtoupper_filter extends php_user_filter {
function filter($entrada, $salida, &$consumido, $cerrar)
{
while ($recipiente = stream_bucket_make_writeable($entrada)) {
$recipiente->data = strtoupper($recipiente->data);
$consumido += $recipiente->datalen;
stream_bucket_append($salida, $recipiente);
}
return PSFS_PASS_ON;
}
}
/* Registrar nuestro filtro con PHP */
stream_filter_register("strtoupper", "strtoupper_filter")
or die("Fallo al registrar el filtro");
$fp = fopen("foo-bar.txt", "w");
/* Enlazar el filtro al flujo recién abierto */
stream_filter_append($fp, "strtoupper");
fwrite($fp, "Fila1\n");
fwrite($fp, "Palabra - 2\n");
fwrite($fp, "Tan Sencillo Como 123\n");
fclose($fp);
/* Leer el contenido desde atrás
*/
readfile("foo-bar.txt");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
FILA1
PALABRA - 2
TAN SENCILLO COMO 123
]]>
</screen>
</example>
</para>
<para>
<example>
<title>Registrar una clase de filtro genérica para comparar múltiples nombres de filtro.</title>
<programlisting role="php">
<![CDATA[
<?php
/* Definir nuestra clase de filtro */
class string_filter extends php_user_filter {
var $modo;
function filter($entrada, $salida, &$consumido, $cerrar)
{
while ($recipiente = stream_bucket_make_writeable($entrada)) {
if ($this->mode == 1) {
$recipiente->data = strtoupper($recipiente->data);
} elseif ($this->mode == 0) {
$recipiente->data = strtolower($recipiente->data);
}
$consumido += $recipiente->datalen;
stream_bucket_append($salida, $recipiente);
}
return PSFS_PASS_ON;
}
function onCreate()
{
if ($this->filtername == 'str.toupper') {
$this->mode = 1;
} elseif ($this->filtername == 'str.tolower') {
$this->mode = 0;
} else {
/* Se preguntó por otro filtro str.*,
informar del fallo, por lo que PHP seguirá mirando */
return false;
}
return true;
}
}
/* Registrar nuestro filtro con PHP */
stream_filter_register("str.*", "string_filter")
or die("Fallo al registrar el filtro");
$fp = fopen("foo-bar.txt", "w");
/* Enlazar el filtro al flujo recién abierto
Alternativamente podríamos enlazar a str.tolower aquí */
stream_filter_append($fp, "str.toupper");
fwrite($fp, "Fila1\n");
fwrite($fp, "Palabra - 2\n");
fwrite($fp, "Tan Sencillo Como 123\n");
fclose($fp);
/* Leer el contenido desde atrás
*/
readfile("foo-bar.txt");
?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
FILA1
PALABRA - 2
TAN SENCILLO COMO 123
]]>
</screen>
</example>
</para>
</refsect1>
<refsect1 role="seealso">
&reftitle.seealso;
<para>
<simplelist>
<member><function>stream_wrapper_register</function></member>
<member><function>stream_filter_append</function></member>
<member><function>stream_filter_prepend</function></member>
</simplelist>
</para>
</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
-->