Merge pull request #344 - Alert customer when key configuration is missi

[ch10558] Alert customer when key configuration is missing

Author: jdeeburke

woocommerce/changelog.txt

@@ -3,6 +3,7 @@
 2019.nn.nn - version 5.4.2-dev.1
  * Tweak - Add replacement helper methods to get the current screen in WordPress and check the screen ID
  * Misc - Change SV_WC_Payment_Gateway::is_configured() from protected to public
+ * Misc - Add admin notice when a gateway is enabled but is not configured and is unable to take payments
 
 2019.08.06 - version 5.4.1
  * Misc - Add a configurable admin notice for plugins running deprecated WooCommerce versions

woocommerce/payment-gateway/class-sv-wc-payment-gateway-plugin.php

@@ -568,6 +568,9 @@ public function add_delayed_admin_notices() {
 
 		// add notices about enabled debug logging
 		$this->add_debug_setting_notices();
+
+		// add notices about gateways not being configured
+		$this->add_gateway_not_configured_notices();
 	}
 
 
@@ -723,6 +726,25 @@ protected function add_debug_setting_notices() {
 	}
 
 
+	/**
+	 * Adds notices about gateways not being configured.
+	 *
+	 * @since 5.4.2-dev.1
+	 */
+	protected function add_gateway_not_configured_notices() {
+
+		foreach ( $this->get_gateways() as $gateway ) {
+
+			if ( $gateway->is_enabled() && ! $gateway->is_configured() && ! $gateway->inherit_settings() ) {
+
+				$this->get_admin_notice_handler()->add_admin_notice( $gateway->get_not_configured_error_message(), $gateway->get_id() . '-not-configured', [
+					'notice_class' => 'error',
+				] );
+			}
+		}
+	}
+
+
 	/** Integration methods ***************************************************/
 
 

woocommerce/payment-gateway/class-sv-wc-payment-gateway.php

@@ -4152,6 +4152,27 @@ public function get_checkout_order_received_order_id() {
 	}
 
 
+	/**
+	 * Returns the error message for display if the gateway is not configured.
+	 *
+	 * @since 5.4.2-dev.1
+	 *
+	 * @return string
+	 */
+	public function get_not_configured_error_message() {
+
+		return sprintf(
+			/* translators: %1$s - gateway name, %2$s - <a> tag, %3$s - </a> tag, %4$s - <a> tag, %5$s - </a> tag */
+			__( 'Heads up! %1$s is not fully configured and cannot accept payments. Please %2$sreview the documentation%3$s and configure the %4$sgateway settings%5$s.', 'woocommerce-plugin-framework' ),
+			$this->get_method_title(),
+			'<a href="' . $this->get_plugin()->get_documentation_url() . '" target="_blank">',
+			'</a>',
+			'<a href="' . $this->get_plugin()->get_settings_url( $this->get_id() ) . '">',
+			'</a>'
+		);
+	}
+
+
 	/** Deprecated Methods ********************************************************************************************/