Merge pull request #45 from mageplaza/2.3-develop

Clean code
mageplaza · Oct 13, 2020 · 61050ec · 61050ec
2 parents 914046a + af7eac7
commit 61050ec
Show file tree

Hide file tree

Showing 12 changed files with 153 additions and 143 deletions.
diff --git a/Block/Adminhtml/Hook/Edit/Tab/General.php b/Block/Adminhtml/Hook/Edit/Tab/General.php
@@ -120,9 +120,9 @@ protected function _prepareForm()
 
         if ($this->_request->getParam('type') === HookType::ORDER || $hook->getHookType() === HookType::ORDER) {
             $fieldset->addField('order_status', 'multiselect', [
-                'name' => 'order_status',
-                'label' => __('Order Status'),
-                'title' => __('Order Status'),
+                'name'   => 'order_status',
+                'label'  => __('Order Status'),
+                'title'  => __('Order Status'),
                 'values' => $this->orderStatus->toOptionArray()
             ]);
         }

diff --git a/Block/Adminhtml/Logs/Edit.php b/Block/Adminhtml/Logs/Edit.php
@@ -83,6 +83,7 @@ protected function _construct()
      * Get replay action URL
      *
      * @param $log
+     *
      * @return string
      */
     protected function getReplayUrl($log)

diff --git a/Block/Adminhtml/Logs/Edit/Form.php b/Block/Adminhtml/Logs/Edit/Form.php
@@ -114,9 +114,9 @@ protected function _prepareForm()
         ]);
 
         $fieldset->addField('body', 'textarea', [
-            'name'     => 'body',
-            'label'    => __('Request Body'),
-            'title'    => __('Request Body')
+            'name'  => 'body',
+            'label' => __('Request Body'),
+            'title' => __('Request Body')
         ]);
 
         $form->addValues($log->getData());

diff --git a/Controller/Adminhtml/Logs/Save.php b/Controller/Adminhtml/Logs/Save.php
@@ -21,12 +21,14 @@
 
 namespace Mageplaza\Webhook\Controller\Adminhtml\Logs;
 
+use Exception;
 use Magento\Framework\App\ResponseInterface;
 use Magento\Framework\Controller\Result\Redirect;
 use Magento\Framework\Controller\ResultInterface;
 use Magento\Framework\Exception\LocalizedException;
 use Mageplaza\Webhook\Controller\Adminhtml\AbstractManageLogs;
 use Mageplaza\Webhook\Model\History;
+use RuntimeException;
 
 /**
  * Class Save
@@ -40,7 +42,7 @@ class Save extends AbstractManageLogs
     public function execute()
     {
         $resultRedirect = $this->resultRedirectFactory->create();
-        $data = $this->getRequest()->getPost('log');
+        $data           = $this->getRequest()->getPost('log');
         /** @var History $log */
         $log = $this->initLog();
 
@@ -53,9 +55,9 @@ public function execute()
             $this->_getSession()->setData('mageplaza_webhook_log', false);
         } catch (LocalizedException $e) {
             $this->messageManager->addError($e->getMessage());
-        } catch (\RuntimeException $e) {
+        } catch (RuntimeException $e) {
             $this->messageManager->addError($e->getMessage());
-        } catch (\Exception $e) {
+        } catch (Exception $e) {
             $this->messageManager->addException($e, __('Something went wrong while saving the Log.'));
         }
 

