Merge pull request #7 from appinlet/master

Migrate 2.4.0 from old repository

Author: bruce-atkinson

README.md

@@ -1,34 +1,41 @@
 # mod-magento_2
 
-PayFast Magento Module v1.1.1 for Magento v2.0 - 2.1.3
+PayFast Magento Module v2.4.0 for Magento 2.4.4+ on PHP 8.1
 -----------------------------------------------------------------------------
-Copyright (c) 2008 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.
+Copyright (c) 2023 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.
 
-******************************************************************************
-                                                                            
-    Please see the URL below for all information concerning this module:
-
-             https://www.payfast.co.za/shopping-carts/magento/
-******************************************************************************
-
-In order to use PayFast with Magento 2.*.3 you will need a working Magento 2.*.3 installation. To install PayFast follow the below instructions:
+In order to use Payfast with Magento 2, you will need a working Magento installation. To install Payfast follow the below instructions:
 
 1. Setup ZAR on your Magento site.
     In the admin panel navigate to 'Stores', and add ZAR under currency Symbols and Rates.
 2. Copy the PayFast app folder to your root Magento folder.
     This will not override any files on your system.
 3. You will now need to run the following commands in the given order:
-    php ./bin/magento module:enable PayFast_Payfast
-    php ./bin/magento setup:di:compile
-    php ./bin/magento setup:static-content:deploy 
-    php ./bin/magento cache:clean
+
+    3.1 php ./bin/magento module:enable PayFast_Payfast
+
+    3.2 php ./bin/magento setup:di:compile  
+
+    3.3 php ./bin/magento setup:static-content:deploy 
+
+    3.4 php ./bin/magento cache:clean
+
 4. Log into the admin panel and navigate to 'Stores'>'Configuration'>'Sales'>'Payment Method' and click on Payfast
 5. Enable the module, as well as debugging. To test in sandbox insert 'test' in the 'server' field and use the following credentials:
+
     Merchant ID: 10000100
+
     Merchant Key: 46f0cd694581a
-   Leave the passphrase blank and setup the other options as required.
+
+    Leave the passphrase blank and setup the other options as required.
+
+   ##NB: configure sending of emails by default magento source code does not allow sending of emails when a payment module does a redirect.
+
 6. Click 'Save Config', you are now ready to test in sandbox, click 'Save Config'.
