From c9d6837a339886845bf3ab0f31f47e26523feb43 Mon Sep 17 00:00:00 2001 From: AllenJB Date: Sun, 12 Oct 2025 15:28:25 +0100 Subject: [PATCH 1/3] litespeed SAPI functions documentation --- appendices/extensions.xml | 2 + reference/apache/book.xml | 4 +- .../functions/apache-request-headers.xml | 2 +- .../functions/apache-response-headers.xml | 2 +- reference/litespeed/book.xml | 42 ++++++++++++++ .../functions/litespeed-finish-request.xml | 55 +++++++++++++++++++ .../functions/litespeed-request-headers.xml | 39 +++++++++++++ .../functions/litespeed-response-headers.xml | 39 +++++++++++++ reference/litespeed/reference.xml | 30 ++++++++++ reference/litespeed/setup.xml | 39 +++++++++++++ reference/litespeed/versions.xml | 32 +++++++++++ 11 files changed, 283 insertions(+), 3 deletions(-) create mode 100644 reference/litespeed/book.xml create mode 100644 reference/litespeed/functions/litespeed-finish-request.xml create mode 100644 reference/litespeed/functions/litespeed-request-headers.xml create mode 100644 reference/litespeed/functions/litespeed-response-headers.xml create mode 100644 reference/litespeed/reference.xml create mode 100644 reference/litespeed/setup.xml create mode 100644 reference/litespeed/versions.xml diff --git a/appendices/extensions.xml b/appendices/extensions.xml index 3434c95e8c14..bd843a6753e5 100644 --- a/appendices/extensions.xml +++ b/appendices/extensions.xml @@ -70,6 +70,7 @@ + @@ -251,6 +252,7 @@ + diff --git a/reference/apache/book.xml b/reference/apache/book.xml index dcb90319e47e..21bb4cb45c9f 100644 --- a/reference/apache/book.xml +++ b/reference/apache/book.xml @@ -9,7 +9,9 @@ &reftitle.intro; - These functions are only available when running PHP as an Apache module. + 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. diff --git a/reference/apache/functions/apache-request-headers.xml b/reference/apache/functions/apache-request-headers.xml index 7e4a91ed6ee4..91263f681053 100644 --- a/reference/apache/functions/apache-request-headers.xml +++ b/reference/apache/functions/apache-request-headers.xml @@ -15,7 +15,7 @@ Fetches all HTTP request headers from the current request. Works in the - Apache, FastCGI, CLI, and FPM webservers. + Apache, Litespeed, FastCGI, CLI, and FPM webservers. diff --git a/reference/apache/functions/apache-response-headers.xml b/reference/apache/functions/apache-response-headers.xml index 574c52622e42..b1132ed86024 100644 --- a/reference/apache/functions/apache-response-headers.xml +++ b/reference/apache/functions/apache-response-headers.xml @@ -15,7 +15,7 @@ Fetch all HTTP response headers. Works in the - Apache, FastCGI, CLI, and FPM webservers. + Apache, Litespeed, FastCGI, CLI, and FPM webservers. diff --git a/reference/litespeed/book.xml b/reference/litespeed/book.xml new file mode 100644 index 000000000000..6661aa41d9ed --- /dev/null +++ b/reference/litespeed/book.xml @@ -0,0 +1,42 @@ + + + + + + Litespeed + + + &reftitle.intro; + + An optimized Server API for running PHP with the Litespeed web server. + + + This SAPI is bundled with PHP. + + + + &reference.litespeed.setup; + &reference.litespeed.reference; + + + + diff --git a/reference/litespeed/functions/litespeed-finish-request.xml b/reference/litespeed/functions/litespeed-finish-request.xml new file mode 100644 index 000000000000..acce01f3e91a --- /dev/null +++ b/reference/litespeed/functions/litespeed-finish-request.xml @@ -0,0 +1,55 @@ + + + + + + litespeed_finish_request + Flushes all response data to the client + + + + &reftitle.description; + + boollitespeed_finish_request + + + + 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. + + + + + &reftitle.parameters; + &no.function.parameters; + + + + &reftitle.returnvalues; + + &return.success; + + + + + 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 @@ + + + + + litespeed_request_headers + &Alias; + apache_request_headers + + + + + &reftitle.description; + + &info.function.alias; + apache_request_headers. + + + + + 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 @@ + + + + + litespeed_response_headers + &Alias; + apache_response_headers + + + + + &reftitle.description; + + &info.function.alias; + apache_response_headers. + + + + + diff --git a/reference/litespeed/reference.xml b/reference/litespeed/reference.xml new file mode 100644 index 000000000000..e9e380235513 --- /dev/null +++ b/reference/litespeed/reference.xml @@ -0,0 +1,30 @@ + + + + + Litespeed &Functions; + + &reference.litespeed.entities.functions; + + + + diff --git a/reference/litespeed/setup.xml b/reference/litespeed/setup.xml new file mode 100644 index 000000000000..94bb6e3553a4 --- /dev/null +++ b/reference/litespeed/setup.xml @@ -0,0 +1,39 @@ + + + + + &reftitle.setup; + + +
+ &reftitle.install; + + For PHP installation on Litespeed see the installation chapter. + +
+ + +
+ + + diff --git a/reference/litespeed/versions.xml b/reference/litespeed/versions.xml new file mode 100644 index 000000000000..ac0d46f3720c --- /dev/null +++ b/reference/litespeed/versions.xml @@ -0,0 +1,32 @@ + + + + + + + + + + + From 86f1be90daca729e706f88430de29b1b2b57818b Mon Sep 17 00:00:00 2001 From: AllenJB Date: Mon, 13 Oct 2025 09:04:54 +0100 Subject: [PATCH 2/3] Fix whitespace --- reference/litespeed/setup.xml | 1 - 1 file changed, 1 deletion(-) diff --git a/reference/litespeed/setup.xml b/reference/litespeed/setup.xml index 94bb6e3553a4..eef41ecea42f 100644 --- a/reference/litespeed/setup.xml +++ b/reference/litespeed/setup.xml @@ -36,4 +36,3 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> - From fac04082ca4964b5f171634990167d7399b557ef Mon Sep 17 00:00:00 2001 From: AllenJB Date: Mon, 13 Oct 2025 10:39:59 +0100 Subject: [PATCH 3/3] litespeed SAPI: Change setup page to link directly to litespeed specific install page --- reference/litespeed/setup.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/reference/litespeed/setup.xml b/reference/litespeed/setup.xml index eef41ecea42f..d7725107d5f2 100644 --- a/reference/litespeed/setup.xml +++ b/reference/litespeed/setup.xml @@ -9,7 +9,7 @@ &reftitle.install; For PHP installation on Litespeed see the installation chapter. + linkend="install.unix.litespeed">installation chapter.