Skip to content

[Sync-En] ext/sqlite3, ext/sockets: document the PHP 8.5 additions #1264

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 1 commit into
base: master
Choose a base branch
from
Open

[Sync-En] ext/sqlite3, ext/sockets: document the PHP 8.5 additions #1264

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
198 changes: 197 additions & 1 deletion reference/sockets/constants.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 890cc22d38fa747c9930fd0d5984c170f2490c1b Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: e079b2a53251ac649dbcf055e604acb2a4ffa513 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no -->
<appendix xml:id="sockets.constants" xmlns="http://docbook.org/ns/docbook">
&reftitle.constants;
Expand Down Expand Up @@ -3147,6 +3147,202 @@
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-rd">
<term>
<constant>SHUT_RD</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Desactiva las operaciones de recepción posteriores sobre el socket.
Se utiliza con <function>socket_shutdown</function>.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-wr">
<term>
<constant>SHUT_WR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Desactiva las operaciones de envío posteriores sobre el socket.
Se utiliza con <function>socket_shutdown</function>.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.shut-rdwr">
<term>
<constant>SHUT_RDWR</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Desactiva las operaciones de envío y de recepción posteriores sobre el socket.
Se utiliza con <function>socket_shutdown</function>.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.udp-segment">
<term>
<constant>UDP_SEGMENT</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Define el tamaño máximo de los segmentos UDP GSO (Generic Segmentation
Offload), lo que permite enviar varios datagramas en una sola llamada al
sistema.
Disponible únicamente en Linux.
Disponible a partir de 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>
Define el tiempo aproximado, en microsegundos, de espera activa durante una
recepción bloqueante cuando no hay datos. Esto reduce la latencia a costa
de consumo de CPU.
Disponible únicamente en Linux.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ip-bindany">
<term>
<constant>IP_BINDANY</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Permite asociar un socket a cualquier dirección, aunque no sea local.
Disponible únicamente en FreeBSD, NetBSD y OpenBSD.
Disponible a partir de 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>
Selecciona la pila TCP (bloque de funciones) utilizada por el socket. Con
<function>socket_set_option</function>, el valor es el nombre de la pila en
forma de <type>string</type>; <function>socket_get_option</function>
devuelve un array con las claves <literal>function_set_name</literal> y
<literal>pcbcnt</literal>.
Disponible únicamente en FreeBSD.
Disponible a partir de 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>
Obtiene el alias de la pila TCP utilizada por el socket, en forma de un
array con las claves <literal>function_set_name</literal> y
<literal>pcbcnt</literal>.
Disponible únicamente en FreeBSD.
Disponible a partir de 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>
Controla la afinidad de dominio NUMA para la reutilización de puerto con
balanceo de carga.
Disponible únicamente en FreeBSD.
Disponible a partir de 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>
Valor de la constante <constant>TCP_REUSPORT_LB_NUMA</constant> que indica
la ausencia de afinidad de dominio NUMA.
Disponible únicamente en FreeBSD.
Disponible a partir de 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>
Valor de la constante <constant>TCP_REUSPORT_LB_NUMA</constant> que indica
una afinidad con el dominio NUMA actual.
Disponible únicamente en FreeBSD.
Disponible a partir de 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>
Opción de socket relacionada con el algoritmo de control de congestión BBR
(Bottleneck Bandwidth and Round-trip propagation time).
Disponible únicamente en FreeBSD.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ipproto-icmp">
<term>
<constant>IPPROTO_ICMP</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Número de protocolo ICMP (Internet Control Message Protocol), utilizado al
crear sockets sin procesar.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
<varlistentry xml:id="constant.ipproto-icmpv6">
<term>
<constant>IPPROTO_ICMPV6</constant>
(<type>int</type>)
</term>
<listitem>
<simpara>
Número de protocolo ICMPv6 (Internet Control Message Protocol version 6),
utilizado al crear sockets IPv6 sin procesar.
Disponible a partir de PHP 8.5.0.
</simpara>
</listitem>
</varlistentry>
</variablelist>

</appendix>
Expand Down
89 changes: 78 additions & 11 deletions reference/sqlite3/sqlite3stmt.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 4d17b7b4947e7819ff5036715dd706be87ae4def Maintainer: PhilDaiguille Status: ready -->
<!-- EN-Revision: e079b2a53251ac649dbcf055e604acb2a4ffa513 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no Maintainer: Marqitos -->
<reference xml:id="class.sqlite3stmt" 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>La clase <classname>SQLite3Stmt</classname></title>
Expand All @@ -10,10 +10,14 @@
<!-- {{{ SQLite3Stmt intro -->
<section xml:id="sqlite3stmt.intro">
&reftitle.intro;
<para>
La clase que representa los comandos preparados
para una base de datos SQLite3.
</para>
<simpara>
La clase que gestiona los comandos preparados para la extensión SQLite 3.
Las instancias se obtienen mediante
<methodname>SQLite3::prepare</methodname>. La llamada a
<methodname>SQLite3Stmt::execute</methodname> ejecuta la consulta y
devuelve un <classname>SQLite3Result</classname> para los conjuntos de
resultados.
</simpara>
</section>
<!-- }}} -->

Expand All @@ -26,18 +30,81 @@
<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:fallback/>
</xi:include>
<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'])">
<xi:fallback/>
</xi:include>
<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'])"/>
</classsynopsis>
<!-- }}} -->

</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>
El comando funciona en modo comando preparado normal (sin
<literal>EXPLAIN</literal>).
Disponible a partir de PHP 8.5.0, cuando se compila con 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>
El comando funciona como si estuviera precedido por
<literal>EXPLAIN</literal>, y devuelve la información sobre los opcodes
de la máquina virtual.
Disponible a partir de PHP 8.5.0, cuando se compila con 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>
El comando funciona como si estuviera precedido por
<literal>EXPLAIN QUERY PLAN</literal>, y devuelve la información de alto
nivel sobre el plan de consulta.
Disponible a partir de PHP 8.5.0, cuando se compila con libsqlite &gt;= 3.43.0.
</simpara>
</listitem>
</varlistentry>

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

</partintro>

&reference.sqlite3.entities.sqlite3stmt;
Expand Down
Loading