From 7fe3bb0d9423340ce1a6b68f582e23275a0624d3 Mon Sep 17 00:00:00 2001
From: Hartmut Holzgraefe <hholzgra@php.net>
Date: Sun, 16 Dec 2001 09:10:54 +0000
Subject: [PATCH] added skeletons for missing functions

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@65253 c90b9560-bf6c-de11-be94-00142212c4b1
---
 functions/apache.xml | 46 ++++++++++++++++++++-
 functions/curl.xml   | 65 +++++++++++++++++++++++++++++-
 functions/imap.xml   | 96 +++++++++++++++++++++++++++++++++++++++++++-
 functions/mcrypt.xml | 50 +++++++++++++++++++++--
 4 files changed, 250 insertions(+), 7 deletions(-)

diff --git a/functions/apache.xml b/functions/apache.xml
index daf3aece00..1160310ca0 100644
--- a/functions/apache.xml
+++ b/functions/apache.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.19 $ -->
+<!-- $Revision: 1.20 $ -->
  <reference id="ref.apache">
   <title>Apache-specific Functions</title>
   <titleabbrev>Apache</titleabbrev>
@@ -223,6 +223,50 @@ while (list ($header, $value) = each ($headers)) {
    </refsect1>
   </refentry>
 
+  <refentry id='function.apache-child-terminate'>
+   <refnamediv>
+    <refname>apache_child_terminate</refname>
+    <refpurpose>Terminate apache process after this request</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>string <function>apache_child_terminate</function></funcdef>
+      <void/>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     <function>apache_child_terminate</function> will terminate the apache
+     process executing the current PHP request. It may be used to terminate
+     a process after a script with high memory consumption has been run
+     as memory will usualy only be freed internaly but not given back
+     to the operation system. 
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id='function.apache-setenv'>
+   <refnamediv>
+    <refname>apache_setenv</refname>
+    <refpurpose>Set an Apache subprocess_env variable</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>apache_setenv</function></funcdef>
+      <paramdef>string <parameter>variable</parameter></paramdef>
+      <paramdef>string <parameter>value</parameter></paramdef>
+      <paramdef>bool <parameter><optional>walk_to_top</optional></parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
  </reference>
 
 <!-- Keep this comment at the end of the file
diff --git a/functions/curl.xml b/functions/curl.xml
index d368482282..9f0b46cf3a 100644
--- a/functions/curl.xml
+++ b/functions/curl.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.20 $ -->
+<!-- $Revision: 1.21 $ -->
  <reference id="ref.curl">
   <title>CURL, Client URL Library Functions</title>
   <titleabbrev>CURL</titleabbrev>
@@ -534,6 +534,69 @@ curl_close ($ch);
     </para>
    </refsect1>
   </refentry>
+
+  <refentry id='function.curl-errno'>
+   <refnamediv>
+    <refname>curl_errno</refname>
+    <refpurpose>Return an integer containing the last error number</refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>curl_errno</function></funcdef>
+      <paramdef>int <parameter>ch</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id='function.curl-error'>
+   <refnamediv>
+    <refname>curl_error</refname>
+    <refpurpose>
+     Return a string contain the last error for the current session 
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>string <function>curl_error</function></funcdef>
+      <paramdef>int <parameter>ch</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+  <refentry id='function.curl-getinfo'>
+   <refnamediv>
+    <refname>curl_getinfo</refname>
+    <refpurpose>
+     Get information regarding a specific transfer
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>string <function>curl_getinfo</function></funcdef>
+      <paramdef>int <parameter>ch</parameter></paramdef>
+      <paramdef>int <parameter>opt</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
  </reference>
 
 <!-- Keep this comment at the end of the file
diff --git a/functions/imap.xml b/functions/imap.xml
index f71be1836b..a7192f9ac4 100644
--- a/functions/imap.xml
+++ b/functions/imap.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.57 $ -->
+<!-- $Revision: 1.58 $ -->
  <reference id='ref.imap'>
   <title>IMAP, POP3 and NNTP functions</title>
   <titleabbrev>IMAP</titleabbrev>
@@ -306,6 +306,29 @@ imap_close($stream);
    </refsect1>
   </refentry>
 
+  <refentry id='function.imap-bodystruct'>
+   <refnamediv>
+    <refname>imap_bodystruct</refname>
+    <refpurpose>
+     Read the structure of a specified body section of a specific message
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>object <function>imap_bodystruct</function></funcdef>
+      <paramdef>int <parameter>stream_id</parameter></paramdef>
+      <paramdef>int <parameter>msg_no</parameter></paramdef>
+      <paramdef>int <parameter>section</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.imap-check">
    <refnamediv>
     <refname>imap_check</refname>
@@ -2091,6 +2114,30 @@ imap_close($mbox);
    </refsect1>
   </refentry>
 
+  <refentry id='function.imap-popen'>
+   <refnamediv>
+    <refname>imap_popen</refname>
+    <refpurpose>
+     Open a persistant IMAP stream to a mailbox
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>imap_popen</function></funcdef>
+      <paramdef>string <parameter>mailbox</parameter></paramdef>
+      <paramdef>string <parameter>user</parameter></paramdef>
+      <paramdef>string <parameter>password</parameter></paramdef>
+      <paramdef>int <parameter><optional>options</optional></parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.imap-qprint">
    <refnamediv>
     <refname>imap_qprint</refname>
@@ -2533,6 +2580,30 @@ print imap_rfc822_write_address("hartmut","cvs.php.net","Hartmut Holzgraefe")."\
    </refsect1>
   </refentry>
 
+  <refentry id='function.imap-setacl'>
+   <refnamediv>
+    <refname>imap_setacl</refname>
+    <refpurpose>
+     Sets the ACL for a giving mailbox
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>imap_setacl</function></funcdef>
+      <paramdef>int <parameter>stream_id</parameter></paramdef>
+      <paramdef>string <parameter>mailbox</parameter></paramdef>
+      <paramdef>string <parameter>id</parameter></paramdef>
+      <paramdef>string <parameter>rights</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.imap-set-quota">
    <refnamediv>
     <refname>imap_set_quota</refname>
@@ -2976,6 +3047,29 @@ imap_close($mbox);
    </refsect1>
   </refentry>
 
+  <refentry id='function.imap-thread'>
+   <refnamediv>
+    <refname>imap_thread</refname>
+    <refpurpose>
+     Return threaded by REFERENCES tree
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>int <function>imap_thread</function></funcdef>
+      <paramdef>int <parameter>stream_id</parameter></paramdef>
+      <paramdef>int <parameter><optional>flags</optional></parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
+
  </reference>
 
 <!-- Keep this comment at the end of the file
diff --git a/functions/mcrypt.xml b/functions/mcrypt.xml
index cb7f6f512c..dbe8364bc0 100644
--- a/functions/mcrypt.xml
+++ b/functions/mcrypt.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.26 $ -->
+<!-- $Revision: 1.27 $ -->
  <reference id="ref.mcrypt">
   <title>Mcrypt Encryption Functions</title>
   <titleabbrev>mcrypt</titleabbrev>
@@ -1144,7 +1144,49 @@ $td = mcrypt_module_open (MCRYPT_DES, "", MCRYPT_MODE_ECB, "/usr/lib/mcrypt-mode
     </para>
    </refsect1>
   </refentry>
+
+  <refentry id='function.mcrypt-module-close'>
+   <refnamediv>
+    <refname>mcrypt_module_close</refname>
+    <refpurpose>
+     Free the descriptor td
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>bool <function>mcrypt_module_close</function></funcdef>
+      <paramdef>resource <parameter>td</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
  
+  <refentry id='function.mcrypt-generic-deinit'>
+   <refnamediv>
+    <refname>mcrypt_generic_deinit</refname>
+    <refpurpose>
+     This function terminates encrypt specified by the descriptor td
+    </refpurpose>
+   </refnamediv>
+   <refsect1>
+    <title>Description</title>
+    <funcsynopsis>
+     <funcprototype>
+      <funcdef>bool <function>mcrypt_generic_deinit</function></funcdef>
+      <paramdef>resource <parameter>td</parameter></paramdef>
+     </funcprototype>
+    </funcsynopsis>
+    <para>
+     &warn.undocumented.func;
+    </para>
+   </refsect1>
+  </refentry>
+
   <refentry id="function.mcrypt-generic-init">
    <refnamediv>
     <refname>mcrypt_generic_init</refname>
@@ -1620,16 +1662,16 @@ else
    </refsect1>
   </refentry>
 
-  <refentry id="function.mcrypt-module-get-algo-supported-key-sizes">
+  <refentry id="function.mcrypt-module-get-supported-key-sizes">
    <refnamediv>
-    <refname>mcrypt_module_get_algo_supported_key_sizes</refname>
+    <refname>mcrypt_module_get_supported_key_sizes</refname>
     <refpurpose>Returns an array with the supported keysizes of the opened algorithm</refpurpose>
    </refnamediv>
    <refsect1>
     <title>Description</title>
     <funcsynopsis>
      <funcprototype>
-      <funcdef>array <function>mcrypt_module_get_algo_supported_key_sizes</function></funcdef>
+      <funcdef>array <function>mcrypt_module_get_supported_key_sizes</function></funcdef>
       <paramdef>string <parameter>algorithm</parameter></paramdef>
       <paramdef>string <parameter><optional>lib_dir</optional></parameter></paramdef>
      </funcprototype>