File: pfpro.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 (331 lines) | stat: -rw-r--r-- 12,414 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
<?xml version="1.0" encoding="utf-8"?>
<!-- $Revision: 1.9 $ -->
 <reference id="ref.pfpro">
  <title>Verisign Payflow Pro 関数</title>
  <titleabbrev>Verisign Payflow Pro</titleabbrev>
  <partintro>
   <simpara>
    この拡張モジュールにより、以前はSignio(<ulink
    url="&url.pfpro;">&url.pfpro;</ulink>)として知られていたVerisign
    Payment Servicesを使用してクレジットカードおよび他の金融トランザク
    ションを処理することが可能になります。
   </simpara>
   <simpara>
    これらの関数は、PHPがオプション<option
    role="configure">--with-pfpro[=DIR]</option>を付けてコンパイルされ
    ている場合にのみ利用可能です。使用するプラットフォーム用の適当な
    SDKが必要です。これは、登録後に<ulink
    url="&url.pfpro.download;">manager interface</ulink>からダウンロー
    ドすることが可能です。この拡張モジュールをSSL対応のWebサーバまたは
    (CURL+SSL拡張のような)他のSSLコンポーネントで使用する際には、β版
    のSDKが必要です。
   </simpara>
   <simpara>
    SDKをダウンロードした後、配布ファイルのディレクトリ<filename
    class="directory">lib</filename>からファイルをコピーする必要があり
    ます。ヘッダファイル<filename>pfpro.h</filename>を
    <filename class="directory">/usr/local/include</filename>に、
    ライブラリファイル<filename>libpfpro.so</filename>を
    <filename class="directory">/usr/local/lib</filename>にコピーして
    下さい。
   </simpara>
   <simpara>
    これらの関数を使用する場合、<function>pfpro_init</function>および
    <function>pfpro_cleanup</function>のコールを省略することが可能です。
    これは、この拡張モジュールが必要に応じて時動的にこれらをコールする
    ためです。しかし、複数のトランザクションを処理し、ライブラリ全体を
    意のままに制御したい場合には、これらの関数を利用することが可能です。
    これら二つの関数コールの間に、<function>pfpro_process</function>を
    使用してトランザクションを何回でも行うことが可能です。
   </simpara>
   <simpara>
    これらの関数は、PHP 4.0.2で追加されました。
   </simpara>
   <note>
    <para>
     これらの関数は、Verisign Payment Servicesへのリンクのみ提供します。
     必要なパラメータの詳細については、Payflow Pro Developers Guideを
     参照下さい。
    </para>
   </note>
  </partintro>

  <refentry id="function.pfpro-init">
   <refnamediv>
    <refname>pfpro_init</refname> 
    <refpurpose>Payflow Proライブラリを初期化する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>void</type><methodname>pfpro_init</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <function>pfpro_init</function>は、Payflow Proライブラリを初期化
     するために使用されます。この関数のコールは省略することができ、こ
     の拡張モジュールは最初のトランザクションの前に
     <function>pfpro_init</function>を自動的にコールします。
    </para>
    <para> 
     <function>pfpro_cleanup</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.pfpro-cleanup">
   <refnamediv>
    <refname>pfpro_cleanup</refname> 
    <refpurpose>Payflow Proライブラリをシャットダウンする</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>void</type><methodname>pfpro_cleanup</methodname>
      <void/>
     </methodsynopsis>
    <para>
     <function>pfpro_cleanup</function>は、Payflow Proライブラリをシャッ
     トダウンするために使用されます。この関数のコールは省略することが
     でき、この拡張モジュールはスクリプト終了時に
     <function>pfpro_cleanup</function>を自動的にコールします。
    </para>
    <para> 
     <function>pfpro_init</function>も参照下さい。
    </para>
   </refsect1>
  </refentry>

  <refentry id="function.pfpro-process">
   <refnamediv>
    <refname>pfpro_process</refname>
    <refpurpose>Payflow Proでトランザクションを処理する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>array</type><methodname>pfpro_process</methodname>
      <methodparam><type>array</type><parameter>parameters</parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>address</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>port</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>timeout</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>proxy address</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>proxy port</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>proxy logon</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>proxy password</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>
     返り値:応答を有する連想配列
    </para>
    <para> 
     <function>pfpro_process</function>は、Payflow Proでトランザクショ
     ンを処理します。最初のパラメータは、エンコードされてプロセッサに
     渡されたキーおよび値を有する連想配列です。
    </para>
    <para>
     2番目のパラメータはオプションであり、接続するホストを指定します。
     デフォルトでは、この値は"test.signio.com"になっており、
     実際のトランザクションを処理するためには"connect.signio.com"に変
     更したいと思うことでしょう。
    </para>
    <para>
     3番目のパラメータは、接続するポートを指定します。デフォルトは443
     、つまり標準SSLポートです。
    </para>
    <para>
     4番目のパラメータは、使用されるタイムアウトを秒数で指定します。
     この値のデフォルトは30秒です。タイムアウトは、プロセッサへのリン
     クが確立されてから計測が開始され、DNSまたはネットワークの問題によ
     りスクリプトが非常に長い時間実行されたままに可能性があることこと
     に注意して下さい。
    </para>
    <para>
     5番目のパラメータには、要すればSSLプロキシのホスト名を指定します。
     6番目のパラメータは、使用するポートを指定します。
    </para>
    <para>
     7番目および8番目のパラメータには、プロキシを使用する際のログイン用
     IDとパスワードを指定します。
    </para>
    <para>
     この関数は、応答のキーおよび値の連想配列を返します。
    </para>
    <note>
     <para>
      必要なパラメータの詳細については、Payflow Pro Developers Guide
      を参照下さい。
     </para>
    </note>
    <example>
     <title>Payflow Proの例</title>
     <programlisting role="php">
