cvs: phpdoc /en/functions cybermut.xml

nicos Sat May 10 10:47:31 2003 EDT Modified files: /phpdoc/en/functions cybermut.xml Log: adding do not edit again

Index: phpdoc/en/functions/cybermut.xml diff -u phpdoc/en/functions/cybermut.xml:1.22 phpdoc/en/functions/cybermut.xml:1.23 --- phpdoc/en/functions/cybermut.xml:1.22 Sat May 10 05:04:36 2003 +++ phpdoc/en/functions/cybermut.xml Sat May 10 10:47:31 2003 @@ -1,16 +1,24 @@ -<?xml version="1.0" encoding="iso-8859-1"?> -<!-- $Revision: 1.22 $ --> +<!-- D O N O T E D I T T H I S F I L E ! ! ! + + it is still here for historical reasons only + (as translators may need to check old revision diffs) + + if you want to change things documented in this file + you should now edit the files found under en/reference + instead --> + + <?xml version="1.0" encoding="iso-8859-1"?> +<!-- $Revision: 1.23 $ --> <reference id="ref.cybermut"> <title>Cr&eacute;dit Mutuel CyberMUT functions</title> <titleabbrev>CyberMUT</titleabbrev> <partintro> <simpara> - This extension allows you to process credit cards transactions using - Cr&eacute;dit Mutuel CyberMUT system ( - <ulink url="&url.cybermut;">&url.cybermut;</ulink>). + This extension allows you to process credit cards transactions using Cr&eacute;dit + Mutuel CyberMUT system (<ulink url="&url.cybermut;">&url.cybermut;</ulink>). </simpara> <simpara> - CynerMUT is a popular Web Payment Service in France, provided by the + CyberMUT is a popular Web Payment Service in France, provided by the Cr&eacute;dit Mutuel bank. If you are foreign in France, these functions will not be useful for you. </simpara> @@ -49,38 +57,37 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>cybermut_creerformulairecm</function></funcdef> - <paramdef>string <parameter>url_CM</parameter></paramdef> - <paramdef>string <parameter>version</parameter></paramdef> - <paramdef>string <parameter>TPE</parameter></paramdef> - <paramdef>string <parameter>montant</parameter></paramdef> - <paramdef>string <parameter>ref_commande</parameter></paramdef> - <paramdef>string <parameter>texte_libre</parameter></paramdef> - <paramdef>string <parameter>url_retour</parameter></paramdef> - <paramdef>string <parameter>url_retour_ok</parameter></paramdef> - <paramdef>string <parameter>url_retour_err</parameter></paramdef> - <paramdef>string <parameter>langue</parameter></paramdef> - <paramdef>string <parameter>code_societe</parameter></paramdef> - <paramdef>string <parameter>texte_bouton</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>cybermut_creerformulairecm</methodname> + <methodparam><type>string</type><parameter>url_CM</parameter></methodparam> + <methodparam><type>string</type><parameter>version</parameter></methodparam> + <methodparam><type>string</type><parameter>TPE</parameter></methodparam> + <methodparam><type>string</type><parameter>montant</parameter></methodparam> + <methodparam><type>string</type><parameter>ref_commande</parameter></methodparam> + <methodparam><type>string</type><parameter>texte_libre</parameter></methodparam> + <methodparam><type>string</type><parameter>url_retour</parameter></methodparam> + <methodparam><type>string</type><parameter>url_retour_ok</parameter></methodparam> + <methodparam><type>string</type><parameter>url_retour_err</parameter></methodparam> + <methodparam><type>string</type><parameter>langue</parameter></methodparam> + <methodparam><type>string</type><parameter>code_societe</parameter></methodparam> + <methodparam><type>string</type><parameter>texte_bouton</parameter></methodparam> + </methodsynopsis> <para> - <function>cynermut_creerformulairecm</function> is used to generate the + <function>cybermut_creerformulairecm</function> is used to generate the HTML form of request for payment. </para> <example> <title>First step of payment (equiv cgi1.c)</title> <programlisting role="php"> -&lt;?php -// Directory where are located the keys +<![CDATA[ +<?php +// Directory where the keys are located putenv("CMKEYDIR=/var/creditmut/cles"); // Version number $VERSION="1.2"; - $retour = creditmut_creerformulairecm( + $retour = cybermut_creerformulairecm( "https://www.creditmutuel.fr/test/telepaiement/paiement.cgi", $VERSION, "1234567890", @@ -95,7 +102,8 @@ "Paiement par carte bancaire"); echo $retour; -?&gt; +?> +]]> </programlisting> </example> <para> @@ -116,35 +124,37 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>bool <function>cybermut_testmac</function></funcdef> - <paramdef>string <parameter>code_MAC</parameter></paramdef> - <paramdef>string <parameter>version</parameter></paramdef> - <paramdef>string <parameter>TPE</parameter></paramdef> - <paramdef>string <parameter>cdate</parameter></paramdef> - <paramdef>string <parameter>montant</parameter></paramdef> - <paramdef>string <parameter>ref_commande</parameter></paramdef> - <paramdef>string <parameter>texte_libre</parameter></paramdef> - <paramdef>string <parameter>code-retour</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>bool</type><methodname>cybermut_testmac</methodname> + <methodparam><type>string</type><parameter>code_MAC</parameter></methodparam> + <methodparam><type>string</type><parameter>version</parameter></methodparam> + <methodparam><type>string</type><parameter>TPE</parameter></methodparam> + <methodparam><type>string</type><parameter>cdate</parameter></methodparam> + <methodparam><type>string</type><parameter>montant</parameter></methodparam> + <methodparam><type>string</type><parameter>ref_commande</parameter></methodparam> + <methodparam><type>string</type><parameter>texte_libre</parameter></methodparam> + <methodparam><type>string</type><parameter>code-retour</parameter></methodparam> + </methodsynopsis> <para> <function>cybermut_testmac</function> is used to make sure that there was not data diddling contained in the received message of confirmation. - Pay attention to parameters code-retour and texte-libre, which cannot be - evaluated as is, because auf the dash. You must retrieve them by using: + Pay attention to parameters <parameter>code-retour</parameter> and + <parameter>texte-libre</parameter>, which cannot be evaluated as is, + because of the dash. You must retrieve them by using: <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php $code_retour=$HTTP_GET_VARS["code-retour"]; $texte_libre=$HTTP_GET_VARS["texte-libre"]; -?&gt; +?> +]]> </programlisting> </para> <example> <title>Last step of payment (equiv cgi2.c)</title> <programlisting role="php"> -&lt;?php +<![CDATA[ +<?php // Make sure that Enable Track Vars is ON. // Directory where are located the keys putenv("CMKEYDIR=/var/creditmut/cles"); @@ -155,7 +165,7 @@ $texte_libre = $HTTP_GET_VARS["texte-libre"]; $code_retour = $HTTP_GET_VARS["code-retour"]; -$mac_ok = creditmut_testmac($MAC,$VERSION,$TPE,$date,$montant,$reference,$texte_libre,$code_retour); +$mac_ok = cybermut_testmac($MAC,$VERSION,$TPE,$date,$montant,$reference,$texte_libre,$code_retour); if ($mac_ok) { @@ -164,11 +174,13 @@ // // - $result=creditmut_creerreponsecm("OK"); - } else { - $result=creditmut_creerreponsecm("Document Falsifie");} + $result=cybermut_creerreponsecm("OK"); +} else { + $result=cybermut_creerreponsecm("Document Falsifie"); +} -?&gt; +?> +]]> </programlisting> </example> <para> @@ -189,19 +201,17 @@ </refnamediv> <refsect1> <title>Description</title> - <funcsynopsis> - <funcprototype> - <funcdef>string <function>cybermut_creerreponsecm</function></funcdef> - <paramdef>string <parameter>phrase</parameter></paramdef> - </funcprototype> - </funcsynopsis> + <methodsynopsis> + <type>string</type><methodname>cybermut_creerreponsecm</methodname> + <methodparam><type>string</type><parameter>phrase</parameter></methodparam> + </methodsynopsis> <para> <function>cybermut_creerreponsecm</function> returns a string containing - delivery aknowledgement message. + delivery acknowledgement message. </para> <para> The parameter is "OK" if the message of confirmation of the payment - were correctly auhentified by <function>cybermut_testmac</function>. + was correctly identified by <function>cybermut_testmac</function>. Any other chain is regarded as an error message. </para> <para> @@ -212,6 +222,7 @@ </refsect1> </refentry> </reference> + <!-- Keep this comment at the end of the file Local variables: mode: sgml @@ -221,6 +232,7 @@ 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 @@ -231,3 +243,4 @@ vim: et tw=78 syn=sgml vi: ts=1 sw=1 --> +