diff --git a/Helper/Data.php b/Helper/Data.php
@@ -135,8 +135,8 @@ public function __construct(
      */
     public function getItemStore($item)
     {
-        if (method_exists($item,'getData')) {
-            return $item->getData('store_id') ? : $this->storeManager->getStore()->getId();
+        if (method_exists($item, 'getData')) {
+            return $item->getData('store_id') ?: $this->storeManager->getStore()->getId();
         }
 
         return $this->storeManager->getStore()->getId();
@@ -145,6 +145,7 @@ public function getItemStore($item)
     /**
      * @param $item
      * @param $hookType
+     *
      * @throws LocalizedException
      * @throws NoSuchEntityException
      */
@@ -167,7 +168,7 @@ public function send($item, $hookType)
         $sendTo         = explode(',', $this->getConfigGeneral('send_to'));
         foreach ($hookCollection as $hook) {
             if ($hook->getHookType() === HookType::ORDER) {
-                $statusItem = $item->getStatus();
+                $statusItem  = $item->getStatus();
                 $orderStatus = explode(',', $hook->getOrderStatus());
                 if (!in_array($statusItem, $orderStatus, true)) {
                     continue;
@@ -267,7 +268,7 @@ public function generateLiquidTemplate($item, $templateHtml)
             $template->parse($templateHtml, $filtersMethods);
 
             if ($item instanceof Product) {
-                $item->setStockItem(NULL);
+                $item->setStockItem(null);
             }
 
             return $template->render([
@@ -392,6 +393,7 @@ public function getBasicAuthHeader($username, $password)
     /**
      * @param $item
      * @param $hookType
+     *
      * @throws LocalizedException
      * @throws NoSuchEntityException
      */

diff --git a/Setup/UpgradeData.php b/Setup/UpgradeData.php
@@ -21,9 +21,9 @@
 
 namespace Mageplaza\Webhook\Setup;
 
-use Magento\Framework\Setup\UpgradeDataInterface;
-use Magento\Framework\Setup\ModuleDataSetupInterface;
 use Magento\Framework\Setup\ModuleContextInterface;
+use Magento\Framework\Setup\ModuleDataSetupInterface;
+use Magento\Framework\Setup\UpgradeDataInterface;
 use Mageplaza\Webhook\Model\CronScheduleFactory;
 use Mageplaza\Webhook\Model\HistoryFactory;
 use Mageplaza\Webhook\Model\HookFactory;
@@ -56,8 +56,7 @@ public function __construct(
         HookFactory $hookFactory,
         CronScheduleFactory $cronScheduleFactory,
         HistoryFactory $historyFactory
-    )
-    {
+    ) {
         $this->hookFactory         = $hookFactory;
         $this->cronScheduleFactory = $cronScheduleFactory;
         $this->historyFactory      = $historyFactory;
@@ -68,10 +67,10 @@ public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface
         if (version_compare($context->getVersion(), '1.0.2', '<')) {
             /**
              * Update hook type of mageplaza_webhook_hook table
-            */
+             */
             $hookCollections = $this->hookFactory->create()->getCollection()
-                ->addFieldToFilter('hook_type', array('eq' => 'new_order'));
-            foreach($hookCollections as $hook) {
+                ->addFieldToFilter('hook_type', ['eq' => 'new_order']);
+            foreach ($hookCollections as $hook) {
                 $hook->setHookType('order');
             }
 
@@ -81,8 +80,8 @@ public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface
              * Update hook type of mageplaza_webhook_cron_schedule table
              */
             $cronScheduleCollections = $this->cronScheduleFactory->create()->getCollection()
-                ->addFieldToFilter('hook_type', array('eq' => 'new_order'));
-            foreach($cronScheduleCollections as $cronSchedule) {
+                ->addFieldToFilter('hook_type', ['eq' => 'new_order']);
+            foreach ($cronScheduleCollections as $cronSchedule) {
                 $cronSchedule->setHookType('order');
             }
 
@@ -92,8 +91,8 @@ public function upgrade(ModuleDataSetupInterface $setup, ModuleContextInterface
              * Update hook type of mageplaza_webhook_history table
              */
             $historyCollections = $this->historyFactory->create()->getCollection()
-                ->addFieldToFilter('hook_type', array('eq' => 'new_order'));
-            foreach($historyCollections as $history) {
+                ->addFieldToFilter('hook_type', ['eq' => 'new_order']);
+            foreach ($historyCollections as $history) {
                 $history->setHookType('order');
             }
 

diff --git a/Setup/UpgradeSchema.php b/Setup/UpgradeSchema.php
@@ -74,15 +74,17 @@ public function upgrade(SchemaSetupInterface $setup, ModuleContextInterface $con
             }
         }
 
-        if(version_compare($context->getVersion(), '1.0.2', '<')) {
-            $tableName = $installer->getTable( 'mageplaza_webhook_hook' );
+        if (version_compare($context->getVersion(), '1.0.2', '<')) {
+            $tableName = $installer->getTable('mageplaza_webhook_hook');
             $installer->getConnection()
-                ->addColumn($tableName,'order_status',
+                ->addColumn(
+                    $tableName,
+                    'order_status',
                     [
-                        'type' => Table::TYPE_TEXT,
-                        'length' => 255,
+                        'type'    => Table::TYPE_TEXT,
+                        'length'  => 255,
                         'comment' => 'Order Status',
-                        'after' => 'status'
+                        'after'   => 'status'
                     ]
                 );
         }

diff --git a/composer.json b/composer.json
@@ -6,7 +6,7 @@
     "liquid/liquid": "^1.4.8"
   },
   "type": "magento2-module",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "license": "proprietary",
   "authors": [
     {

diff --git a/etc/events.xml b/etc/events.xml
@@ -1,75 +1,75 @@
-<?xml version="1.0"?>
-<!--
-/**
- * Mageplaza
- *
- * NOTICE OF LICENSE
- *
- * This source file is subject to the Mageplaza.com license that is
- * available through the world-wide-web at this URL:
- * https://www.mageplaza.com/LICENSE.txt
- *
- * DISCLAIMER
- *
- * Do not edit or add to this file if you wish to upgrade this extension to newer
- * version in the future.
- *
- * @category    Mageplaza
- * @package     Mageplaza_Webhook
- * @copyright   Copyright (c) Mageplaza (https://www.mageplaza.com/)
- * @license     https://www.mageplaza.com/LICENSE.txt
- */
--->
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
-    <event name="sales_order_save_before">
-        <observer name="mp_wh_save_order_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
-    </event>
-    <event name="sales_order_save_after">
-        <observer name="mp_wh_order" instance="Mageplaza\Webhook\Observer\AfterOrder"/>
-    </event>
-    <event name="sales_order_status_history_save_after">
-        <observer name="mp_wh_before_order" instance="Mageplaza\Webhook\Observer\AfterOrderComment"/>
-    </event>
-    <event name="sales_order_invoice_save_after">
-        <observer name="mp_wh_new_invoice" instance="Mageplaza\Webhook\Observer\AfterInvoice"/>
-    </event>
-    <event name="sales_order_shipment_save_after">
-        <observer name="mp_wh_new_shipment" instance="Mageplaza\Webhook\Observer\AfterShipment"/>
-    </event>
-    <event name="sales_order_creditmemo_save_after">
-        <observer name="mp_wh_new_creditmemo" instance="Mageplaza\Webhook\Observer\AfterCreditmemo"/>
-    </event>
-    <event name="customer_save_before">
-        <observer name="mp_wh_save_customer_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
-    </event>
-    <event name="customer_save_after">
-        <observer name="mp_wh_new_customer" instance="Mageplaza\Webhook\Observer\AfterCustomer"/>
-    </event>
-    <event name="customer_delete_before">
-        <observer name="mp_wh_delete_customer" instance="Mageplaza\Webhook\Observer\BeforeDeleteCustomer"/>
-    </event>
-    <event name="catalog_product_save_before">
-        <observer name="mp_wh_product_save_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
-    </event>
-    <event name="catalog_product_save_after">
-        <observer name="mp_wh_new_product" instance="Mageplaza\Webhook\Observer\AfterProduct"/>
-    </event>
-    <event name="catalog_product_delete_before">
-        <observer name="mp_wh_delete_product" instance="Mageplaza\Webhook\Observer\BeforeDeleteProduct"/>
-    </event>
-    <event name="catalog_category_save_before">
-        <observer name="mp_wh_category_save_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
-    </event>
-    <event name="catalog_category_save_after">
-        <observer name="mp_wh_category_save_after" instance="Mageplaza\Webhook\Observer\AfterCategory"/>
-    </event>
-    <event name="catalog_category_delete_before">
-        <observer name="mp_wh_delete_product" instance="Mageplaza\Webhook\Observer\BeforeDeleteCategory"/>
-    </event>
-    <event name="customer_login">
-        <observer name="mp_wh_customer_login" instance="Mageplaza\Webhook\Observer\CustomerLogin"/>
-    </event>
-    <event name="newsletter_subscriber_save_after">
-        <observer name="mp_wh_subscriber" instance="Mageplaza\Webhook\Observer\Subscriber"/>
-    </event>
-</config>
+<?xml version="1.0"?>
+<!--
+/**
+ * Mageplaza
+ *
+ * NOTICE OF LICENSE
+ *
+ * This source file is subject to the Mageplaza.com license that is
+ * available through the world-wide-web at this URL:
+ * https://www.mageplaza.com/LICENSE.txt
+ *
+ * DISCLAIMER
+ *
+ * Do not edit or add to this file if you wish to upgrade this extension to newer
+ * version in the future.
+ *
+ * @category    Mageplaza
+ * @package     Mageplaza_Webhook
+ * @copyright   Copyright (c) Mageplaza (https://www.mageplaza.com/)
+ * @license     https://www.mageplaza.com/LICENSE.txt
+ */
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
+    <event name="sales_order_save_before">
+        <observer name="mp_wh_save_order_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
+    </event>
+    <event name="sales_order_save_after">
+        <observer name="mp_wh_order" instance="Mageplaza\Webhook\Observer\AfterOrder"/>
+    </event>
+    <event name="sales_order_status_history_save_after">
+        <observer name="mp_wh_before_order" instance="Mageplaza\Webhook\Observer\AfterOrderComment"/>
+    </event>
+    <event name="sales_order_invoice_save_after">
+        <observer name="mp_wh_new_invoice" instance="Mageplaza\Webhook\Observer\AfterInvoice"/>
+    </event>
+    <event name="sales_order_shipment_save_after">
+        <observer name="mp_wh_new_shipment" instance="Mageplaza\Webhook\Observer\AfterShipment"/>
+    </event>
+    <event name="sales_order_creditmemo_save_after">
+        <observer name="mp_wh_new_creditmemo" instance="Mageplaza\Webhook\Observer\AfterCreditmemo"/>
+    </event>
+    <event name="customer_save_before">
+        <observer name="mp_wh_save_customer_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
+    </event>
+    <event name="customer_save_after">
+        <observer name="mp_wh_new_customer" instance="Mageplaza\Webhook\Observer\AfterCustomer"/>
+    </event>
+    <event name="customer_delete_before">
+        <observer name="mp_wh_delete_customer" instance="Mageplaza\Webhook\Observer\BeforeDeleteCustomer"/>
+    </event>
+    <event name="catalog_product_save_before">
+        <observer name="mp_wh_product_save_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
+    </event>
+    <event name="catalog_product_save_after">
+        <observer name="mp_wh_new_product" instance="Mageplaza\Webhook\Observer\AfterProduct"/>
+    </event>
+    <event name="catalog_product_delete_before">
+        <observer name="mp_wh_delete_product" instance="Mageplaza\Webhook\Observer\BeforeDeleteProduct"/>
+    </event>
+    <event name="catalog_category_save_before">
+        <observer name="mp_wh_category_save_before" instance="Mageplaza\Webhook\Observer\BeforeSave"/>
+    </event>
+    <event name="catalog_category_save_after">
+        <observer name="mp_wh_category_save_after" instance="Mageplaza\Webhook\Observer\AfterCategory"/>
+    </event>
+    <event name="catalog_category_delete_before">
+        <observer name="mp_wh_delete_product" instance="Mageplaza\Webhook\Observer\BeforeDeleteCategory"/>
+    </event>
+    <event name="customer_login">
+        <observer name="mp_wh_customer_login" instance="Mageplaza\Webhook\Observer\CustomerLogin"/>
+    </event>
+    <event name="newsletter_subscriber_save_after">
+        <observer name="mp_wh_subscriber" instance="Mageplaza\Webhook\Observer\Subscriber"/>
+    </event>
+</config>