woocommerce / woocommerce-gateway-stripe

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

Doc Comments +2 added lines, -2 removed lines

@@ -69,7 +69,7 @@ 
 	 * Whether the gateway and Payment Request Button (prerequisites for Apple Pay) are enabled.
 	 *
 	 * @since 4.5.4
-	 * @return string Whether Apple Pay required settings are enabled.
+	 * @return boolean Whether Apple Pay required settings are enabled.
 	 */
 	private function is_enabled() {
 		$stripe_enabled                 = 'yes' === $this->get_option( 'enabled', 'no' );
@@ -103,7 +103,7 @@ 
 	 * Add to the list of publicly allowed query variables.
 	 *
 	 * @param  array $query_vars - provided public query vars.
-	 * @return array Updated public query vars.
+	 * @return string[] Updated public query vars.
 	 */
 	public function whitelist_domain_association_query_param( $query_vars ) {
 		$query_vars[] = 'apple-developer-merchantid-domain-association';

Spacing +56 added lines, -56 removed lines

@@ -5,7 +5,7 @@ 
  * @since 4.0.6
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -32,16 +32,16 @@ 
 	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( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_settings_change' ), 10, 2 );
-		add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+		add_action('woocommerce_stripe_updated', array($this, 'verify_domain_if_configured'));
+		add_action('update_option_woocommerce_stripe_settings', array($this, 'verify_domain_on_settings_change'), 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         = '';
 	}
 
@@ -53,13 +53,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;
@@ -72,8 +72,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;
 	}
@@ -85,8 +85,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');
 	}
 
 	/**
@@ -96,7 +96,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');
 	}
 
 	/**
@@ -105,7 +105,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;
 	}
@@ -115,17 +115,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;
 	}
 
@@ -136,9 +136,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';
@@ -156,22 +156,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));
 		}
 	}
 
@@ -183,25 +183,25 @@ 
 	 *
 	 * @param string $secret_key
 	 */
-	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!');
 
-		} 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());
 		}
 	}
 
@@ -215,7 +215,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;
 		}
 
@@ -223,7 +223,7 @@ 
 		flush_rewrite_rules();
 
 		// Register the domain with Apple Pay.
-		$this->register_domain_with_apple( $secret_key );
+		$this->register_domain_with_apple($secret_key);
 
 		// Show/hide failure note if necessary.
 		WC_Stripe_Inbox_Notes::notify_of_apple_pay_domain_verification_if_needed();
@@ -235,7 +235,7 @@ 
 	 * @since 4.5.3
 	 * @version 4.5.4
 	 */
-	public function verify_domain_on_settings_change( $prev_settings, $settings ) {
+	public function verify_domain_on_settings_change($prev_settings, $settings) {
 		// Grab previous state and then update cached settings.
 		$this->stripe_settings = $prev_settings;
 		$prev_secret_key       = $this->get_secret_key();
@@ -243,7 +243,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();
 		}
 	}
@@ -254,16 +254,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;
 		}
 
@@ -272,28 +272,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>