mirror of
https://github.com/sigmasternchen/php-doc-en
synced 2025-03-16 17:08:54 +00:00
7839d91186
removing the others git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@78562 c90b9560-bf6c-de11-be94-00142212c4b1
405 lines
13 KiB
XML
405 lines
13 KiB
XML
<!-- D O N O T E D I T T H I S F I L E ! ! !
|
|
|
|
it is still here for historical reasons only
|
|
(as translators may need to check old revision diffs)
|
|
|
|
if you want to change things documented in this file
|
|
you should now edit the files found under en/reference
|
|
instead -->
|
|
|
|
<?xml version="1.0" encoding="iso-8859-1"?>
|
|
<!-- $Revision: 1.13 $ -->
|
|
<!--
|
|
CCVS Documentation by Brendan W. McAdams <brendan@plexmedia.com>
|
|
Copyright (c) 2000 by the PHP Group
|
|
|
|
-Special Thanks to Red Hat, Inc. for the contribution of their original
|
|
documentation for the php3 version of this module, which helped us
|
|
start this document.
|
|
-->
|
|
|
|
<reference id="ref.ccvs">
|
|
<title>CCVS API Functions</title>
|
|
<titleabbrev>CCVS</titleabbrev>
|
|
|
|
<partintro>
|
|
<simpara>
|
|
These functions interface the CCVS API, allowing you to directly
|
|
work with CCVS from your PHP scripts. CCVS is <ulink
|
|
url="&url.redhat;">RedHat's</ulink> solution to the "middle-man"
|
|
in credit card processing. It lets you directly address the
|
|
credit card clearing houses via your *nix box and a modem. Using
|
|
the CCVS module for PHP, you can process credit cards directly
|
|
through CCVS via your PHP Scripts. The following references will
|
|
outline the process.
|
|
</simpara>
|
|
<simpara>
|
|
To enable CCVS Support in PHP, first verify your CCVS installation
|
|
directory. You will then need to configure PHP with the <option
|
|
role="configure">--with-ccvs</option> option. If you use this
|
|
option without specifying the path to your CCVS installation, PHP
|
|
Will attempt to look in the default CCVS Install location
|
|
(/usr/local/ccvs). If CCVS is in a non-standard location, run
|
|
configure with: <option
|
|
role="configure">--with-ccvs=$ccvs_path</option>, where $ccvs_path
|
|
is the path to your CCVS installation. Please note that CCVS
|
|
support requires that $ccvs_path/lib and $ccvs_path/include exist,
|
|
and include cv_api.h under the include directory and libccvs.a
|
|
under the lib directory.
|
|
</simpara>
|
|
<simpara>
|
|
Additionally, a ccvsd process will need to be running for the
|
|
configurations you intend to use in your PHP scripts. You will
|
|
also need to make sure the PHP Processes are running under the
|
|
same user as your CCVS was installed as (e.g. if you installed
|
|
CCVS as user 'ccvs', your PHP processes must run as 'ccvs' as
|
|
well.)
|
|
</simpara>
|
|
<simpara>
|
|
Additional information about CCVS can be found at <ulink
|
|
url="&url.redhat.ccvs;">&url.redhat.ccvs;</ulink>.
|
|
</simpara>
|
|
<simpara>
|
|
This documentation section is being worked on. Until then, RedHat
|
|
maintains slightly outdated but still useful documentation at
|
|
<ulink url="&url.redhat.support;">&url.redhat.support;</ulink>.
|
|
</simpara>
|
|
<simpara>
|
|
Update: CCVS has been discontinued by Red Hat and there are no plans
|
|
to issue further keys or support contracts. Those looking for a
|
|
replacement can consider
|
|
<ulink url="&url.redhat.mcve;">MCVE by Main Street Softworks</ulink>
|
|
as a potential replacement. It is similar in design and has documented
|
|
PHP support!
|
|
</simpara>
|
|
</partintro>
|
|
|
|
<refentry id="function.ccvs-init">
|
|
<refnamediv>
|
|
<refname>ccvs_init</refname>
|
|
<refpurpose>Initialize CCVS for use</refpurpose>
|
|
</refnamediv>
|
|
<refsect1>
|
|
<title>Description</title>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_init</methodname>
|
|
<methodparam><type>string</type><parameter>name</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_done</methodname>
|
|
<methodparam><type>string</type><parameter>sess</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_new</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_add</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>argtype</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>argval</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_delete</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_auth</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_return</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_reverse</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_sale</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_void</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_status</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>int</type><methodname>ccvs_count</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>type</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_lookup</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>invoice</parameter></methodparam>
|
|
<methodparam><type>int</type><parameter>inum</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_report</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>type</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_command</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>type</parameter></methodparam>
|
|
<methodparam><type>string</type><parameter>argval</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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>
|
|
<methodsynopsis>
|
|
<type>string</type><methodname>ccvs_textvalue</methodname>
|
|
<methodparam><type>string</type><parameter>session</parameter></methodparam>
|
|
</methodsynopsis>
|
|
<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
|
|
-->
|
|
|