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

From: Date: Mon, 15 Jan 2007 02:21:24 +0000
Subject: cvs: phpdoc /en/reference/pfpro/functions pfpro-cleanup.xml pfpro-init.xml pfpro-process-raw.xml pfpro-process.xml pfpro-version.xml
Groups: php.doc 
Request: Send a blank email to phpdoc+get-969374803@lists.php.net to get a copy of this message
didou Mon Jan 15 02:21:24 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: WS, prepare for new doc style

http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml:1.3 phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml:1.4 --- phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml:1.3 Fri Jun 24 09:11:42 2005 +++ phpdoc/en/reference/pfpro/functions/pfpro-cleanup.xml Mon Jan 15 02:21:24 2007 @@ -1,30 +1,29 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/pfpro.xml, last change in rev 1.1 --> - <refentry id="function.pfpro-cleanup"> - <refnamediv> - <refname>pfpro_cleanup</refname> - <refpurpose>Shuts down the Payflow Pro library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - See also <function>pfpro_init</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.pfpro-cleanup"> + <refnamediv> + <refname>pfpro_cleanup</refname> + <refpurpose>Shuts down the Payflow Pro library</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + See also <function>pfpro_init</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-init.xml?r1=1.3&r2=1.4&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-init.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-init.xml:1.3 phpdoc/en/reference/pfpro/functions/pfpro-init.xml:1.4 --- phpdoc/en/reference/pfpro/functions/pfpro-init.xml:1.3 Fri Jun 24 09:11:44 2005 +++ phpdoc/en/reference/pfpro/functions/pfpro-init.xml Mon Jan 15 02:21:24 2007 @@ -1,28 +1,27 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.3 $ --> -<!-- splitted from ./en/functions/pfpro.xml, last change in rev 1.1 --> - <refentry id="function.pfpro-init"> - <refnamediv> - <refname>pfpro_init</refname> - <refpurpose>Initialises the Payflow Pro library</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <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. - </para> - <para> - See also <function>pfpro_cleanup</function>. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.4 $ --> +<refentry id="function.pfpro-init"> + <refnamediv> + <refname>pfpro_init</refname> + <refpurpose>Initialises the Payflow Pro library</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <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. + </para> + <para> + See also <function>pfpro_cleanup</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml?r1=1.7&r2=1.8&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.7 phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml:1.8 --- phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml:1.7 Wed Mar 3 10:06:44 2004 +++ phpdoc/en/reference/pfpro/functions/pfpro-process-raw.xml Mon Jan 15 02:21:24 2007 @@ -1,49 +1,48 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.7 $ --> -<!-- splitted from ./en/functions/pfpro.xml, last change in rev 1.1 --> - <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> - <methodsynopsis> - <type>string</type><methodname>pfpro_process_raw</methodname> - <methodparam><type>string</type><parameter>parameters</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>proxy_address</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>proxy_port</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>proxy_logon</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>proxy_password</parameter></methodparam> - </methodsynopsis> - <para> - Returns: A string containing the response. - </para> - <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. - </para> - <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. - </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"> +<!-- $Revision: 1.8 $ --> +<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> + <methodsynopsis> + <type>string</type><methodname>pfpro_process_raw</methodname> + <methodparam><type>string</type><parameter>parameters</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy_address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>proxy_port</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy_logon</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy_password</parameter></methodparam> + </methodsynopsis> + <para> + Returns: A string containing the response. + </para> + <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. + </para> + <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. + </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"> <![CDATA[ <?php @@ -61,14 +60,14 @@ ?> ]]> - </programlisting> - </example> - <para> - See also - <function>pfpro_process</function>. - </para> - </refsect1> - </refentry> + </programlisting> + </example> + <para> + See also + <function>pfpro_process</function>. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-process.xml?r1=1.6&r2=1.7&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-process.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-process.xml:1.6 phpdoc/en/reference/pfpro/functions/pfpro-process.xml:1.7 --- phpdoc/en/reference/pfpro/functions/pfpro-process.xml:1.6 Wed Mar 3 10:13:47 2004 +++ phpdoc/en/reference/pfpro/functions/pfpro-process.xml Mon Jan 15 02:21:24 2007 @@ -1,71 +1,70 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.6 $ --> -<!-- splitted from ./en/functions/pfpro.xml, last change in rev 1.1 --> - <refentry id="function.pfpro-process"> - <refnamediv> - <refname>pfpro_process</refname> - <refpurpose>Process a transaction with Payflow Pro</refpurpose> - </refnamediv> - <refsect1> - <title>Description</title> - <methodsynopsis> - <type>array</type><methodname>pfpro_process</methodname> - <methodparam><type>array</type><parameter>parameters</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>proxy_address</parameter></methodparam> - <methodparam choice="opt"><type>int</type><parameter>proxy_port</parameter></methodparam> - <methodparam choice="opt"><type>string</type><parameter>proxy_logon</parameter></methodparam> - <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. - </para> - <para> - The fifth parameter, if required, specifies the hostname of your - SSL proxy. The sixth parameter specifies the port to use. - </para> - <para> - The seventh and eighth parameters specify the logon identity - and password to use on the proxy. - </para> - <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"> +<!-- $Revision: 1.7 $ --> +<refentry id="function.pfpro-process"> + <refnamediv> + <refname>pfpro_process</refname> + <refpurpose>Process a transaction with Payflow Pro</refpurpose> + </refnamediv> + <refsect1> + <title>Description</title> + <methodsynopsis> + <type>array</type><methodname>pfpro_process</methodname> + <methodparam><type>array</type><parameter>parameters</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>port</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>timeout</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy_address</parameter></methodparam> + <methodparam choice="opt"><type>int</type><parameter>proxy_port</parameter></methodparam> + <methodparam choice="opt"><type>string</type><parameter>proxy_logon</parameter></methodparam> + <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. + </para> + <para> + The fifth parameter, if required, specifies the hostname of your + SSL proxy. The sixth parameter specifies the port to use. + </para> + <para> + The seventh and eighth parameters specify the logon identity + and password to use on the proxy. + </para> + <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"> <![CDATA[ <?php @@ -100,10 +99,10 @@ ?> ]]> - </programlisting> - </example> - </refsect1> - </refentry> + </programlisting> + </example> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables: http://cvs.php.net/viewvc.cgi/phpdoc/en/reference/pfpro/functions/pfpro-version.xml?r1=1.2&r2=1.3&diff_format=u Index: phpdoc/en/reference/pfpro/functions/pfpro-version.xml diff -u phpdoc/en/reference/pfpro/functions/pfpro-version.xml:1.2 phpdoc/en/reference/pfpro/functions/pfpro-version.xml:1.3 --- phpdoc/en/reference/pfpro/functions/pfpro-version.xml:1.2 Wed Apr 17 06:43:11 2002 +++ phpdoc/en/reference/pfpro/functions/pfpro-version.xml Mon Jan 15 02:21:24 2007 @@ -1,23 +1,22 @@ <?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.2 $ --> -<!-- splitted from ./en/functions/pfpro.xml, last change in rev 1.1 --> - <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> - <methodsynopsis> - <type>string</type><methodname>pfpro_version</methodname> - <void/> - </methodsynopsis> - <para> - <function>pfpro_version</function> returns the version string - of the Payflow Pro library. At the time of writing, this was L211. - </para> - </refsect1> - </refentry> +<!-- $Revision: 1.3 $ --> +<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> + <methodsynopsis> + <type>string</type><methodname>pfpro_version</methodname> + <void/> + </methodsynopsis> + <para> + <function>pfpro_version</function> returns the version string + of the Payflow Pro library. At the time of writing, this was L211. + </para> + </refsect1> +</refentry> <!-- Keep this comment at the end of the file Local variables:
« previous php.doc (#969374803) next »