From df59b841b6e5f685f180c09ea1c12aa64736ef6b Mon Sep 17 00:00:00 2001
From: Friedhelm Betz <betz@php.net>
Date: Tue, 14 Jun 2005 15:31:17 +0000
Subject: [PATCH] move cybermut from peardoc back to phpdoc

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@188379 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/cybermut/configure.xml              | 31 +++++++++
 .../functions/cybermut-creerformulairecm.xml  | 62 +++++++++++++++++
 .../functions/cybermut-creerreponsecm.xml     | 60 ++++++++++++++++
 .../cybermut/functions/cybermut-testmac.xml   | 63 +++++++++++++++++
 reference/cybermut/reference.xml              | 68 +++++++++++++++++++
 5 files changed, 284 insertions(+)
 create mode 100644 reference/cybermut/configure.xml
 create mode 100644 reference/cybermut/functions/cybermut-creerformulairecm.xml
 create mode 100644 reference/cybermut/functions/cybermut-creerreponsecm.xml
 create mode 100644 reference/cybermut/functions/cybermut-testmac.xml
 create mode 100644 reference/cybermut/reference.xml

diff --git a/reference/cybermut/configure.xml b/reference/cybermut/configure.xml
new file mode 100644
index 0000000000..6db312d6dd
--- /dev/null
+++ b/reference/cybermut/configure.xml
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.3 $ -->
+<section id="cybermut.installation">
+ &reftitle.install;
+ <para>
+ 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 <filename>libcm-mac.a</filename> and <filename>cm-mac.h</filename>. 
+ </para>
+</section>
+
+<!-- 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
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
diff --git a/reference/cybermut/functions/cybermut-creerformulairecm.xml b/reference/cybermut/functions/cybermut-creerformulairecm.xml
new file mode 100644
index 0000000000..a9274c3b03
--- /dev/null
+++ b/reference/cybermut/functions/cybermut-creerformulairecm.xml
@@ -0,0 +1,62 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.4 $ -->
+<!-- splitted from ./en/functions/cybermut.xml, last change in rev 1.2 -->
+<refentry id="function.cybermut-creerformulairecm">
+ <refnamediv>
+  <refname>cybermut_creerformulairecm</refname> 
+  <refpurpose>Generate HTML form of request for payment</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>pfpro_init</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>price</parameter></methodparam>
+   <methodparam><type>string</type><parameter>ref_command</parameter></methodparam>
+   <methodparam><type>string</type><parameter>text_free</parameter></methodparam>
+   <methodparam><type>string</type><parameter>url_return</parameter></methodparam>
+   <methodparam><type>string</type><parameter>url_return_ok</parameter></methodparam>
+   <methodparam><type>string</type><parameter>url_return_err</parameter></methodparam>
+   <methodparam><type>string</type><parameter>language</parameter></methodparam>
+   <methodparam><type>string</type><parameter>code_company</parameter></methodparam>
+   <methodparam><type>string</type><parameter>text_button</parameter></methodparam>
+  </methodsynopsis>
+  <para>
+   <function>cybermut_creerformulairecm</function> is used to generate the
+   HTML form of request for payment.
+  </para>
+ </refsect1>
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>cybermut_testmac</function></member>
+    <member><function>cybermut_creerreponsecm</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/cybermut/functions/cybermut-creerreponsecm.xml b/reference/cybermut/functions/cybermut-creerreponsecm.xml
new file mode 100644
index 0000000000..3501cd3a30
--- /dev/null
+++ b/reference/cybermut/functions/cybermut-creerreponsecm.xml
@@ -0,0 +1,60 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.4 $ -->
+<!-- splitted from ./en/functions/cybermut.xml, last change in rev 1.2 -->
+<refentry id="function.cybermut-creerreponsecm">
+ <refnamediv>
+  <refname>cybermut_creerreponsecm</refname>
+  <refpurpose>Generate the delivery's acknowledgement of the payment's confirmation</refpurpose>
+ </refnamediv>
+ <refsect1 role="description">
+  &reftitle.description;
+  <methodsynopsis>
+   <type>string</type><methodname>cybermut_creerreponsecm</methodname>
+   <methodparam><type>string</type><parameter>sentence</parameter></methodparam>
+  </methodsynopsis>
+  <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>
+ </refsect1>
+
+ <refsect1 role="returnvalues">
+  &reftitle.returnvalues;
+  <para>
+   Returns a string containing the message of aknowledgement of delivery.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>cybermut_creerformulairecm</function></member>
+    <member><function>cybermut_testmac</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/cybermut/functions/cybermut-testmac.xml b/reference/cybermut/functions/cybermut-testmac.xml
new file mode 100644
index 0000000000..77bf72774b
--- /dev/null
+++ b/reference/cybermut/functions/cybermut-testmac.xml
@@ -0,0 +1,63 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.5 $ -->
+<!-- splitted from ./en/functions/cybermut.xml, last change in rev 1.2 -->
+<refentry id="function.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 role="description">
+  &reftitle.description;
+  <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>price</parameter></methodparam>
+   <methodparam><type>string</type><parameter>ref_command</parameter></methodparam>
+   <methodparam><type>string</type><parameter>text_free</parameter></methodparam>
+   <methodparam><type>string</type><parameter>code_return</parameter></methodparam>
+  </methodsynopsis>
+  <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 <parameter>code_return</parameter> and
+   <parameter>text_free</parameter>, which cannot be evaluated as is,
+   because of the dash.
+  </para>
+ </refsect1>
+
+ <refsect1 role="seealso">
+  &reftitle.seealso;
+  <para>
+   <simplelist>
+    <member><function>cybermut_creerformulairecm</function></member>
+    <member><function>cybermut_creerreponsecm</function></member>
+   </simplelist>
+  </para>
+ </refsect1>
+</refentry>
+
+<!-- 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
+indent-tabs-mode:nil
+sgml-parent-document:nil
+sgml-default-dtd-file:"../../../../manual.ced"
+sgml-exposed-tags:nil
+sgml-local-catalogs:nil
+sgml-local-ecat-files:nil
+End:
+vim600: syn=xml fen fdm=syntax fdl=2 si
+vim: et tw=78 syn=sgml
+vi: ts=1 sw=1
+-->
+
diff --git a/reference/cybermut/reference.xml b/reference/cybermut/reference.xml
new file mode 100644
index 0000000000..334542b6af
--- /dev/null
+++ b/reference/cybermut/reference.xml
@@ -0,0 +1,68 @@
+<?xml version="1.0" encoding="iso-8859-1"?>
+<!-- $Revision: 1.6 $ -->
+<!-- Author: Chaillan Nicolas <nicos@php.net> -->
+ <reference id="ref.cybermut">
+  <title>Credit Mutuel CyberMUT functions</title>
+  <titleabbrev>CyberMUT</titleabbrev>
+  <partintro>
+   <section id="cybermut.intro">
+    &reftitle.intro;
+    <para>
+     This extension allows you to process credit cards transactions using
+     <ulink url="&url.cybermut;">Credit Mutuel CyberMUT system </ulink>.
+    </para> 
+    <para>
+     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.
+    </para>
+    <para>
+     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.
+    </para>
+    &note.no-windows.extension;
+    <note>
+     <para>
+      &pecl.moved-ver;4.3.0
+     </para>
+    </note>
+   </section>
+   
+   <section id="cybermut.requirements">
+    &reftitle.required;
+    <para>
+     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).
+    </para>
+    <note>
+     <simpara>
+      These functions only provide a link to CyberMUT SDK. Be sure to read the
+      CyberMUT Developers Guide for full details of the required parameters.
+     </simpara>
+    </note>
+   </section>
+  </partintro>
+
+&reference.cybermut.functions;
+
+ </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:
+-->