Merge pull request #26 from AppInlet/release/1.8.0

[1.8.0]

Author: bruce-atkinson

CHANGELOG.md

@@ -1,22 +1,33 @@
 # Changelog
 
-## [1.7.0](https://github.com/Payfast/mod-gravityforms/releases/tag/v1.7.0)
+## [1.8.0](https://github.com/Payfast/gravityforms-aggregation/releases/tag/v1.8.0)
+
+### Added
+
+- Updated Common Library to version 1.4.0.
+- Revised configuration branding to Payfast Aggregation.
+
+### Fixed
+
+- Resolved an issue where certain subscription forms were failing to process payments.
+
+## [1.7.0](https://github.com/Payfast/gravityforms-aggregation/releases/tag/v1.7.0)
 
 ### Added
 
 - Enhanced plugin compatibility with WordPress Marketplace by adhering to updated code quality standards, improving
   performance and security.
 - Upgraded Payfast Common Library to version 1.4.0.
 
-## [1.6.0](https://github.com/Payfast/mod-gravityforms/releases/tag/v1.6.0)
+## [1.6.0](https://github.com/Payfast/gravityforms-aggregation/releases/tag/v1.6.0)
 
 ### Added
 
 - Tested with WordPress 6.7.1 and Gravity Forms 2.9.1.
 - Code standards for PHP 8.2.
 - Updated the Payfast Common Library.
 
-## [1.5.5](https://github.com/Payfast/mod-gravityforms/releases/tag/v1.5.5)
+## [1.5.5](https://github.com/Payfast/gravityforms-aggregation/releases/tag/v1.5.5)
 
 ### Added
 
@@ -26,7 +37,7 @@
 
 - Improved compatibility with other gateways.
 
-## [1.5.4](https://github.com/Payfast/mod-gravityforms/releases/tag/v1.5.4)
+## [1.5.4](https://github.com/Payfast/gravityforms-aggregation/releases/tag/v1.5.4)
 
 ### Added
 
@@ -42,7 +53,7 @@
 
 - Bug fixes and improvements.
 
-## [1.5.3](https://github.com/Payfast/mod-gravityforms/releases/tag/v1.5.3)
+## [1.5.3](https://github.com/Payfast/gravityforms-aggregation/releases/tag/v1.5.3)
 
 ### Added
 

README.md

@@ -1,16 +1,16 @@
-# mod-gravityforms
+# gravityforms-aggregation
 
-## Payfast module v1.7.0 for Gravity Forms v2.9.13
+## Payfast Aggregation module v1.8.0 for Gravity Forms v2.9.17
 
