Merge branch 'release/1.0.0'

Author: hchabane21

.gitignore

@@ -0,0 +1,3 @@
+.project
+.buildpath
+/.settings/

.travis.yml

@@ -9,7 +9,7 @@ php:
   - 7.1
 
 script:
-- phpunit example/
-- phpunit lib/
-- phpunit config/
-- phpunit return/
+  - phpunit example/
+  - phpunit lib/
+  - phpunit config/
+  - phpunit return/

CHANGELOG.md

@@ -0,0 +1,2 @@
+1.0.0, 2022-06-23:
+- New PHP sample code for Lyra payment gateway integration.

CONTRIBUTING.md

@@ -0,0 +1,8 @@
+# Contributing to Lyra PHP payment form examples
+
+Anyone is welcome to contribute to Lyra PHP payment form examples. There are various ways you can contribute:
+
+- Raise an issue on GitHub.
+- Send us a Pull Request on **develop** branch with your bug fixes.
+- Fork your own copy of the repository to add new features.
+- Provide feedback and suggestions on enhancements.

COPYING.md

@@ -0,0 +1,13 @@
+Copyright © 2022 Lyra Network.
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this software except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

LICENSE LICENSE.txtLICENSE renamed to LICENSE.txt

@@ -178,15 +178,15 @@
    APPENDIX: How to apply the Apache License to your work.
 
       To apply the Apache License to your work, attach the following
-      boilerplate notice, with the fields enclosed by brackets "{}"
+      boilerplate notice, with the fields enclosed by brackets "[]"
       replaced with your own identifying information. (Don't include
       the brackets!)  The text should be enclosed in the appropriate
       comment syntax for the file format. We also recommend that a
       file or class name and description of purpose be included on the
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright {yyyy} {name of copyright owner}
+   Copyright [yyyy] [name of copyright owner]
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
@@ -198,5 +198,4 @@
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
-   limitations under the License.
-
+   limitations under the License.

README.md

