-
Notifications
You must be signed in to change notification settings - Fork 70
/
filter.xml
137 lines (131 loc) · 5.09 KB
/
filter.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
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4f6742c6efd4746d46eea65eedf3101a55f3d31d Maintainer: tmn Status: ready -->
<!-- Reviewed: no -->
<refentry xml:id="php-user-filter.filter" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>php_user_filter::filter</refname>
<refpurpose>
Вызывается, как только применяется фильтр
</refpurpose>
</refnamediv>
<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="php_user_filter">
<modifier>public</modifier> <type>int</type><methodname>php_user_filter::filter</methodname>
<methodparam><type>resource</type><parameter>in</parameter></methodparam>
<methodparam><type>resource</type><parameter>out</parameter></methodparam>
<methodparam><type>int</type><parameter role="reference">consumed</parameter></methodparam>
<methodparam><type>bool</type><parameter>closing</parameter></methodparam>
</methodsynopsis>
<para>
Этот метод вызывается всякий раз, когда данные читаются из присоединённого
потока или записываются в него (такими функциями, как
<function>fread</function> или <function>fwrite</function>).
</para>
</refsect1>
<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>in</parameter></term>
<listitem>
<para>
<parameter>in</parameter> - ресурс, указывающий на
<literal>bucket brigade</literal>, которая содержит один или
несколько объектов <literal>bucket</literal> содержащих фильтруемые данные.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>out</parameter></term>
<listitem>
<para>
<parameter>out</parameter> – ресурс, указывающий на другой объект
<literal>bucket brigade</literal>, в который будут помещаться
модифицированные бакеты.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>consumed</parameter></term>
<listitem>
<para>
<parameter>consumed</parameter>, который должен <emphasis>всегда</emphasis>
передаваться по ссылке, должен увеличиваться на размер данных, которые
фильтр читает и изменяет. В большинстве случаев это значит, что вы сами будете
увеличивать значение <parameter>consumed</parameter> на
<literal>$bucket->datalen</literal> для каждого <literal>$bucket</literal>.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term><parameter>closing</parameter></term>
<listitem>
<para>
Если поток закрывается (следовательно, это последний фильтр в цепочке),
аргумент <parameter>closing</parameter> примет значение &true;.
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1 role="returnvalues">
&reftitle.returnvalues;
<para>
Метод <methodname>filter</methodname> должен возвращать одно из трёх
значений.
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>Возвращаемое значение</entry>
<entry>Описание</entry>
</row>
</thead>
<tbody>
<row>
<entry><constant>PSFS_PASS_ON</constant></entry>
<entry>
Фильтр отработал успешно, данные доступны через аргумент
<parameter>out</parameter> <literal>bucket brigade</literal>.
</entry>
</row>
<row>
<entry><constant>PSFS_FEED_ME</constant></entry>
<entry>
Фильтр отработал успешно, однако доступных для вывода данных нет.
Требуются ещё данные из потока или предыдущего фильтра.
</entry>
</row>
<row>
<entry><constant>PSFS_ERR_FATAL</constant> (по умолчанию)</entry>
<entry>
Фильтр вызвал необрабатываемую ошибку и не может продолжить выполнение.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</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
-->