-This is the Payfast module for Gravity Forms. Please feel free
+This is the Payfast Aggregation module for Gravity Forms. Please feel free
 to [contact the Payfast support team](https://payfast.io/contact/) should you require any assistance.
 
 ## Installation
 
 1. Log in to your WordPress Admin panel.
 2. Navigate to **Plugins > Add New > Upload Plugin**.
 3. Click **Choose File** and select
-   **[gravityformspayfast.zip](https://github.com/Payfast/mod-gravityforms/releases/download/v1.7.0/gravityformspayfast.zip)**.
+   **[gravityformspayfast.zip](https://github.com/Payfast/gravityforms-aggregation/releases/download/v1.8.0/gravityformspayfast.zip)**.
 4. Click **Install Now**.
 5. Click **Activate Plugin**.
    5. Go to **Forms** -> **Settings**, under **Default Currency**, select **South African Rand** and click 

gravityformspayfast/class-gf-payfast.php

@@ -22,8 +22,8 @@ class GFPayFast extends GFPaymentAddOn
     protected $_path = 'gravityformspayfast/payfast.php';
     protected $_full_path = __FILE__;
     protected $_url = 'http://www.gravityforms.com';
-    protected $_title = 'Gravity Forms Payfast Add-On';
-    protected $_short_title = 'Payfast';
+    protected $_title = 'Gravity Forms Payfast Aggregation Add-On';
+    protected $_short_title = 'Payfast Aggregation';
     protected $_supports_callbacks = true;
     protected $_capabilities = array('gravityforms_payfast', 'gravityforms_payfast_uninstall');
     // Members plugin integration
@@ -35,7 +35,7 @@ class GFPayFast extends GFPaymentAddOn
     // Automatic upgrade enabled
     private $productionUrl = 'https://www.payfast.co.za/eng/process/';
     private $sandboxUrl = 'https://sandbox.payfast.co.za/eng/process/';
-    private $_pf_gf_module_ver = '1.7.0';
+    private $_pf_gf_module_ver = '1.8.0';
 
     public static function get_instance()
     {
@@ -122,7 +122,7 @@ public function feed_list_no_item_message()
         if (!rgar($settings, 'gf_payfast_configured')) {
             return sprintf(
             // translators: 1: opening anchor tag to Payfast settings, 2: closing anchor tag.
-                __('To get started, configure your %1$sPayfast Settings%2$s!', 'gravityformspayfast'),
+                __('To get started, configure your %1$sPayfast Aggregation Settings%2$s!', 'gravityformspayfast'),
                 '<a href="' . admin_url('admin.php?page=gf_settings&subview=' . $this->_slug) . '">',
                 '</a>'
             );
@@ -1039,23 +1039,23 @@ function (response) {
             <h1><?php
                 printf(
                 // translators: %1$s and %s are the opening and closing <h1> tags for the Payfast link.
-                    esc_html__('Payfast Add-On v%s', 'gravityformspayfast'),
+                    esc_html__('Payfast Aggregation Add-On v%s', 'gravityformspayfast'),
                     esc_html($this->_pf_gf_module_ver)
                 ) ?></h1>
             <div class="about-text"><?php
                 esc_html_e(
-                    'Thank you for updating! The new version of the Gravity Forms Payfast Add-On makes changes to how you manage your Payfast integration.',
+                    'Thank you for updating! The new version of the Gravity Forms Payfast Aggregation Add-On makes changes to how you manage your Payfast integration.',
                     'gravityformspayfast'
                 ) ?></div>
             <div class="changelog">
                 <hr/>
                 <div class="feature-section col two-col">
                     <div class="col-1">
                         <h3><?php
-                            esc_html_e('Manage Payfast Contextually', 'gravityformspayfast') ?></h3>
+                            esc_html_e('Manage Payfast Aggregation Contextually', 'gravityformspayfast') ?></h3>
                         <p><?php
                             esc_html_e(
-                                'Payfast Feeds are now accessed via the Payfast sub-menu within the Form Settings for the Form you would like to integrate Payfast with.',
+                                'Payfast Aggregation Feeds are now accessed via the Payfast Aggregation sub-menu within the Form Settings for the Form you would like to integrate Payfast Aggregation with.',
                                 'gravityformspayfast'
                             ) ?></p>
                     </div>
@@ -1156,7 +1156,7 @@ public function admin_edit_payment_status_details($form_id, $lead)
         ?>
         <div id="edit_payment_status_details" style="display:block">
             <table>
-                <caption>Edit Payfast payment status details</caption>
+                <caption>Edit Payfast Aggregation payment status details</caption>
                 <tr>
                     <th scope="col">Payment Information</th>
                 </tr>
@@ -1648,12 +1648,13 @@ public function paymentStatus(
                             $amountGross,
                             $paymentId
                         ),
+
                     ];
 
                     $payfastRequest->pflog('- Log subscription payment');
                     $this->insertTransaction($paymentId, 'payment', $transactionId, $action['amount']);
                     $payfastRequest->pflog('- Log subscription payment');
-                    GFFormsModel::add_note($paymentId, 0, 'Payfast', $action['note'], 'success');
+                    GFFormsModel::add_note($paymentId, 0, 'Payfast Aggregation', $action['note'], 'success');
                 }
                 $this->sendNotifications(
                     $sendAdminMail,
@@ -1678,7 +1679,7 @@ public function paymentStatus(
                     $pfData['m_payment_id']
                 );
                 GFAPI::update_entry_property($pfData['m_payment_id'], 'payment_status', 'Cancelled');
-                GFFormsModel::add_note($pfData['m_payment_id'], 0, 'Payfast', $note, 'Cancelled');
+                GFFormsModel::add_note($pfData['m_payment_id'], 0, 'Payfast Aggregation', $note, 'Cancelled');
 
                 // Perform any custom actions
                 do_action('gform_payfast_payment_cancelled', $pfData);

gravityformspayfast/classes/PfGfForm.php

@@ -14,43 +14,43 @@ public static function getFields(): array
         return array(
             array(
                 'name'     => 'payfastMerchantId',
-                'label'    => __('Payfast Merchant ID ', 'gravityformspayfast'),
+                'label'    => __('Merchant ID ', 'gravityformspayfast'),
                 'type'     => 'text',
                 'class'    => 'medium',
                 'required' => false,
                 'tooltip'  => GFPayFast::H6_TAG . __(
-                        'Payfast Merchant ID',
+                        'Merchant ID',
                         'gravityformspayfast'
                     ) . GFPayFast::H6_TAG_END . __(
-                                  'Enter your Payfast Merchant ID.',
+                                  'Enter your Merchant ID.',
                                   'gravityformspayfast'
                               )
             ),
             array(
                 'name'     => 'payfastMerchantKey',
-                'label'    => __('Payfast Merchant Key ', 'gravityformspayfast'),
+                'label'    => __('Merchant Key ', 'gravityformspayfast'),
                 'type'     => 'text',
                 'class'    => 'medium',
                 'required' => false,
                 'tooltip'  => GFPayFast::H6_TAG . __(
-                        'Payfast Merchant Key',
+                        'Merchant Key',
                         'gravityformspayfast'
                     ) . GFPayFast::H6_TAG_END . __(
-                                  'Enter your Payfast Merchant Key.',
+                                  'Enter your Merchant Key.',
                                   'gravityformspayfast'
                               )
             ),
             array(
                 'name'     => 'passphrase',
-                'label'    => __('Payfast Passphrase ', 'gravityformspayfast'),
+                'label'    => __('Passphrase ', 'gravityformspayfast'),
                 'type'     => 'text',
                 'class'    => 'medium',
                 'required' => false,
                 'tooltip'  => GFPayFast::H6_TAG . __(
-                        'Payfast Passphrase',
+                        'Passphrase',
                         'gravityformspayfast'
                     ) . GFPayFast::H6_TAG_END . __(
-                                  'Only enter a passphrase if it is set on your Payfast account.',
+                                  'Only enter a passphrase if it is set on your Payfast Aggregation account.',
                                   'gravityformspayfast'
                               )
             ),
@@ -73,7 +73,7 @@ public static function getFields(): array
                 'horizontal'    => true,
                 'default_value' => 'production',
                 'tooltip'       => GFPayFast::H6_TAG . __('Mode', 'gravityformspayfast') . GFPayFast::H6_TAG_END . __(
-                        'Select Production to enable live transactions. Select Test for testing with the Payfast Sandbox.',
+                        'Select Production to enable live transactions. Select Test for testing with Sandbox.',
                         'gravityformspayfast'
                     )
             ),
@@ -190,7 +190,7 @@ public function getPayfastConfigurationInstructions(): array
                        sprintf(
                        // translators: %1$s and %2$s are the opening and closing <a> tags for the Payfast link.
                            __(
-                               'You will need a Payfast account in order to use the Payfast Add-On. Navigate to %1$sPayfast%2$s to register.',
+                               'You will need an account in order to use the Payfast Aggregation Add-On. Navigate to %1$sPayfast%2$s to register.',
                                'gravityformspayfast'
                            ),
                            '<a href="https://payfast.io" target="_blank">',
@@ -199,29 +199,29 @@ public function getPayfastConfigurationInstructions(): array
                        '</p>
             <ul>
                 <li>' . __(
-                           'The Payfast settings are configured per form. Navigate to \'Forms\' -> select \'Settings\' for the form, and select the \'Payfast\' tab.',
+                           'The Payfast Aggregation settings are configured per form. Navigate to \'Forms\' -> select \'Settings\' for the form, and select the \'Payfast Aggregation\' tab.',
                            'gravityformspayfast'
                        ) . '</li>' .
                        '<li>' . __(
-                           'From there, click \'Add New\' to configure Payfast feed settings for the currently selected form.',
+                           'From there, click \'Add New\' to configure Payfast Aggregation feed settings for the currently selected form.',
                            'gravityformspayfast'
                        ) . '</li>' .
                        '</ul>
             <p style="text-align: left;">' .
                        __(
-                           'Enable \'Debug\' below to log the server-to-server communication between Payfast and your website, for each transaction. The log file for debugging can be found at /wp-content/plugins/gravityformspayfast/payfast.log. If activated, be sure to protect it by adding an .htaccess file in the same directory. If not, the file will be readable by anyone. ',
+                           'Enable \'Debug\' below to log the server-to-server communication between Payfast Aggregation and your website, for each transaction. The log file for debugging can be found at /wp-content/plugins/gravityformspayfast/payfast.log. If activated, be sure to protect it by adding an .htaccess file in the same directory. If not, the file will be readable by anyone. ',
                            'gravityformspayfast'
                        ) .
                        '</p>';
 
         return array(
             array(
-                'title'       => esc_html__('How to configure Payfast', 'gravityformspayfast'),
+                'title'       => esc_html__('How to configure Payfast Aggregation', 'gravityformspayfast'),
                 'description' => $description,
                 'fields'      => array(
                     array(
                         'name'    => 'gf_payfast_debug',
-                        'label'   => esc_html__('Payfast Debug', 'gravityformspayfast'),
+                        'label'   => esc_html__('Debug', 'gravityformspayfast'),
                         'type'    => 'checkbox',
                         'choices' => array(
                             array(
@@ -251,7 +251,7 @@ public function getCancelUrl(): array
                 'class'    => 'medium',
                 'required' => false,
                 'tooltip'  => GFPayFast::H6_TAG . __('Cancel URL', 'gravityformspayfast') . GFPayFast::H6_TAG_END . __(
-                        'Enter the URL the user should be sent to should they cancel before completing their payment. It currently defaults to the Payfast website.',
+                        'Enter the URL the user should be sent to should they cancel before completing their payment. It currently defaults to the Payfast Aggregation website.',
                         'gravityformspayfast'
                     )
             ),

gravityformspayfast/classes/PfGfUtilities.php

@@ -201,34 +201,38 @@ public function includeVariablesIfSubscription($meta, array $varArray, $entry, $
                 'custom_str4'       => gmdate('Y-m-d'),
                 'subscription_type' => 1,
                 'billing_date'      => gmdate('Y-m-d'),
-                'frequency'         => rgar($meta, 'frequency'),
-                'cycles'            => rgar($meta, 'cycles'),
             ]);
 
-            $recurringAmountField = $meta['recurring_amount_field'] ?? null;
 
-            if ($recurringAmountField !== 'form_total') {
-                if (!empty($entry[$recurringAmountField . '.2'])) {
-                    // Case: Specific recurring amount field with decimal value
-                    $varArray['recurring_amount'] = str_replace(
-                        ",",
-                        "",
-                        substr($entry[$recurringAmountField . '.2'], 1)
-                    );
-                } elseif (!empty($entry[$recurringAmountField])) {
-                    // Case: Specific recurring amount field without decimal value
-                    $varArray['recurring_amount'] = substr(
-                        $entry[$recurringAmountField],
-                        strpos($entry[$recurringAmountField], '|') + 1
-                    );
-                } else {
-                    // Fallback to order total
-                    $varArray['recurring_amount'] = GFCommon::get_order_total($form, $entry);
-                }
+        $recurringAmountField = $meta['recurring_amount_field'] ?? null;
+
+        if ($recurringAmountField !== 'form_total') {
+            if (!empty($entry[$recurringAmountField . '.2'])) {
+                // Case: Specific recurring amount field with decimal value
+                $varArray['recurring_amount'] = str_replace(
+                    ",",
+                    "",
+                    substr($entry[$recurringAmountField . '.2'], 1)
+                );
+            } elseif (!empty($entry[$recurringAmountField])) {
+                // Case: Specific recurring amount field without decimal value
+                $varArray['recurring_amount'] = substr(
+                    $entry[$recurringAmountField],
+                    strpos($entry[$recurringAmountField], '|') + 1
+                );
             } else {
-                // Case: Recurring amount is based on form total
+                // Fallback to order total
                 $varArray['recurring_amount'] = GFCommon::get_order_total($form, $entry);
             }
+        } else {
+            // Case: Recurring amount is based on form total
+            $varArray['recurring_amount'] = GFCommon::get_order_total($form, $entry);
+        }
+
+        $varArray = array_merge($varArray, [
+                'frequency'         => rgar($meta, 'frequency'),
+                'cycles'            => rgar($meta, 'cycles'),
+            ]);
         }
 
         return array($varArray, $entry);