Merge pull request #17 from AppInlet/release/2.7.0

[2.7.0]

Author: bruce-atkinson

CHANGELOG.md

@@ -1,18 +1,27 @@
 # Changelog
 
-## [[2.6.0]](https://github.com/Payfast/mod-magento_2/releases/tag/v2.6.0)
+## [[2.7.0]](https://github.com/Payfast/magento-aggregation/releases/tag/v2.7.0)
+
+### Added
+
+- Added support for Magento 2.4.8+ and PHP 8.4.
+- Updated Common Library to version 1.4.0.
+- Updated branding to use the Payfast by Network logo.
+- Revised configuration branding to Payfast Aggregation.
+
+## [[2.6.0]](https://github.com/Payfast/magento-aggregation/releases/tag/v2.6.0)
 
 ### Added
 
 - Update for Magento 2.4.7+ and PHP 8.2.
 
-## [[2.5.1]](https://github.com/Payfast/mod-magento_2/releases/tag/v2.5.1)
+## [[2.5.1]](https://github.com/Payfast/magento-aggregation/releases/tag/v2.5.1)
 
 ### Fixed
 
 - Dynamic creation of properties error (php 8.2+).
 
-## [[2.5.0]](https://github.com/Payfast/mod-magento_2/releases/tag/v2.5.0)
+## [[2.5.0]](https://github.com/Payfast/magento-aggregation/releases/tag/v2.5.0)
 
 ### Added
 
@@ -23,7 +32,7 @@
 
 - Bug fixes and code quality improvements.
 
-## [[2.4.1]](https://github.com/Payfast/mod-magento_2/releases/tag/v2.4.1)
+## [[2.4.1]](https://github.com/Payfast/magento-aggregation/releases/tag/v2.4.1)
 
 ### Added
 
@@ -43,7 +52,7 @@
 
 - Update branding.
 
-## [[2.4.0]](https://github.com/Payfast/mod-magento_2/releases/tag/v2.4.0)
+## [[2.4.0]](https://github.com/Payfast/magento-aggregation/releases/tag/v2.4.0)
 
 ### Added
 

README.md

@@ -1,8 +1,8 @@
-# mod-magento_2
+# magento-aggregation
 
-## Payfast module v2.6.0 for Magento v2.4.7
+## Payfast Aggregation module v2.7.0 for Magento v2.4.8
 
