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
|
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<reference xml:id="class.streambucket" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>The StreamBucket class</title>
<titleabbrev>StreamBucket</titleabbrev>
<partintro>
<section xml:id="streambucket.intro">
&reftitle.intro;
<simpara>
A stream bucket is a chunk of a stream which can be extracted from bucket brigades.
</simpara>
</section>
<section xml:id="streambucket.synopsis">
&reftitle.classsynopsis;
<classsynopsis class="class">
<ooclass>
<modifier>final</modifier>
<classname>StreamBucket</classname>
</ooclass>
<classsynopsisinfo role="comment">&Properties;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>resource</type>
<varname linkend="streambucket.props.bucket">bucket</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>string</type>
<varname linkend="streambucket.props.data">data</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="streambucket.props.datalen">datalen</varname>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>readonly</modifier>
<type>int</type>
<varname linkend="streambucket.props.datalength">dataLength</varname>
</fieldsynopsis>
</classsynopsis>
</section>
<section xml:id="streambucket.props">
&reftitle.properties;
<variablelist>
<varlistentry xml:id="streambucket.props.bucket">
<term>resource <varname>bucket</varname></term>
<listitem>
<simparapara>A <literal>userfilter.bucket</literal> resource.</simparapara>
</listitem>
</varlistentry>
<varlistentry xml:id="streambucket.props.data">
<term>string <varname>data</varname></term>
<listitem>
<simparapara>The current string in the bucket.</simparapara>
</listitem>
</varlistentry>
<varlistentry xml:id="streambucket.props.datalen">
<term>int <varname>datalen</varname></term>
<listitem>
<simparapara>
The length of the string in the bucket.
Deprecated as of PHP 8.4 in favor of <literal>StreamBucket::$dataLength</literal>.
</simparapara>
</listitem>
</varlistentry>
<varlistentry xml:id="streambucket.props.dataLength">
<term>int <varname>dataLength</varname></term>
<listitem>
<simparapara>The length of the string in the bucket.</simparapara>
</listitem>
</varlistentry>
</variablelist>
</section>
<section role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>stream_bucket_new</function></member>
<member><function>stream_bucket_append</function></member>
<member><function>stream_bucket_prepend</function></member>
<member><function>stream_bucket_make_writeable</function></member>
</simplelist>
</section>
</partintro>
&reference.stream.entities.streambucket;
</reference>
<!-- 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
-->
|
