mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 00:48:54 +00:00
added skeletons for yet undocumented extensions
git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@65178 c90b9560-bf6c-de11-be94-00142212c4b1
This commit is contained in:
Hartmut Holzgraefe
parent
ba8b96491f
commit
82815f96a3
10 changed files with 1951 additions and 0 deletions
120
functions/crack.xml
Normal file
120
functions/crack.xml
Normal file
|
|
@ -0,0 +1,120 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.crack">
|
||||
<title>Crack functions</title>
|
||||
<titleabbrev>Crack functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.crack-opendict">
|
||||
<refnamediv>
|
||||
<refname>crack_opendict</refname>
|
||||
<refpurpose>Opens a new cracklib dictionary</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>crack_opendict</function></funcdef>
|
||||
<paramdef>string <parameter>dictionary</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.crack-closedict">
|
||||
<refnamediv>
|
||||
<refname>crack_closedict</refname>
|
||||
<refpurpose>Closes an open cracklib dictionary </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>crack_closedict</function></funcdef>
|
||||
<paramdef>int
|
||||
<parameter><optional>link_identifier</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.crack-check">
|
||||
<refnamediv>
|
||||
<refname>crack_check</refname>
|
||||
<refpurpose>] string password) Performs an obscure check with the given password </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>crack_check</function></funcdef>
|
||||
<paramdef>int
|
||||
<parameter><optional>dictionary</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>string <parameter>password</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.crack-getlastmessage">
|
||||
<refnamediv>
|
||||
<refname>crack_getlastmessage</refname>
|
||||
<refpurpose>Returns the message from the last obscure check</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>crack_getlastmessage</function></funcdef>
|
||||
<void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
61
functions/dotnet.xml
Normal file
61
functions/dotnet.xml
Normal file
|
|
@ -0,0 +1,61 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.dotnet">
|
||||
<title>.NET functions</title>
|
||||
<titleabbrev>.NET functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.dotnet-load">
|
||||
<refnamediv>
|
||||
<refname>dotnet_load</refname>
|
||||
<refpurpose>Loads a DOTNET module</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>dotnet_load</function></funcdef>
|
||||
<paramdef>string <parameter>assembly_name</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>datatype_name</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>int
|
||||
<parameter><optional>codepage</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
57
functions/fribidi.xml
Normal file
57
functions/fribidi.xml
Normal file
|
|
@ -0,0 +1,57 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.fribidi">
|
||||
<title>FriBiDi functions</title>
|
||||
<titleabbrev>FriBiDi functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.fribidi-log2vis">
|
||||
<refnamediv>
|
||||
<refname>fribidi_log2vis</refname>
|
||||
<refpurpose>Convert a logical string to a visual one </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>fribidi_log2vis</function></funcdef>
|
||||
<paramdef>string <parameter>str</parameter></paramdef>
|
||||
<paramdef>string <parameter>direction</parameter></paramdef>
|
||||
<paramdef>int <parameter>charset</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
305
functions/mailparse.xml
Normal file
305
functions/mailparse.xml
Normal file
|
|
@ -0,0 +1,305 @@
|
|||
<reference id="ref.mailparse">
|
||||
<title>mailparse functions</title>
|
||||
<titleabbrev>mailparse functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.mailparse-uudecode-all">
|
||||
<refnamediv>
|
||||
<refname>mailparse_uudecode_all</refname>
|
||||
<refpurpose>Scans the data from fp and extract each embedded uuencoded file. Returns an array listing filename information </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>mailparse_uudecode_all</function></funcdef>
|
||||
<paramdef>resource <parameter>fp</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-rfc822-parse-addresses">
|
||||
<refnamediv>
|
||||
<refname>mailparse_rfc822_parse_addresses</refname>
|
||||
<refpurpose>Parse addresses and returns a hash containing that data </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>mailparse_rfc822_parse_addresses</function></funcdef>
|
||||
<paramdef>string <parameter>addresses</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-determine-best-xfer-encoding">
|
||||
<refnamediv>
|
||||
<refname>mailparse_determine_best_xfer_encoding</refname>
|
||||
<refpurpose>Figures out the best way of encoding the content read from the file pointer fp, which must be seek-able </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>mailparse_determine_best_xfer_encoding</function></funcdef>
|
||||
<paramdef>resource <parameter>fp</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-stream-encode">
|
||||
<refnamediv>
|
||||
<refname>mailparse_stream_encode</refname>
|
||||
<refpurpose>Streams data from source file pointer, apply encoding and write to destfp </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>mailparse_stream_encode</function></funcdef>
|
||||
<paramdef>resource <parameter>sourcefp</parameter></paramdef>
|
||||
<paramdef>resource <parameter>destfp</parameter></paramdef>
|
||||
<paramdef>string <parameter>encoding</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-parse">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_parse</refname>
|
||||
<refpurpose>Incrementally parse data into buffer </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>void <function>mailparse_msg_parse</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045buf</parameter></paramdef>
|
||||
<paramdef>string <parameter>data</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-parse-file">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_parse_file</refname>
|
||||
<refpurpose>Parse file and return a resource representing the structure </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>resource <function>mailparse_msg_parse_file</function></funcdef>
|
||||
<paramdef>string <parameter>filename</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-free">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_free</refname>
|
||||
<refpurpose>Frees a handle allocated by mailparse_msg_crea</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>void <function>mailparse_msg_free</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045buf</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-create">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_create</refname>
|
||||
<refpurpose>Returns a handle that can be used to parse a message </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>mailparse_msg_create</function></funcdef>
|
||||
<void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-get-structure">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_get_structure</refname>
|
||||
<refpurpose>Returns an array of mime section names in the supplied message </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>mailparse_msg_get_structure</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-extract-part">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_extract_part</refname>
|
||||
<refpurpose>Extracts/decodes a message section. If callbackfunc is not specified, the contents will be sent to "stdout" </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>void <function>mailparse_msg_extract_part</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045</parameter></paramdef>
|
||||
<paramdef>string <parameter>msgbody</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>callbackfunc</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-extract-part-file">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_extract_part_file</refname>
|
||||
<refpurpose>Extracts/decodes a message section, decoding the transfer encoding </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>mailparse_msg_extract_part_file</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045</parameter></paramdef>
|
||||
<paramdef>string <parameter>filename</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>callbackfunc</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-get-part-data">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_get_part_data</refname>
|
||||
<refpurpose>Returns an associative array of info about the message </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>mailparse_msg_get_part_data</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.mailparse-msg-get-part">
|
||||
<refnamediv>
|
||||
<refname>mailparse_msg_get_part</refname>
|
||||
<refpurpose>Returns a handle on a given section in a mimemessage </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>mailparse_msg_get_part</function></funcdef>
|
||||
<paramdef>resource <parameter>rfc2045</parameter></paramdef>
|
||||
<paramdef>string <parameter>mimesection</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
140
functions/muscat.xml
Normal file
140
functions/muscat.xml
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.muscat">
|
||||
<title>muscat functions</title>
|
||||
<titleabbrev>muscat functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.muscat-setup">
|
||||
<refnamediv>
|
||||
<refname>muscat_setup</refname>
|
||||
<refpurpose>Creates a new muscat session and returns the handle. Size is the ammount of memory in bytes to allocate for muscat muscat_dir is the muscat installation dir e.g. "/usr/local/empower", it defaults to the compile time muscat directory </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>resource <function>muscat_setup</function></funcdef>
|
||||
<paramdef>int <parameter>size</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>muscat_dir</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.muscat-setup-net">
|
||||
<refnamediv>
|
||||
<refname>muscat_setup_net</refname>
|
||||
<refpurpose>Creates a new muscat session and returns the handle. muscat_host is the hostname to connect to port is the port number to connect to - actually takes exactly the same args as fsockopen </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>resource <function>muscat_setup_net</function></funcdef>
|
||||
<paramdef>string <parameter>muscat_host</parameter></paramdef>
|
||||
<paramdef>int <parameter>port</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.muscat-give">
|
||||
<refnamediv>
|
||||
<refname>muscat_give</refname>
|
||||
<refpurpose>Sends string to the core muscat api </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>muscat_give</function></funcdef>
|
||||
<paramdef>resource <parameter>muscat_handle</parameter></paramdef>
|
||||
<paramdef>string <parameter>string</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.muscat-get">
|
||||
<refnamediv>
|
||||
<refname>muscat_get</refname>
|
||||
<refpurpose>Gets a line back from the core muscat api. Returns a literal FALSE when there is no more to get (as opposed to ""). Use === FALSE or !== FALSE to check for this </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>muscat_get</function></funcdef>
|
||||
<paramdef>resource <parameter>muscat_handle</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.muscat-close">
|
||||
<refnamediv>
|
||||
<refname>muscat_close</refname>
|
||||
<refpurpose>Shuts down the muscat session and releases any memory back to php. [Not back to the system, note!] </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>muscat_close</function></funcdef>
|
||||
<paramdef>resource <parameter>muscat_handle</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
332
functions/notes.xml
Normal file
332
functions/notes.xml
Normal file
|
|
@ -0,0 +1,332 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.notes">
|
||||
<title>notes functions</title>
|
||||
<titleabbrev>notes functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.notes-create-db">
|
||||
<refnamediv>
|
||||
<refname>notes_create_db</refname>
|
||||
<refpurpose>Create a Lotus Notes database </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>notes_create_db</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-drop-db">
|
||||
<refnamediv>
|
||||
<refname>notes_drop_db</refname>
|
||||
<refpurpose>Drop a Lotus Notes database </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>notes_drop_db</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-version">
|
||||
<refnamediv>
|
||||
<refname>notes_version</refname>
|
||||
<refpurpose>Get the version Lotus Notes </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_version</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-create-note">
|
||||
<refnamediv>
|
||||
<refname>notes_create_note</refname>
|
||||
<refpurpose>Create a note using form form_name </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_create_note</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>form_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-mark-read">
|
||||
<refnamediv>
|
||||
<refname>notes_mark_read</refname>
|
||||
<refpurpose>Mark a note_id as read for the User user_nam</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_mark_read</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>user_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>note_id</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-mark-unread">
|
||||
<refnamediv>
|
||||
<refname>notes_mark_unread</refname>
|
||||
<refpurpose>Mark a note_id as unread for the User user_na</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_mark_unread</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>user_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>note_id</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-unread">
|
||||
<refnamediv>
|
||||
<refname>notes_unread</refname>
|
||||
<refpurpose>Returns the unread note id's for the current User user_nam</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_unread</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>user_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-header-info">
|
||||
<refnamediv>
|
||||
<refname>notes_header_info</refname>
|
||||
<refpurpose>Open the message msg_number in the specified mailbox on the specified server (leave serv</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>object <function>notes_header_info</function></funcdef>
|
||||
<paramdef>string <parameter>server</parameter></paramdef>
|
||||
<paramdef>string <parameter>mailbox</parameter></paramdef>
|
||||
<paramdef>int <parameter>msg_number</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-body">
|
||||
<refnamediv>
|
||||
<refname>notes_body</refname>
|
||||
<refpurpose>Open the message msg_number in the specified mailbox on the specified server (leave serv</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>notes_body</function></funcdef>
|
||||
<paramdef>string <parameter>server</parameter></paramdef>
|
||||
<paramdef>string <parameter>mailbox</parameter></paramdef>
|
||||
<paramdef>int <parameter>msg_number</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-find-note">
|
||||
<refnamediv>
|
||||
<refname>notes_find_note</refname>
|
||||
<refpurpose>Returns a note id found in database_name. Specify the name of the note. Leaving type bla</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>notes_find_note</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>name</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>type</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-nav-create">
|
||||
<refnamediv>
|
||||
<refname>notes_nav_create</refname>
|
||||
<refpurpose>Create a navigator name, in database_name </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>notes_nav_create</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-search">
|
||||
<refnamediv>
|
||||
<refname>notes_search</refname>
|
||||
<refpurpose>Find notes that match keywords in database_na</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_search</function></funcdef>
|
||||
<paramdef>string <parameter>database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>keywords</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-copy-db">
|
||||
<refnamediv>
|
||||
<refname>notes_copy_db</refname>
|
||||
<refpurpose>title]) Create a note using form form_name </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>notes_copy_db</function></funcdef>
|
||||
<paramdef>string <parameter>from_database_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>to_database_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.notes-list-msgs">
|
||||
<refnamediv>
|
||||
<refname>notes_list_msgs</refname>
|
||||
<refpurpose>Returns the notes from a selected database_nam</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>notes_list_msgs</function></funcdef>
|
||||
<paramdef>string <parameter>db</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
75
functions/qtdom.xml
Normal file
75
functions/qtdom.xml
Normal file
|
|
@ -0,0 +1,75 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.qtdom">
|
||||
<title>qtdom functions</title>
|
||||
<titleabbrev>qtdom functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.qdom-tree">
|
||||
<refnamediv>
|
||||
<refname>qdom_tree</refname>
|
||||
<refpurpose>creates a tree of an xml string </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>object <function>qdom_tree</function></funcdef>
|
||||
<paramdef>string <parameter></parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.qdom-error">
|
||||
<refnamediv>
|
||||
<refname>qdom_error</refname>
|
||||
<refpurpose>Returns the error string from the last QDOM operation or FALSE if no errors occured</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>qdom_error</function></funcdef>
|
||||
<void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
412
functions/vpopmail.xml
Normal file
412
functions/vpopmail.xml
Normal file
|
|
@ -0,0 +1,412 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.vpopmail">
|
||||
<title>vpopmail functions</title>
|
||||
<titleabbrev>vpopmail functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.vpopmail-add-domain">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_add_domain</refname>
|
||||
<refpurpose>Add a new virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_add_domain</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>dir</parameter></paramdef>
|
||||
<paramdef>int <parameter>uid</parameter></paramdef>
|
||||
<paramdef>int <parameter>gid</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-del-domain">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_del_domain</refname>
|
||||
<refpurpose>Delete a virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_del_domain</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-add-alias-domain">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_add_alias_domain</refname>
|
||||
<refpurpose>Add an alias for a virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_add_alias_domain</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>aliasdomain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-add-domain-ex">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_add_domain_ex</refname>
|
||||
<refpurpose>Add a new virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_add_domain_ex</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>passwd</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>quota</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>bounce</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>bool
|
||||
<parameter><optional>apop</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-del-domain-ex">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_del_domain_ex</refname>
|
||||
<refpurpose>Delete a virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_del_domain_ex</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-add-alias-domain-ex">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_add_alias_domain_ex</refname>
|
||||
<refpurpose>Add alias to an existing virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_add_alias_domain_ex</function></funcdef>
|
||||
<paramdef>string <parameter>olddomain</parameter></paramdef>
|
||||
<paramdef>string <parameter>newdomain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-add-user">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_add_user</refname>
|
||||
<refpurpose>Add a new user to the specified virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_add_user</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>password</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>gecos</optional></parameter>
|
||||
</paramdef>
|
||||
<paramdef>bool
|
||||
<parameter><optional>apop</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-del-user">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_del_user</refname>
|
||||
<refpurpose>Delete a user from a virtual domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_del_user</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-passwd">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_passwd</refname>
|
||||
<refpurpose>Change a virtual user's password </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_passwd</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>password</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-set-user-quota">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_set_user_quota</refname>
|
||||
<refpurpose>Sets a virtual user's quota </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_set_user_quota</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>quota</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-auth-user">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_auth_user</refname>
|
||||
<refpurpose>Attempt to validate a username/domain/password. Returns true/false </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_auth_user</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>password</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>apop</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-alias-add">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_alias_add</refname>
|
||||
<refpurpose>insert a virtual alias </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_alias_add</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
<paramdef>string <parameter>alias</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-alias-del">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_alias_del</refname>
|
||||
<refpurpose>deletes all virtual aliases of a user </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_alias_del</function></funcdef>
|
||||
<paramdef>string <parameter>user</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-alias-del-domain">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_alias_del_domain</refname>
|
||||
<refpurpose>deletes all virtual aliases of a domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>vpopmail_alias_del_domain</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-alias-get">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_alias_get</refname>
|
||||
<refpurpose>get all lines of an alias for a domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>vpopmail_alias_get</function></funcdef>
|
||||
<paramdef>string <parameter>alias</parameter></paramdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-alias-get-all">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_alias_get_all</refname>
|
||||
<refpurpose>get all lines of an alias for a domain </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>vpopmail_alias_get_all</function></funcdef>
|
||||
<paramdef>string <parameter>domain</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.vpopmail-error">
|
||||
<refnamediv>
|
||||
<refname>vpopmail_error</refname>
|
||||
<refpurpose>Get text message for last vpopmail error. Returns string </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>vpopmail_error</function></funcdef>
|
||||
<void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
140
functions/w32api.xml
Normal file
140
functions/w32api.xml
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!-- $Revision: 1.1 $ -->
|
||||
<reference id="ref.w32api">
|
||||
<title>W32api functions</title>
|
||||
<titleabbrev>W32api functions</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.w32api-set-call-method">
|
||||
<refnamediv>
|
||||
<refname>w32api_set_call_method</refname>
|
||||
<refpurpose>Sets the calling method used </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>void <function>w32api_set_call_method</function></funcdef>
|
||||
<paramdef>int <parameter>method</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.w32api-register-function">
|
||||
<refnamediv>
|
||||
<refname>w32api_register_function</refname>
|
||||
<refpurpose>Registers function function_name from library with PHP </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>w32api_register_function</function></funcdef>
|
||||
<paramdef>string <parameter>libary</parameter></paramdef>
|
||||
<paramdef>string <parameter>function_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.w32api-invoke-function">
|
||||
<refnamediv>
|
||||
<refname>w32api_invoke_function</refname>
|
||||
<refpurpose>....) Invokes function funcname with the arguments passed after the function name </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>mixed <function>w32api_invoke_function</function></funcdef>
|
||||
<paramdef>string <parameter>funcname</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.w32api-deftype">
|
||||
<refnamediv>
|
||||
<refname>w32api_deftype</refname>
|
||||
<refpurpose>...) Defines a type for use with other w32api_functions. </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>w32api_deftype</function></funcdef>
|
||||
<paramdef>string <parameter>typename</parameter></paramdef>
|
||||
<paramdef>string <parameter>member1_type</parameter></paramdef>
|
||||
<paramdef>string <parameter>member1_name</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.w32api-init-dtype">
|
||||
<refnamediv>
|
||||
<refname>w32api_init_dtype</refname>
|
||||
<refpurpose>; Creates an instance to the data type typename and fills it with the values val1, val2, the function</refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>resource <function>w32api_init_dtype</function></funcdef>
|
||||
<paramdef>string <parameter>typename</parameter></paramdef>
|
||||
<paramdef>mixed <parameter>val1</parameter></paramdef>
|
||||
<paramdef>mixed <parameter>val2</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
309
functions/xmlrpc.xml
Normal file
309
functions/xmlrpc.xml
Normal file
|
|
@ -0,0 +1,309 @@
|
|||
<reference id="ref.xmlrpc">
|
||||
<title>XMLRPC functions</title>
|
||||
<titleabbrev>XMLRPC function</titleabbrev>
|
||||
|
||||
<partintro>
|
||||
&warn.experimental;
|
||||
<para>
|
||||
</para>
|
||||
</partintro>
|
||||
|
||||
|
||||
<refentry id="function.xmlrpc-encode-request">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_encode_request</refname>
|
||||
<refpurpose>Generates XML for a method request </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>xmlrpc_encode_request</function></funcdef>
|
||||
<paramdef>string <parameter>method</parameter></paramdef>
|
||||
<paramdef>mixed <parameter>params</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-encode">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_encode</refname>
|
||||
<refpurpose>Generates XML for a PHP value </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>xmlrpc_encode</function></funcdef>
|
||||
<paramdef>mixed <parameter>value</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-decode-request">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_decode_request</refname>
|
||||
<refpurpose>& method [, string encoding]) Decodes XML into native PHP types </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>xmlrpc_decode_request</function></funcdef>
|
||||
<paramdef>string <parameter>xml</parameter></paramdef>
|
||||
<paramdef>string <parameter></parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-decode">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_decode</refname>
|
||||
<refpurpose>Decodes XML into native PHP types </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>xmlrpc_decode</function></funcdef>
|
||||
<paramdef>string <parameter>xml</parameter></paramdef>
|
||||
<paramdef>string
|
||||
<parameter><optional>encoding</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-server-create">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_server_create</refname>
|
||||
<refpurpose>Creates an xmlrpc server </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>resource <function>xmlrpc_server_create</function></funcdef>
|
||||
<void/>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-server-destroy">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_server_destroy</refname>
|
||||
<refpurpose>Destroys server resources </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>void <function>xmlrpc_server_destroy</function></funcdef>
|
||||
<paramdef>resource <parameter>server</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-server-register-method">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_server_register_method</refname>
|
||||
<refpurpose>Register a PHP function to resource method matching method_name </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>xmlrpc_server_register_method</function></funcdef>
|
||||
<paramdef>resource <parameter>server</parameter></paramdef>
|
||||
<paramdef>string <parameter>method_name</parameter></paramdef>
|
||||
<paramdef>string <parameter>function</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-server-register-introspection-callback">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_server_register_introspection_callback</refname>
|
||||
<refpurpose>Register a PHP function to generate documentation </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>xmlrpc_server_register_introspection_callback</function></funcdef>
|
||||
<paramdef>resource <parameter>server</parameter></paramdef>
|
||||
<paramdef>string <parameter>function</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-server-call-method">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_server_call_method</refname>
|
||||
<refpurpose>Parses XML requests and call methods </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>mixed <function>xmlrpc_server_call_method</function></funcdef>
|
||||
<paramdef>resource <parameter>server</parameter></paramdef>
|
||||
<paramdef>string <parameter>xml</parameter></paramdef>
|
||||
<paramdef>mixed <parameter>user_data</parameter></paramdef>
|
||||
<paramdef>array
|
||||
<parameter><optional>output_options</optional></parameter>
|
||||
</paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-server-add-introspection-data">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_server_add_introspection_data</refname>
|
||||
<refpurpose>Adds introspection documentation </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>int <function>xmlrpc_server_add_introspection_data</function></funcdef>
|
||||
<paramdef>resource <parameter>server</parameter></paramdef>
|
||||
<paramdef>array <parameter>desc</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-parse-method-descriptions">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_parse_method_descriptions</refname>
|
||||
<refpurpose>Decodes XML into a list of method descriptions </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>array <function>xmlrpc_parse_method_descriptions</function></funcdef>
|
||||
<paramdef>string <parameter>xml</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-set-type">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_set_type</refname>
|
||||
<refpurpose>Sets xmlrpc type, base64 or datetime, for a PHP string value </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>bool <function>xmlrpc_set_type</function></funcdef>
|
||||
<paramdef>string <parameter>value</parameter></paramdef>
|
||||
<paramdef>string <parameter>type</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
<refentry id="function.xmlrpc-get-type">
|
||||
<refnamediv>
|
||||
<refname>xmlrpc_get_type</refname>
|
||||
<refpurpose>Gets xmlrpc type for a PHP value. Especially useful for base64 and datetime strings </refpurpose>
|
||||
</refnamediv>
|
||||
<refsect1>
|
||||
<title>Description</title>
|
||||
<funcsynopsis>
|
||||
<funcprototype>
|
||||
<funcdef>string <function>xmlrpc_get_type</function></funcdef>
|
||||
<paramdef>mixed <parameter>value</parameter></paramdef>
|
||||
</funcprototype>
|
||||
</funcsynopsis>
|
||||
&warn.experimental.func;
|
||||
<para>
|
||||
&warn.undocumented.func;
|
||||
</para>
|
||||
</refsect1>
|
||||
</refentry>
|
||||
|
||||
</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:"../../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
|
||||
-->
|
||||
|
||||
Loading…
Reference in a new issue