-
Notifications
You must be signed in to change notification settings - Fork 807
PHP 8.4: Document StreamBucket
#4297
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
3f8a4bc
Synchronize manual with stubs for PHP 8.4 - part 10
kocsismate dae9b52
Address review comments
kocsismate 3a5d6af
Update reference/stream/streambucket.xml
kocsismate a663438
Remove <para> tag
kocsismate 2f2fd66
Use entities
kocsismate File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When does it return
nullactually?There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As far as I managed to understand https://github.com/php/php-src/blob/d6d78545ea405e89a44445a9a32d77a75fd8bb6b/ext/standard/user_filters.c#L356, it returns null if the brigade is empty (?). The 2nd part of the condition seems to be always non-null (
bucketvariable).There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, at least under ZendMM,
php_stream_bucket_make_writeable()cannot return NULL; that code is from 2003; maybe we should move thephp_stream_bucket_make_writeable()inside the if-branch.Anyhow, reading the manual helps understanding the implementation. E.g. the info on https://www.php.net/manual/en/function.stream-bucket-append.php explains everything; and https://www.php.net/manual/en/function.stream-bucket-make-writeable.php (emphasis mine):
is also quite entertaining. ;)
Might not make sense to try to figure out this particular return value meaning for now.