Skip to content

ext/sqlite3, ext/sockets: document the PHP 8.5 additions #5819

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.

Sign up for GitHub

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

Open
lacatoire wants to merge 3 commits into
base: master
Choose a base branch
from
+498 −2
Open

ext/sqlite3, ext/sockets: document the PHP 8.5 additions #5819

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
55c49a4
ext/sqlite3, ext/sockets: document the PHP 8.5 additions
lacatoire Aug 31, 2026
bdd1cff
docs(sqlite3): add cross-links to SQLite3Stmt class and method pages
lacatoire Sep 2, 2026
514752a
fix(sqlite3): use <simpara> for inline-only paragraph in SQLite3Stmt …
lacatoire Sep 2, 2026
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
192 changes: 192 additions & 0 deletions reference/sockets/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3185,6 +3185,198 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-rd">
<term>
<constant>SHUT_RD</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Disables further receive operations on the socket.
Used with <function>socket_shutdown</function>.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-wr">
<term>
<constant>SHUT_WR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Disables further send operations on the socket.
Used with <function>socket_shutdown</function>.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-rdwr">
<term>
<constant>SHUT_RDWR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Disables further send and receive operations on the socket.
Used with <function>socket_shutdown</function>.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.udp-segment">
<term>
<constant>UDP_SEGMENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Sets the maximum size of UDP Generic Segmentation Offload (GSO) segments,
allowing multiple datagrams to be sent in a single system call.
Available on Linux only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.so-busy-poll">
<term>
<constant>SO_BUSY_POLL</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Sets the approximate time in microseconds to busy poll on a blocking
receive when there is no data. This reduces latency at the cost of CPU.
Available on Linux only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ip-bindany">
<term>
<constant>IP_BINDANY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Allows binding a socket to any address, even if it is not local.
Available on FreeBSD, NetBSD, and OpenBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-function-blk">
<term>
<constant>TCP_FUNCTION_BLK</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Selects the TCP stack (function block) used by the socket. With
<function>socket_set_option</function> the value is the name of the stack
as a <type>string</type>; <function>socket_get_option</function> returns an
array with the <literal>function_set_name</literal> and
<literal>pcbcnt</literal> keys.
Available on FreeBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-function-alias">
<term>
<constant>TCP_FUNCTION_ALIAS</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Retrieves the alias of the TCP stack used by the socket, as an array with
the <literal>function_set_name</literal> and <literal>pcbcnt</literal> keys.
Available on FreeBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-reusport-lb-numa">
<term>
<constant>TCP_REUSPORT_LB_NUMA</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Controls NUMA domain affinity for load-balanced port reuse.
Available on FreeBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-reusport-lb-numa-nodom">
<term>
<constant>TCP_REUSPORT_LB_NUMA_NODOM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Constant value for <constant>TCP_REUSPORT_LB_NUMA</constant> indicating
no NUMA domain affinity.
Available on FreeBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-reusport-lb-numa-curdom">
<term>
<constant>TCP_REUSPORT_LB_NUMA_CURDOM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Constant value for <constant>TCP_REUSPORT_LB_NUMA</constant> indicating
affinity for the current NUMA domain.
Available on FreeBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.tcp-bbr-algorithm">
<term>
<constant>TCP_BBR_ALGORITHM</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Socket option related to the BBR (Bottleneck Bandwidth and Round-trip
propagation time) congestion control algorithm.
Available on FreeBSD only.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ipproto-icmp">
<term>
<constant>IPPROTO_ICMP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Internet Control Message Protocol (ICMP) protocol number,
used when creating raw sockets.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ipproto-icmpv6">
<term>
<constant>IPPROTO_ICMPV6</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Internet Control Message Protocol version 6 (ICMPv6) protocol number,
used when creating raw IPv6 sockets.
Available as of PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>

</appendix>
Expand Down
71 changes: 69 additions & 2 deletions reference/sqlite3/sqlite3stmt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,12 @@
<!-- {{{ SQLite3Stmt intro -->
<section xml:id="sqlite3stmt.intro">
&reftitle.intro;
<para>
<simpara>
A class that handles prepared statements for the SQLite 3 extension.
</para>
Instances are obtained from <methodname>SQLite3::prepare</methodname>.
Calling <methodname>SQLite3Stmt::execute</methodname> runs the query and
returns a <classname>SQLite3Result</classname> for result sets.
</simpara>
</section>
<!-- }}} -->

