Skip to content

Commit fef3e7d

Browse files
committed
Sync methods of php_user_filter docs
1 parent 1eb386b commit fef3e7d

File tree

3 files changed

+28
-37
lines changed

3 files changed

+28
-37
lines changed

reference/stream/php_user_filter/filter.xml

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,15 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: 158a015e881963245f2197c2535e7fc2d476a766 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 4f6742c6efd4746d46eea65eedf3101a55f3d31d Maintainer: seros Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="php-user-filter.filter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>php_user_filter::filter</refname>
97
<refpurpose>Llamado cuando se aplica un filtro</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
12+
<methodsynopsis role="php_user_filter">
1513
<modifier>public</modifier> <type>int</type><methodname>php_user_filter::filter</methodname>
1614
<methodparam><type>resource</type><parameter>in</parameter></methodparam>
1715
<methodparam><type>resource</type><parameter>out</parameter></methodparam>
@@ -22,9 +20,9 @@
2220
Este método es llamado siempre que los datos son leídos desde o escritos en
2321
el flujo adjunto (como con <function>fread</function> o <function>fwrite</function>).
2422
</para>
25-
23+
2624
</refsect1>
27-
25+
2826
<refsect1 role="parameters">
2927
&reftitle.parameters;
3028
<variablelist>
@@ -53,7 +51,7 @@
5351
<parameter>consumed</parameter>, el cual <emphasis>siempre</emphasis> debe
5452
ser declarado por referencia, debería ser incrementado por la longitud de la información
5553
que el filtro lee y altera. En la mayoría de los casos esto significa que se
56-
incrementará <parameter>consumed</parameter> por <literal>$recipiente->datalen</literal>
54+
incrementará <parameter>consumed</parameter> por <literal>$recipiente-&gt;datalen</literal>
5755
para cada <literal>$recipiente</literal>.
5856
</para>
5957
</listitem>
@@ -70,7 +68,7 @@
7068
</varlistentry>
7169
</variablelist>
7270
</refsect1>
73-
71+
7472
<refsect1 role="returnvalues">
7573
&reftitle.returnvalues;
7674
<para>
@@ -110,10 +108,9 @@
110108
</informaltable>
111109
</para>
112110
</refsect1>
113-
114-
115-
</refentry>
116111

112+
113+
</refentry>
117114
<!-- Keep this comment at the end of the file
118115
Local variables:
119116
mode: sgml

reference/stream/php_user_filter/onclose.xml

Lines changed: 9 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,17 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: 158a015e881963245f2197c2535e7fc2d476a766 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 4f6742c6efd4746d46eea65eedf3101a55f3d31d Maintainer: seros Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="php-user-filter.onclose" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>php_user_filter::onClose</refname>
97
<refpurpose>Llamado cuando se cierra el filtro</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
12+
<methodsynopsis role="php_user_filter">
1513
<modifier>public</modifier> <type>void</type><methodname>php_user_filter::onClose</methodname>
16-
<void />
14+
<void/>
1715
</methodsynopsis>
1816
<para>
1917
Este método es llamado bajo el cierre del filtro (normalmente también
@@ -22,24 +20,23 @@
2220
cualquier recurso durante <literal>onCreate()</literal>,
2321
este sería el momento de destruirlo o deshacerse de él.
2422
</para>
25-
23+
2624
</refsect1>
27-
25+
2826
<refsect1 role="parameters">
2927
&reftitle.parameters;
3028
&no.function.parameters;
3129
</refsect1>
32-
30+
3331
<refsect1 role="returnvalues">
3432
&reftitle.returnvalues;
3533
<para>
3634
El valor de retorono es ignorado.
3735
</para>
3836
</refsect1>
39-
40-
41-
</refentry>
4237

38+
39+
</refentry>
4340
<!-- Keep this comment at the end of the file
4441
Local variables:
4542
mode: sgml

reference/stream/php_user_filter/oncreate.xml

Lines changed: 10 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,24 @@
11
<?xml version="1.0" encoding="utf-8"?>
2-
<!-- $Revision$ -->
3-
<!-- EN-Revision: 158a015e881963245f2197c2535e7fc2d476a766 Maintainer: seros Status: ready -->
2+
<!-- EN-Revision: 4f6742c6efd4746d46eea65eedf3101a55f3d31d Maintainer: seros Status: ready -->
43
<!-- Reviewed: no -->
5-
64
<refentry xml:id="php-user-filter.oncreate" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
75
<refnamediv>
86
<refname>php_user_filter::onCreate</refname>
97
<refpurpose>Llamado cuando se crea el filtro</refpurpose>
108
</refnamediv>
11-
9+
1210
<refsect1 role="description">
1311
&reftitle.description;
14-
<methodsynopsis>
12+
<methodsynopsis role="php_user_filter">
1513
<modifier>public</modifier> <type>bool</type><methodname>php_user_filter::onCreate</methodname>
16-
<void />
14+
<void/>
1715
</methodsynopsis>
1816
<para>
1917
Este método se llama durante la instanciación del objeto de la clase del
2018
filtro. Si el filtro asigna o inicializa cualquier otro recurso
2119
(como un buffer), éste es el lugar para hacerlo.
2220
</para>
23-
21+
2422
<para>
2523
Cuando primero se instancia el filtro, y
2624
se llama a <literal>elfiltro-&gt;onCreate()</literal>, estarán disponibles
@@ -64,25 +62,24 @@
6462
</tgroup>
6563
</informaltable>
6664
</para>
67-
65+
6866
</refsect1>
69-
67+
7068
<refsect1 role="parameters">
7169
&reftitle.parameters;
7270
&no.function.parameters;
7371
</refsect1>
74-
72+
7573
<refsect1 role="returnvalues">
7674
&reftitle.returnvalues;
7775
<para>
7876
La implementación de
7977
este método debería devolver &false; en caso de error, o &true; en caso de éxito.
8078
</para>
8179
</refsect1>
82-
83-
84-
</refentry>
8580

81+
82+
</refentry>
8683
<!-- Keep this comment at the end of the file
8784
Local variables:
8885
mode: sgml

0 commit comments

Comments
 (0)