[DOC-CVS] [doc-en] master: Saai: Document Litespeed SAPI functions (#4922)

Author: AllenJB (AllenJB)
Committer: GitHub (web-flow)
Pusher: jordikroon
Date: 2026-05-20T19:22:15+02:00

Commit: https://github.com/php/doc-en/commit/8a0888aeb20d187289664eb1116fa30228837478
Raw diff: https://github.com/php/doc-en/commit/8a0888aeb20d187289664eb1116fa30228837478.diff

Saai: Document Litespeed SAPI functions (#4922)

* litespeed SAPI functions documentation

Co-authored-by: Jordi Kroon <[email protected]>

Changed paths:
  A  reference/litespeed/book.xml
  A  reference/litespeed/functions/litespeed-finish-request.xml
  A  reference/litespeed/functions/litespeed-request-headers.xml
  A  reference/litespeed/functions/litespeed-response-headers.xml
  A  reference/litespeed/reference.xml
  A  reference/litespeed/setup.xml
  A  reference/litespeed/versions.xml
  M  appendices/extensions.xml
  M  appendices/migration74/other-changes.xml
  M  reference/apache/book.xml
  M  reference/apache/functions/apache-request-headers.xml
  M  reference/apache/functions/apache-response-headers.xml


Diff:

diff --git a/appendices/extensions.xml b/appendices/extensions.xml
index 28202c591c88..47bd5c6a1a76 100644
--- a/appendices/extensions.xml
+++ b/appendices/extensions.xml
@@ -70,6 +70,7 @@
    <listitem><simpara><xref linkend="book.json"/></simpara></listitem>
    <listitem><simpara><xref linkend="book.ldap"/></simpara></listitem>
    <listitem><simpara><xref linkend="book.libxml"/></simpara></listitem>
+   <listitem><simpara><xref linkend="book.litespeed"/></simpara></listitem>
    <listitem><simpara><xref linkend="book.lua"/></simpara></listitem>
    <listitem><simpara><xref linkend="book.luasandbox"/></simpara></listitem>
    <listitem><simpara><xref linkend="book.lzf"/></simpara></listitem>
@@ -253,6 +254,7 @@
     <listitem><para><xref linkend="book.iconv"/></para></listitem>
     <listitem><para><xref linkend="book.image"/></para></listitem>
     <listitem><para><xref linkend="book.intl"/></para></listitem>
+    <listitem><para><xref linkend="book.litespeed"/></para></listitem>
     <listitem><para><xref linkend="book.mbstring"/></para></listitem>
     <listitem><para><xref linkend="book.mhash"/></para></listitem>
     <listitem><para><xref linkend="book.pcntl"/></para></listitem>
diff --git a/appendices/migration74/other-changes.xml b/appendices/migration74/other-changes.xml
index 884d4d2e4698..15e72436c577 100644
--- a/appendices/migration74/other-changes.xml
+++ b/appendices/migration74/other-changes.xml
@@ -201,7 +201,7 @@
    </listitem>
 
    <listitem>
-    <simpara>Litespeed:</simpara>
+    <simpara>LiteSpeed:</simpara>
     <itemizedlist>
      <listitem>
       <simpara>
diff --git a/reference/apache/book.xml b/reference/apache/book.xml
index dcb90319e47e..d4cfae6819d9 100644
--- a/reference/apache/book.xml
+++ b/reference/apache/book.xml
@@ -8,9 +8,11 @@
  <!-- {{{ preface -->
  <preface xml:id="intro.apache">
   &reftitle.intro;
-  <para>
-   These functions are only available when running PHP as an Apache module.
-  </para>
+  <simpara>
+   These functions are available when running PHP as an Apache module. Some
+   functions may be available when running under other web server APIs. Check
+   individual function documentation for details.
+  </simpara>
  </preface>
  <!-- }}} -->
 
diff --git a/reference/apache/functions/apache-request-headers.xml b/reference/apache/functions/apache-request-headers.xml
index 7e4a91ed6ee4..e4e8f0cc7660 100644
--- a/reference/apache/functions/apache-request-headers.xml
+++ b/reference/apache/functions/apache-request-headers.xml
@@ -13,22 +13,22 @@
    <type>array</type><methodname>apache_request_headers</methodname>
    <void/>
   </methodsynopsis>
-  <para>
+  <simpara>
    Fetches all HTTP request headers from the current request. Works in the
-   Apache, FastCGI, CLI, and FPM webservers.
-  </para>
+   Apache, LiteSpeed, FastCGI, CLI, and FPM webservers.
+  </simpara>
  </refsect1>
 
  <refsect1 role="parameters">
   &reftitle.parameters;
   &no.function.parameters;
  </refsect1>
- 
+
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
-  <para>
+  <simpara>
    An associative array of all the HTTP headers in the current request.
-  </para>
+  </simpara>
  </refsect1>
 
  <refsect1 role="changelog">
@@ -54,7 +54,7 @@
    </informaltable>
   </para>
  </refsect1>
- 
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
@@ -89,13 +89,13 @@ Connection: Keep-Alive
  <refsect1 role="notes">
   &reftitle.notes;
   <note>
-   <para>
+   <simpara>
     You can also get at the value of the common <acronym>CGI</acronym> variables by
     reading them from the environment, which works whether or not
     you are using PHP as an <productname>Apache</productname> module. Use
     <function>phpinfo</function> to see a list of all of the available
     <link linkend="language.variables.predefined">environment variables</link>.
-   </para>
+   </simpara>
   </note>
  </refsect1>
 
diff --git a/reference/apache/functions/apache-response-headers.xml b/reference/apache/functions/apache-response-headers.xml
index 574c52622e42..8589f99d3dcd 100644
--- a/reference/apache/functions/apache-response-headers.xml
+++ b/reference/apache/functions/apache-response-headers.xml
@@ -13,10 +13,10 @@
    <type>array</type><methodname>apache_response_headers</methodname>
    <void/>
   </methodsynopsis>
-  <para>
+  <simpara>
    Fetch all HTTP response headers.  Works in the
-   Apache, FastCGI, CLI, and FPM webservers.
-  </para>
+   Apache, LiteSpeed, FastCGI, CLI, and FPM webservers.
+  </simpara>
  </refsect1>
 
  <refsect1 role="parameters">
@@ -26,11 +26,11 @@
 
  <refsect1 role="returnvalues">
   &reftitle.returnvalues;
-  <para>
+  <simpara>
    An array of all Apache response headers on success.
-  </para>
+  </simpara>
  </refsect1>
- 
+
  <refsect1 role="examples">
   &reftitle.examples;
   <para>
diff --git a/reference/litespeed/book.xml b/reference/litespeed/book.xml
new file mode 100644
index 000000000000..e4e7b3e891b6
--- /dev/null
+++ b/reference/litespeed/book.xml
@@ -0,0 +1,42 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<book xml:id="book.litespeed" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <?phpdoc extension-membership="bundled" ?>
+ <title>LiteSpeed</title>
+
+ <preface xml:id="intro.litespeed">
+  &reftitle.intro;
+  <simpara>
+   An optimized Server API for running PHP with the LiteSpeed web server.
+  </simpara>
+  <simpara>
+   This SAPI is bundled with PHP.
+  </simpara>
+ </preface>
+
+ &reference.litespeed.setup;
+ &reference.litespeed.reference;
+
+</book>
+
+ <!-- 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
+ -->
diff --git a/reference/litespeed/functions/litespeed-finish-request.xml b/reference/litespeed/functions/litespeed-finish-request.xml
new file mode 100644
index 000000000000..aba2ca828f4c
--- /dev/null
+++ b/reference/litespeed/functions/litespeed-finish-request.xml
@@ -0,0 +1,83 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.litespeed-finish-request" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>litespeed_finish_request</refname>
+  <refpurpose>Flushes all response data to the client</refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>bool</type><methodname>litespeed_finish_request</methodname>
+   <void />
+  </methodsynopsis>
+  <simpara>
+   This function flushes all response data to the client and finishes the
+   request. This allows for time consuming tasks to be performed without
+   leaving the connection to the client open.
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <simpara>
+   &return.success;
+  </simpara>
+ </refsect1>
+
+ <refsect1 role="changelog">
+  &reftitle.changelog;
+  <informaltable>
+   <tgroup cols="2">
+    <thead>
+     <row>
+      <entry>&Version;</entry>
+      <entry>&Description;</entry>
+     </row>
+    </thead>
+    <tbody>
+     <row>
+      <entry>7.2.18</entry>
+      <entry>
+       This function became available.
+      </entry>
+     </row>
+    </tbody>
+   </tgroup>
+  </informaltable>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <simplelist>
+   <member><function>fastcgi_finish_request</function></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
+ -->
diff --git a/reference/litespeed/functions/litespeed-request-headers.xml b/reference/litespeed/functions/litespeed-request-headers.xml
new file mode 100644
index 000000000000..6cd37e622957
--- /dev/null
+++ b/reference/litespeed/functions/litespeed-request-headers.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.litespeed-request-headers" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>litespeed_request_headers</refname>
+  <refpurpose>&Alias;
+   <function>apache_request_headers</function>
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <simpara>
+   &info.function.alias;
+   <function>apache_request_headers</function>.
+  </simpara>
+ </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
+ -->
diff --git a/reference/litespeed/functions/litespeed-response-headers.xml b/reference/litespeed/functions/litespeed-response-headers.xml
new file mode 100644
index 000000000000..92c0c5c8f4c4
--- /dev/null
+++ b/reference/litespeed/functions/litespeed-response-headers.xml
@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<refentry xml:id="function.litespeed-response-headers" xmlns="http://docbook.org/ns/docbook">
+ <refnamediv>
+  <refname>litespeed_response_headers</refname>
+  <refpurpose>&Alias;
+   <function>apache_response_headers</function>
+  </refpurpose>
+ </refnamediv>
+
+ <refsect1 role="description">
+  &reftitle.description;
+  <simpara>
+   &info.function.alias;
+   <function>apache_response_headers</function>.
+  </simpara>
+ </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
+ -->
diff --git a/reference/litespeed/reference.xml b/reference/litespeed/reference.xml
new file mode 100644
index 000000000000..cfa3b8f58ecb
--- /dev/null
+++ b/reference/litespeed/reference.xml
@@ -0,0 +1,30 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<reference xml:id="ref.litespeed" xmlns="http://docbook.org/ns/docbook">
+ <title>LiteSpeed &Functions;</title>
+
+ &reference.litespeed.entities.functions;
+
+</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
+ -->
diff --git a/reference/litespeed/setup.xml b/reference/litespeed/setup.xml
new file mode 100644
index 000000000000..e92f40fe4111
--- /dev/null
+++ b/reference/litespeed/setup.xml
@@ -0,0 +1,38 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<chapter xml:id="litespeed.setup" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ &reftitle.setup;
+
+ <!-- {{{ Installation -->
+ <section xml:id="litespeed.installation">
+  &reftitle.install;
+  <simpara>
+   For PHP installation on LiteSpeed see the <link
+   linkend="install.unix.litespeed">installation chapter</link>.
+  </simpara>
+ </section>
+ <!-- }}} -->
+
+</chapter>
+
+ <!-- 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
+ -->
diff --git a/reference/litespeed/versions.xml b/reference/litespeed/versions.xml
new file mode 100644
index 000000000000..60fde039344c
--- /dev/null
+++ b/reference/litespeed/versions.xml
@@ -0,0 +1,32 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+<!--
+  Do NOT translate this file
+-->
+
+<versions>
+ <function name="litespeed_request_headers" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
+ <function name="litespeed_response_headers" from="PHP 5 &gt;= 5.3.0, PHP 7, PHP 8"/>
+ <function name="litespeed_finish_request" from="PHP 7 &gt;= 7.2.18, PHP 8"/>
+</versions>
+
+ <!-- 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
+ -->