mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-26 13:58:55 +00:00
d6b431c9ff
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@326648 c90b9560-bf6c-de11-be94-00142212c4b1
104 lines
2.7 KiB
XML
104 lines
2.7 KiB
XML
<?xml version="1.0" encoding="utf-8"?>
|
|
<!-- $Revision$ -->
|
|
<!-- Generated by xml_proto.php v2.2. Found in /scripts directory of phpdoc. -->
|
|
<refentry xml:id="function.stream-bucket-prepend" xmlns="http://docbook.org/ns/docbook">
|
|
<refnamediv>
|
|
<refname>stream_bucket_prepend</refname>
|
|
<refpurpose>
|
|
Prepend bucket to brigade
|
|
</refpurpose>
|
|
</refnamediv>
|
|
<refsect1 role="description">
|
|
&reftitle.description;
|
|
<methodsynopsis>
|
|
<type>void</type><methodname>stream_bucket_prepend</methodname>
|
|
<methodparam><type>resource</type><parameter>brigade</parameter></methodparam>
|
|
<methodparam><type>resource</type><parameter>bucket</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<para>
|
|
This function can be called to prepend a bucket to a bucket brigade. It
|
|
is typically called from <methodname>php_user_filter::filter</methodname>.
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="parameters">
|
|
&reftitle.parameters;
|
|
<variablelist>
|
|
<varlistentry>
|
|
<term><parameter>brigade</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
<parameter>brigade</parameter> is a resource pointing to a <literal>bucket brigade</literal>
|
|
which contains one or more <literal>bucket</literal> objects.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
<varlistentry>
|
|
<term><parameter>bucket</parameter></term>
|
|
<listitem>
|
|
<para>
|
|
A bucket object.
|
|
</para>
|
|
</listitem>
|
|
</varlistentry>
|
|
</variablelist>
|
|
</refsect1>
|
|
<refsect1 role="returnvalues">
|
|
&reftitle.returnvalues;
|
|
<para>
|
|
&return.void;
|
|
</para>
|
|
</refsect1>
|
|
|
|
<refsect1 role="examples">
|
|
&reftitle.examples;
|
|
<para>
|
|
<example>
|
|
<title><function>stream_bucket_prepend</function> examples</title>
|
|
<programlisting role="php">
|
|
<![CDATA[
|
|
<?php
|
|
|
|
class foo extends php_user_filter {
|
|
protected $calls = 0;
|
|
public function filter($in, $out, &$consumed, $closing) {
|
|
while ($bucket = stream_bucket_make_writeable($in)) {
|
|
$consumed += $bucket->datalen;
|
|
if ($this->calls++ == 2) {
|
|
// This bucket will appear again before any other bucket.
|
|
stream_bucket_prepend($in, $bucket);
|
|
}
|
|
}
|
|
return PSFS_FEED_ME;
|
|
}
|
|
}
|
|
stream_filter_register('test', 'foo');
|
|
print file_get_contents('php://filter/read=test/resource=foo');
|
|
?>
|
|
]]>
|
|
</programlisting>
|
|
</example>
|
|
</para>
|
|
</refsect1>
|
|
</refentry>
|
|
|
|
<!-- 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
|
|
-->
|