woocommerce / woocommerce-gateway-stripe

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

Doc Comments +1 added lines, -1 removed lines

@@ -184,7 +184,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 +81 added lines, -81 removed lines

@@ -5,7 +5,7 @@ 
  * @since 4.0.6
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -53,27 +53,27 @@ 
 	public $apple_pay_verify_notice;
 
 	public function __construct() {
-		add_action( 'woocommerce_stripe_updated', array( $this, 'verify_domain_if_needed' ) );
-		add_action( 'update_option_woocommerce_stripe_settings', array( $this, 'verify_domain_on_new_secret_key' ), 10, 2 );
-
-		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 );
-
-		$this->stripe_settings         = get_option( 'woocommerce_stripe_settings', array() );
-		$this->stripe_enabled          = $this->get_option( 'enabled' );
-		$this->payment_request         = 'yes' === $this->get_option( 'payment_request', 'yes' );
-		$this->apple_pay_domain_set    = 'yes' === $this->get_option( 'apple_pay_domain_set', 'no' );
-		$this->apple_pay_rewrite_flush = 'yes' === $this->get_option( 'apple_pay_rewrite_flush', 'no' );
+		add_action('woocommerce_stripe_updated', array($this, 'verify_domain_if_needed'));
+		add_action('update_option_woocommerce_stripe_settings', array($this, 'verify_domain_on_new_secret_key'), 10, 2);
+
+		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);
+
+		$this->stripe_settings         = get_option('woocommerce_stripe_settings', array());
+		$this->stripe_enabled          = $this->get_option('enabled');
+		$this->payment_request         = 'yes' === $this->get_option('payment_request', 'yes');
+		$this->apple_pay_domain_set    = 'yes' === $this->get_option('apple_pay_domain_set', 'no');
+		$this->apple_pay_rewrite_flush = 'yes' === $this->get_option('apple_pay_rewrite_flush', 'no');
 		$this->apple_pay_verify_notice = '';
 		$this->secret_key              = $this->get_secret_key();
 
-		if ( empty( $this->stripe_settings ) ) {
+		if (empty($this->stripe_settings)) {
 			return;
 		}
 
-		add_action( 'init', array( $this, 'init_apple_pay' ) );
-		add_action( 'admin_notices', array( $this, 'admin_notices' ) );
+		add_action('init', array($this, 'init_apple_pay'));
+		add_action('admin_notices', array($this, 'admin_notices'));
 	}
 
 	/**
@@ -84,13 +84,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;
@@ -103,8 +103,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');
 	}
 
 	/**
@@ -116,9 +116,9 @@ 
 	public function init_apple_pay() {
 		if (
 			is_admin() &&
-			isset( $_GET['page'] ) && 'wc-settings' === $_GET['page'] &&
-			isset( $_GET['tab'] ) && 'checkout' === $_GET['tab'] &&
-			isset( $_GET['section'] ) && 'stripe' === $_GET['section'] &&
+			isset($_GET['page']) && 'wc-settings' === $_GET['page'] &&
+			isset($_GET['tab']) && 'checkout' === $_GET['tab'] &&
+			isset($_GET['section']) && 'stripe' === $_GET['section'] &&
 			$this->payment_request
 		) {
 			$this->verify_domain();
@@ -132,9 +132,9 @@ 
 	 * @version 3.1.0
 	 * @param string $secret_key
 	 */
-	private function register_domain_with_apple( $secret_key = '' ) {
-		if ( empty( $secret_key ) ) {
-			throw new Exception( __( 'Unable to verify domain - missing secret key.', 'woocommerce-gateway-stripe' ) );
+	private function register_domain_with_apple($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';
@@ -152,22 +152,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));
 		}
 	}
 
@@ -177,7 +177,7 @@ 
 	public function add_domain_association_rewrite_rule() {
 		$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');
 	}
 
 	/**
@@ -186,7 +186,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;
 	}
@@ -196,19 +196,19 @@ 
 	 *
 	 * @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';
-		$contents = file_get_contents( $path );
+		$contents = file_get_contents($path);
 
-		header( 'Content-Type: application/octet-stream' );
-		echo esc_html( $contents );
+		header('Content-Type: application/octet-stream');
+		echo esc_html($contents);
 
 		exit;
 	}
@@ -223,43 +223,43 @@ 
 	 * @since 4.3.0
 	 * @return bool True on success, false on failure.
 	 */
