Skip to content

[Sync-En] readline: Document functions unavailable where feature is not supported (#4923) #1222

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

Merged
julionc merged 1 commit into from
Sep 2, 2026
Merged

[Sync-En] readline: Document functions unavailable where feature is not supported (#4923) #1222

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
10 changes: 9 additions & 1 deletion language-snippets.ent
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: 1ab1069cdd60b4ec4c18c0832924e20109159902 Maintainer: argosback Status: ready -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: argosback Status: ready -->

<!ENTITY installation.enabled.disable 'Esta extensión está activada por defecto. Puede ser desactivada utilizando la opción de configuración: '>

Expand Down Expand Up @@ -4593,6 +4593,14 @@ xmlns="http://docbook.org/ns/docbook"><simpara>Esta función ha sido
</informaltable>
'>

<!-- readline -->
<!ENTITY readline.system-callback-support '
<simpara xmlns="http://docbook.org/ns/docbook">
Esta función solo está disponible si la biblioteca readline con la que se compiló
PHP la admite. No está disponible en Windows.
</simpara>
'>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
Expand Down
7 changes: 4 additions & 3 deletions reference/readline/book.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<book xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="book.readline">
<?phpdoc extension-membership="bundledexternal" ?>
<title>GNU Readline</title>
Expand All @@ -19,7 +18,9 @@
<link linkend="features.commandline">línea de comandos</link>.
</simpara>
<simpara>
A partir de PHP 7.1.0 esta extensión es soportada en Windows. </simpara>
A partir de PHP 7.1.0 esta extensión es soportada en Windows, donde está compilada
contra libedit. No todas las funciones están presentes en esa compilación; véase
<link linkend="readline.requirements">los requisitos</link>.</simpara>
<caution>
<simpara>
¡La extensión readline no es thread-safe! Por consiguiente, el uso de esta
Expand Down
4 changes: 2 additions & 2 deletions reference/readline/functions/readline-callback-handler-install.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: be246a268d0d5ab0b215c429cb031e70c98327ef Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-handler-install">
<refnamediv>
<refname>readline_callback_handler_install</refname>
Expand All @@ -28,6 +27,7 @@
la interconexión IO / entrada de usuario, a diferencia de
<function>readline</function>.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
4 changes: 2 additions & 2 deletions reference/readline/functions/readline-callback-handler-remove.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-handler-remove">
<refnamediv>
<refname>readline_callback_handler_remove</refname>
Expand All @@ -18,6 +17,7 @@
Elimina un manejador de devolución de llamada instalado previamente y restaura
los parámetros del terminal.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
4 changes: 2 additions & 2 deletions reference/readline/functions/readline-callback-read-char.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-callback-read-char">
<refnamediv>
<refname>readline_callback_read_char</refname>
Expand All @@ -19,6 +18,7 @@
función informa a la interfaz de devolución de llamada readline instalada mediante
<function>readline_callback_handler_install</function> de que una línea está lista para ser ingresada.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand Down
8 changes: 6 additions & 2 deletions reference/readline/functions/readline-list-history.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: no Maintainer: Marqitos -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-list-history">
<refnamediv>
<refname>readline_list_history</refname>
Expand All @@ -17,6 +16,11 @@
<simpara>
Lista el historial.
</simpara>
<simpara>
Esta función solo está disponible si la biblioteca readline con la que se compiló
PHP proporciona listado de historial. Esto siempre es el caso con GNU Readline
y en Windows.
</simpara>
</refsect1>

<refsect1 role="parameters">
Expand Down
16 changes: 7 additions & 9 deletions reference/readline/functions/readline-on-new-line.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-on-new-line">
<refnamediv>
<refname>readline_on_new_line</refname>
Expand All @@ -17,6 +16,7 @@
<simpara>
Indica a readline que el cursor ha pasado a una nueva línea.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand All @@ -31,13 +31,11 @@
</simpara>
</refsect1>

<refsect1 role="notes">
&reftitle.notes;
<note>
<simpara>
Esta función solo está disponible si es soportada por la biblioteca readline subyacente. No es soportada en Windows.
</simpara>
</note>
<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>readline_callback_handler_install</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Expand Down
11 changes: 9 additions & 2 deletions reference/readline/functions/readline-redisplay.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<refentry xmlns="http://docbook.org/ns/docbook" xml:id="function.readline-redisplay">
<refnamediv>
<refname>readline_redisplay</refname>
Expand All @@ -17,6 +16,7 @@
<simpara>
Solicita a readline que vuelva a mostrar la información.
</simpara>
&readline.system-callback-support;
</refsect1>

<refsect1 role="parameters">
Expand All @@ -30,6 +30,13 @@
&return.void;
</simpara>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><function>readline_callback_handler_install</function></member>
</simplelist>
</refsect1>
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
Expand Down
17 changes: 15 additions & 2 deletions reference/readline/setup.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision$ -->
<!-- EN-Revision: 53208f9bd0a035a4e1409ba700106540474c9ef1 Maintainer: PhilDaiguille Status: ready -->
<!-- Reviewed: yes -->
<!-- EN-Revision: 8648d1cda141537b5dbd403a0bf0e6eb8c086e9d Maintainer: PhilDaiguille Status: ready -->
<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xml:id="readline.setup">
&reftitle.setup;

Expand All @@ -20,6 +19,20 @@
y disponible para descarga en
<link xlink:href="&url.libedit;">&url.libedit;</link>.
</simpara>
<simpara>
Ambas bibliotecas no ofrecen las mismas funcionalidades, por lo que algunas funciones
están ausentes en ciertas compilaciones. Las funciones que gestionan la interfaz de
devolución de llamada,
<function>readline_callback_handler_install</function>,
<function>readline_callback_handler_remove</function>,
<function>readline_callback_read_char</function>,
<function>readline_redisplay</function> y
<function>readline_on_new_line</function>, solo están presentes cuando la biblioteca
subyacente las proporciona, y están ausentes en Windows. Llamar a una función ausente
lanza una <exceptionname>Error</exceptionname>.
<function>function_exists</function> permite comprobar si una función dada está disponible,
y la constante <constant>READLINE_LIB</constant> indica qué biblioteca se está utilizando.
</simpara>
</section>
<!-- }}} -->

Expand Down