-This is the Payfast module for Magento 2. Please feel free
+This is the Payfast Aggregation module for Magento 2. Please feel free
 to [contact the Payfast support team](https://payfast.io/contact/) should you require any assistance.
 
 ## Installation
@@ -14,7 +14,7 @@ to [contact the Payfast support team](https://payfast.io/contact/) should you re
 3. You will now need to run the following commands in the given order:
 
 ```
-composer require payfast/payfast-common:v1.1.0
+composer require payfast/payfast-common:v1.4.0
 php ./bin/magento module:enable Payfast_Payfast
 php ./bin/magento setup:di:compile
 php ./bin/magento setup:static-content:deploy

app/code/Payfast/Payfast/Block/Form.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2024 Payfast (Pty) Ltd
+ * Copyright (c) 2025 Payfast (Pty) Ltd
  */
 
 namespace Payfast\Payfast\Block;
@@ -13,9 +13,6 @@
 use Payfast\Payfast\Model\ConfigFactory;
 use Payfast\Payfast\Model\PayfastConfigProvider;
 
-/**
- * Form class
- */
 class Form extends \Magento\Payment\Block\Form
 {
     /**

app/code/Payfast/Payfast/Block/Info.php

@@ -5,9 +5,6 @@
 use Magento\Framework\Phrase;
 use Magento\Payment\Block\ConfigurableInfo;
 
-/**
- * Info class
- */
 class Info extends ConfigurableInfo
 {
     /**

app/code/Payfast/Payfast/Block/Payment/Info.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2024 Payfast (Pty) Ltd
+ * Copyright (c) 2025 Payfast (Pty) Ltd
  */
 
 namespace Payfast\Payfast\Block\Payment;

app/code/Payfast/Payfast/Block/Payment/Request.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2024 Payfast (Pty) Ltd
+ * Copyright (c) 2025 Payfast (Pty) Ltd
  */
 
 namespace Payfast\Payfast\Block\Payment;
@@ -14,9 +14,6 @@
 use Payfast\Payfast\Helper\Data;
 use Payfast\Payfast\Model\Payfast;
 
-/**
- * Request class
- */
 class Request extends Template
 {
 
@@ -71,9 +68,9 @@ public function __construct(
         $this->_orderFactory    = $orderFactory;
         $this->_checkoutSession = $checkoutSession;
         parent::__construct($context, $data);
-        $this->readFactory     = $readFactory;
-        $this->reader          = $reader;
-        $this->_paymentMethod  = $paymentMethod;
+        $this->readFactory    = $readFactory;
+        $this->reader         = $reader;
+        $this->_paymentMethod = $paymentMethod;
     }
 
     /**

app/code/Payfast/Payfast/Controller/AbstractPayfast.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2024 Payfast (Pty) Ltd
+ * Copyright (c) 2025 Payfast (Pty) Ltd
  */
 
 namespace Payfast\Payfast\Controller;

app/code/Payfast/Payfast/Controller/Notify/Index.php

@@ -2,15 +2,6 @@
 
 namespace Payfast\Payfast\Controller\Notify;
 
-/**
- * Copyright (c) 2024 Payfast (Pty) Ltd
- * You (being anyone who is not Payfast (Pty) Ltd) may download and use this plugin / code in your own website
- * in conjunction with a registered and active Payfast account. If your Payfast account is terminated for any reason,
- * you may not use this plugin / code or part thereof.
- * Except as expressly indicated in this licence, you may not use, copy, modify or distribute this plugin / code or
- * part thereof in any way.
- */
-
 use Exception;
 use LogicException;
 use Magento\Framework\App\Action\HttpPostActionInterface;
@@ -27,11 +18,8 @@
 use Payfast\Payfast\Model\Config as PayfastConfig;
 use Payfast\Payfast\Model\Info;
 use Magento\Framework\Controller\ResultFactory;
-use Payfast\PayfastCommon\PayfastCommon;
+use Payfast\PayfastCommon\Aggregator\Request\PaymentRequest;
 
-/**
- * Index class
- */
 class Index extends AbstractPayfast implements CsrfAwareActionInterface, HttpPostActionInterface
 {
 
@@ -42,14 +30,14 @@ class Index extends AbstractPayfast implements CsrfAwareActionInterface, HttpPos
      */
     public function execute(): ResultInterface
     {
-        $debugMode = $this->getConfigData('debug');
-        $payfastCommon = new PayfastCommon((bool)$debugMode);
+        $debugMode      = $this->getConfigData('debug');
+        $paymentRequest = new PaymentRequest((bool)$debugMode);
 
         $moduleInfo = [
-            'pfSoftwareName' => 'Magento',
-            'pfSoftwareVer' => '2.4.7',
+            'pfSoftwareName'       => 'Magento',
+            'pfSoftwareVer'        => '2.4.7',
             'pfSoftwareModuleName' => 'Payfast-Magento',
-            'pfModuleVer' => '2.6.0'
+            'pfModuleVer'          => '2.7.0'
         ];
 
         $this->_logger->debug('Notify: ' . json_encode($this->request->getPostValue()));
@@ -65,9 +53,9 @@ public function execute(): ResultInterface
 
         $pfHost = $this->paymentMethod->getPayfastHost($serverMode);
 
-        $payfastCommon->pflog(' Payfast ITN call received');
+        $paymentRequest->pflog(' Payfast ITN call received');
 
-        $payfastCommon->pflog('Server = ' . $pfHost);
+        $paymentRequest->pflog('Server = ' . $pfHost);
 
         //// Notify Payfast that information has been received
         $resultRaw = $this->resultFactory->create(ResultFactory::TYPE_RAW);
@@ -87,58 +75,58 @@ public function execute(): ResultInterface
 
         //// Get data sent by Payfast
         // Posted variables from ITN
-        $pfData = PayfastCommon::pfGetData();
+        $pfData = $paymentRequest->pfGetData();
 
         if (empty($pfData)) {
             $pfError  = true;
-            $pfErrMsg = PayfastCommon::PF_ERR_BAD_ACCESS;
+            $pfErrMsg = $paymentRequest::PF_ERR_BAD_ACCESS;
         }
 
         //// Verify security signature
         if (!$pfError) {
-            $payfastCommon->pflog('Verify security signature');
+            $paymentRequest->pflog('Verify security signature');
 
             // If signature different, log for debugging
-            if (!$payfastCommon->pfValidSignature(
+            if (!$paymentRequest->pfValidSignature(
                 $pfData,
                 $pfParamString,
                 $passPhrase
             )) {
                 $pfError  = true;
-                $pfErrMsg = PayfastCommon::PF_ERR_INVALID_SIGNATURE;
+                $pfErrMsg = $paymentRequest::PF_ERR_INVALID_SIGNATURE;
             }
         }
 
         //// Get internal order and verify it hasn't already been processed
         if (!$pfError) {
-            $payfastCommon->pflog("Check order hasn't been processed");
+            $paymentRequest->pflog("Check order hasn't been processed");
 
             // Load order
             $orderId = $pfData[Info::M_PAYMENT_ID];
 
             $this->_order = $this->orderFactory->create()->loadByIncrementId($orderId);
 
-            $payfastCommon->pflog('order status is : ' . $this->_order->getStatus());
+            $paymentRequest->pflog('order status is : ' . $this->_order->getStatus());
 
             // Check order is in "pending payment" state
             if ($this->_order->getState() !== Order::STATE_PENDING_PAYMENT) {
-                $pfErrMsg = PayfastCommon::PF_ERR_ORDER_PROCESSED;
+                $pfErrMsg = $paymentRequest::PF_ERR_ORDER_PROCESSED;
             }
         }
 
         //// Verify data received
         if (!$pfError) {
-            $payfastCommon->pflog('Verify data received');
+            $paymentRequest->pflog('Verify data received');
 
-            if (!$payfastCommon->pfValidData($moduleInfo, $pfHost, $pfParamString)) {
+            if (!$paymentRequest->pfValidData($moduleInfo, $pfHost, $pfParamString)) {
                 $pfError  = true;
-                $pfErrMsg = PayfastCommon::PF_ERR_BAD_ACCESS;
+                $pfErrMsg = $paymentRequest::PF_ERR_BAD_ACCESS;
             }
         }
 
         //// Check status and update order
         if (!$pfError) {
-            $payfastCommon->pflog('Check status and update order');
+            $paymentRequest->pflog('Check status and update order');
 
             // Successful
             if ($pfData[Info::PAYMENT_STATUS] === 'COMPLETE') {
@@ -155,7 +143,7 @@ public function execute(): ResultInterface
 
         // If an error occurred
         if ($pfError) {
-            $payfastCommon->pflog('Error occurred: ' . $pfErrMsg);
+            $paymentRequest->pflog('Error occurred: ' . $pfErrMsg);
             $this->_logger->critical($pre . 'Error occured : ' . $pfErrMsg);
 
             return $this->rawResult
@@ -278,11 +266,11 @@ protected function saveInvoice(): void
      */
     private function setPaymentAdditionalInformation(array $pfData): void
     {
-        $debugMode = $this->getConfigData('debug');
-        $payfastCommon = new PayfastCommon((bool)$debugMode);
+        $debugMode      = $this->getConfigData('debug');
+        $paymentRequest = new PaymentRequest((bool)$debugMode);
 
-        $payfastCommon->pflog(__METHOD__ . ' : bof');
-        $payfastCommon->pflog('Order complete');
+        $paymentRequest->pflog(__METHOD__ . ' : bof');
+        $paymentRequest->pflog('Order complete');
 
         try {
             // Update order additional payment information

app/code/Payfast/Payfast/Controller/Redirect/Cancel.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2024 Payfast (Pty) Ltd
+ * Copyright (c) 2025 Payfast (Pty) Ltd
  */
 
 namespace Payfast\Payfast\Controller\Redirect;

app/code/Payfast/Payfast/Controller/Redirect/Index.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2024 Payfast (Pty) Ltd
+ * Copyright (c) 2025 Payfast (Pty) Ltd
  */
 
 namespace Payfast\Payfast\Controller\Redirect;