-
Notifications
You must be signed in to change notification settings - Fork 769
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
PHP 8.4: Document
StreamBucket (#4297)
Co-authored-by: Christoph M. Becker <cmbecker69@gmx.de>
- Loading branch information
1 parent
f6678a7
commit 32caa89
Showing
7 changed files
with
210 additions
and
33 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,121 @@ | ||
| <?xml version="1.0" encoding="utf-8"?> | ||
| <!-- $Revision$ --> | ||
| <reference xml:id="class.streambucket" role="class" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:xi="http://www.w3.org/2001/XInclude"> | ||
|
|
||
| <title>The StreamBucket class</title> | ||
| <titleabbrev>StreamBucket</titleabbrev> | ||
|
|
||
| <partintro> | ||
|
|
||
| <section xml:id="streambucket.intro"> | ||
| &reftitle.intro; | ||
| <simpara> | ||
| A stream bucket is a chunk of a stream which can be extracted from bucket brigades. | ||
| </simpara> | ||
| </section> | ||
|
|
||
| <section xml:id="streambucket.synopsis"> | ||
| &reftitle.classsynopsis; | ||
|
|
||
| <classsynopsis class="class"> | ||
| <ooclass> | ||
| <modifier>final</modifier> | ||
| <classname>StreamBucket</classname> | ||
| </ooclass> | ||
|
|
||
| <classsynopsisinfo role="comment">&Properties;</classsynopsisinfo> | ||
| <fieldsynopsis> | ||
| <modifier>public</modifier> | ||
| <modifier>readonly</modifier> | ||
| <type>resource</type> | ||
| <varname linkend="streambucket.props.bucket">bucket</varname> | ||
| </fieldsynopsis> | ||
| <fieldsynopsis> | ||
| <modifier>public</modifier> | ||
| <modifier>readonly</modifier> | ||
| <type>string</type> | ||
| <varname linkend="streambucket.props.data">data</varname> | ||
| </fieldsynopsis> | ||
| <fieldsynopsis> | ||
| <modifier>public</modifier> | ||
| <modifier>readonly</modifier> | ||
| <type>int</type> | ||
| <varname linkend="streambucket.props.datalen">datalen</varname> | ||
| </fieldsynopsis> | ||
| <fieldsynopsis> | ||
| <modifier>public</modifier> | ||
| <modifier>readonly</modifier> | ||
| <type>int</type> | ||
| <varname linkend="streambucket.props.datalength">dataLength</varname> | ||
| </fieldsynopsis> | ||
| </classsynopsis> | ||
| </section> | ||
|
|
||
| <section xml:id="streambucket.props"> | ||
| &reftitle.properties; | ||
| <variablelist> | ||
| <varlistentry xml:id="streambucket.props.bucket"> | ||
| <term>resource <varname>bucket</varname></term> | ||
| <listitem> | ||
| <simparapara>A <literal>userfilter.bucket</literal> resource.</simparapara> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry xml:id="streambucket.props.data"> | ||
| <term>string <varname>data</varname></term> | ||
| <listitem> | ||
| <simparapara>The current string in the bucket.</simparapara> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry xml:id="streambucket.props.datalen"> | ||
| <term>int <varname>datalen</varname></term> | ||
| <listitem> | ||
| <simparapara> | ||
| The length of the string in the bucket. | ||
| Deprecated as of PHP 8.4 in favor of <literal>StreamBucket::$dataLength</literal>. | ||
| </simparapara> | ||
| </listitem> | ||
| </varlistentry> | ||
| <varlistentry xml:id="streambucket.props.dataLength"> | ||
| <term>int <varname>dataLength</varname></term> | ||
| <listitem> | ||
| <simparapara>The length of the string in the bucket.</simparapara> | ||
| </listitem> | ||
| </varlistentry> | ||
| </variablelist> | ||
| </section> | ||
|
|
||
| <section role="seealso"> | ||
| &reftitle.seealso; | ||
| <simplelist> | ||
| <member><function>stream_bucket_new</function></member> | ||
| <member><function>stream_bucket_append</function></member> | ||
| <member><function>stream_bucket_prepend</function></member> | ||
| <member><function>stream_bucket_make_writeable</function></member> | ||
| </simplelist> | ||
| </section> | ||
|
|
||
| </partintro> | ||
|
|
||
| &reference.stream.entities.streambucket; | ||
|
|
||
| </reference> | ||
| <!-- 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 | ||
| --> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters