cvs: peardoc /en/pecl cybermut.xml
| From: | CHAILLAN Nicolas | Date: | Wed, 14 May 2003 19:08:40 +0000 |
| Subject: | cvs: peardoc /en/pecl cybermut.xml | ||
| Groups: | php.pear.doc | ||
| Request: | Send a blank email to pear-doc+get-822@lists.php.net to get a copy of this message | ||
nicos Wed May 14 15:08:40 2003 EDT
Added files:
/peardoc/en/pecl cybermut.xml
Log:
Initial commit
Index: peardoc/en/pecl/cybermut.xml
+++ peardoc/en/pecl/cybermut.xml
<?xml version="1.0" encoding="iso-8859-1"?>
<!-- $Revision: 1.1 $ -->
<!-- Author: Chaillan Nicolas <nicos@php.net> -->
<reference id="pecl.cybermut">
<title>Credit Mutuel CyberMUT functions</title>
<titleabbrev>CyberMUT</titleabbrev>
<partintro>
<simpara>
This extension allows you to process credit cards transactions using Credit
Mutuel CyberMUT system (<ulink url="http://www.creditmutuel.fr/centre_commercial/vendez_sur_internet.html">http://www.creditmutuel.fr/centre_commercial/vendez_sur_internet.html</ulink>).
</simpara>
<simpara>
CynerMUT is a popular Web Payment Service in France, provided by the
Credit Mutuel bank. If you are foreign in France, these functions will not
be useful for you.
</simpara>
<simpara>
These functions are only available if PHP has been compiled with the
<option role="configure">--with-cybermut[=DIR]</option> option, where DIR
is
the location of libcm-mac.a and cm-mac.h. You will require the
appropriate SDK for your platform, which may be sent to you after your
CyberMUT's subscription (contact them via Web, or go to the nearest
Credit Mutuel).
</simpara>
<simpara>
The use of these functions is almost identical to the original functions,
except for the parameters of return for CreerFormulaireCM and CreerReponseCM,
which are returned directly by functions PHP, whereas they had passed in
reference in the original functions.
</simpara>
<note><para>
These functions only provide a link to CyberMUT SDK. Be sure to read the
CyberMUT Developers Guide for full details of the required parameters.
</para></note>
</partintro>
<refentry id="pecl.cybermut.cybermut_creerformulairecm">
<refnamediv>
<refname>cybermut_creerformulairecm</refname>
<refpurpose>Generate HTML form of request for payment</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>pfpro_init</function></funcdef>
<paramdef>string <parameter>url_cm</parameter></paramdef>
<paramdef>string <parameter>version</parameter></paramdef>
<paramdef>string <parameter>tpe</parameter></paramdef>
<paramdef>string <parameter>price</parameter></paramdef>
<paramdef>string <parameter>ref_command</parameter></paramdef>
<paramdef>string <parameter>text_free</parameter></paramdef>
<paramdef>string <parameter>url_return</parameter></paramdef>
<paramdef>string <parameter>url_return_ok</parameter></paramdef>
<paramdef>string <parameter>url_return_err</parameter></paramdef>
<paramdef>string <parameter>language</parameter></paramdef>
<paramdef>string <parameter>code_company</parameter></paramdef>
<paramdef>string <parameter>text_button</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>cybermut_creerformulairecm</function> is used to generate the
HTML form of request for payment.
</para>
<para>
See also <function>cybermut_testmac</function>
<function>cybermut_creerreponsecm</function>.
</para>
</refsect1>
</refentry>
<refentry id="pecl.cybermut.cybermut_testmac">
<refnamediv>
<refname>cybermut_testmac</refname>
<refpurpose>Make sure that there was no data diddling contained
in the received message of confirmation</refpurpose>
</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>price</parameter></paramdef>
<paramdef>string <parameter>ref_command</parameter></paramdef>
<paramdef>string <parameter>text_free</parameter></paramdef>
<paramdef>string <parameter>code_return</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
<function>cybermut_testmac</function> is used to make sure that there was
no data diddling contained in the received message of confirmation.
Pay attention to parameters code_return and text_free, which cannot be
evaluated as is, because of the dash.
</para>
<para>
See also <function>cybermut_creerformulairecm</function>
<function>cybermut_creerreponsecm</function>.
</para>
</refsect1>
</refentry>
<refentry id="pecl.cybermut.cybermut_creerreponsecm">
<refnamediv>
<refname>cybermut_creerreponsecm</refname>
<refpurpose>Generate the delivery's acknowledgement of the payment's
confirmation</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<funcsynopsis>
<funcprototype>
<funcdef>string <function>cybermut_creerreponsecm</function></funcdef>
<paramdef>string <parameter>sentence</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<para>
Returns: string containing the message of aknowledgement of delivery.
</para>
<para>
The parameter is "OK" if the message of confirmation of the payment
were correctly auhentified by <function>cybermut_testmac</function>.
Any other chain is regarded as an error message.
</para>
<para>
See also <function>cybermut_creerformulairecm</function>
<function>cybermut_testmac</function>.
</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
sgml-parent-document:nil
sgml-default-dtd-file:"../../manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
-->