Merge pull request #1 from sms77io/dev

BulkSMS: added options ; added refund event

Author: matthiez

.gitignore

@@ -1,4 +1,2 @@
 .idea/
-vendor/
-*.zip
-TODO
+vendor/

LICENSE

@@ -1,4 +1,3 @@
-![Sms77.io Logo](https://www.sms77.io/wp-content/uploads/2019/07/sms77-Logo-400x79.png "sms77")
 # sms77.io PrestaShop module
 
 ## Installation
@@ -23,6 +22,9 @@ Available message placeholders:
 - {1} => Last name
 - {2} => Order-ID (where available)
 
-#### Screenshots
-#### Screenshots
-![Screenshot of plugin settings](https://tettra-production.s3.us-west-2.amazonaws.com/0d6efb4f154041e899af17bdcd19c1b5/bcac36a50716f4f73cd84020c4bf091d/d822b155a4112474fdb7aea5ee22465e/cb30d8dd64d0e83fcc7822a40f1703d9/mLBF1Q0g4SCVCXQSEfzElQAJBvxDiaqqTTSqY2lS.png "PrestaShop.Sms77: Settings")
+#### Implemented Events
+- SMS77_MSG_ON_DELIVERY (orderState->id = 5)
+- SMS77_MSG_ON_INVOICE (orderState->id = [1, 10, 13])
+- SMS77_MSG_ON_PAYMENT (orderState->id = [2, 11])
+- SMS77_MSG_ON_REFUND (orderState->id = 7)
+- SMS77_MSG_ON_SHIPMENT (orderState->id = 4)

README.md

@@ -13,8 +13,7 @@
  * @license   LICENSE
  */
 
-abstract class Constants
-{
+abstract class Constants {
     const API_KEY = 'SMS77_API_KEY';
     const BULK = 'SMS77_BULK';
     const BULK_COUNTRIES = 'SMS77_BULK_COUNTRIES';
@@ -23,11 +22,13 @@ abstract class Constants
     const MSG_ON_DELIVERY = 'SMS77_MSG_ON_DELIVERY';
     const MSG_ON_INVOICE = 'SMS77_MSG_ON_INVOICE';
     const MSG_ON_PAYMENT = 'SMS77_MSG_ON_PAYMENT';
+    const MSG_ON_REFUND = 'SMS77_MSG_ON_REFUND';
     const MSG_ON_SHIPMENT = 'SMS77_MSG_ON_SHIPMENT';
     const ON_DELIVERY = 'SMS77_ON_DELIVERY';
     const ON_INVOICE = 'SMS77_ON_INVOICE';
     const ON_PAYMENT = 'SMS77_ON_PAYMENT';
     const ON_SHIPMENT = 'SMS77_ON_SHIPMENT';
+    const ON_REFUND = 'SMS77_ON_REFUND';
     const SIGNATURE = 'SMS77_SIGNATURE';
     const SIGNATURE_POSITION = 'SMS77_SIGNATURE_POSITION';
 
@@ -38,14 +39,17 @@ abstract class Constants
         self::MSG_ON_DELIVERY => false,
         self::MSG_ON_INVOICE => false,
         self::MSG_ON_PAYMENT => false,
+        self::MSG_ON_REFUND => false,
         self::MSG_ON_SHIPMENT => false,
         self::ON_DELIVERY => 'Dear {0} {1}. Your order #{2} has been delivered. Enjoy your goods!',
-        self::ON_INVOICE => 'Dear {0} {1}. An invoice has been generated for your order #{2}. 
-        Log in to your account in order to have a look at it. Best regards!',
-        self::ON_PAYMENT => 'Dear {0} {1}. A payment has been made for your order #{2}. 
-        Log in to your account for more information. Best regards!',
-        self::ON_SHIPMENT => 'Dear {0} {1}. Your order #{2} has been shipped. 
-        Log in to your customer account for more information. Best regards!',
+        self::ON_INVOICE => 'Dear {0} {1}. An invoice has been generated for your order #{2}.'
+            . ' Log in to your account in order to have a look at it. Best regards!',
+        self::ON_PAYMENT => 'Dear {0} {1}. A payment has been made for your order #{2}.'
+            . ' Log in to your account for more information. Best regards!',
+        self::ON_REFUND => 'Dear {0} {1}. A refund has been initiated for order #{2}.'
+            . ' Log in to your account for more information. Best regards!',
+        self::ON_SHIPMENT => 'Dear {0} {1}. Your order #{2} has been shipped.'
+            . ' Log in to your customer account for more information. Best regards!',
         self::SIGNATURE => '',
         self::SIGNATURE_POSITION => 'append',
     ];

classes/Constants.php

@@ -1,48 +1,34 @@
 <?php
 /**
  * NOTICE OF LICENSE
- *
  * This file is licenced under the Software License Agreement.
  * With the purchase or the installation of the software in your application
  * you accept the licence agreement.
- *
  * You must not modify, adapt or create derivative works of this source code
- *
  * @author    sms77.io
  * @copyright 2019-present sms77 e.K.
  * @license   LICENSE
  */
 
-require_once __DIR__ . "/../controllers/admin/Sms77AdminController.php";
-require_once __DIR__ . "/Constants.php";
-
-class Form extends HelperForm
-{
+class Form extends HelperForm {
     public function __construct($name) {
         parent::__construct();
         $defaultLang = (int)Configuration::get('PS_LANG_DEFAULT');
         $this->allow_employee_form_lang = $defaultLang;
         $this->currentIndex = Sms77AdminController::$currentIndex . "&configure=$name";
         $this->default_form_language = $defaultLang;
 
-        $setFieldsValue = function ($k, $v) {
-            $name = "config[$k]";
+        foreach (Configuration::getMultiple(array_keys(Constants::CONFIGURATION))
+                 as $k => $v) {
+            $optionName = "config[$k]";
 
             if (is_array($v)) {
-                $name .= '[]';
+                $optionName .= '[]';
             }
 
-            $this->fields_value[$name] = $v;
-        };
-
-        foreach (Configuration::getMultiple(array_keys(Constants::CONFIGURATION)) as $k => $v) {
-            $setFieldsValue($k, $v);
+            $this->fields_value[$optionName] = $v;
         }
 
-        $toName = function ($key) {
-            return "config[$key]";
-        };
-
         $this->fields_form = [
             [
                 'form' => [
@@ -57,7 +43,7 @@ public function __construct($name) {
                         [
                             'tab' => 'settings',
                             'type' => 'text',
-                            'name' => $toName(Constants::API_KEY),
+                            'name' => FormUtil::toName(Constants::API_KEY),
                             'label' => $this->l('API-Key'),
                             'hint' => $this->l('Your sms77.io API-Key.'),
                             'desc' => $this->l('An API-Key is needed for sending. Get yours now at sms77.io'),
@@ -84,10 +70,15 @@ public function __construct($name) {
                             'Text on delivery?',
                             'Send a text message after delivery?'
                         ),
+                        $this->makeBool(
+                            'REFUND',
+                            'Text on refund?',
+                            'Send a text message after refund initiation?'
+                        ),
                         [
                             'tab' => 'settings',
                             'type' => 'text',
-                            'name' => $toName(Constants::FROM),
+                            'name' => FormUtil::toName(Constants::FROM),
                             'label' => $this->l('From'),
                             'hint' => $this->l('Set a custom sender number or name.'),
                             'desc' => $this->l('Max 11 alphanumeric or 16 numeric characters.'),
@@ -109,25 +100,18 @@ public function __construct($name) {
                             'ON_DELIVERY',
                             'Sets the text message sent to the customer after delivery.'
                         ),
+                        $this->makeTextarea(
+                            'ON_REFUND',
+                            'Sets the text message sent to the customer after refund.'
+                        ),
                         $this->makeTextarea(
                             'SIGNATURE',
                             'Sets a signature to add to all messages.'
                         ),
-                        [
-                            'tab' => 'settings',
-                            'type' => 'radio',
-                            'name' => $toName(Constants::SIGNATURE_POSITION),
-                            'label' => $this->l('Signature position'),
-                            'hint' => $this->l('Decides at which position the signature gets inserted.'),
-                            'desc' => $this->l('Decides at which position the signature gets inserted.'),
-                            'values' => array_map(function ($pos) {
-                                return [
-                                    'id' => "sms77_config_signature_position_$pos",
-                                    'label' => $pos,
-                                    'value' => $pos,
-                                ];
-                            }, Constants::SIGNATURE_POSITIONS),
-                        ],
+                        FormUtil::signaturePosition(
+                            $this->l('Signature position'),
+                            $this->l('Decides at which position the signature gets inserted.'),
+                            'settings', true),
                     ],
                     'submit' => [
                         'title' => $this->l('Save'),
@@ -148,57 +132,37 @@ public function __construct($name) {
             'save' =>
                 [
                     'desc' => $this->l('Save'),
-                    'href' => Sms77AdminController::$currentIndex . "&configure=$name&save$name&token="
+                    'href' => Sms77AdminController::$currentIndex
+                        . "&configure=$name&save$name&token="
                         . Tools::getAdminTokenLite('AdminModules'),
                 ],
             'back' => [
-                'href' => Sms77AdminController::$currentIndex . '&token=' . Tools::getAdminTokenLite('AdminModules'),
+                'href' => Sms77AdminController::$currentIndex
+                    . '&token=' . Tools::getAdminTokenLite('AdminModules'),
                 'desc' => $this->l('Back to list'),
             ],
         ];
         $this->toolbar_scroll = true;
     }
 
-    private function makeTextarea($action, $trans, $tab = 'settings') {
-        $trans = $this->l($trans);
-
-        return [
-            'tab' => $tab,
-            'type' => 'textarea',
-            'name' => "config[SMS77_$action]",
-            'label' => $trans,
-            'hint' => $trans,
-            'desc' => $trans,
-        ];
-    }
-
-    private function makeSwitch($action, $label, $desc, $values, $isBool) {
-        $descHit = $this->l($desc);
-
-        return [
-            'tab' => 'settings',
-            'type' => 'switch',
-            'name' => "config[SMS77_$action]",
-            'label' => $this->l($label),
-            'desc' => $descHit,
-            'hint' => $descHit,
-            'is_bool' => $isBool,
-            'values' => $values,
-        ];
-    }
-
+    /**
+     * @param string $action
+     * @param string $label
+     * @param string $desc
+     * @return array
+     */
     private function makeBool($action, $label, $desc) {
-        $sAction = Tools::strtolower($action);
+        return FormUtil::makeSwitch("config[SMS77_MSG_ON_$action]",
+            $label, Tools::strtolower($action), true, 'settings', $desc);
+    }
 
-        return $this->makeSwitch("MSG_ON_$action", $label, $desc, [
-            [
-                'id' => 'on_' . $sAction . '_on',
-                'value' => 1,
-            ],
-            [
-                'id' => 'on_' . $sAction . '_off',
-                'value' => 0,
-            ],
-        ], true);
+    /**
+     * @param string $action
+     * @param string $trans
+     * @return array
+     */
+    private function makeTextarea($action, $trans) {
+        return FormUtil::makeTextarea(
+            "config[SMS77_$action]", $trans, 'settings');
     }
 }

classes/Form.php

@@ -0,0 +1,92 @@
+<?php
+/**
+ * NOTICE OF LICENSE
+ * This file is licenced under the Software License Agreement.
+ * With the purchase or the installation of the software in your application
+ * you accept the licence agreement.
+ * You must not modify, adapt or create derivative works of this source code
+ * @author    sms77.io
+ * @copyright 2019-present sms77 e.K.
+ * @license   LICENSE
+ */
+
+class FormUtil {
+    public static function signaturePosition($label, $hintDesc, $tab, $toName) {
+        return [
+            'tab' => $tab,
+            'type' => 'radio',
+            'name' => $toName
+                ? self::toName(Constants::SIGNATURE_POSITION)
+                : Constants::SIGNATURE_POSITION,
+            'label' => $label,
+            'hint' => $hintDesc,
+            'desc' => $hintDesc,
+            'values' => array_map(static function($pos) {
+                return [
+                    'id' => "sms77_config_signature_position_$pos",
+                    'label' => $pos,
+                    'value' => $pos,
+                ];
+            }, Constants::SIGNATURE_POSITIONS),
+        ];
+    }
+
+    public static function toName($key) {
+        return "config[$key]";
+    }
+
+    /**
+     * @param string $name
+     * @param string $text
+     * @param string | null $tab
+     * @return array
+     */
+    public static function makeTextarea($name, $text, $tab) {
+        return [
+            'desc' => $text,
+            'hint' => $text,
+            'label' => $text,
+            'name' => $name,
+            'tab' => $tab,
+            'type' => 'textarea',
+        ];
+    }
+
+    /**
+     * @param string $name
+     * @param string $label
+     * @param string $shortAction
+     * @param boolean $isBool
+     * @param string | null $tab
+     * @param string|null $desc
+     * @return array
+     */
+    public static function makeSwitch($name, $label, $shortAction = null,
+                                      $isBool = false, $tab = null, $desc = null) {
+        if (!$shortAction) {
+            $shortAction = $name;
+        }
+
+        $values = [
+            [
+                'id' => $shortAction . '_on',
+                'value' => 1,
+            ],
+            [
+                'id' => $shortAction . '_off',
+                'value' => 0,
+            ],
+        ];
+
+        return [
+            'desc' => $desc,
+            'hint' => $desc,
+            'is_bool' => $isBool,
+            'label' => $label,
+            'name' => $name,
+            'tab' => $tab,
+            'type' => 'switch',
+            'values' => $values,
+        ];
+    }
+}

classes/FormUtil.php

@@ -0,0 +1,32 @@
+<?php
+/**
+ * NOTICE OF LICENSE
+ *
+ * This file is licenced under the Software License Agreement.
+ * With the purchase or the installation of the software in your application
+ * you accept the licence agreement.
+ *
+ * You must not modify, adapt or create derivative works of this source code
+ *
+ * @author    sms77.io
+ * @copyright 2019-present sms77 e.K.
+ * @license   LICENSE
+ */
+
+class OrderPersonalizer extends Personalizer {
+    /**
+     * OrderPersonalizer constructor.
+     * @param string $action
+     * @param array $address
+     * @param int $orderId
+     */
+    public function __construct($action, $address, $orderId) {
+        parent::__construct(Configuration::get("SMS77_ON_$action"));
+
+        $this->addAddress($address);
+
+        $this->addPlaceholders([$orderId]);
+
+        $this->fillPlaceholders();
+    }
+}