Expand All @@ -24,6 +27,29 @@
<classname>SQLite3Stmt</classname>
</ooclass>

<classsynopsisinfo role="comment">&Constants;</classsynopsisinfo>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="sqlite3stmt.constants.explain-mode-prepared">SQLite3Stmt::EXPLAIN_MODE_PREPARED</varname>
<initializer>0</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="sqlite3stmt.constants.explain-mode-explain">SQLite3Stmt::EXPLAIN_MODE_EXPLAIN</varname>
<initializer>1</initializer>
</fieldsynopsis>
<fieldsynopsis>
<modifier>public</modifier>
<modifier>const</modifier>
<type>int</type>
<varname linkend="sqlite3stmt.constants.explain-mode-explain-query-plan">SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN</varname>
<initializer>2</initializer>
</fieldsynopsis>

<classsynopsisinfo role="comment">&Methods;</classsynopsisinfo>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sqlite3stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:constructorsynopsis[@role='SQLite3Stmt'])"/>
<xi:include xpointer="xmlns(db=http://docbook.org/ns/docbook) xpointer(id('class.sqlite3stmt')/db:refentry/db:refsect1[@role='description']/descendant::db:methodsynopsis[@role='SQLite3Stmt'])"/>
Expand All @@ -32,6 +58,47 @@

</section>

<!-- {{{ SQLite3Stmt constants -->
<section xml:id="sqlite3stmt.constants">
&reftitle.constants;
<variablelist>

<varlistentry xml:id="sqlite3stmt.constants.explain-mode-prepared">
<term><constant>SQLite3Stmt::EXPLAIN_MODE_PREPARED</constant></term>
<listitem>
<simpara>
The statement operates in normal prepared statement mode (no <literal>EXPLAIN</literal>).
Available as of PHP 8.5.0, when compiled against libsqlite &gt;= 3.43.0.
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="sqlite3stmt.constants.explain-mode-explain">
<term><constant>SQLite3Stmt::EXPLAIN_MODE_EXPLAIN</constant></term>
<listitem>
<simpara>
The statement operates as if prefixed with <literal>EXPLAIN</literal>,
returning opcode information from the virtual machine.
Available as of PHP 8.5.0, when compiled against libsqlite &gt;= 3.43.0.
</simpara>
</listitem>
</varlistentry>

<varlistentry xml:id="sqlite3stmt.constants.explain-mode-explain-query-plan">
<term><constant>SQLite3Stmt::EXPLAIN_MODE_EXPLAIN_QUERY_PLAN</constant></term>
<listitem>
<simpara>
The statement operates as if prefixed with <literal>EXPLAIN QUERY PLAN</literal>,
returning high-level query plan information.
Available as of PHP 8.5.0, when compiled against libsqlite &gt;= 3.43.0.
</simpara>
</listitem>
</varlistentry>

</variablelist>
</section>
<!-- }}} -->

</partintro>

&reference.sqlite3.entities.sqlite3stmt;
Expand Down
86 changes: 86 additions & 0 deletions reference/sqlite3/sqlite3stmt/busy.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<refentry xml:id="sqlite3stmt.busy" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>SQLite3Stmt::busy</refname>
<refpurpose>Returns whether the statement has been fetched but not yet completed</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis role="SQLite3Stmt">
<modifier>public</modifier> <type>bool</type><methodname>SQLite3Stmt::busy</methodname>
<void/>
</methodsynopsis>
<simpara>
Returns whether the statement is busy, i.e. it has been started with
<methodname>SQLite3Stmt::execute</methodname> and has rows remaining to be fetched,
but has not yet been completed or reset.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Returns &true; if the statement has been executed and still has rows to fetch,
&false; otherwise.
</simpara>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>8.5.0</entry>
<entry>
This method was added.
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>SQLite3Stmt::execute</methodname></member>
<member><methodname>SQLite3Stmt::reset</methodname></member>
<member><methodname>SQLite3Stmt::close</methodname></member>
</simplelist>
</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
-->
Loading