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 (388 lines) | stat: -rw-r--r-- 13,200 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
384
385
386
387
388
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.5 $ -->
<!-- 
CCVS Documentation by Brendan W. McAdams <brendan@plexmedia.com>
Copyright (c) 2000 by the PHP Group

-Special Thanks to RedHat, 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 関数</title>
  <titleabbrev>CCVS</titleabbrev>

  <partintro>
   <simpara>
    以下の関数は、CCVS API へのインターフェースであり、PHPスクリプトか
    らCCVSを直接利用可能にするものです。CCVSは、
    <ulink url="&url.redhat;">RedHat</ulink>によるクレジットカード処理
    用の <ulink url="&url.redhat;">RedHat</ulink>による"仲介人"ソリュー
    ションです。これにより、*nixマシンとモデムによりクレジットカード情
    報センターに直接アクセスすることが可能になります。PHPのCCVSモジュー
    ルを使用すれば、PHPスクリプトによりCCVSを用いて直接クレジットカー
    ドの処理が可能になります。以下のリファレンスに処理の概要を示します。
   </simpara>
   <simpara>
    PHPでCCVSサポートを有効にするには、まずCCVSをインストールしたディ
    レクトリを調べて下さい。続いて、オプション <option
    role="configure">--with-ccvs</option> を付けてPHPのconfigureを実行
    する必要があります。CCVSのインストールパスを指定せずにこのオ
    プションを使用した場合、PHPはデフォルトのCCVSインストール位置
    (/usr/local/ccvs)を探します。CCVSが標準以外の場所にある場合、
    <option role="configure">--with-ccvs=$ccvs_path</option>を付けて
    configure を実行して下さい。ただし、$ccvs_path は CCVSのインストー
    ルパスです。CCVSサポートは$ccvs_path/lib および $ccvs_path/include
    が存在していることを前提とし、includeディレクトリからcv_api.h、
    libディレクトリからlibccvs.aを読み込むことに注意して下さい。
   </simpara>
   <simpara>
    また、PHPスクリプトが使用する設定で ccvsd プロセスを実行しておく必
    要があります。CCVSがインストールされたのと同じユーザでPHPプロセス
    が実行されているかを確認する必要があります。(例えば、ユーザー'
    ccvs'でCCVSをインストールした場合には、PHPプロセスのユーザーを同様
    に'ccvs'として実行する必要があります。)
   </simpara>
   <simpara>
    CCVSに関する詳細な情報は、
    <ulink url="&url.redhat.ccvs;">&url.redhat.ccvs;</ulink>から入手可
    能です。
   </simpara>
   <simpara>
    このドキュメントセクションは、作成中です。完成までは、RedHatがやや
    古いですがまだ有用なドキュメントを
    <ulink url="&url.redhat.support;">&url.redhat.support;</ulink>にて
    公開していますので参照下さい。
   </simpara>
  </partintro>

  <refentry id="function.ccvs-init">
   <refnamediv>
    <refname>ccvs_init</refname>
    <refpurpose>CCVSを初期化する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>CCVSエンジンを終了し、クリアする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>新規に空のトランザクションを生成する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>トランザクションにデータを追加する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>トランザクションを削除する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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> 
     あるトランザクションにおいてクレジット認証を行う
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     クレジットカード所有者に店側から金を伝送する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     処理済みの認証を完全に取り消す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     クレジットカード所有者から店側に金を伝送する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     完了したトランザクションを完全に取り消す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>送付状のステータスを確認する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     システムに保存された指定した型のトランザクション数を得る
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     データベース #にある特定の型の項目を探す
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>バックグラウン通信プロセスの状態を返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>
     単一のプロトコルに基づく、一般的なCCVS APIで利用できないコマンド
     を実行する
    </refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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>前の関数コールに関する返り値を取得する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</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
-->