-	public function update_domain_association_file( $force = false ) {
-		$path     = untrailingslashit( $_SERVER['DOCUMENT_ROOT'] );
+	public function update_domain_association_file($force = false) {
+		$path     = untrailingslashit($_SERVER['DOCUMENT_ROOT']);
 		$dir      = '.well-known';
 		$file     = 'apple-developer-merchantid-domain-association';
 		$fullpath = $path . '/' . $dir . '/' . $file;
 
-		$existing_contents = @file_get_contents( $fullpath );
-		$new_contents = @file_get_contents( WC_STRIPE_PLUGIN_PATH . '/' . $file );
-		if ( ( ! $existing_contents && ! $force ) || $existing_contents === $new_contents ) {
+		$existing_contents = @file_get_contents($fullpath);
+		$new_contents = @file_get_contents(WC_STRIPE_PLUGIN_PATH . '/' . $file);
+		if (( ! $existing_contents && ! $force) || $existing_contents === $new_contents) {
 			return true;
 		}
 
 		$error = null;
-		if ( ! file_exists( $path . '/' . $dir ) ) {
-			if ( ! @mkdir( $path . '/' . $dir, 0755 ) ) { // @codingStandardsIgnoreLine
-				$error = __( 'Unable to create domain association folder to domain root.', 'woocommerce-gateway-stripe' );
+		if ( ! file_exists($path . '/' . $dir)) {
+			if ( ! @mkdir($path . '/' . $dir, 0755)) { // @codingStandardsIgnoreLine
+				$error = __('Unable to create domain association folder to domain root.', 'woocommerce-gateway-stripe');
 			}
 		}
-		if ( ! @copy( WC_STRIPE_PLUGIN_PATH . '/' . $file, $fullpath ) ) { // @codingStandardsIgnoreLine
-			$error = __( 'Unable to copy domain association file to domain root.', 'woocommerce-gateway-stripe' );
+		if ( ! @copy(WC_STRIPE_PLUGIN_PATH . '/' . $file, $fullpath)) { // @codingStandardsIgnoreLine
+			$error = __('Unable to copy domain association file to domain root.', 'woocommerce-gateway-stripe');
 		}
 
-		if ( isset( $error ) ) {
+		if (isset($error)) {
 			$url            = 'https://' . $_SERVER['HTTP_HOST'] . '/' . $dir . '/' . $file;
-			$response       = wp_remote_get( $url );
-			$already_hosted = wp_remote_retrieve_body( $response ) === $new_contents;
-			if ( ! $already_hosted ) {
+			$response       = wp_remote_get($url);
+			$already_hosted = wp_remote_retrieve_body($response) === $new_contents;
+			if ( ! $already_hosted) {
 				WC_Stripe_Logger::log(
 					'Error: ' . $error . ' ' .
 					/* translators: expected domain association file URL */
-					sprintf( __( 'To enable Apple Pay, domain association file must be hosted at %s.', 'woocommerce-gateway-stripe' ), $url )
+					sprintf(__('To enable Apple Pay, domain association file must be hosted at %s.', 'woocommerce-gateway-stripe'), $url)
 				);
 			}
 			return $already_hosted;
 		}
 
-		WC_Stripe_Logger::log( 'Domain association file updated.' );
+		WC_Stripe_Logger::log('Domain association file updated.');
 		return true;
 	}
 
@@ -270,33 +270,33 @@ 
 	 * @version 3.1.0
 	 */
 	public function verify_domain() {
-		if ( ! $this->apple_pay_rewrite_flush ) {
+		if ( ! $this->apple_pay_rewrite_flush) {
 			flush_rewrite_rules();
 			$this->stripe_settings['apple_pay_rewrite_flush'] = 'yes';
 			$this->apple_pay_rewrite_flush = true;
-			update_option( 'woocommerce_stripe_settings', $this->stripe_settings );
+			update_option('woocommerce_stripe_settings', $this->stripe_settings);
 		}
 
 		try {
 			// At this point then the domain association folder and file should be available.
 			// Proceed to verify/and or verify again.
-			$this->register_domain_with_apple( $this->secret_key );
+			$this->register_domain_with_apple($this->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());
 		}
 	}
 
@@ -306,14 +306,14 @@ 
 	 * @since 4.5.3
 	 * @version 4.5.3
 	 */
-	public function verify_domain_on_new_secret_key( $prev_settings, $settings ) {
+	public function verify_domain_on_new_secret_key($prev_settings, $settings) {
 		$this->stripe_settings = $prev_settings;
 		$prev_secret_key = $this->get_secret_key();
 
 		$this->stripe_settings = $settings;
 		$this->secret_key = $this->get_secret_key();
 
-		if ( ! empty( $this->secret_key ) && $this->secret_key !== $prev_secret_key ) {
+		if ( ! empty($this->secret_key) && $this->secret_key !== $prev_secret_key) {
 			$this->verify_domain();
 		}
 	}
@@ -325,7 +325,7 @@ 
 	 * @version 4.5.3
 	 */
 	public function verify_domain_if_needed() {
-		if ( $this->payment_request ) {
+		if ($this->payment_request) {
 			$this->verify_domain();
 		}
 	}
@@ -336,16 +336,16 @@ 
 	 * @since 4.0.6
 	 */
 	public function admin_notices() {
-		if ( ! $this->stripe_enabled || ! $this->payment_request ) {
+		if ( ! $this->stripe_enabled || ! $this->payment_request) {
 			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;
 		}
 
@@ -354,28 +354,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>