reference/stream/functions/stream-bucket-make-writeable.xml
3561c702e7bea3265a72bbd598d0ef079db60145
...
...
@@ -5,20 +5,78 @@
5
5
<refnamediv>
6
6
<refname>stream_bucket_make_writeable</refname>
7
7
<refpurpose>
8
-
Return a bucket object from the brigade for operating on
8
+
Returns a bucket object from the brigade to operate on
9
9
</refpurpose>
10
10
</refnamediv>
11
+

11
12
<refsect1 role="description">
12
13
&reftitle.description;
13
14
<methodsynopsis>
14
15
<type class="union"><type>object</type><type>null</type></type><methodname>stream_bucket_make_writeable</methodname>
15
16
<methodparam><type>resource</type><parameter>brigade</parameter></methodparam>
16
17
</methodsynopsis>
18
+
<para>
19
+
This function is called whenever there is the need to access and operate on the content contains in a brigade. It is
20
+
typically called from <methodname>php_user_filter::filter</methodname>.
21
+
</para>
22
+
</refsect1>
17
23

18
-
&warn.undocumented.func;
24
+
<refsect1 role="parameters">
25
+
&reftitle.parameters;
26
+
<para>
27
+
<variablelist>
28
+
<varlistentry>
29
+
<term><parameter>brigade</parameter></term>
30
+
<listitem>
31
+
<para>
32
+
The brigade to return a bucket object from.
33
+
</para>
34
+
</listitem>
35
+
</varlistentry>
36
+
</variablelist>
37
+
</para>
38
+
</refsect1>
19
39

40
+
<refsect1 role="returnvalues">
41
+
&reftitle.returnvalues;
42
+
<para>
43
+
Returns a bucket object with the properties listed below or &null;.
44
+
<variablelist>
45
+
<varlistentry>
46
+
<term>
47
+
<property>data</property>
48
+
(<type>string</type>)
49
+
</term>
50
+
<listitem>
51
+
<para>
52
+
<parameter>data</parameter> <literal>bucket</literal> The current string in the bucket.
53
+
</para>
54
+
</listitem>
55
+
</varlistentry>
56
+
<varlistentry>
57
+
<term>
58
+
<property>datalen</property>
59
+
(<type>integer</type>)
60
+
</term>
61
+
<listitem>
62
+
<para>
63
+
<parameter>datalen</parameter> <literal>bucket</literal> The length of the string in the bucket.
64
+
</para>
65
+
</listitem>
66
+
</varlistentry>
67
+
</variablelist>
68
+
</para>
20
69
</refsect1>
21
70

71
+
<refsect1 role="seealso">
72
+
&reftitle.seealso;
73
+
<para>
74
+
<simplelist>
75
+
<member><function>stream_bucket_append</function></member>
76
+
<member><function>stream_bucket_prepend</function></member>
77
+
</simplelist>
78
+
</para>
79
+
</refsect1>
22
80
</refentry>
23
81

24
82
<!-- Keep this comment at the end of the file
25
83