Document Litespeed SAPI functions

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>
@@ -251,6 +252,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>

reference/apache/book.xml

@@ -9,7 +9,9 @@
  <preface xml:id="intro.apache">
   &reftitle.intro;
   <para>
-   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.
   </para>
  </preface>
  <!-- }}} -->

reference/apache/functions/apache-request-headers.xml

@@ -15,7 +15,7 @@
   </methodsynopsis>
   <para>
    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.
   </para>
  </refsect1>
 

reference/apache/functions/apache-response-headers.xml

@@ -15,7 +15,7 @@
   </methodsynopsis>
   <para>
    Fetch all HTTP response headers.  Works in the
-   Apache, FastCGI, CLI, and FPM webservers.
+   Apache, Litespeed, FastCGI, CLI, and FPM webservers.
   </para>
  </refsect1>
 

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">
+ <?phpdoc extension-membership="bundled" ?>
+ <title>Litespeed</title>
+
+ <preface xml:id="intro.litespeed">
+  &reftitle.intro;
+  <para>
+   An optimized Server API for running PHP with the Litespeed web server.
+  </para>
+  <para>
+   This SAPI is bundled with PHP.
+  </para>
+ </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
+ -->

reference/litespeed/functions/litespeed-finish-request.xml

@@ -0,0 +1,55 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!-- $Revision$ -->
+
+<refentry xml:id="function.litespeed-finish-request" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
+ <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>
+  <para>
+   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.
+  </para>
+ </refsect1>
+
+ <refsect1 role="parameters">
+  &reftitle.parameters;
+  &no.function.parameters;
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   &return.success;
+  </para>
+ </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
+ -->

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
+ -->

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
+ -->

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
+ -->

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;
+  <para>
+   For PHP installation on Litespeed see the <link
+   linkend="install.unix.litespeed">installation chapter</link>.
+  </para>
+ </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
+ -->

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 5 &gt;= 5.3.0, PHP 7, 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
+ -->