From a94c605f42f46115449eeaa553921c08c0222627 Mon Sep 17 00:00:00 2001 From: Mehdi Achour Date: Mon, 15 Jan 2007 02:21:24 +0000 Subject: [PATCH] WS, prepare for new doc style git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@227260 c90b9560-bf6c-de11-be94-00142212c4b1 --- reference/pfpro/functions/pfpro-cleanup.xml | 51 ++++--- reference/pfpro/functions/pfpro-init.xml | 47 +++--- .../pfpro/functions/pfpro-process-raw.xml | 101 +++++++------ reference/pfpro/functions/pfpro-process.xml | 137 +++++++++--------- reference/pfpro/functions/pfpro-version.xml | 37 +++-- 5 files changed, 184 insertions(+), 189 deletions(-) diff --git a/reference/pfpro/functions/pfpro-cleanup.xml b/reference/pfpro/functions/pfpro-cleanup.xml index 7d37dffd02..0c6dca9c00 100644 --- a/reference/pfpro/functions/pfpro-cleanup.xml +++ b/reference/pfpro/functions/pfpro-cleanup.xml @@ -1,30 +1,29 @@ - - - - - pfpro_cleanup - Shuts down the Payflow Pro library - - - Description - - boolpfpro_cleanup - - - - pfpro_cleanup 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 pfpro_cleanup - after your script terminates. - - - See also pfpro_init. - - - + + + + pfpro_cleanup + Shuts down the Payflow Pro library + + + Description + + boolpfpro_cleanup + + + + pfpro_cleanup 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 pfpro_cleanup + after your script terminates. + + + See also pfpro_init. + + + - - - - pfpro_init - Initialises the Payflow Pro library - - - Description - - boolpfpro_init - - - - pfpro_init is used to initialise - the Payflow Pro library. You may omit this call, in which case - this extension will automatically call pfpro_init - before the first transaction. - - - See also pfpro_cleanup. - - - + + + + pfpro_init + Initialises the Payflow Pro library + + + Description + + boolpfpro_init + + + + pfpro_init is used to initialise + the Payflow Pro library. You may omit this call, in which case + this extension will automatically call pfpro_init + before the first transaction. + + + See also pfpro_cleanup. + + + - - - - pfpro_process_raw - Process a raw transaction with Payflow Pro - - - Description - - stringpfpro_process_raw - stringparameters - stringaddress - intport - inttimeout - stringproxy_address - intproxy_port - stringproxy_logon - stringproxy_password - - - Returns: A string containing the response. - - - pfpro_process_raw processes a raw transaction - string with Payflow Pro. You should really use - pfpro_process instead, as the encoding - rules of these transactions are non-standard. - - - The first parameter in this case is a string containing the raw - transaction request. All other parameters are the same as with - pfpro_process. The return value is a string - containing the raw response. - + + + + pfpro_process_raw + Process a raw transaction with Payflow Pro + + + Description + + stringpfpro_process_raw + stringparameters + stringaddress + intport + inttimeout + stringproxy_address + intproxy_port + stringproxy_logon + stringproxy_password + + + Returns: A string containing the response. + + + pfpro_process_raw processes a raw transaction + string with Payflow Pro. You should really use + pfpro_process instead, as the encoding + rules of these transactions are non-standard. + + + The first parameter in this case is a string containing the raw + transaction request. All other parameters are the same as with + pfpro_process. The return value is a string + containing the raw response. + - - 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 pfpro_process instead. - + + 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 pfpro_process instead. + - - Payflow Pro raw example - + + Payflow Pro raw example + ]]> - - - - See also - pfpro_process. - - - + + + + See also + pfpro_process. + + + - - - - pfpro_process - Process a transaction with Payflow Pro - - - Description - - arraypfpro_process - arrayparameters - stringaddress - intport - inttimeout - stringproxy_address - intproxy_port - stringproxy_logon - stringproxy_password - - - Returns: An associative array containing the response - - - pfpro_process 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. - - - 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. - - - The third parameter specifies the port to connect on. It - defaults to 443, the standard SSL port. - - - 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. - - - The fifth parameter, if required, specifies the hostname of your - SSL proxy. The sixth parameter specifies the port to use. - - - The seventh and eighth parameters specify the logon identity - and password to use on the proxy. - - - The function returns an associative array of the keys and values - in the response. - + + + + pfpro_process + Process a transaction with Payflow Pro + + + Description + + arraypfpro_process + arrayparameters + stringaddress + intport + inttimeout + stringproxy_address + intproxy_port + stringproxy_logon + stringproxy_password + + + Returns: An associative array containing the response + + + pfpro_process 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. + + + 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. + + + The third parameter specifies the port to connect on. It + defaults to 443, the standard SSL port. + + + 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. + + + The fifth parameter, if required, specifies the hostname of your + SSL proxy. The sixth parameter specifies the port to use. + + + The seventh and eighth parameters specify the logon identity + and password to use on the proxy. + + + The function returns an associative array of the keys and values + in the response. + - - Be sure to read the Payflow Pro Developers Guide for full details - of the required parameters. - + + Be sure to read the Payflow Pro Developers Guide for full details + of the required parameters. + - - Payflow Pro example - + + Payflow Pro example + ]]> - - - - + + + + - - - - pfpro_version - Returns the version of the Payflow Pro software - - - Description - - stringpfpro_version - - - - pfpro_version returns the version string - of the Payflow Pro library. At the time of writing, this was L211. - - - + + + + pfpro_version + Returns the version of the Payflow Pro software + + + Description + + stringpfpro_version + + + + pfpro_version returns the version string + of the Payflow Pro library. At the time of writing, this was L211. + + +