woocommerce / woocommerce-gateway-stripe

includes/admin/class-wc-stripe-inbox-notes.php

Doc Comments +1 added lines

@@ -21,6 +21,7 @@
 
 	/**
 	 * Manage notes to show after Apple Pay domain verification.
+	 * @param boolean $verification_complete
 	 */
 	public static function notify_on_apple_pay_domain_verification( $verification_complete ) {
 		if ( ! class_exists( 'Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes' ) ) {

Spacing +38 added lines, -38 removed lines

@@ -1,5 +1,5 @@ 
 <?php
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -16,39 +16,39 @@ 
 	const FAILURE_NOTE_NAME = 'stripe-apple-pay-domain-verification-needed';
 
 	public function __construct() {
-		add_action( 'wc_stripe_apple_pay_post_setup_success', array( self::class, 'create_marketing_note' ) );
+		add_action('wc_stripe_apple_pay_post_setup_success', array(self::class, 'create_marketing_note'));
 	}
 
 	/**
 	 * Manage notes to show after Apple Pay domain verification.
 	 */
-	public static function notify_on_apple_pay_domain_verification( $verification_complete ) {
-		if ( ! class_exists( 'Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes' ) ) {
+	public static function notify_on_apple_pay_domain_verification($verification_complete) {
+		if ( ! class_exists('Automattic\WooCommerce\Admin\Notes\WC_Admin_Notes')) {
 			return;
 		}
 
-		if ( ! class_exists( 'WC_Data_Store' ) ) {
+		if ( ! class_exists('WC_Data_Store')) {
 			return;
 		}
 
-		if ( $verification_complete ) {
-			if ( self::should_show_marketing_note() && ! wp_next_scheduled( 'wc_stripe_apple_pay_post_setup_success' ) ) {
-				wp_schedule_single_event( time() + DAY_IN_SECONDS, 'wc_stripe_apple_pay_post_setup_success' );
+		if ($verification_complete) {
+			if (self::should_show_marketing_note() && ! wp_next_scheduled('wc_stripe_apple_pay_post_setup_success')) {
+				wp_schedule_single_event(time() + DAY_IN_SECONDS, 'wc_stripe_apple_pay_post_setup_success');
 			}
 
 			// If the domain verification completed after failure note was created, make sure it's marked as actioned.
-			$data_store       = WC_Data_Store::load( 'admin-note' );
-			$failure_note_ids = $data_store->get_notes_with_name( self::FAILURE_NOTE_NAME );
-			if ( ! empty( $failure_note_ids ) ) {
-				$note_id = array_pop( $failure_note_ids );
-				$note    = WC_Admin_Notes::get_note( $note_id );
-				if ( false !== $note && WC_Admin_Note::E_WC_ADMIN_NOTE_ACTIONED !== $note->get_status() ) {
-					$note->set_status( WC_Admin_Note::E_WC_ADMIN_NOTE_ACTIONED );
+			$data_store       = WC_Data_Store::load('admin-note');
+			$failure_note_ids = $data_store->get_notes_with_name(self::FAILURE_NOTE_NAME);
+			if ( ! empty($failure_note_ids)) {
+				$note_id = array_pop($failure_note_ids);
+				$note    = WC_Admin_Notes::get_note($note_id);
+				if (false !== $note && WC_Admin_Note::E_WC_ADMIN_NOTE_ACTIONED !== $note->get_status()) {
+					$note->set_status(WC_Admin_Note::E_WC_ADMIN_NOTE_ACTIONED);
 					$note->save();
 				}
 			}
 		} else {
-			if ( empty( $failure_note_ids ) ) {
+			if (empty($failure_note_ids)) {
 				self::create_failure_note();
 			}
 		}
@@ -60,23 +60,23 @@ 
 	public static function should_show_marketing_note() {
 		// Display to US merchants only.
 		$base_location = wc_get_base_location();
-		if ( ! $base_location || 'US' !== $base_location['country'] ) {
+		if ( ! $base_location || 'US' !== $base_location['country']) {
 			return false;
 		}
 
 		// Make sure Apple Pay is enabled and setup is successful.
-		$stripe_settings       = get_option( 'woocommerce_stripe_settings', array() );
-		$stripe_enabled        = isset( $stripe_settings['enabled'] ) && 'yes' === $stripe_settings['enabled'];
-		$button_enabled        = isset( $stripe_settings['payment_request'] ) && 'yes' === $stripe_settings['payment_request'];
-		$verification_complete = isset( $stripe_settings['apple_pay_domain_set'] ) && 'yes' === $stripe_settings['apple_pay_domain_set'];
-		if ( ! $stripe_enabled || ! $button_enabled || ! $verification_complete ) {
+		$stripe_settings       = get_option('woocommerce_stripe_settings', array());
+		$stripe_enabled        = isset($stripe_settings['enabled']) && 'yes' === $stripe_settings['enabled'];
+		$button_enabled        = isset($stripe_settings['payment_request']) && 'yes' === $stripe_settings['payment_request'];
+		$verification_complete = isset($stripe_settings['apple_pay_domain_set']) && 'yes' === $stripe_settings['apple_pay_domain_set'];
+		if ( ! $stripe_enabled || ! $button_enabled || ! $verification_complete) {
 			return false;
 		}
 
 		// Make sure note doesn't already exist.
-		$data_store       = WC_Data_Store::load( 'admin-note' );
-		$success_note_ids = $data_store->get_notes_with_name( self::SUCCESS_NOTE_NAME );
-		if ( ! empty( $success_note_ids ) ) {
+		$data_store       = WC_Data_Store::load('admin-note');
+		$success_note_ids = $data_store->get_notes_with_name(self::SUCCESS_NOTE_NAME);
+		if ( ! empty($success_note_ids)) {
 			return false;
 		}
 
@@ -88,19 +88,19 @@ 
 	 */
 	public static function create_marketing_note() {
 		// Make sure conditions for this note still hold.
-		if ( ! self::should_show_marketing_note() ) {
+		if ( ! self::should_show_marketing_note()) {
 			return;
 		}
 
 		$note = new WC_Admin_Note();
-		$note->set_title( __( 'Boost sales this holiday season with Apple Pay!', 'woocommerce-gateway-stripe' ) );
-		$note->set_content( __( 'Now that you accept Apple Pay® with Stripe, you can increase conversion rates by letting your customers know that Apple Pay is available. Here’s a marketing guide to help you get started.', 'woocommerce-gateway-stripe' ) );
-		$note->set_type( WC_Admin_Note::E_WC_ADMIN_NOTE_MARKETING );
-		$note->set_name( self::SUCCESS_NOTE_NAME );
-		$note->set_source( 'woocommerce-gateway-stripe' );
+		$note->set_title(__('Boost sales this holiday season with Apple Pay!', 'woocommerce-gateway-stripe'));
+		$note->set_content(__('Now that you accept Apple Pay® with Stripe, you can increase conversion rates by letting your customers know that Apple Pay is available. Here’s a marketing guide to help you get started.', 'woocommerce-gateway-stripe'));
+		$note->set_type(WC_Admin_Note::E_WC_ADMIN_NOTE_MARKETING);
+		$note->set_name(self::SUCCESS_NOTE_NAME);
+		$note->set_source('woocommerce-gateway-stripe');
 		$note->add_action(
 			'marketing-guide',
-			__( 'See marketing guide', 'woocommerce-gateway-stripe' ),
+			__('See marketing guide', 'woocommerce-gateway-stripe'),
 			'https://developer.apple.com/apple-pay/marketing/'
 		);
 		$note->save();
@@ -111,14 +111,14 @@ 
 	 */
 	public static function create_failure_note() {
 		$note = new WC_Admin_Note();
-		$note->set_title( __( 'Apple Pay domain verification needed', 'woocommerce-gateway-stripe' ) );
-		$note->set_content( __( 'The WooCommerce Stripe Gateway extension attempted to perform domain verification on behalf of your store, but was unable to do so. This must be resolved before Apple Pay can be offered to your customers.', 'woocommerce-gateway-stripe' ) );
-		$note->set_type( WC_Admin_Note::E_WC_ADMIN_NOTE_INFORMATIONAL );
-		$note->set_name( self::FAILURE_NOTE_NAME );
-		$note->set_source( 'woocommerce-gateway-stripe' );
+		$note->set_title(__('Apple Pay domain verification needed', 'woocommerce-gateway-stripe'));
+		$note->set_content(__('The WooCommerce Stripe Gateway extension attempted to perform domain verification on behalf of your store, but was unable to do so. This must be resolved before Apple Pay can be offered to your customers.', 'woocommerce-gateway-stripe'));
+		$note->set_type(WC_Admin_Note::E_WC_ADMIN_NOTE_INFORMATIONAL);
+		$note->set_name(self::FAILURE_NOTE_NAME);
+		$note->set_source('woocommerce-gateway-stripe');
 		$note->add_action(
 			'learn-more',
-			__( 'Learn more', 'woocommerce-gateway-stripe' ),
+			__('Learn more', 'woocommerce-gateway-stripe'),
 			'https://docs.woocommerce.com/document/stripe/#apple-pay'
 		);
 		$note->save();

includes/class-wc-stripe-apple-pay-registration.php

Spacing +60 added lines, -60 removed lines

@@ -5,7 +5,7 @@ 
  * @since 4.0.6
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -32,17 +32,17 @@ 
 	public $apple_pay_verify_notice;
 
 	public function __construct() {
-		add_action( 'init', array( $this, 'add_domain_association_rewrite_rule' ) );
-		add_filter( 'query_vars', array( $this, 'whitelist_domain_association_query_param' ), 10, 1 );
-		add_action( 'parse_request', array( $this, 'parse_domain_association_request' ), 10, 1 );
+		add_action('init', array($this, 'add_domain_association_rewrite_rule'));
+		add_filter('query_vars', array($this, 'whitelist_domain_association_query_param'), 10, 1);
+		add_action('parse_request', array($this, 'parse_domain_association_request'), 10, 1);
 
-		add_action( 'woocommerce_stripe_updated', array( $this, 'verify_domain_if_configured' ) );
-		add_action( 'add_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_new_settings' ), 10, 2 );
-		add_action( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_updated_settings' ), 10, 2 );
-		add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+		add_action('woocommerce_stripe_updated', array($this, 'verify_domain_if_configured'));
+		add_action('add_option_woocommerce_stripe_settings', array($this, 'verify_domain_on_new_settings'), 10, 2);
+		add_action('update_option_woocommerce_stripe_settings', array($this, 'verify_domain_on_updated_settings'), 10, 2);
+		add_action('admin_notices', array($this, 'admin_notices'));
 
-		$this->stripe_settings         = get_option( 'woocommerce_stripe_settings', array() );
-		$this->apple_pay_domain_set    = 'yes' === $this->get_option( 'apple_pay_domain_set', 'no' );
+		$this->stripe_settings         = get_option('woocommerce_stripe_settings', array());
+		$this->apple_pay_domain_set    = 'yes' === $this->get_option('apple_pay_domain_set', 'no');
 		$this->apple_pay_verify_notice = '';
 	}
 
@@ -54,13 +54,13 @@ 
 	 * @param string default
 	 * @return string $setting_value
 	 */
-	public function get_option( $setting = '', $default = '' ) {
-		if ( empty( $this->stripe_settings ) ) {
+	public function get_option($setting = '', $default = '') {
+		if (empty($this->stripe_settings)) {
 			return $default;
 		}
 
-		if ( ! empty( $this->stripe_settings[ $setting ] ) ) {
-			return $this->stripe_settings[ $setting ];
+		if ( ! empty($this->stripe_settings[$setting])) {
+			return $this->stripe_settings[$setting];
 		}
 
 		return $default;
@@ -73,8 +73,8 @@ 
 	 * @return string Whether Apple Pay required settings are enabled.
 	 */
 	private function is_enabled() {
-		$stripe_enabled                 = 'yes' === $this->get_option( 'enabled', 'no' );
-		$payment_request_button_enabled = 'yes' === $this->get_option( 'payment_request', 'yes' );
+		$stripe_enabled                 = 'yes' === $this->get_option('enabled', 'no');
+		$payment_request_button_enabled = 'yes' === $this->get_option('payment_request', 'yes');
 
 		return $stripe_enabled && $payment_request_button_enabled;
 	}
@@ -86,8 +86,8 @@ 
 	 * @return string Secret key.
 	 */
 	private function get_secret_key() {
-		$testmode = 'yes' === $this->get_option( 'testmode', 'no' );
-		return $testmode ? $this->get_option( 'test_secret_key' ) : $this->get_option( 'secret_key' );
+		$testmode = 'yes' === $this->get_option('testmode', 'no');
+		return $testmode ? $this->get_option('test_secret_key') : $this->get_option('secret_key');
 	}
 
 	/**
@@ -97,7 +97,7 @@ 
 		$regex    = '^\.well-known\/apple-developer-merchantid-domain-association$';
 		$redirect = 'index.php?apple-developer-merchantid-domain-association=1';
 
-		add_rewrite_rule( $regex, $redirect, 'top' );
+		add_rewrite_rule($regex, $redirect, 'top');
 	}
 
 	/**
@@ -106,7 +106,7 @@ 
 	 * @param  array $query_vars - provided public query vars.
 	 * @return array Updated public query vars.
 	 */
-	public function whitelist_domain_association_query_param( $query_vars ) {
+	public function whitelist_domain_association_query_param($query_vars) {
 		$query_vars[] = 'apple-developer-merchantid-domain-association';
 		return $query_vars;
 	}
@@ -116,17 +116,17 @@ 
 	 *
 	 * @param WP WordPress environment object.
 	 */
-	public function parse_domain_association_request( $wp ) {
+	public function parse_domain_association_request($wp) {
 		if (
-			! isset( $wp->query_vars['apple-developer-merchantid-domain-association'] ) ||
+			! isset($wp->query_vars['apple-developer-merchantid-domain-association']) ||
 			'1' !== $wp->query_vars['apple-developer-merchantid-domain-association']
 		) {
 			return;
 		}
 
 		$path = WC_STRIPE_PLUGIN_PATH . '/apple-developer-merchantid-domain-association';
-		header( 'Content-Type: application/octet-stream' );
-		echo esc_html( file_get_contents( $path ) );
+		header('Content-Type: application/octet-stream');
+		echo esc_html(file_get_contents($path));
 		exit;
 	}
 
@@ -137,9 +137,9 @@ 
 	 * @version 4.5.4
 	 * @param string $secret_key
 	 */
-	private function make_domain_registration_request( $secret_key ) {
-		if ( empty( $secret_key ) ) {
-			throw new Exception( __( 'Unable to verify domain - missing secret key.', 'woocommerce-gateway-stripe' ) );
+	private function make_domain_registration_request($secret_key) {
+		if (empty($secret_key)) {
+			throw new Exception(__('Unable to verify domain - missing secret key.', 'woocommerce-gateway-stripe'));
 		}
 
 		$endpoint = 'https://api.stripe.com/v1/apple_pay/domains';
@@ -157,22 +157,22 @@ 
 			$endpoint,
 			array(
 				'headers' => $headers,
-				'body'    => http_build_query( $data ),
+				'body'    => http_build_query($data),
 			)
 		);
 
-		if ( is_wp_error( $response ) ) {
+		if (is_wp_error($response)) {
 			/* translators: error message */
-			throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $response->get_error_message() ) );
+			throw new Exception(sprintf(__('Unable to verify domain - %s', 'woocommerce-gateway-stripe'), $response->get_error_message()));
 		}
 
-		if ( 200 !== $response['response']['code'] ) {
-			$parsed_response = json_decode( $response['body'] );
+		if (200 !== $response['response']['code']) {
+			$parsed_response = json_decode($response['body']);
 
 			$this->apple_pay_verify_notice = $parsed_response->error->message;
 
 			/* translators: error message */
-			throw new Exception( sprintf( __( 'Unable to verify domain - %s', 'woocommerce-gateway-stripe' ), $parsed_response->error->message ) );
+			throw new Exception(sprintf(__('Unable to verify domain - %s', 'woocommerce-gateway-stripe'), $parsed_response->error->message));
 		}
 	}
 
@@ -186,27 +186,27 @@ 
 	 *
 	 * @return bool Whether domain verification succeeded.
 	 */
-	public function register_domain_with_apple( $secret_key ) {
+	public function register_domain_with_apple($secret_key) {
 		try {
-			$this->make_domain_registration_request( $secret_key );
+			$this->make_domain_registration_request($secret_key);
 
 			// No errors to this point, verification success!
 			$this->stripe_settings['apple_pay_domain_set'] = 'yes';
 			$this->apple_pay_domain_set                    = true;
 
-			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
+			update_option('woocommerce_stripe_settings', $this->stripe_settings);
 
-			WC_Stripe_Logger::log( 'Your domain has been verified with Apple Pay!' );
+			WC_Stripe_Logger::log('Your domain has been verified with Apple Pay!');
 
 			return true;
 
-		} catch ( Exception $e ) {
+		} catch (Exception $e) {
 			$this->stripe_settings['apple_pay_domain_set'] = 'no';
 			$this->apple_pay_domain_set                    = false;
 
-			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
+			update_option('woocommerce_stripe_settings', $this->stripe_settings);
 
-			WC_Stripe_Logger::log( 'Error: ' . $e->getMessage() );
+			WC_Stripe_Logger::log('Error: ' . $e->getMessage());
 
 			return false;
 		}
@@ -221,7 +221,7 @@ 
 	public function verify_domain_if_configured() {
 		$secret_key = $this->get_secret_key();
 
-		if ( ! $this->is_enabled() || empty( $secret_key ) ) {
+		if ( ! $this->is_enabled() || empty($secret_key)) {
 			return;
 		}
 
@@ -229,10 +229,10 @@ 
 		flush_rewrite_rules();
 
 		// Register the domain with Apple Pay.
-		$verification_complete = $this->register_domain_with_apple( $secret_key );
+		$verification_complete = $this->register_domain_with_apple($secret_key);
 
 		// Show/hide notes if necessary.
-		WC_Stripe_Inbox_Notes::notify_on_apple_pay_domain_verification( $verification_complete );
+		WC_Stripe_Inbox_Notes::notify_on_apple_pay_domain_verification($verification_complete);
 	}
 
 	/**
@@ -241,8 +241,8 @@ 
 	 * @since 4.5.4
 	 * @version 4.5.4
 	 */
-	public function verify_domain_on_new_settings( $option, $settings ) {
-		$this->verify_domain_on_updated_settings( array(), $settings );
+	public function verify_domain_on_new_settings($option, $settings) {
+		$this->verify_domain_on_updated_settings(array(), $settings);
 	}
 
 	/**
@@ -251,7 +251,7 @@ 
 	 * @since 4.5.3
 	 * @version 4.5.4
 	 */
-	public function verify_domain_on_updated_settings( $prev_settings, $settings ) {
+	public function verify_domain_on_updated_settings($prev_settings, $settings) {
 		// Grab previous state and then update cached settings.
 		$this->stripe_settings = $prev_settings;
 		$prev_secret_key       = $this->get_secret_key();
@@ -259,7 +259,7 @@ 
 		$this->stripe_settings = $settings;
 
 		// If Stripe or Payment Request Button wasn't enabled (or secret key was different) then might need to verify now.
-		if ( ! $prev_is_enabled || ( $this->get_secret_key() !== $prev_secret_key ) ) {
+		if ( ! $prev_is_enabled || ($this->get_secret_key() !== $prev_secret_key)) {
 			$this->verify_domain_if_configured();
 		}
 	}
@@ -270,16 +270,16 @@ 
 	 * @since 4.0.6
 	 */
 	public function admin_notices() {
-		if ( ! $this->is_enabled() ) {
+		if ( ! $this->is_enabled()) {
 			return;
 		}
 
-		if ( ! current_user_can( 'manage_woocommerce' ) ) {
+		if ( ! current_user_can('manage_woocommerce')) {
 			return;
 		}
 
-		$empty_notice = empty( $this->apple_pay_verify_notice );
-		if ( $empty_notice && ( $this->apple_pay_domain_set || empty( $this->secret_key ) ) ) {
+		$empty_notice = empty($this->apple_pay_verify_notice);
+		if ($empty_notice && ($this->apple_pay_domain_set || empty($this->secret_key))) {
 			return;
 		}
 
@@ -288,28 +288,28 @@ 
 		 * when setting screen is displayed. So if domain verification is not set,
 		 * something went wrong so lets notify user.
 		 */
-		$allowed_html                      = array(
+		$allowed_html = array(
 			'a' => array(
 				'href'  => array(),
 				'title' => array(),
 			),
 		);
-		$verification_failed_without_error = __( 'Apple Pay domain verification failed.', 'woocommerce-gateway-stripe' );
-		$verification_failed_with_error    = __( 'Apple Pay domain verification failed with the following error:', 'woocommerce-gateway-stripe' );
+		$verification_failed_without_error = __('Apple Pay domain verification failed.', 'woocommerce-gateway-stripe');
+		$verification_failed_with_error    = __('Apple Pay domain verification failed with the following error:', 'woocommerce-gateway-stripe');
 		$check_log_text                    = sprintf(
 			/* translators: 1) HTML anchor open tag 2) HTML anchor closing tag */
-			esc_html__( 'Please check the %1$slogs%2$s for more details on this issue. Logging must be enabled to see recorded logs.', 'woocommerce-gateway-stripe' ),
-			'<a href="' . admin_url( 'admin.php?page=wc-status&tab=logs' ) . '">',
+			esc_html__('Please check the %1$slogs%2$s for more details on this issue. Logging must be enabled to see recorded logs.', 'woocommerce-gateway-stripe'),
+			'<a href="' . admin_url('admin.php?page=wc-status&tab=logs') . '">',
 			'</a>'
 		);
 
 		?>
 		<div class="error stripe-apple-pay-message">
-			<?php if ( $empty_notice ) : ?>
-				<p><?php echo esc_html( $verification_failed_without_error ); ?></p>
+			<?php if ($empty_notice) : ?>
+				<p><?php echo esc_html($verification_failed_without_error); ?></p>
 			<?php else : ?>
-				<p><?php echo esc_html( $verification_failed_with_error ); ?></p>
-				<p><i><?php echo wp_kses( make_clickable( esc_html( $this->apple_pay_verify_notice ) ), $allowed_html ); ?></i></p>
+				<p><?php echo esc_html($verification_failed_with_error); ?></p>
+				<p><i><?php echo wp_kses(make_clickable(esc_html($this->apple_pay_verify_notice)), $allowed_html); ?></i></p>
 			<?php endif; ?>
 			<p><?php echo $check_log_text; ?></p>
 		</div>