2023-11-15: v2.5.2

- Tested on Magento 2.4.6.
- Refactor in keeping with Magento 2 PHP code standards.
- Update composer requirements.
- Add option to force Payment Type selection.
- Add Apple Pay, Samsung Pay and RCS Payment Types.
- Fix redirection issues to payment page (CSP whitelist).

Author: bruce-atkinson

paygate/paygate-payweb-gateway/Api/Data/PayWebApiInterface.php renamed to Api/Data/PayWebApiInterface.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 PayGate (Pty) Ltd
+ * Copyright (c) 2023 Payfast (Pty) Ltd
  *
  * Author: App Inlet (Pty) Ltd
  *

paygate/paygate-payweb-gateway/Api/PayWebApiManagementInterface.php renamed to Api/PayWebApiManagementInterface.php

@@ -1,6 +1,6 @@
 <?php
 /**
- * Copyright (c) 2022 PayGate (Pty) Ltd
+ * Copyright (c) 2023 Payfast (Pty) Ltd
  *
  * Author: App Inlet (Pty) Ltd
  *
@@ -9,17 +9,19 @@
 
 namespace PayGate\PayWeb\Api;
 
+use Magento\Framework\Controller\Result\Json;
+
 interface PayWebApiManagementInterface
 {
     /**
-     * get PayWeb Api data.
+     * Get PayWeb Api data.
      *
      * @param int $id Left-hand operand.
      * @param int $quote_id
      *
-     * @return string
+     * @return Json
      * @api
      * @noinspection PhpUnused
      */
-    public function getApiData(int $id, int $quote_id): string;
+    public function getApiData(int $id, int $quote_id): Json;
 }

paygate/paygate-payweb-gateway/Block/Customer/CardRenderer.php renamed to Block/Customer/CardRenderer.php

@@ -1,12 +1,18 @@
 <?php
-/** @noinspection PhpUnused */
+/**
+ * @noinspection PhpUnused
+ */
 
-/** @noinspection PhpUndefinedNamespaceInspection */
+/**
+ * @noinspection PhpUndefinedNamespaceInspection
+ */
 
-/** @noinspection PhpUndefinedNamespaceInspection */
+/**
+ * @noinspection PhpUndefinedNamespaceInspection
+ */
 
 /*
- * Copyright (c) 2022 PayGate (Pty) Ltd
+ * Copyright (c) 2023 Payfast (Pty) Ltd
  *
  * Author: App Inlet (Pty) Ltd
  *
@@ -23,10 +29,10 @@ class CardRenderer extends AbstractCardRenderer
     /**
      * Can render specified token
      *
-     * @param PaymentTokenInterface $token
+     * @param        PaymentTokenInterface $token
      *
-     * @return boolean
-     * @since 100.1.0
+     * @return       boolean
+     * @since        100.1.0
      * @noinspection PhpUnused
      */
     public function canRender(PaymentTokenInterface $token): bool
@@ -35,54 +41,59 @@ public function canRender(PaymentTokenInterface $token): bool
     }
 
     /**
-     * @return string
-     * @since 100.1.0
+     * Returns Token Masked CC
+     *
+     * @return       string
+     * @since        100.1.0
      * @noinspection PhpUnused
-     * @noinspection PhpUndefinedMethodInspection
      */
     public function getNumberLast4Digits(): string
     {
         return $this->getTokenDetails()['maskedCC'];
     }
 
     /**
-     * @return string
-     * @since 100.1.0
+     * Gets Token Expiration Date
+     *
+     * @return       string
+     * @since        100.1.0
      * @noinspection PhpUnused
-     * @noinspection PhpUndefinedMethodInspection
      */
     public function getExpDate(): string
     {
         return $this->getTokenDetails()['expirationDate'];
     }
 
     /**
-     * @return string
-     * @since 100.1.0
+     * Gets the token icon URL
+     *
+     * @return       string
+     * @since        100.1.0
      * @noinspection PhpUnused
-     * @noinspection PhpUndefinedMethodInspection
      */
     public function getIconUrl(): string
     {
         return $this->getIconForType($this->getTokenDetails()['type'])['url'];
     }
 
     /**
-     * @return int
-     * @since 100.1.0
+     * Gets the token icon height
+     *
+     * @return       int
+     * @since        100.1.0
      * @noinspection PhpUnused
-     * @noinspection PhpUndefinedMethodInspection
      */
     public function getIconHeight(): int
     {
         return $this->getIconForType($this->getTokenDetails()['type'])['height'];
     }
 
     /**
-     * @return int
-     * @since 100.1.0
+     * Gets the token icon width
+     *
+     * @return       int
+     * @since        100.1.0
      * @noinspection PhpUnused
-     * @noinspection PhpUndefinedMethodInspection
      */
     public function getIconWidth(): int
     {

paygate/paygate-payweb-gateway/Block/Form.php renamed to Block/Form.php

@@ -1,10 +1,14 @@
 <?php
-/** @noinspection PhpMissingFieldTypeInspection */
+/**
+ * @noinspection PhpMissingFieldTypeInspection
+ */
 
-/** @noinspection PhpUndefinedNamespaceInspection */
+/**
+ * @noinspection PhpUndefinedNamespaceInspection
+ */
 
 /**
- * Copyright (c) 2022 PayGate (Pty) Ltd
+ * Copyright (c) 2023 Payfast (Pty) Ltd
  *
  * Author: App Inlet (Pty) Ltd
  *
@@ -50,6 +54,8 @@ class Form extends \Magento\Payment\Block\Form
     protected ?Config $_config;
 
     /**
+     * test
+     *
      * @var bool
      */
     protected $_isScopePrivate;
@@ -64,14 +70,13 @@ class Form extends \Magento\Payment\Block\Form
      */
     protected $_logger;
 
-
     /**
-     * @param Context $context
-     * @param ConfigFactory $paygateConfigFactory
+     * @param Context           $context
+     * @param ConfigFactory     $paygateConfigFactory
      * @param ResolverInterface $localeResolver
-     * @param Data $paygateData
-     * @param CurrentCustomer $currentCustomer
-     * @param array $data
+     * @param Data              $paygateData
+     * @param CurrentCustomer   $currentCustomer
+     * @param array             $data
      */
     public function __construct(
         Context $context,
@@ -110,7 +115,7 @@ public function getMethodCode(): string|Paygate
     /**
      * Set template and redirect message
      *
-     * @return null
+     * @return       null
      * @noinspection PhpUnused
      */
     protected function _construct()
@@ -122,5 +127,4 @@ protected function _construct()
 
         return null;
     }
-
 }