-7. Once you are ready to go live, insert 'live' into the 'server' field and input your PayFast credentials. Set debug log to 'No', and the other options as required.
-8. Click 'Save Config', you are now ready to process live transactions via PayFast.
+
+7. Once you are ready to go live, insert 'live' into the 'server' field and input your Payfast credentials. Set debug log to 'No', and the other options as required.
+8. Click 'Save Config', you are now ready to process live transactions via Payfast.
+
+Please [click here](https://payfast.io/integration/shopping-carts/magento/) for more information concerning this module.

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

@@ -4,64 +4,78 @@
  * 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.
  */
-namespace Payfast\Payfast\Block\Payfast;
+namespace Payfast\Payfast\Block;
 
 use Magento\Customer\Helper\Session\CurrentCustomer;
 use Magento\Framework\Locale\ResolverInterface;
-use Magento\Framework\View\Element\Template;
 use Magento\Framework\View\Element\Template\Context;
+use Payfast\Payfast\Helper\Data;
 use Payfast\Payfast\Model\Config;
-use Payfast\Payfast\Model\Payfast\Checkout;
+use Payfast\Payfast\Model\PayfastConfigProvider;
 
 class Form extends \Magento\Payment\Block\Form
 {
-    /** @var string Payment method code */
+    /**
+     * @var string Payment method code
+     */
     protected $_methodCode = Config::METHOD_CODE;
 
-    /** @var \Payfast\Payfast\Helper\Data */
+    /**
+     * @var Data
+     */
     protected $_payfastData;
 
-    /** @var \Payfast\Payfast\Model\ConfigFactory */
+    /**
+     * @var \Payfast\Payfast\Model\ConfigFactory
+     */
     protected $payfastConfigFactory;
 
-    /** @var ResolverInterface */
+    /**
+     * @var ResolverInterface
+     */
     protected $_localeResolver;
 
-    /** @var \Payfast\Payfast\Model\Config */
+    /**
+     * @var \Payfast\Payfast\Model\Config
+     */
     protected $_config;
 
-    /** @var bool */
+    /**
+     * @var bool
+     */
     protected $_isScopePrivate;
 
-    /** @var CurrentCustomer */
+    /**
+     * @var CurrentCustomer
+     */
     protected $currentCustomer;
 
     /**
-     * @param Context $context
+     * @param Context                              $context
      * @param \Payfast\Payfast\Model\ConfigFactory $payfastConfigFactory
-     * @param ResolverInterface $localeResolver
-     * @param \Payfast\Payfast\Helper\Data $payfastData
-     * @param CurrentCustomer $currentCustomer
-     * @param array $data
+     * @param ResolverInterface                    $localeResolver
+     * @param Data         $payfastData
+     * @param CurrentCustomer                      $currentCustomer
+     * @param array                                $data
      */
     public function __construct(
         Context $context,
-        \Payfast\Payfast\Model\ConfigFactory $payfastConfigFactory,
+        PayfastConfigProvider $payfastConfigFactory,
         ResolverInterface $localeResolver,
-        \Payfast\Payfast\Helper\Data $payfastData,
+        Data $payfastData,
         CurrentCustomer $currentCustomer,
         array $data = []
     ) {
         $pre = __METHOD__ . " : ";
-        $this->_logger->debug( $pre . 'bof' );
         $this->_payfastData = $payfastData;
         $this->payfastConfigFactory = $payfastConfigFactory;
+        parent::__construct($context, $data);
+        $this->_logger->debug($pre . 'bof');
         $this->_localeResolver = $localeResolver;
-        $this->_config = null;
+
         $this->_isScopePrivate = true;
         $this->currentCustomer = $currentCustomer;
-        parent::__construct($context, $data);
-        $this->_logger->debug( $pre . "eof" );
+        $this->_logger->debug($pre . "eof");
     }
 
     /**
@@ -72,9 +86,8 @@ public function __construct(
     protected function _construct()
     {
         $pre = __METHOD__ . " : ";
-        $this->_logger->debug( $pre . 'bof' );
-        $this->_config = $this->payfastConfigFactory->create()->setMethod( $this->getMethodCode() );
-        parent::_construct();
+        $this->_logger->debug($pre . 'bof');
+        $this->_config = $this->payfastConfigFactory->create()->setMethod($this->getMethodCode());
     }
 
     /**
@@ -85,12 +98,8 @@ protected function _construct()
     public function getMethodCode()
     {
         $pre = __METHOD__ . " : ";
-        $this->_logger->debug( $pre . 'bof' );
+        $this->_logger->debug($pre . 'bof');
 
         return $this->_methodCode;
     }
-
-
-
-
 }

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

@@ -0,0 +1,18 @@
+<?php namespace Payfast\Payfast\Block;
+
+use Magento\Framework\Phrase;
+use Magento\Payment\Block\ConfigurableInfo;
+
+class Info extends ConfigurableInfo
+{
+    /**
+     * Returns label
+     *
+     * @param  string $field
+     * @return Phrase
+     */
+    protected function getLabel($field): Phrase
+    {
+        return __($field);
+    }
+}

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

@@ -6,27 +6,28 @@
  */
 namespace Payfast\Payfast\Block\Payment;
 
+use Magento\Framework\View\Element\Template\Context;
+use Payfast\Payfast\Model\InfoFactory;
+
 /**
  * PayFast common payment info block
  * Uses default templates
  */
 class Info extends \Magento\Payment\Block\Info
 {
     /**
-     * @var \Payfast\Payfast\Model\InfoFactory
+     * @var InfoFactory
      */
     protected $_payfastInfoFactory;
 
     /**
-     * @param \Magento\Framework\View\Element\Template\Context $context
-     * @param \Magento\Payment\Model\Config $paymentConfig
-     * @param \Payfast\Payfast\Model\InfoFactory $payfastInfoFactory
-     * @param array $data
+     * @param Context     $context
+     * @param InfoFactory $payfastInfoFactory
+     * @param array       $data
      */
     public function __construct(
-        \Magento\Framework\View\Element\Template\Context $context,
-        \Magento\Payment\Model\Config $paymentConfig,
-        \Payfast\Payfast\Model\InfoFactory $payfastInfoFactory,
+        Context $context,
+        InfoFactory $payfastInfoFactory,
         array $data = []
     ) {
         $this->_payfastInfoFactory = $payfastInfoFactory;

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

@@ -7,47 +7,61 @@
 
 namespace Payfast\Payfast\Block\Payment;
 
+use Magento\Checkout\Model\Session;
+use Magento\Framework\Filesystem\Directory\ReadFactory;
+use Magento\Framework\Module\Dir\Reader;
+use Magento\Framework\View\Element\Template;
+use Magento\Framework\View\Element\Template\Context;
+use Magento\Sales\Model\OrderFactory;
+use Payfast\Payfast\Helper\Data;
+use Payfast\Payfast\Model\Payfast;
 
-class Request extends \Magento\Framework\View\Element\Template
+class Request extends Template
 {
 
-    /** @var \Payfast\Payfast\Model\Payfast $_paymentMethod*/
+    /**
+     * @var Payfast $_paymentMethod
+     */
     protected $_paymentMethod;
 
     /**
-     * @var \Magento\Sales\Model\OrderFactory
+     * @var OrderFactory
      */
     protected $_orderFactory;
 
     /**
-     * @var \Magento\Checkout\Model\Session
+     * @var Session
      */
     protected $_checkoutSession;
 
-    /** @var \Magento\Framework\Filesystem\Directory\ReadFactory  $readFactory*/
+    /**
+     * @var ReadFactory  $readFactory
+     */
     protected $readFactory;
 
-    /** @var \Magento\Framework\Module\Dir\Reader $reader */
+    /**
+     * @var Reader $reader
+     */
     protected $reader;
 
     /**
-     * @param \Magento\Framework\View\Element\Template\Context $context
-     * @param \Magento\Sales\Model\OrderFactory $orderFactory
-     * @param \Magento\Checkout\Model\Session $checkoutSession
-     * @param \Payfast\Payfast\Helper\Data $pfHelper
-     * @param \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory
-     * @param \Magento\Framework\Module\Dir\Reader $reader
-     * @param \Payfast\Payfast\Model\Payfast $paymentMethod
-     * @param array $data
+     * @param Context      $context
+     * @param OrderFactory $orderFactory
+     * @param Session      $checkoutSession
+     * @param Data         $pfHelper
+     * @param ReadFactory  $readFactory
+     * @param Reader       $reader
+     * @param Payfast      $paymentMethod
+     * @param array        $data
      */
     public function __construct(
-        \Magento\Framework\View\Element\Template\Context $context,
-        \Magento\Sales\Model\OrderFactory $orderFactory,
-        \Magento\Checkout\Model\Session $checkoutSession,
-        \Payfast\Payfast\Helper\Data $pfHelper,
-        \Magento\Framework\Filesystem\Directory\ReadFactory $readFactory,
-        \Magento\Framework\Module\Dir\Reader $reader,
-        \Payfast\Payfast\Model\Payfast $paymentMethod,
+        Context $context,
+        OrderFactory $orderFactory,
+        Session $checkoutSession,
+        Data $pfHelper,
+        ReadFactory $readFactory,
+        Reader $reader,
+        Payfast $paymentMethod,
         array $data = []
     ) {
         $this->_hssHelper = $pfHelper;
@@ -63,14 +77,13 @@ public function __construct(
     public function _prepareLayout()
     {
         $this->setMessage('Redirecting to Payfast')
-            ->setId( 'payfast_checkout' )
-            ->setName( 'payfast_checkout' )
-            ->setFormMethod( 'POST' )
+            ->setId('payfast_checkout')
+            ->setName('payfast_checkout')
+            ->setFormMethod('POST')
             ->setFormAction($this->_paymentMethod->getPayFastUrl())
             ->setFormData($this->_paymentMethod->getStandardCheckoutFormFields())
             ->setSubmitForm('<script type="text/javascript">document.getElementById( "payfast_checkout" ).submit();</script>');
 
         return parent::_prepareLayout(); // TODO: Change the autogenerated stub
     }
-
 }