<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Prepend bucket to brigade</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-bucket-new.html">stream_bucket_new</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-context-create.html">stream_context_create</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.stream-bucket-prepend" class="refentry">
<div class="refnamediv">
<h1 class="refname">stream_bucket_prepend</h1>
<p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">stream_bucket_prepend</span> — <span class="dc-title">
Prepend bucket to brigade
</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.stream-bucket-prepend-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><span class="type void">void</span></span> <span class="methodname"><strong>stream_bucket_prepend</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$brigade</code></span>
, <span class="methodparam"><span class="type">resource</span> <code class="parameter">$bucket</code></span>
)</div>
<p class="para rdfs-comment">
This function can be called to prepend a bucket to a bucket brigade. It
is typically called from <span class="methodname"><a href="php-user-filter.filter.html" class="methodname">php_user_filter::filter()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.stream-bucket-prepend-parameters">
<h3 class="title">Parameters</h3>
<dl>
<dt>
<span class="term"><em><code class="parameter">brigade</code></em></span>
<dd>
<p class="para">
<em><code class="parameter">brigade</code></em> is a resource pointing to a <em>bucket brigade</em>
which contains one or more <em>bucket</em> objects.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">bucket</code></em></span>
<dd>
<p class="para">
A bucket object.
</p>
</dd>
</dt>
</dl>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.stream-bucket-prepend-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
No value is returned.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.stream-bucket-prepend-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4009">
<p><strong>Example #1 <span class="function"><strong>stream_bucket_prepend()</strong></span> examples</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /><br /></span><span style="color: #007700">class </span><span style="color: #0000BB">foo </span><span style="color: #007700">extends </span><span style="color: #0000BB">php_user_filter </span><span style="color: #007700">{<br /> protected </span><span style="color: #0000BB">$calls </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /> public function </span><span style="color: #0000BB">filter</span><span style="color: #007700">(</span><span style="color: #0000BB">$in</span><span style="color: #007700">, </span><span style="color: #0000BB">$out</span><span style="color: #007700">, &</span><span style="color: #0000BB">$consumed</span><span style="color: #007700">, </span><span style="color: #0000BB">$closing</span><span style="color: #007700">) {<br /> while (</span><span style="color: #0000BB">$bucket </span><span style="color: #007700">= </span><span style="color: #0000BB">stream_bucket_make_writeable</span><span style="color: #007700">(</span><span style="color: #0000BB">$in</span><span style="color: #007700">)) {<br /> </span><span style="color: #0000BB">$consumed </span><span style="color: #007700">+= </span><span style="color: #0000BB">$bucket</span><span style="color: #007700">-></span><span style="color: #0000BB">datalen</span><span style="color: #007700">;<br /> if (</span><span style="color: #0000BB">$this</span><span style="color: #007700">-></span><span style="color: #0000BB">calls</span><span style="color: #007700">++ == </span><span style="color: #0000BB">2</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// This bucket will appear again before any other bucket.<br /> </span><span style="color: #0000BB">stream_bucket_prepend</span><span style="color: #007700">(</span><span style="color: #0000BB">$in</span><span style="color: #007700">, </span><span style="color: #0000BB">$bucket</span><span style="color: #007700">);<br /> }<br /> }<br /> return </span><span style="color: #0000BB">PSFS_FEED_ME</span><span style="color: #007700">;<br /> }<br />}<br /></span><span style="color: #0000BB">stream_filter_register</span><span style="color: #007700">(</span><span style="color: #DD0000">'test'</span><span style="color: #007700">, </span><span style="color: #DD0000">'foo'</span><span style="color: #007700">);<br />print </span><span style="color: #0000BB">file_get_contents</span><span style="color: #007700">(</span><span style="color: #DD0000">'php://filter/read=test/resource=foo'</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.stream-bucket-new.html">stream_bucket_new</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.stream-context-create.html">stream_context_create</a></div>
<div class="up"><a href="ref.stream.html">Stream Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
