File: ccvs.xml

package info (click to toggle)
phpdoc 20020310-1
  • links: PTS
  • area: main
  • in suites: woody
  • size: 35,272 kB
  • ctags: 354
  • sloc: xml: 799,767; php: 1,395; cpp: 500; makefile: 200; sh: 140; awk: 51
file content (383 lines) | stat: -rw-r--r-- 12,918 bytes parent folder | download
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
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.10 $ -->
<!--
Documentation CCVS par Brendan W. McAdams <brendan@plexmedia.com>
Copyright (c) 2000 par le PHP Group
- Tous nos vifs remerciement &agrave; RedHat, Inc. pour leur contribution &agrave; la
documentation originale pour PHP 3, qui nous a aid&eacute; &agrave; d&eacute;marrer de
fichier.
-->
<reference id="ref.ccvs">
 <title>Paiement CCVS</title>
 <titleabbrev>CCVS</titleabbrev>
 <partintro>
  <simpara>
   Ces fonctions font l'interface avec les API CCVS, vous permettant
   de travailler directement avec CCVS depuis vos scripts PHP.
   CCVS est la solution apport&eacute;e par <ulink url="&url.redhat;">RedHat</ulink>
   au probl&egrave;me de l'interm&eacute;diaire, lors du traitement de transactions
   de cartes de cr&eacute;dit. Il vous permet travailler directement avec
   les maisons de cr&eacute;dits, via votre bo&icirc;te *nix et un modem. En utilisant
   le module CCVS pour PHP, vous pouvez effectuer des transactions
   avec les cartes de cr&eacute;dits, directement depuis vos scripts PHP via
   CCVS. La suite vous montrera comment proc&eacute;der.
  </simpara>
  <simpara>
   Pour activer le support CCVS de PHP, commencez par v&eacute;rifier votre
   installation CCVS. Vous devez configurer PHP avec l'option
   <link linkend="install.configure.with-ccvs"><option role="configure">--with-ccvs</option></link>.
   Si vous utilisez cette
   option sans sp&eacute;cifier le chemin de votre installation, PHP essaiera
   de la trouver &agrave; sa position par d&eacute;faut (/usr/local/ccvs). Si CCVS est
   install&eacute; dans un autre dossier, lancez la configuration avec :
   <link linkend="install.configure.with-ccvs"><option role="configure">--with-ccvs=$ccvs_path</option></link>,
   o&ugrave; $ccvs_path est le chemin de votre installation CCVS.
   Notez bien que CCVS requiert
   que <filename>$ccvs_path/lib</filename> et <filename>$ccvs_path/include</filename>
   existent, et qu'ils contiennent respectivement
   <filename>cv_api.h</filename> et <filename>libccvs.a</filename> sous
   <filename>include</filename> et <filename>lib</filename>.
  </simpara>
  <simpara>
   De plus, un d&eacute;mon ccvsd doit &ecirc;tre disponible sur votre configuration,
   et qu'il soit accessible &agrave; vos scripts PHP. Assurez-vous aussi que
   l'utilisateur qui ex&eacute;cute les scripts PHP est le m&ecirc;me que celui qui
   a install&eacute; CCVS (i.e. si vous avez install&eacute; CCVS avec l'utilisateur 'ccvs',
   vos scripts PHP doivent tourner aussi en 'ccvs').
  </simpara>
  <simpara>
   Plus de d&eacute;tails sur CCVS sont disponibles &agrave; <ulink
   url="&url.redhat.ccvs;">&url.redhat.ccvs;</ulink>.
  </simpara>
  <simpara>
   Cette documentation est en chantier. Jusqu'&agrave; sa finalisation, RedHat
   entretient une version l&eacute;g&egrave;rement d&eacute;mod&eacute;e
   mais bien pratique &agrave;
   <ulink url="&url.redhat.support;">&url.redhat.support;</ulink>.
  </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:
-->