Version 5.6.3 release (#26)

Co-authored-by: Tiku Okoye <tiku@paystack.com>
Co-authored-by: Tiku <57668978+tiku-paystack@users.noreply.github.com>
Co-authored-by: tolu-paystack <60101507+tolu-paystack@users.noreply.github.com>
Co-authored-by: tolu-paystack <tolu@paystack.com>

Author: 3 people

.gitignore

@@ -0,0 +1,2 @@
+.DS_Store
+.idea

README.md

@@ -10,7 +10,7 @@
 
 **Tested up to:** 5.4
 
-**Stable tag:** 5.6.2
+**Stable tag:** 5.6.3
 
 **License:** GPLv2 or later
 
@@ -103,7 +103,7 @@ You can also follow me on Twitter! **[@tubiz](https://twitter.com/tubiz)**
 
 
 ### Configure the plugin
-To configure the plugin, go to __WooCommerce > Settings__ from the left hand menu, then click __Checkout__ from the top tab. You will see __Paystack__ as part of the available Checkout Options. Click on it to configure the payment gateway.
+To configure the plugin, go to __WooCommerce > Settings__ from the left hand menu, then click __Checkout__ from the top tab. You will see __Paystack__ as part of the available Checkout Options. Click on it to configure the payment gateway.
 
 * __Enable/Disable__ - check the box to enable Paystack Payment Gateway.
 * __Title__ - allows you to determine what your customers will see this payment option as on the checkout page.
@@ -145,80 +145,91 @@ To configure the plugin, go to __WooCommerce > Settings__ from the left hand me
 
 ## Changelog
 
-### 5.6.2 - March 12, 2020 =
+### 5.6.3 - July 27, 2020
+*   New: Add support for ZAR as an accepted currency.
+*   New: Add setting to remove "Cancel order & restore cart" button.
+*   New: Minimum PHP version: 5.6
+*   New: Minimum WooCommerce supported version: 3.0.0
+*   Misc: Add icon for Ghanaian payment methods to checkout.
+*   Misc: Remove GBP as an accepted currency.
+*   Fix: Cart not fully cleared after successful payment.
+*   Fix: Selected payment icons not displayed on custom gateways settings page.
+*   Tweak: WooCommerce 4.3 compatibility.
+
+### 5.6.2 - March 12, 2020
 *   Update: WooCommerce 4.0 compatibility.
 
-### 5.6.1 - November 13, 2019 ###
+### 5.6.1 - November 13, 2019
 *   Update: WooCommerce 3.8 compatibility.
 
-### 5.6.0 - August 7, 2019 ###
+### 5.6.0 - August 7, 2019
 *   New: Support for refunds via Paystack from the order details screen.
 *   New: Log successful transaction to Paystack metrics tracker.
 *   New: Add support for sending additional order details to Paystack when making payment using a saved card.
 *   New: Add support for sending additional order details to Paystack when a subscription payment is renewed.
 *   Update: WC 3.7 compatibility.
 
-### 5.5.0 - May 27, 2019 =
+### 5.5.0 - May 27, 2019
 *   Misc: Renamed Diamond Bank to Access Bank (Diamond)
 *   Tweak: Significant cleanup of code formatting and adherence of WordPress coding standards
 *   New: Support for translation
 
-### 5.4.2 - February 13, 2019 =
+### 5.4.2 - February 13, 2019
 *   Misc: Remove Paystack fee and Paystack payout amount on the order details page
 
-### 5.4.1 - February 1, 2019 ###
+### 5.4.1 - February 1, 2019
 *   Fix: Split payment not working properly when the split payment transaction charge setting field is empty
 
-### 5.4.0 - December 9, 2018 ###
+### 5.4.0 - December 9, 2018
 *   New: Add support for Paystack split payments
 *   New: Display Paystack fee and Paystack payout amount on the order details page
 *   Misc: Add support for WooCommerce 3.5
 *   Misc: Renamed Skye Bank Plc to Polaris Bank Limited
 *   Misc: Add new banks (ALAT by WEMA, ASO Savings and Loans, MainStreet Bank & Ekondo Microfinance Bank) to Allowed Banks Card list
 *   Misc: Add new banks logos (ALAT by WEMA, ASO Savings and Loans, MainStreet Bank & Ekondo Microfinance Bank) to Payment Icons list
 
-### 5.3.1 - July 26, 2018 ###
+### 5.3.1 - July 26, 2018
 *	Fix: The bank payment channel not showing in the default gateway
 
-### 5.3.0 - June 2, 2018 =
+### 5.3.0 - June 2, 2018
 *	Fix: Saved cards feature not working in the custom gateways
 *	Fix: Custom gateways not processing automatic renewal payments via WooCommerce Subscriptions plugin
 
-### 5.2.1 - June 1, 2018 =
+### 5.2.1 - June 1, 2018
 *	Misc: Add support for WooCommerce 3.4
 
-### 5.2.0 - May 18, 2018 ###
+### 5.2.0 - May 18, 2018
 *	New: Add support for multiple subscriptions purchase using WooCommerce Subscriptions plugin
 *	Fix: Deprecated functions in the Tbz_WC_Gateway_Paystack_Subscription class
 
-### 5.1.0 - March 27, 2018 ###
+### 5.1.0 - March 27, 2018
 *	New: Add support for GHS (Ghanaian cedi) currency
 * 	Fix: Deprecated WooCommerce 2.X functions
 
-### 5.0.2 - September 15, 2017 ###
+### 5.0.2 - September 15, 2017
 *	Fix: Illegal string offset warnings when plugin is newly installed
 
-### 5.0.1 - September 14, 2017 ###
+### 5.0.1 - September 14, 2017
 *	Fix: Fatal error on the checkout page if WooCommerce 2.6.14 and below is installed
 
-### 5.0.0 - August 29, 2017 ###
+### 5.0.0 - August 29, 2017
 *	New: Add support for Paystack custom filters
 *	New: Create additional Paystack gateways (max of 5) using different custom filters. You can create a gateway that accepts only Verve cards, a gateway that accepts only bank account payments, a gateway that accepts only GTB issued Mastercard.
 
-### 4.1.0 - July 7, 2017 ###
+### 4.1.0 - July 7, 2017
 *	Fix: Deprecated WooCommerce 2.X functions
 
-### 4.0.1 - April 10, 2017 ###
+### 4.0.1 - April 10, 2017
 * 	Fix: Fatal error if WooCommerce 2.6.14 and below is installed
 
-### 4.0.0 - April 10, 2017 ###
+### 4.0.0 - April 10, 2017
 * 	New: Add support for Paystack Inline Embed.
 *  	New: Add support for sending additional order details to Paystack
 
-### 3.1.1 - February 13, 2017 ###
+### 3.1.1 - February 13, 2017
 * 	New: Changed Paystack payment methods icon.
 
-### 3.1.0 - January 10, 2017 ###
+### 3.1.0 - January 10, 2017
 * 	New: Add support for USD and GBP currency. Note this has to be enabled by Paystack for your account before it can be used on your site.
 
 ### 3.0.0 - November 11, 2016
@@ -245,8 +256,8 @@ To configure the plugin, go to __WooCommerce > Settings__ from the left hand me
 
 ## Upgrade Notice
 
-### 5.6.2 ###
-*   WooCommerce 4.0 compatibility.
+### 5.6.3 ###
+*   Fixes.
 
 ## Screenshots ##
 
@@ -272,4 +283,4 @@ To configure the plugin, go to __WooCommerce > Settings__ from the left hand me
 
 ### 5. Manage saved cards from your account page
 ###
-![Screenshot 5](https://github.com/tubiz/woo-paystack/blob/master/assets/images/screenshot-5.png)
+![Screenshot 5](https://github.com/tubiz/woo-paystack/blob/master/assets/images/screenshot-5.png)

assets/images/paystack-gh.png

@@ -77,7 +77,7 @@ jQuery( function( $ ) {
 
 			$( ".wc-paystack-payment-icons" ).select2( {
 				templateResult: formatPaystackPaymentIcons,
-				templateSelection: formatPaystackPaymentIcons
+				templateSelection: formatPaystackPaymentIconDisplay
 			} );
 
 		}
@@ -87,12 +87,18 @@ jQuery( function( $ ) {
 		if ( !payment_method.id ) {
 			return payment_method.text;
 		}
+
 		var $payment_method = $(
 			'<span><img src=" ' + wc_paystack_admin_params.plugin_url + '/assets/images/' + payment_method.element.value.toLowerCase() + '.png" class="img-flag" style="height: 15px; weight:18px;" /> ' + payment_method.text + '</span>'
 		);
+
 		return $payment_method;
 	};
 
+	function formatPaystackPaymentIconDisplay( payment_method ) {
+		return payment_method.text;
+	};
+
 	wc_paystack_admin.init();
 
 } );

assets/js/paystack-admin.js

@@ -46,6 +46,13 @@ public function init_form_fields() {
 					'embed'  => __( 'Inline Embed', 'woo-paystack' ),
 				),
 			),
+			'remove_cancel_order_button'       => array(
+				'title'       => __( 'Remove Cancel Order & Restore Cart Button', 'woo-paystack' ),
+				'label'       => __( 'Remove the cancel order & restore cart button on the pay for order page', 'woo-paystack' ),
+				'type'        => 'checkbox',
+				'description' => '',
+				'default'     => 'no',
+			),
 			'split_payment'                    => array(
 				'title'       => __( 'Split Payment', 'woo-paystack' ),
 				'label'       => __( 'Enable Split Payment', 'woo-paystack' ),
@@ -345,7 +352,8 @@ public function payment_icons() {
 			'mastercard'    => __( 'Mastercard', 'woo-paystack' ),
 			'paystackwhite' => __( 'Secured by Paystack White', 'woo-paystack' ),
 			'paystackblue'  => __( 'Secured by Paystack Blue', 'woo-paystack' ),
-			'paystack-wc'   => __( 'Paystack', 'woo-paystack' ),
+			'paystack-wc'   => __( 'Paystack Nigeria', 'woo-paystack' ),
+			'paystack-gh'   => __( 'Paystack Ghana', 'woo-paystack' ),
 			'access'        => __( 'Access Bank', 'woo-paystack' ),
 			'alat'          => __( 'ALAT by WEMA', 'woo-paystack' ),
 			'aso'           => __( 'ASO Savings and Loans', 'woo-paystack' ),

assets/js/paystack-admin.min.js

@@ -62,6 +62,13 @@ class WC_Gateway_Paystack extends WC_Payment_Gateway_CC {
 	 */
 	public $split_payment;
 
+	/**
+	 * Should the cancel & remove order button be removed on the pay for order page.
+	 *
+	 * @var bool
+	 */
+	public $remove_cancel_order_button;
+
 	/**
 	 * Paystack sub account code.
 	 *
@@ -199,10 +206,11 @@ public function __construct() {
 
 		$this->saved_cards = $this->get_option( 'saved_cards' ) === 'yes' ? true : false;
 
-		$this->split_payment       = $this->get_option( 'split_payment' ) === 'yes' ? true : false;
-		$this->subaccount_code     = $this->get_option( 'subaccount_code' );
-		$this->charges_account     = $this->get_option( 'split_payment_charge_account' );
-		$this->transaction_charges = $this->get_option( 'split_payment_transaction_charge' );
+		$this->split_payment              = $this->get_option( 'split_payment' ) === 'yes' ? true : false;
+		$this->remove_cancel_order_button = $this->get_option( 'remove_cancel_order_button' ) === 'yes' ? true : false;
+		$this->subaccount_code            = $this->get_option( 'subaccount_code' );
+		$this->charges_account            = $this->get_option( 'split_payment_charge_account' );
+		$this->transaction_charges        = $this->get_option( 'split_payment_transaction_charge' );
 
 		$this->custom_metadata = $this->get_option( 'custom_metadata' ) === 'yes' ? true : false;
 
@@ -250,9 +258,9 @@ public function __construct() {
 	 */
 	public function is_valid_for_use() {
 
-		if ( ! in_array( get_woocommerce_currency(), apply_filters( 'woocommerce_paystack_supported_currencies', array( 'NGN', 'USD', 'GBP', 'GHS' ) ) ) ) {
+		if ( ! in_array( get_woocommerce_currency(), apply_filters( 'woocommerce_paystack_supported_currencies', array( 'NGN', 'USD', 'ZAR', 'GHS' ) ) ) ) {
 
-			$this->msg = sprintf( __( 'Paystack does not support your store currency. Kindly set it to either NGN (&#8358), GHS (&#x20b5;), USD (&#36;) or GBP (&#163;) <a href="%s">here</a>', 'woo-paystack' ), admin_url( 'admin.php?page=wc-settings&tab=general' ) );
+			$this->msg = sprintf( __( 'Paystack does not support your store currency. Kindly set it to either NGN (&#8358), GHS (&#x20b5;), USD (&#36;) or ZAR (R) <a href="%s">here</a>', 'woo-paystack' ), admin_url( 'admin.php?page=wc-settings&tab=general' ) );
 
 			return false;
 
@@ -267,7 +275,13 @@ public function is_valid_for_use() {
 	 */
 	public function get_icon() {
 
-		$icon = '<img src="' . WC_HTTPS::force_https_url( plugins_url( 'assets/images/paystack-wc.png', WC_PAYSTACK_MAIN_FILE ) ) . '" alt="cards" />';
+		$base_location = wc_get_base_location();
+
+		if ( 'GH' === $base_location['country'] ) {
+			$icon = '<img src="' . WC_HTTPS::force_https_url( plugins_url( 'assets/images/paystack-gh.png', WC_PAYSTACK_MAIN_FILE ) ) . '" alt="Paystack Payment Options" />';
+		} else {
+			$icon = '<img src="' . WC_HTTPS::force_https_url( plugins_url( 'assets/images/paystack-wc.png', WC_PAYSTACK_MAIN_FILE ) ) . '" alt="Paystack Payment Options" />';
+		}
 
 		return apply_filters( 'woocommerce_gateway_icon', $icon, $this->id );
 
@@ -421,6 +435,13 @@ public function init_form_fields() {
 				'description' => __( 'Enter your Live Public Key here.', 'woo-paystack' ),
 				'default'     => '',
 			),
+			'remove_cancel_order_button'       => array(
+				'title'       => __( 'Remove Cancel Order & Restore Cart Button', 'woo-paystack' ),
+				'label'       => __( 'Remove the cancel order & restore cart button on the pay for order page', 'woo-paystack' ),
+				'type'        => 'checkbox',
+				'description' => '',
+				'default'     => 'no',
+			),
 			'split_payment'                    => array(
 				'title'       => __( 'Split Payment', 'woo-paystack' ),
 				'label'       => __( 'Enable Split Payment', 'woo-paystack' ),
@@ -939,7 +960,7 @@ function_exists( 'wc_reduce_stock_levels' ) ? wc_reduce_stock_levels( $order_id
 
 					$this->save_subscription_payment_token( $order_id, $paystack_response );
 
-					wc_empty_cart();
+					WC()->cart->empty_cart();
 
 					return true;
 
@@ -997,14 +1018,21 @@ public function receipt_page( $order_id ) {
 
 			echo '<div id="paystackWooCommerceEmbedContainer"></div>';
 
-			echo '<div id="paystack_form"><form id="order_review" method="post" action="' . WC()->api_request_url( 'WC_Gateway_Paystack' ) . '"></form>
-				<a href="' . esc_url( $order->get_cancel_order_url() ) . '" style="text-align:center; color: #EF3315; display: block; outline: none;">' . __( 'Cancel order &amp; restore cart', 'woo-paystack' ) . '</a></div>';
+			echo '<div id="paystack_form"><form id="order_review" method="post" action="' . WC()->api_request_url( 'WC_Gateway_Paystack' ) . '"></form>';
+
+			if ( ! $this->remove_cancel_order_button ) {
+				echo '<a href="' . esc_url( $order->get_cancel_order_url() ) . '" style="text-align:center; color: #ef3315; display: block; outline: none;">' . __( 'Cancel order &amp; restore cart', 'woo-paystack' ) . '</a></div>';
+			}
 
 		} else {
 
 			echo '<p>' . __( 'Thank you for your order, please click the button below to pay with Paystack.', 'woo-paystack' ) . '</p>';
 
-			echo '<div id="paystack_form"><form id="order_review" method="post" action="' . WC()->api_request_url( 'WC_Gateway_Paystack' ) . '"></form><button class="button alt" id="paystack-payment-button">' . __( 'Pay Now', 'woo-paystack' ) . '</button> <a class="button cancel" href="' . esc_url( $order->get_cancel_order_url() ) . '">' . __( 'Cancel order &amp; restore cart', 'woo-paystack' ) . '</a></div>';
+			echo '<div id="paystack_form"><form id="order_review" method="post" action="' . WC()->api_request_url( 'WC_Gateway_Paystack' ) . '"></form><button class="button alt" id="paystack-payment-button">' . __( 'Pay Now', 'woo-paystack' ) . '</button>';
+
+			if ( ! $this->remove_cancel_order_button ) {
+				echo '  <a class="button cancel" href="' . esc_url( $order->get_cancel_order_url() ) . '">' . __( 'Cancel order &amp; restore cart', 'woo-paystack' ) . '</a></div>';
+			}
 
 		}
 
@@ -1115,7 +1143,7 @@ function_exists( 'wc_reduce_stock_levels' ) ? wc_reduce_stock_levels( $order_id
 
 					$this->save_card_details( $paystack_response, $order->get_user_id(), $order_id );
 
-					wc_empty_cart();
+					WC()->cart->empty_cart();
 
 				} else {
 
@@ -1220,7 +1248,7 @@ function_exists( 'wc_reduce_stock_levels' ) ? wc_reduce_stock_levels( $order_id
 
 				wc_add_notice( $notice, $notice_type );
 
-				wc_empty_cart();
+				WC()->cart->empty_cart();
 
 			} else {
 
@@ -1250,7 +1278,7 @@ function_exists( 'wc_reduce_stock_levels' ) ? wc_reduce_stock_levels( $order_id
 
 					$order->add_order_note( sprintf( __( 'Payment via Paystack successful (Transaction Reference: %s)', 'woo-paystack' ), $paystack_ref ) );
 
-					wc_empty_cart();
+					WC()->cart->empty_cart();
 
 				}
 			}