paygate/paygate-payweb-gateway/Block/Payment/Info.php renamed to Block/Payment/Info.php

@@ -1,10 +1,14 @@
 <?php
-/** @noinspection PhpPropertyOnlyWrittenInspection */
+/**
+ * @noinspection PhpPropertyOnlyWrittenInspection
+ */
 
-/** @noinspection PhpUndefinedNamespaceInspection */
+/**
+ * @noinspection PhpUndefinedNamespaceInspection
+ */
 
 /*
- * Copyright (c) 2022 PayGate (Pty) Ltd
+ * Copyright (c) 2023 Payfast (Pty) Ltd
  *
  * Author: App Inlet (Pty) Ltd
  *
@@ -18,7 +22,7 @@
 use PayGate\PayWeb\Model\InfoFactory;
 
 /**
- * PayGate common payment info block
+ * Paygate common payment info block
  * Uses default templates
  */
 class Info extends \Magento\Payment\Block\Info
@@ -27,13 +31,17 @@ class Info extends \Magento\Payment\Block\Info
      * @var InfoFactory
      */
     protected InfoFactory $_PaygateInfoFactory;
+
+    /**
+     * @var Config
+     */
     private Config $_paymentConfig;
 
     /**
-     * @param Context $context
-     * @param Config $paymentConfig
+     * @param Context     $context
+     * @param Config      $paymentConfig
      * @param InfoFactory $PaygateInfoFactory
-     * @param array $data
+     * @param array       $data
      */
     public function __construct(
         Context $context,
@@ -45,5 +53,4 @@ public function __construct(
         $this->_paymentConfig      = $paymentConfig;
         parent::__construct($context, $data);
     }
-
 }

paygate/paygate-payweb-gateway/Block/Payment/Request.php renamed to Block/Payment/Request.php

@@ -1,12 +1,18 @@
 <?php
-/** @noinspection PhpMissingFieldTypeInspection */
+/**
+ * @noinspection PhpMissingFieldTypeInspection
+ */
 
-/** @noinspection PhpUnused */
+/**
+ * @noinspection PhpUnused
+ */
 
-/** @noinspection PhpUndefinedNamespaceInspection */
+/**
+ * @noinspection PhpUndefinedNamespaceInspection
+ */
 
 /**
- * Copyright (c) 2022 PayGate (Pty) Ltd
+ * Copyright (c) 2023 Payfast (Pty) Ltd
  *
  * Author: App Inlet (Pty) Ltd
  *
@@ -50,16 +56,20 @@ class Request extends Template
      * @var Reader $reader
      */
     protected Reader $reader;
+
+    /**
+     * @var true
+     */
     protected $_isScopePrivate;
 
     /**
-     * @param Context $context
+     * @param Context      $context
      * @param OrderFactory $orderFactory
-     * @param Session $checkoutSession
-     * @param ReadFactory $readFactory
-     * @param Reader $reader
-     * @param PayGate $paymentMethod
-     * @param array $data
+     * @param Session      $checkoutSession
+     * @param ReadFactory  $readFactory
+     * @param Reader       $reader
+     * @param PayGate      $paymentMethod
+     * @param array        $data
      *
      * @noinspection PhpUnused
      */
@@ -81,22 +91,24 @@ public function __construct(
         $this->_paymentMethod  = $paymentMethod;
     }
 
-    /** @noinspection PhpUnused
+    /**
+     * Builds submit form
+     *
+     * @noinspection PhpUnused
      * @noinspection PhpUndefinedMethodInspection
      */
     public function _prepareLayout()
     {
-        $this->setMessage('Redirecting to PayGate')
-             ->setId('paygate_checkout')
-             ->setName('paygate_checkout')
-             ->setFormMethod('POST')
-             ->setFormAction('https://secure.paygate.co.za/payweb3/process.trans')
-             ->setFormData($this->_paymentMethod->getStandardCheckoutFormFields())
-             ->setSubmitForm(
-                 '<script type="text/javascript">document.getElementById( "paygate_checkout" ).submit();</script>'
-             );
+        $this->setMessage('Redirecting to Paygate')
+            ->setId('paygate_checkout')
+            ->setName('paygate_checkout')
+            ->setFormMethod('POST')
+            ->setFormAction('https://secure.paygate.co.za/payweb3/process.trans')
+            ->setFormData($this->_paymentMethod->getStandardCheckoutFormFields())
+            ->setSubmitForm(
+                '<script type="text/javascript">document.getElementById( "paygate_checkout" ).submit();</script>'
+            );
 
         return parent::_prepareLayout();
     }
-
 }