Merge branch '5.4.2-dev' into ch7127-add-standard-subscription-data-to-orders

Author: unfulvio

woocommerce/admin/abstract-sv-wc-plugin-admin-setup-wizard.php

@@ -145,9 +145,7 @@ protected function add_hooks() {
 	 */
 	public function add_admin_notices() {
 
-		$current_screen = get_current_screen();
-
-		if ( ( $current_screen && 'plugins' === $current_screen->id ) || $this->get_plugin()->is_plugin_settings() ) {
+		if ( Framework\SV_WC_Helper::is_current_screen( 'plugins' ) || $this->get_plugin()->is_plugin_settings() ) {
 
 			if ( $this->is_complete() && $this->get_documentation_notice_message() ) {
 				$notice_id = "wc_{$this->id}_docs";

woocommerce/changelog.txt

@@ -2,6 +2,9 @@
 
 2019.nn.nn - version 5.4.2-dev.1
  * Tweak - Add a standard set of subscription details to orders payment data set by a gateway
+ * 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/class-sv-wc-helper.php

@@ -956,6 +956,41 @@ public static function f_x( $text, $context ) {
 		/** Misc functions ****************************************************/
 
 
+		/**
+		 * Gets the WordPress current screen.
+		 *
+		 * @see get_current_screen() replacement which is always available, unlike the WordPress core function
+		 *
+		 * @since 5.4.2-dev.1
+		 *
+		 * @return \WP_Screen|null
+		 */
+		public static function get_current_screen() {
+			global $current_screen;
+
+			return $current_screen ?: null;
+		}
+
+
+		/**
+		 * Checks if the current screen matches a specified ID.
+		 *
+		 * This helps avoiding using the get_current_screen() function which is not always available,
+		 * or setting the substitute global $current_screen every time a check needs to be performed.
+		 *
+		 * @since 5.4.2-dev.1
+		 *
+		 * @param string $id id (or property) to compare
+		 * @param string $prop optional property to compare, defaults to screen id
+		 * @return bool
+		 */
+		public static function is_current_screen( $id, $prop = 'id' ) {
+			global $current_screen;
+
+			return isset( $current_screen->$prop ) && $id === $current_screen->$prop;
+		}
+
+
 		/**
 		 * Convert a 2-character country code into its 3-character equivalent, or
 		 * vice-versa, e.g.

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 ***************************************************/
 
 
@@ -822,7 +844,7 @@ public function subscriptions_maybe_edit_renewal_support_status( $html, $gateway
 	 */
 	public function subscriptions_add_renewal_support_status_inline_style() {
 
-		if ( SV_WC_Plugin_Compatibility::normalize_wc_screen_id() === get_current_screen()->id ) {
+		if ( SV_WC_Helper::is_current_screen( SV_WC_Plugin_Compatibility::normalize_wc_screen_id() ) ) {
 			wp_add_inline_style( 'woocommerce_admin_styles', '.sv-wc-payment-gateway-renewal-status-inactive{font-size:1.4em;display:block;text-indent:-9999px;position:relative;height:1em;width:1em;cursor:pointer}.sv-wc-payment-gateway-renewal-status-inactive:before{line-height:1;margin:0;position:absolute;width:100%;height:100%;content:"\e016";color:#ffba00;font-family:WooCommerce;speak:none;font-weight:400;font-variant:normal;text-transform:none;-webkit-font-smoothing:antialiased;text-indent:0;top:0;left:0;text-align:center}' );
 		}
 	}

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

@@ -1539,13 +1539,14 @@ public function is_available() {
 
 
 	/**
-	 * Returns true if the gateway is properly configured to perform transactions
+	 * Determines whether the gateway is properly configured to perform transactions.
 	 *
 	 * @since 1.0.0
-	 * @see SV_WC_Payment_Gateway::is_configured()
-	 * @return boolean true if the gateway is properly configured
+	 *
+	 * @return bool
 	 */
-	protected function is_configured() {
+	public function is_configured() {
+
 		// override this to check for gateway-specific required settings (user names, passwords, secret keys, etc)
 		return true;
 	}
@@ -4151,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 ********************************************************************************************/