cvs: phpdoc /en/reference/pfpro/functions pfpro-cleanup.xml pfpro-init.xml pfpro-process-raw.xml pfpro-process.xml pfpro-version.xml

didou Mon Jan 15 03:00:55 2007 UTC Modified files: /phpdoc/en/reference/pfpro/functions pfpro-cleanup.xml pfpro-init.xml pfpro-process-raw.xml pfpro-process.xml pfpro-version.xml Log: pfpro: switch to new style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml:1.4 phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml:1.5 --- phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml:1.4 Mon Jan 15 02:21:24 2007 +++ phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml Mon Jan 15 03:00:55 2007 @@ -1,26 +1,39 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.pfpro-cleanup"> <refnamediv> <refname>pfpro_cleanup</refname> <refpurpose>Shuts down the Payflow Pro library</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pfpro_cleanup</methodname> <void/> </methodsynopsis> <para> - <function>pfpro_cleanup</function> is used to shutdown the - Payflow Pro library cleanly. It should be called after you - have processed any transactions and before the end of your script. - However you may omit this call, in which case this - extension will automatically call <function>pfpro_cleanup</function> - after your script terminates. + Used to shutdown the Payflow Pro library cleanly. </para> <para> - See also <function>pfpro_init</function>. + This function should be called after you have processed any transactions + and before the end of your script. + However you may omit this call, in which case this extension will + automatically call <function>pfpro_cleanup</function> after your script + terminates. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>pfpro_init</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-init.xml?r1=1.4&r2=1.5&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-init.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-init.xml:1.4 phpdoc/en/reference/pfpro/functions/pfpro-init.xml:1.5 --- phpdoc/en/reference/pfpro/functions/pfpro-init.xml:1.4 Mon Jan 15 02:21:24 2007 +++ phpdoc/en/reference/pfpro/functions/pfpro-init.xml Mon Jan 15 03:00:55 2007 @@ -1,24 +1,36 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.4 $ --> +<!-- $Revision: 1.5 $ --> <refentry id="function.pfpro-init"> <refnamediv> <refname>pfpro_init</refname> <refpurpose>Initialises the Payflow Pro library</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>bool</type><methodname>pfpro_init</methodname> <void/> </methodsynopsis> <para> - <function>pfpro_init</function> is used to initialise - the Payflow Pro library. You may omit this call, in which case - this extension will automatically call <function>pfpro_init</function> - before the first transaction. + Used to initialise the Payflow Pro library. </para> <para> - See also <function>pfpro_cleanup</function>. + You may omit this call, in which case this extension will automatically + call <function>pfpro_init</function> before the first transaction. + </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + &return.success; + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; + <para> + <simplelist> + <member><function>pfpro_cleanup</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml?r1=1.8&r2=1.9&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml:1.8 phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml:1.9 --- phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml:1.8 Mon Jan 15 02:21:24 2007 +++ phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml Mon Jan 15 03:00:55 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.8 $ --> +<!-- $Revision: 1.9 $ --> <refentry id="function.pfpro-process-raw"> <refnamediv> <refname>pfpro_process_raw</refname> <refpurpose>Process a raw transaction with Payflow Pro</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>pfpro_process_raw</methodname> <methodparam><type>string</type><parameter>parameters</parameter></methodparam> @@ -19,36 +19,117 @@ <methodparam choice="opt"><type>string</type><parameter>proxy_password</parameter></methodparam> </methodsynopsis> <para> - Returns: A string containing the response. + <function>pfpro_process_raw</function> processes a raw transaction string + with Payflow Pro. You should really use <function>pfpro_process</function> + instead, as the encoding rules of these transactions are non-standard. </para> + <note> + <para> + Be sure to read the Payflow Pro Developers Guide for full details + of the required parameters and encoding rules. You would be + well advised to use <function>pfpro_process</function> instead. + </para> + </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - <function>pfpro_process_raw</function> processes a raw transaction - string with Payflow Pro. You should really use - <function>pfpro_process</function> instead, as the encoding - rules of these transactions are non-standard. + <variablelist> + <varlistentry> + <term><parameter>parameters</parameter></term> + <listitem> + <para> + A string containing the raw transaction request. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>address</parameter></term> + <listitem> + <para> + Specifies the host to connect to. By default this is + <literal>test.signio.com</literal>, that you will certainly want to + change this to <literal>connect.signio.com</literal> in order to + process live transactions. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + Specifies the port to connect on. It defaults to 443, the standard SSL + port number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + Specifies the timeout to be used, in seconds. This defaults to 30 + seconds. + Note that this timeout appears to only begin once a link to the + processor has been established and so your script could potentially + continue for a very long time in case of DNS or network problems. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_address</parameter></term> + <listitem> + <para> + If required, specifies the hostname of your SSL proxy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_port</parameter></term> + <listitem> + <para> + If required, specifies the port of your SSL proxy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_logon</parameter></term> + <listitem> + <para> + If required, specifies the logon identity to use on the SSL proxy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_password</parameter></term> + <listitem> + <para> + If required, specifies the password to use on the SSL proxy. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The first parameter in this case is a string containing the raw - transaction request. All other parameters are the same as with - <function>pfpro_process</function>. The return value is a string - containing the raw response. + Returns a string containing the raw response. </para> - - <note><para> - Be sure to read the Payflow Pro Developers Guide for full details - of the required parameters and encoding rules. You would be - well advised to use <function>pfpro_process</function> instead. - </para></note> - - <example> - <title>Payflow Pro raw example</title> - <programlisting role="php"> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; + <para> + <example> + <title>Payflow Pro raw example</title> + <programlisting role="php"> <![CDATA[ <?php pfpro_init(); -$response = pfpro_process_raw("USER=mylogin&PWD[5]=m&ndy&PARTNER=VeriSign&TRXTYPE=S&TENDER=C&AMT=1.50&ACCT=4111111111111111&EXPDATE=0904"); +$response = pfpro_process_raw( +"USER=mylogin&PWD[5]=m&ndy&PARTNER=VeriSign&TRXTYPE=S" . +"&TENDER=C&AMT=1.50&ACCT=4111111111111111&EXPDATE=0904"); if (!$response) { die("Couldn't establish link to Verisign.\n"); @@ -60,11 +141,16 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> + </refsect1> + <refsect1 role="seealso"> + &reftitle.seealso; <para> - See also - <function>pfpro_process</function>. + <simplelist> + <member><function>pfpro_process</function></member> + </simplelist> </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-process.xml?r1=1.7&r2=1.8&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-process.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-process.xml:1.7 phpdoc/en/reference/pfpro/functions/pfpro-process.xml:1.8 --- phpdoc/en/reference/pfpro/functions/pfpro-process.xml:1.7 Mon Jan 15 02:21:24 2007 +++ phpdoc/en/reference/pfpro/functions/pfpro-process.xml Mon Jan 15 03:00:55 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> +<!-- $Revision: 1.8 $ --> <refentry id="function.pfpro-process"> <refnamediv> <refname>pfpro_process</refname> <refpurpose>Process a transaction with Payflow Pro</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>array</type><methodname>pfpro_process</methodname> <methodparam><type>array</type><parameter>parameters</parameter></methodparam> @@ -19,52 +19,108 @@ <methodparam choice="opt"><type>string</type><parameter>proxy_password</parameter></methodparam> </methodsynopsis> <para> - Returns: An associative array containing the response - </para> - <para> <function>pfpro_process</function> processes a transaction - with Payflow Pro. The first parameter is an associative - array containing keys and values that will be encoded and - passed to the processor. - </para> - <para> - The second parameter is optional and specifies the host - to connect to. By default this is "test.signio.com", so - you will certainly want to change this to "connect.signio.com" - in order to process live transactions. - </para> - <para> - The third parameter specifies the port to connect on. It - defaults to 443, the standard SSL port. - </para> - <para> - The fourth parameter specifies the timeout to be used, in seconds. - This defaults to 30 seconds. Note that this timeout appears to only - begin once a link to the processor has been established and so your - script could potentially continue for a very long time in the event - of DNS or network problems. + with Payflow Pro. </para> + <note> + <para> + Be sure to read the Payflow Pro Developers Guide for full details + of the required parameters. + </para> + </note> + </refsect1> + <refsect1 role="parameters"> + &reftitle.parameters; <para> - The fifth parameter, if required, specifies the hostname of your - SSL proxy. The sixth parameter specifies the port to use. + <variablelist> + <varlistentry> + <term><parameter>parameters</parameter></term> + <listitem> + <para> + An associative array containing keys and values that will be encoded + and passed to the processor. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>address</parameter></term> + <listitem> + <para> + Specifies the host to connect to. By default this is + <literal>test.signio.com</literal>, that you will certainly want to + change this to <literal>connect.signio.com</literal> in order to + process live transactions. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>port</parameter></term> + <listitem> + <para> + Specifies the port to connect on. It defaults to 443, the standard SSL + port number. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>timeout</parameter></term> + <listitem> + <para> + Specifies the timeout to be used, in seconds. This defaults to 30 + seconds. + Note that this timeout appears to only begin once a link to the + processor has been established and so your script could potentially + continue for a very long time in case of DNS or network problems. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_address</parameter></term> + <listitem> + <para> + If required, specifies the hostname of your SSL proxy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_port</parameter></term> + <listitem> + <para> + If required, specifies the port of your SSL proxy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_logon</parameter></term> + <listitem> + <para> + If required, specifies the logon identity to use on the SSL proxy. + </para> + </listitem> + </varlistentry> + <varlistentry> + <term><parameter>proxy_password</parameter></term> + <listitem> + <para> + If required, specifies the password to use on the SSL proxy. + </para> + </listitem> + </varlistentry> + </variablelist> </para> + </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; <para> - The seventh and eighth parameters specify the logon identity - and password to use on the proxy. + Returns an associative array of the keys and values in the response. </para> + </refsect1> + <refsect1 role="examples"> + &reftitle.examples; <para> - The function returns an associative array of the keys and values - in the response. - </para> - - <note><para> - Be sure to read the Payflow Pro Developers Guide for full details - of the required parameters. - </para></note> - - <example> - <title>Payflow Pro example</title> - <programlisting role="php"> + <example> + <title>Payflow Pro example</title> + <programlisting role="php"> <![CDATA[ <?php @@ -77,7 +133,7 @@ 'TENDER' => 'C', 'AMT' => 1.50, 'ACCT' => '4111111111111111', - 'EXPDATE' => '0904' + 'EXPDATE' => '0909' ); $response = pfpro_process($transaction); @@ -99,8 +155,9 @@ ?> ]]> - </programlisting> - </example> + </programlisting> + </example> + </para> </refsect1> </refentry> http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-version.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-version.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-version.xml:1.3 phpdoc/en/reference/pfpro/functions/pfpro-version.xml:1.4 --- phpdoc/en/reference/pfpro/functions/pfpro-version.xml:1.3 Mon Jan 15 02:21:24 2007 +++ phpdoc/en/reference/pfpro/functions/pfpro-version.xml Mon Jan 15 03:00:55 2007 @@ -1,12 +1,12 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> +<!-- $Revision: 1.4 $ --> <refentry id="function.pfpro-version"> <refnamediv> <refname>pfpro_version</refname> <refpurpose>Returns the version of the Payflow Pro software</refpurpose> </refnamediv> - <refsect1> - <title>Description</title> + <refsect1 role="description"> + &reftitle.description; <methodsynopsis> <type>string</type><methodname>pfpro_version</methodname> <void/> @@ -16,6 +16,12 @@ of the Payflow Pro library. At the time of writing, this was L211. </para> </refsect1> + <refsect1 role="returnvalues"> + &reftitle.returnvalues; + <para> + Returns the version number, as a string. + </para> + </refsect1> </refentry> <!-- Keep this comment at the end of the file