@@ -1,33 +1,33 @@
-# PayZen VADS payment exemple - PHP
-
-[![Build Status](https://travis-ci.org/lyra/vads-payment-php.svg?branch=master)](https://travis-ci.org/lyra/vads-payment-php)
+# Lyra PHP payment form example
 
 ## Introduction
-The code presented here is a demonstration of the implementation of the VADS PayZen payment system, aimed to ease its use and learning.
 
+The code presented here is an example of the implementation of the Lyra payment gateway form integration in PHP. It aims to ease its use and learning.
 
 ## Contents
-* payzenFormToolBox.php, the core file, defining an utility class encapsulating all the PayZen logics of this example
 
-## Example
-* `config/config.php`, a centralized configuration and initialisation file
-* `return/form-return.php`, the file for the return URL after payment
-* `return/ipn-return.php`, a minimal implementation of the IPN callback (notification must be turned on in the back-office with the correct URL)
+This project main contents are:
+* `lib/locale`: contains the different translation files for French, English, German and Spanish languages.
+* `lib/lyra-payment-form-sdk`: core files that contains the Lyra payment SDK logic.
+* `lib/tools`: the core file, defining an utilitary class encapsulating all the Lyra logics of the examples.
+* `config/Config.php`: a centralized configuration and initialization file.
+* `example/`: contains the logic implementation of the different payment examples.
+* `example/return-payment.php`: the file for the return URL at the end of the payment.
+* Some other resources for styling pages.
 
 ## The first use
-1. Place the files on the same directory, under the root of your web-server
-2. In `config/config.php`, replace the occurences of `[***CHANGE-ME***]` by the actual values of your PayZen account
-3. Access `index.html` from your browser.
-4. Follow the PayZen indications to perform the payment
 
+1. Copy the content of this project to your PHP web server.
+2. In `config/Config.php`, replace the occurrence of the token `[***CHANGE-ME***]` by the actual return url and configure all settings with the actual values from your gateway Back Office.
+3. Access the `index.php` page from your browser.
+4. Follow the indications to perform a payment
 
 ## The next steps
 
-You will also find here the instructions on how to plug the toolbox logging process to your own logging mechanism, how to override the IPN and RETURN URL defined for your PayZen account, and finally, you can change the `TEST` parameter to `PRODUCTION` to switch to _real_ payment mode, with *all* the caution this decision expects.
-
-
+You will also find here the instructions on how to plug the toolbox logging process to your own logging mechanism, how
+to override the IPN and RETURN URL defined for your gateway Back Office. And finally, you can change the `TEST` parameter
+to `PRODUCTION` to switch to real payment mode, with *all* the caution this decision expects.
 
 ## Note
-* The documentation used to write this code was [Guide d'implementation formulaire de paiement, v3.4](https://payzen.io)
-
 
+* The documentation used to write this code was [Guide d'implementation formulaire de paiement, v3.4](https://payzen.io)

assets/css/style.css

@@ -0,0 +1,102 @@
+body {
+    padding-top: 70px;
+    /*
+    * Required padding for .navbar-fixed-top. Remove if using .navbar-static-top.
+    * Change if height of navigation changes.
+    */
+    padding-bottom: 8em;
+}
+
+.navbar, .navbar-inverse {
+    background-color: #293c7a;
+    border-color : #293c7a;
+}
+
+.navbar-inverse .navbar-nav > li > a, .navbar-inverse .navbar-brand {
+    color: #fff;
+}
+
+.form-control {
+    min-width: 220px;
+}
+
+/* Style the buttons that are used to open and close the accordion panel */
+.accordion {
+    background-color: #eee;
+    color: #444;
+    cursor: pointer;
+    padding: 18px;
+    width: 100%;
+    text-align: left;
+    border: none;
+    outline: none;
+    transition: 0.4s;
+}
+
+/*
+ * Add a background color to the button if it is clicked on (add the .active class with JS),
+ * and when you move the mouse over it (hover).
+ */
+.active, .accordion:hover {
+    background-color: #ccc;
+}
+
+/* Style the accordion panel. Note: hidden by default */
+.panel {
+    padding: 0 18px;
+    background-color: white;
+    display: none;
+    overflow: hidden;
+}
+
+.forminput[type=text] {
+    width: 20%;
+    padding: 12px 20px;
+    margin: 8px 0;
+    display: inline-block;
+    border: 1px solid #ccc;
+    border-radius: 4px;
+    box-sizing: border-box;
+}
+
+.forminput[type=number] {
+    width: 100%;
+    padding: 12px 20px;
+    margin: 8px 0;
+    display: inline-block;
+    border: 1px solid #ccc;
+    border-radius: 4px;
+    box-sizing: border-box;
+}
+
+.forminput[type=submit] {
+    width: 100%;
+    background-color: #293c7a;
+    color: white;
+    padding: 14px 20px;
+    margin: 8px 0;
+    border: none;
+    border-radius: 4px;
+    cursor: pointer;
+}
+
+.forminput[type=submit]:hover {
+    background-color: #293c7a;
+}
+
+.checkoutdiv {
+    border-radius: 5px;
+    background-color: #f2f2f2;
+    padding: 20px;
+}
+
+.close {
+    float: right;
+    font-size: 21px;
+    font-weight: 700;
+    line-height: 1;
+    color: #000;
+    text-shadow: 0 1px 0 #fff;
+    filter: alpha(opacity=20);
+    opacity: .2;
+}

assets/js/script.js

@@ -0,0 +1,27 @@
+/**
+ * Copyright © Lyra Network.
+ * This file is part of Lyra PHP payment form example. See COPYING.md for license details.
+ *
+ * @author    Lyra Network <https://www.lyra.com>
+ * @copyright Lyra Network
+ * @license   http://www.apache.org/licenses/
+ */
+
+var acc = document.getElementsByClassName("accordion");
+var i;
+
+for (i = 0; i < acc.length; i++) {
+    acc[i].addEventListener("click", function () {
+        // Toggle between adding and removing the "active" class
+        // to highlight the button that controls the panel.
+        this.classList.toggle("active");
+
+        // Toggle between hiding and showing the active panel.
+        var panel = this.nextElementSibling;
+        if (panel.style.display === "block") {
+            panel.style.display = "none";
+        } else {
+            panel.style.display = "block";
+        }
+    });
+}

config/config.php

@@ -1,54 +1,110 @@
 <?php
-/*
- * PayZen VADS payment example
- *
- * Bootstraping code, handles initialisation and configuration
- *
- * @version 0.7
+/**
+ * Copyright © Lyra Network.
+ * This file is part of Lyra PHP payment form example. See COPYING.md for license details.
  *
+ * @author    Lyra Network <https://www.lyra.com>
+ * @copyright Lyra Network
+ * @license   http://www.apache.org/licenses/
  */
 
-
-require "../lib/class-payment-form-toolbox.php";
-
 /**
- * Toolbox initialisation, using PayZen account informations
+ * Configuration initialisation, using Lyra account informations.
  *
- * Shop ID (shopID)
- * 8-digit shop ID provided in your Back Office (Menu: Settings > Shop > Certificates).
+ * shop ID (site_id)
+ * 8-digit shop ID provided in your Back Office (Menu: Settings > Shop > Keys).
  *
- * Certificate (certTest || certProd)
- * provided in your Back Office (Menu: Settings > Shop > Certificates).
+ * Test key or Production key (key_test || key_prod)
+ * provided in your Back Office (Menu: Settings > Shop > Keys).
  *
- * Mode (ctxMode)
+ * Mode (ctx_mode)
  * Allows to indicate the operating mode of the module (TEST or PRODUCTION)
  *
- * Platform URL (platform)
+ * Platform URL (platform_url)
  * the platform URL needs to be changed according to your needs (COUNTRY)
  * DEMO: https://demo.payzen.eu/vads-payment/
  * France: https://secure.payzen.eu/vads-payment/
  * Brazil: https://secure.payzen.com.br/vads-payment/
  * Germany: https://de.payzen.eu/vads-payment/
  * Chili: https://secure.payzen.cl/vads-payment/
- * India: https://secure.payzen.co.in/vads-payment/
  *
- * Ask support at payzen.io for your platform URL if you don't know it
+ * Ask support at https://www.lyra.com/support/ for your platform URL if you don't know it.
  *
- * IPN (optional)
- * Instant Payment Notification URL
- * will override the IPN URL and popuplate the vads_url_check field
+ * Signature algorithm (sign_algo)
+ * The signature algorithm chosen in the shop configuration: 'SHA-256'/'SHA-1'
+ *
+ * Return Mode (return_mode)
+ * This setting defines the return mode by which the settings will be sent back to the shop
+ * (3 possible values GET / POST / NONE). If this field is not filled the gateway does not
+ * send back any data to the shop when the customer returns to the shop.
+ *
+ * URL Return (url_return)
+ * Shop return URL. When the customer clicks on "return to the shop" this URL allows to treat
+ * the data in order to display the payment details. It is strongly recommended NOT to treat
+ * the data in the database (order update, order record) after the payment analysis.
+ * The server URL must allow you to update the database.
+ *
+ * Data acquisition mode (action_mode)
+ * This setting is set to INTERACTIVE if the card details are entered on the payment gateway.
+ *
+ * Debug Mode (debug)
+ * TRUE: Allows to display the fields which will be sent to the shop.
+ * FALSE: Automatic redirection to the payment page.
  */
+class Config
+{
+    /**
+     * @var array string[]
+     */
+    private $config_params = array (
+        'site_id' => '12345678',
+        'key_test' => '1111111111111111',
+        'key_prod' => '2222222222222222',
+        'ctx_mode' => 'TEST', // 'TEST' / 'PRODUCTION'
+        'platform_url' => 'https://secure.payzen.eu/vads-payment/',
+        'sign_algo' => 'SHA-256', // 'SHA-256'/'SHA-1'
+        'return_mode' => 'POST',// 'POST' / 'GET'
+        'url_return' => '***CHANGE-ME***',
+        'action_mode' => 'INTERACTIVE',//'INTERACTIVE'/ 'IFRAME'
+        'debug' => true // TRUE / FALSE
+    );
+
+    /**
+     * @return string
+     */
+    public function getAbsPath()
+    {
+        return realpath(implode(DIRECTORY_SEPARATOR, ['.', '..'])) . DIRECTORY_SEPARATOR;
+    }
 
-$args = array(
-    'shopID'    => '[***CHANGE-ME***]', // shopID
-    'certTest'  => '[***CHANGE-ME***]', // certificate, TEST-version
-    'certProd'  => '[***CHANGE-ME***]', // certificate, PRODUCTION-version
-    'ctxMode'   => 'TEST',              // PRODUCTION || TEST
-    'platform'  => '[***CHANGE-ME***]', // Platform URL
-    'algorithm'  => 'sha256', // the signature algorithm chosen in the shop configuration
-    'debug'    => true
-);
+    /**
+     * @return array
+     */
+    public function getConfigParams()
+    {
+        return $this->config_params;
+    }
 
-$toolbox = new paymentFormToolbox($args);
+    /**
+     * @param $name
+     * @return mixed|void
+     */
+    public function getConfigParam($name)
+    {
+        if (array_key_exists($name, $this->config_params)) {
+            return $this->config_params[$name];
+        }
+    }
 
-return $toolbox;
+    /**
+     * @param $name
+     * @param $value
+     * @return void
+     */
+    public function setConfigParam($name, $value)
+    {
+        if (! empty($name)) {
+            $this->config_params[$name] = $value;
+        }
+    }
+}