Skip to content
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

Fix GH-2209: update return value and changelog of stream_set_chunk_size() #2663

Merged
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 29 additions & 5 deletions reference/stream/functions/stream-set-chunk-size.xml
Original file line number Diff line number Diff line change
Expand Up @@ -45,20 +45,44 @@
<para>
Returns the previous chunk size on success.
</para>
<para>
Will return &false; if <parameter>size</parameter> is less than 1 or
greater than <constant>PHP_INT_MAX</constant>.
</para>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<para>
Will emit an <constant>E_WARNING</constant> level error if <parameter>size</parameter>
A <classname>ValueError</classname> is thrown if <parameter>size</parameter>
is less than 1 or greater than <constant>PHP_INT_MAX</constant>.
</para>
</refsect1>

<refsect1 role="changelog"><!-- {{{ -->
&reftitle.changelog;
<para>
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PHP 8.0.0</entry>
<entry>
A <classname>ValueError</classname> is now thrown if
<parameter>size</parameter> is less than 1 or greater than
<constant>PHP_INT_MAX</constant>. Previously, an
<constant>E_WARNING</constant> level error was emitted and &false; was
returned.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</para>
</refsect1><!-- }}} -->

</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down