1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.12 $ -->
<!--
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
-->
|
