hholzgra Mon Dec 17 06:29:26 2001 EDT
Modified files:
/phpdoc/en/functions ccvs.xml
Log:
added skeletons for undocumented functions
Index: phpdoc/en/functions/ccvs.xml
diff -u phpdoc/en/functions/ccvs.xml:1.8 phpdoc/en/functions/ccvs.xml:1.9
--- phpdoc/en/functions/ccvs.xml:1.8 Wed Dec 12 15:46:38 2001
+++ phpdoc/en/functions/ccvs.xml Mon Dec 17 06:29:26 2001
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.8 $ -->
+<!-- $Revision: 1.9 $ -->
<!--
CCVS Documentation by Brendan W. McAdams <[EMAIL PROTECTED]>
Copyright (c) 2000 by the PHP Group
@@ -57,19 +57,341 @@
</simpara>
</partintro>
- <refentry>
+ <refentry id="function.ccvs-init">
<refnamediv>
- <refname></refname>
- <refpurpose></refpurpose>
+ <refname>ccvs_init</refname>
+ <refpurpose>Initialize CCVS for use</refpurpose>
</refnamediv>
<refsect1>
- <title></title>
+ <title>Description</title>
<funcsynopsis>
<funcprototype>
- <funcdef> <function></function></funcdef>
- <paramdef> <parameter></parameter></paramdef>
+ <funcdef>string <function>ccvs_init</function></funcdef>
+ <paramdef>string <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-done">
+ <refnamediv>
+ <refname>ccvs_done</refname>
+ <refpurpose>Terminate CCVS engine and do cleanup work</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_done</function></funcdef>
+ <paramdef>string <parameter>sess</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-new">
+ <refnamediv>
+ <refname>ccvs_new</refname>
+ <refpurpose>Create a new, blank transaction </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_new</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-add">
+ <refnamediv>
+ <refname>ccvs_add</refname>
+ <refpurpose>Add data to a transaction </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_add</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ <paramdef>string <parameter>argtype</parameter></paramdef>
+ <paramdef>string <parameter>argval</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-delete">
+ <refnamediv>
+ <refname>ccvs_delete</refname>
+ <refpurpose>Delete a transaction</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_delete</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-auth">
+ <refnamediv>
+ <refname>ccvs_auth</refname>
+ <refpurpose>
+ Perform credit authorization test on a transaction
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_auth</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-return">
+ <refnamediv>
+ <refname>ccvs_return</refname>
+ <refpurpose>
+ Transfer funds from the merchant to the credit card holder
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_return</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-reverse">
+ <refnamediv>
+ <refname>ccvs_reverse</refname>
+ <refpurpose>
+ Perform a full reversal on an already-processed authorization
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_reverse</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-sale">
+ <refnamediv>
+ <refname>ccvs_sale</refname>
+ <refpurpose>
+ Transfer funds from the credit card holder to the merchant
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_sale</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-void">
+ <refnamediv>
+ <refname>ccvs_void</refname>
+ <refpurpose>
+ Perform a full reversal on a completed transaction
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_void</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-status">
+ <refnamediv>
+ <refname>ccvs_status</refname>
+ <refpurpose>Check the status of an invoice</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_status</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-count">
+ <refnamediv>
+ <refname>ccvs_count</refname>
+ <refpurpose>
+ Find out how many transactions of a given type are stored in the system
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>int <function>ccvs_count</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>type</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-lookup">
+ <refnamediv>
+ <refname>ccvs_lookup</refname>
+ <refpurpose>
+ Look up an item of a particular type in the database #
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_lookup</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>invoice</parameter></paramdef>
+ <paramdef>int <parameter>inum</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-report">
+ <refnamediv>
+ <refname>ccvs_report</refname>
+ <refpurpose>Return the status of the background communication process
+</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_report</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>type</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-command">
+ <refnamediv>
+ <refname>ccvs_command</refname>
+ <refpurpose>
+ Performs a command which is peculiar to a single protocol,
+ and thus is not available in the general CCVS API
+ </refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_command</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ <paramdef>string <parameter>type</parameter></paramdef>
+ <paramdef>string <parameter>argval</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
+ </refsect1>
+ </refentry>
+
+ <refentry id="function.ccvs-textvalue">
+ <refnamediv>
+ <refname>ccvs_textvalue</refname>
+ <refpurpose>Get text return value for previous function call</refpurpose>
+ </refnamediv>
+ <refsect1>
+ <title>Description</title>
+ <funcsynopsis>
+ <funcprototype>
+ <funcdef>string <function>ccvs_textvalue</function></funcdef>
+ <paramdef>string <parameter>session</parameter></paramdef>
+ </funcprototype>
+ </funcsynopsis>
+ <para>
+ &warn.undocumented.func;
+ </para>
</refsect1>
</refentry>