<![CDATA[
<?php

pfpro_init();

$transaction = array(USER	=> 'mylogin',
		     PWD	=> 'mypassword',
		     TRXTYPE	=> 'S',
		     TENDER	=> 'C',
		     AMT	=> 1.50,
		     ACCT	=> '4111111111111111',
		     EXPDATE	=> '0904'
		     );

$response = pfpro_process($transaction);

if (!$response) {
  die("Couldn't establish link to Verisign.\n");
}

echo "Verisign response code was ".$response[RESULT];
echo ", which means: ".$response[RESPMSG]."\n";

echo "\nThe transaction request: ";
print_r($transaction);

echo "\nThe response: ";
print_r($response);

pfpro_cleanup();

?>
]]>
     </programlisting>
    </example>
   </refsect1>
  </refentry>

  <refentry id="function.pfpro-process-raw">
   <refnamediv>
    <refname>pfpro_process_raw</refname>
    <refpurpose>Payflow Proにより素のトランザクションを処理する</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>pfpro_process_raw</methodname>
      <methodparam><type>string</type><parameter>parameters</parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>address</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>port</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>timeout</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>proxy address</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>int</type><parameter>
	<replaceable><optional>proxy port</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>proxy logon</optional></replaceable>
       </parameter></methodparam>
      <methodparam><type>string</type><parameter>
	<replaceable><optional>proxy password</optional></replaceable>
       </parameter></methodparam>
     </methodsynopsis>
    <para>
     返り値: 応答を有する文字列
    </para>
    <para> 
     <function>pfpro_process_raw</function>は、生のトランザクション文
     字列をPayflow Proで処理します。実際には、
     これらのトランザクションのエンコーディング規則が非標準であるため、
     <function>pfpro_process</function>を代わりに使用するべきです。
    </para>
    <para>
     この場合の最初のパラメータには、生のトランザクション要求を有する
     文字列です。他の全てのパラメータは、
     <function>pfpro_process</function>と同じです。返り値は、
     生の応答を有する文字列です。
    </para>
    <note>
     <para>
      必要なパラメータおよびエンコーディング規約の詳細については、
      Payflow Pro Developers Guideを参照下さい。代わりに
      <function>pfpro_process</function>を使用することを強く推奨します。
     </para>
    </note>
    <example>
     <title>Payflow Pro raw の例</title>
     <programlisting role="php">
<![CDATA[
<?php

pfpro_init();

$response = pfpro_process("USER=mylogin&PWD[5]=m&ndy&TRXTYPE=S&TENDER=C&AMT=1.50&ACCT=4111111111111111&EXPDATE=0904");

if (!$response) {
  die("Couldn't establish link to Verisign.\n");
}

echo "Verisign raw response was ".$response;

pfpro_cleanup();

?>
]]>
     </programlisting>
    </example>
   </refsect1>
  </refentry>

  <refentry id="function.pfpro-version">
   <refnamediv>
    <refname>pfpro_version</refname>
    <refpurpose>Payflow Pro ソフトウエアのバージョンを返す</refpurpose>
   </refnamediv>
   <refsect1>
    <title>説明</title>
     <methodsynopsis>
      <type>string</type><methodname>pfpro_version</methodname>
      <void/>
     </methodsynopsis>
    <para> 
     <function>pfpro_version</function>は、Payflow Proライブラリのバー
     ジョンを文字列で返します。この文書を書いている時点では、このバー
     ジョンは、L211です。
    </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:
-->