From cd2f425def45b19d2409c5fb3c1473ef7eb592dc Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Kristian=20K=C3=B6hntopp?= <kk@php.net>
Date: Sun, 12 Nov 2000 22:13:46 +0000
Subject: [PATCH] Added stuff on output buffering callbacks.

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@35624 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/outcontrol.xml | 48 +++++++++++++++++++++++++++++++++++++++-
 1 file changed, 47 insertions(+), 1 deletion(-)

diff --git a/functions/outcontrol.xml b/functions/outcontrol.xml
index 2b2eda7933..456e298a61 100644
--- a/functions/outcontrol.xml
+++ b/functions/outcontrol.xml
@@ -94,7 +94,11 @@ ob_end_flush();
     <funcsynopsis>
      <funcprototype>
       <funcdef>void <function>ob_start</function></funcdef>
-      <void/>
+      <paramdef>string
+       <parameter>
+        <optional>output_callback</optional>
+       </parameter>
+      </paramdef>
      </funcprototype>
     </funcsynopsis>
     <para>
@@ -110,6 +114,48 @@ ob_end_flush();
      <function>ob_end_clean</function> will silently discard the
      buffer contents.
     </para>
+    <para>
+     An optional output_callback function may be specified. This 
+     function takes a string as a parameter and returns a string.
+     The function will be called at <function>ob_end_flush</function>
+     time and will receive the contents of the output buffer as its
+     parameter. It must return a new output buffer as a result, 
+     which is what will be printed.
+    </para>
+    <para>
+     Output buffers are stackable, that is, you may call
+     <function>ob_start</function> while another
+     <function>ob_start</function> is active. Just make
+     sure that you call <function>ob_end_flush()</function>
+     the appropriate number of times. If multiple output callback
+     functions are active, output is being filtered sequentially
+     through each of them in nesting order.
+    </para>
+    <example>
+     <title>Callback function example</title>
+     <programlisting role="php">
+&lt;?php
+function c($str) {
+  // Druu Chunusun mut dum Kuntrubuß...
+  return nl2br(ereg_replace("[aeiou]", "u", $str));
+}
+
+function d($str) {
+  return strip_tags($str);
+}
+?>
+
+&lt;?php ob_start("c"); ?&gt;
+Drei Chinesen mit dem Kontrabaß...
+&lt;?php ob_start("d"); ?&gt;
+&lt;h1&gt;..saßen auf der Straße und erzählten sich was...&lt;/h1&gt;
+&lt;?php ob_end_flush(); ?&gt;
+... da kam die Polizei, ja was ist denn das?
+&lt;?php ob_end_flush(); ?&gt;
+
+?&gt;
+     </programlisting>
+    </example>
     <para>
      See also <function>ob_get_contents</function>,
      <function>ob_end_flush</function>,