[prev in list] [next in list] [prev in thread] [next in thread] 

List:       php-doc-cvs
Subject:    [DOC-CVS] [doc-en] master: Document stream_bucket_make_writable()
From:       ignace nyamagana butera via GitHub <noreply () php ! net>
Date:       2021-11-29 21:59:36
Message-ID: pmaoMfup1U1784AHG5ZLcotJPNcXBu9z3EExFXAK4Q () main ! php ! net
[Download RAW message or body]

Author: ignace nyamagana butera (nyamsprod)
Committer: GitHub (web-flow)
Pusher: cmb69
Date: 2021-11-29T23:00:21+01:00

Commit: https://github.com/php/doc-en/commit/3561c702e7bea3265a72bbd598d0ef079db60145
Raw diff: https://github.com/php/doc-en/commit/3561c702e7bea3265a72bbd598d0ef079db60145.diff


Document stream_bucket_make_writable()

Closes GH-1156.

Changed paths:
  M  reference/stream/functions/stream-bucket-make-writeable.xml


Diff:

diff --git a/reference/stream/functions/stream-bucket-make-writeable.xml \
b/reference/stream/functions/stream-bucket-make-writeable.xml index \
                aeeac02ac9..5f4f2ff49b 100644
--- a/reference/stream/functions/stream-bucket-make-writeable.xml
+++ b/reference/stream/functions/stream-bucket-make-writeable.xml
@@ -5,20 +5,78 @@
  <refnamediv>
   <refname>stream_bucket_make_writeable</refname>
   <refpurpose>
-   Return a bucket object from the brigade for operating on
+   Returns a bucket object from the brigade to operate on
   </refpurpose>
  </refnamediv>
+
  <refsect1 role="description">
   &reftitle.description;
   <methodsynopsis>
    <type class="union"><type>object</type><type>null</type></type><methodname>stream_bucket_make_writeable</methodname>
  <methodparam><type>resource</type><parameter>brigade</parameter></methodparam>
   </methodsynopsis>
+  <para>
+   This function is called whenever there is the need to access and operate on the \
content contains in a brigade. It is +   typically called from \
<methodname>php_user_filter::filter</methodname>. +  </para>
+ </refsect1>
 
-  &warn.undocumented.func;
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  <para>
+   <variablelist>
+    <varlistentry>
+     <term><parameter>brigade</parameter></term>
+     <listitem>
+      <para>
+       The brigade to return a bucket object from.
+      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
+ </refsect1>
 
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a bucket object with the properties listed below or &null;.
+   <variablelist>
+    <varlistentry>
+     <term>
+      <property>data</property>
+      (<type>string</type>)
+     </term>
+     <listitem>
+      <para>
+       <parameter>data</parameter> <literal>bucket</literal> The current string in \
the bucket. +      </para>
+     </listitem>
+    </varlistentry>
+    <varlistentry>
+     <term>
+      <property>datalen</property>
+      (<type>integer</type>)
+     </term>
+     <listitem>
+      <para>
+       <parameter>datalen</parameter> <literal>bucket</literal> The length of the \
string in the bucket. +      </para>
+     </listitem>
+    </varlistentry>
+   </variablelist>
+  </para>
  </refsect1>
 
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>stream_bucket_append</function></member>
+    <member><function>stream_bucket_prepend</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
 </refentry>
 
 <!-- Keep this comment at the end of the file

-- 
PHP Documentation Commits Mailing List (http://www.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php


[prev in list] [next in list] [prev in thread] [next in thread]