insideout10 / wordlift-plugin

src/admin/partials/admin-setup/step-3.php

Spacing +6 added lines, -6 removed lines

@@ -1,15 +1,15 @@ 
 <!-- Pane 3 content -->
 <script type="text/html" id="page-2">
 	<h2 class="page-title">
-		<?php esc_html_e( 'License Key', 'wordlift' ); ?>
+		<?php esc_html_e('License Key', 'wordlift'); ?>
 	</h2>
 
 	<p class="page-txt">
 		<?php
 		$grab_a_key_link = sprintf(
 			'<a target="_blank" href="%s">%s</a>',
-			esc_attr__( 'https://wordlift.io/pricing', 'wordlift' ),
-			esc_html__( 'grab a key', 'wordlift' )
+			esc_attr__('https://wordlift.io/pricing', 'wordlift'),
+			esc_html__('grab a key', 'wordlift')
 		);
 
 		echo sprintf(
@@ -31,7 +31,7 @@ 
 		name="key"
 		value=""
 		autocomplete="off"
-		placeholder="<?php echo esc_attr_x( 'License Key', 'Input text placeholder', 'wordlift' ); ?>"
+		placeholder="<?php echo esc_attr_x('License Key', 'Input text placeholder', 'wordlift'); ?>"
 	>
 	<div>
         <p class="wl-val-key-error">
@@ -44,7 +44,7 @@ 
 			target="_tab"
 			class="button wl-default-action"
 		>
-			<?php esc_html_e( 'Grab a Key!', 'wordlift' ); ?>
+			<?php esc_html_e('Grab a Key!', 'wordlift'); ?>
 		</a>
 
 		<input
@@ -52,7 +52,7 @@ 
 			type="button"
 			data-wl-next="wl-next"
 			class="button"
-			value="<?php esc_attr_e( 'Next', 'wordlift' ); ?>"
+			value="<?php esc_attr_e('Next', 'wordlift'); ?>"
 		>
 	</div>
 </script>

src/includes/class-wordlift-configuration-service.php

Indentation +659 added lines, -659 removed lines

@@ -11,7 +11,7 @@ 
  */
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -21,560 +21,560 @@ 
  */
 class Wordlift_Configuration_Service {
 
-	/**
-	 * The entity base path option name.
-	 *
-	 * @since 3.6.0
-	 */
-	const ENTITY_BASE_PATH_KEY = 'wl_entity_base_path';
-
-	/**
-	 * The skip wizard (admin installation wizard) option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const SKIP_WIZARD = 'wl_skip_wizard';
-
-	/**
-	 * WordLift's key option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const KEY = 'key';
-
-	/**
-	 * WordLift's configured language option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const LANGUAGE = 'site_language';
-
-	/**
-	 * WordLift's configured country code.
-	 *
-	 * @since 3.18.0
-	 */
-	const COUNTRY_CODE = 'country_code';
-
-	/**
-	 * The publisher entity post ID option name.
-	 *
-	 * @since 3.9.0
-	 */
-	const PUBLISHER_ID = 'publisher_id';
-
-	/**
-	 * The dataset URI option name
-	 *
-	 * @since 3.10.0
-	 */
-	const DATASET_URI = 'redlink_dataset_uri';
-
-	/**
-	 * The link by default option name.
-	 *
-	 * @since 3.11.0
-	 */
-	const LINK_BY_DEFAULT = 'link_by_default';
-
-	/**
-	 * The analytics enable option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENABLE = 'analytics_enable';
-
-	/**
-	 * The analytics entity uri dimension option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENTITY_URI_DIMENSION = 'analytics_entity_uri_dimension';
-
-	/**
-	 * The analytics entity type dimension option.
-	 *
-	 * @since 3.21.0
-	 */
-	const ANALYTICS_ENTITY_TYPE_DIMENSION = 'analytics_entity_type_dimension';
-
-	/**
-	 * The user preferences about sharing data option.
-	 *
-	 * @since 3.19.0
-	 */
-	const SEND_DIAGNOSTIC = 'send_diagnostic';
-
-	/**
-	 * The package type configuration key.
-	 *
-	 * @since 3.20.0
-	 */
-	const PACKAGE_TYPE = 'package_type';
-
-	/**
-	 * The {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The Wordlift_Configuration_Service's singleton instance.
-	 *
-	 * @since  3.6.0
-	 *
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $instance Wordlift_Configuration_Service's singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Configuration_Service's instance.
-	 *
-	 * @since 3.6.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return \Wordlift_Configuration_Service
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get a configuration given the option name and a key. The option value is
-	 * expected to be an array.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @param string $option The option name.
-	 * @param string $key A key in the option value array.
-	 * @param string $default The default value in case the key is not found (by default an empty string).
-	 *
-	 * @return mixed The configuration value or the default value if not found.
-	 */
-	private function get( $option, $key, $default = '' ) {
-
-		$options = get_option( $option, array() );
-
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
-	}
-
-	/**
-	 * Set a configuration parameter.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
-	 * @param string $key The value key.
-	 * @param mixed  $value The value.
-	 */
-	private function set( $option, $key, $value ) {
-
-		$values         = get_option( $option );
-		$values         = isset( $values ) ? $values : array();
-		$values[ $key ] = $value;
-		update_option( $option, $values );
-
-	}
-
-	/**
-	 * Get the entity base path, by default 'entity'.
-	 *
-	 * @since 3.6.0
-	 *
-	 * @return string The entity base path.
-	 */
-	public function get_entity_base_path() {
-
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
-	}
-
-	/**
-	 * Get the entity base path.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param string $value The entity base path.
-	 */
-	public function set_entity_base_path( $value ) {
-
-		$this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
-
-	}
-
-	/**
-	 * Whether the installation skip wizard should be skipped.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @return bool True if it should be skipped otherwise false.
-	 */
-	public function is_skip_wizard() {
-
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
-	}
-
-	/**
-	 * Set the skip wizard parameter.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param bool $value True to skip the wizard. We expect a boolean value.
-	 */
-	public function set_skip_wizard( $value ) {
-
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
-
-	}
-
-	/**
-	 * Get WordLift's key.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @return string WordLift's key or an empty string if not set.
-	 */
-	public function get_key() {
-
-		return $this->get( 'wl_general_settings', self::KEY, '' );
-	}
-
-	/**
-	 * Set WordLift's key.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param string $value WordLift's key.
-	 */
-	public function set_key( $value ) {
-
-		$this->set( 'wl_general_settings', self::KEY, $value );
-	}
-
-	/**
-	 * Get WordLift's configured language, by default 'en'.
-	 *
-	 * Note that WordLift's language is used when writing strings to the Linked Data dataset, not for the analysis.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @return string WordLift's configured language code ('en' by default).
-	 */
-	public function get_language_code() {
-
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
-	}
-
-	/**
-	 * Set WordLift's language code, used when storing strings to the Linked Data dataset.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param string $value WordLift's language code.
-	 */
-	public function set_language_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
-
-	}
-
-	/**
-	 * Set the user preferences about sharing diagnostic with us.
-	 *
-	 * @since 3.19.0
-	 *
-	 * @param string $value The user preferences(yes/no).
-	 */
-	public function set_diagnostic_preferences( $value ) {
-
-		$this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
-
-	}
-
-	/**
-	 * Get the user preferences about sharing diagnostic.
-	 *
-	 * @since 3.19.0
-	 */
-	public function get_diagnostic_preferences() {
-
-		return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
-	}
-
-	/**
-	 * Get WordLift's configured country code, by default 'us'.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @return string WordLift's configured country code ('us' by default).
-	 */
-	public function get_country_code() {
-
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
-	}
-
-	/**
-	 * Set WordLift's country code.
-	 *
-	 * @since 3.18.0
-	 *
-	 * @param string $value WordLift's country code.
-	 */
-	public function set_country_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
-
-	}
-
-	/**
-	 * Get the publisher entity post id.
-	 *
-	 * The publisher entity post id points to an entity post which contains the data for the publisher used in schema.org
-	 * Article markup.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @return int|NULL The publisher entity post id or NULL if not set.
-	 */
-	public function get_publisher_id() {
-
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
-	}
-
-	/**
-	 * Set the publisher entity post id.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param int $value The publisher entity post id.
-	 */
-	public function set_publisher_id( $value ) {
-
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
-
-	}
-
-	/**
-	 * Get the dataset URI.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @return string The dataset URI or an empty string if not set.
-	 */
-	public function get_dataset_uri() {
-
-		return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
-	}
-
-	/**
-	 * Set the dataset URI.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @param string $value The dataset URI.
-	 */
-	public function set_dataset_uri( $value ) {
-
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
-	}
-
-	/**
-	 * Get the package type.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @return string The package type or an empty string if not set.
-	 */
-	public function get_package_type() {
-
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
-	}
-
-	/**
-	 * Set the package type.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $value The package type.
-	 */
-	public function set_package_type( $value ) {
-
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
-	}
-
-	/**
-	 * Intercept the change of the WordLift key in order to set the dataset URI.
-	 *
-	 *
-	 * @since 3.20.0 as of #761, we save settings every time a key is set, not only when the key changes, so to
-	 *               store the configuration parameters such as country or language.
-	 * @since 3.11.0
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/761
-	 *
-	 * @param array $old_value The old settings.
-	 * @param array $new_value The new settings.
-	 */
-	public function update_key( $old_value, $new_value ) {
-
-		// Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
-		// $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $new_value['key'] ) ? $new_value['key'] : '';
-
-		// If the key hasn't changed, don't do anything.
-		// WARN The 'update_option' hook is fired only if the new and old value are not equal.
-		//		if ( $old_key === $new_key ) {
-		//			return;
-		//		}
-
-		// If the key is empty, empty the dataset URI.
-		if ( '' === $new_key ) {
-			$this->set_dataset_uri( '' );
-		}
-
-		// make the request to the remote server.
-		$this->get_remote_dataset_uri( $new_key );
-
-	}
-
-	/**
-	 * Handle retrieving the dataset uri from the remote server.
-	 *
-	 * If a valid dataset uri is returned it is stored in the appropriate option,
-	 * otherwise the option is set to empty string.
-	 *
-	 * @since 3.17.0 send the site URL and get the dataset URI.
-	 * @since 3.12.0
-	 *
-	 * @param string $key The key to be used.
-	 */
-	public function get_remote_dataset_uri( $key ) {
-
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
-
-		/**
-		 * Allow 3rd parties to change the site_url.
-		 *
-		 * @since 3.20.0
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-		 *
-		 * @param string $site_url The site url.
-		 */
-		$site_url = apply_filters( 'wl_production_site_url', site_url() );
+    /**
+     * The entity base path option name.
+     *
+     * @since 3.6.0
+     */
+    const ENTITY_BASE_PATH_KEY = 'wl_entity_base_path';
+
+    /**
+     * The skip wizard (admin installation wizard) option name.
+     *
+     * @since 3.9.0
+     */
+    const SKIP_WIZARD = 'wl_skip_wizard';
+
+    /**
+     * WordLift's key option name.
+     *
+     * @since 3.9.0
+     */
+    const KEY = 'key';
+
+    /**
+     * WordLift's configured language option name.
+     *
+     * @since 3.9.0
+     */
+    const LANGUAGE = 'site_language';
+
+    /**
+     * WordLift's configured country code.
+     *
+     * @since 3.18.0
+     */
+    const COUNTRY_CODE = 'country_code';
+
+    /**
+     * The publisher entity post ID option name.
+     *
+     * @since 3.9.0
+     */
+    const PUBLISHER_ID = 'publisher_id';
+
+    /**
+     * The dataset URI option name
+     *
+     * @since 3.10.0
+     */
+    const DATASET_URI = 'redlink_dataset_uri';
+
+    /**
+     * The link by default option name.
+     *
+     * @since 3.11.0
+     */
+    const LINK_BY_DEFAULT = 'link_by_default';
+
+    /**
+     * The analytics enable option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENABLE = 'analytics_enable';
+
+    /**
+     * The analytics entity uri dimension option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENTITY_URI_DIMENSION = 'analytics_entity_uri_dimension';
+
+    /**
+     * The analytics entity type dimension option.
+     *
+     * @since 3.21.0
+     */
+    const ANALYTICS_ENTITY_TYPE_DIMENSION = 'analytics_entity_type_dimension';
+
+    /**
+     * The user preferences about sharing data option.
+     *
+     * @since 3.19.0
+     */
+    const SEND_DIAGNOSTIC = 'send_diagnostic';
+
+    /**
+     * The package type configuration key.
+     *
+     * @since 3.20.0
+     */
+    const PACKAGE_TYPE = 'package_type';
+
+    /**
+     * The {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Log_Service $log The {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The Wordlift_Configuration_Service's singleton instance.
+     *
+     * @since  3.6.0
+     *
+     * @access private
+     * @var \Wordlift_Configuration_Service $instance Wordlift_Configuration_Service's singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Configuration_Service's instance.
+     *
+     * @since 3.6.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @since 3.6.0
+     *
+     * @return \Wordlift_Configuration_Service
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Get a configuration given the option name and a key. The option value is
+     * expected to be an array.
+     *
+     * @since 3.6.0
+     *
+     * @param string $option The option name.
+     * @param string $key A key in the option value array.
+     * @param string $default The default value in case the key is not found (by default an empty string).
+     *
+     * @return mixed The configuration value or the default value if not found.
+     */
+    private function get( $option, $key, $default = '' ) {
 
-		// Build the URL.
-		$url = $this->get_accounts()
-		       . '?key=' . rawurlencode( $key )
-		       . '&url=' . rawurlencode( $site_url )
-		       . '&country=' . $this->get_country_code()
-		       . '&language=' . $this->get_language_code();
+        $options = get_option( $option, array() );
 
-		$args     = wp_parse_args( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
-			'method' => 'PUT',
-		) );
+        return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+    }
+
+    /**
+     * Set a configuration parameter.
+     *
+     * @since 3.9.0
+     *
+     * @param string $option Name of option to retrieve. Expected to not be SQL-escaped.
+     * @param string $key The value key.
+     * @param mixed  $value The value.
+     */
+    private function set( $option, $key, $value ) {
+
+        $values         = get_option( $option );
+        $values         = isset( $values ) ? $values : array();
+        $values[ $key ] = $value;
+        update_option( $option, $values );
+
+    }
+
+    /**
+     * Get the entity base path, by default 'entity'.
+     *
+     * @since 3.6.0
+     *
+     * @return string The entity base path.
+     */
+    public function get_entity_base_path() {
+
+        return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+    }
+
+    /**
+     * Get the entity base path.
+     *
+     * @since 3.9.0
+     *
+     * @param string $value The entity base path.
+     */
+    public function set_entity_base_path( $value ) {
+
+        $this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
 
-		$response = wp_remote_request( $url, $args );
+    }
+
+    /**
+     * Whether the installation skip wizard should be skipped.
+     *
+     * @since 3.9.0
+     *
+     * @return bool True if it should be skipped otherwise false.
+     */
+    public function is_skip_wizard() {
 
-		// The response is an error.
-		if ( is_wp_error( $response ) ) {
-			$this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+        return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+    }
+
+    /**
+     * Set the skip wizard parameter.
+     *
+     * @since 3.9.0
+     *
+     * @param bool $value True to skip the wizard. We expect a boolean value.
+     */
+    public function set_skip_wizard( $value ) {
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+        $this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
 
-			return;
-		}
+    }
 
-		// The response is not OK.
-		if ( 200 !== (int) $response['response']['code'] ) {
-			$this->log->error( "Unexpected status code when opening URL $url: " . $response['response']['code'] );
+    /**
+     * Get WordLift's key.
+     *
+     * @since 3.9.0
+     *
+     * @return string WordLift's key or an empty string if not set.
+     */
+    public function get_key() {
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+        return $this->get( 'wl_general_settings', self::KEY, '' );
+    }
 
-			return;
-		}
+    /**
+     * Set WordLift's key.
+     *
+     * @since 3.9.0
+     *
+     * @param string $value WordLift's key.
+     */
+    public function set_key( $value ) {
 
-		/*
+        $this->set( 'wl_general_settings', self::KEY, $value );
+    }
+
+    /**
+     * Get WordLift's configured language, by default 'en'.
+     *
+     * Note that WordLift's language is used when writing strings to the Linked Data dataset, not for the analysis.
+     *
+     * @since 3.9.0
+     *
+     * @return string WordLift's configured language code ('en' by default).
+     */
+    public function get_language_code() {
+
+        return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+    }
+
+    /**
+     * Set WordLift's language code, used when storing strings to the Linked Data dataset.
+     *
+     * @since 3.9.0
+     *
+     * @param string $value WordLift's language code.
+     */
+    public function set_language_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::LANGUAGE, $value );
+
+    }
+
+    /**
+     * Set the user preferences about sharing diagnostic with us.
+     *
+     * @since 3.19.0
+     *
+     * @param string $value The user preferences(yes/no).
+     */
+    public function set_diagnostic_preferences( $value ) {
+
+        $this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
+
+    }
+
+    /**
+     * Get the user preferences about sharing diagnostic.
+     *
+     * @since 3.19.0
+     */
+    public function get_diagnostic_preferences() {
+
+        return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
+    }
+
+    /**
+     * Get WordLift's configured country code, by default 'us'.
+     *
+     * @since 3.18.0
+     *
+     * @return string WordLift's configured country code ('us' by default).
+     */
+    public function get_country_code() {
+
+        return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+    }
+
+    /**
+     * Set WordLift's country code.
+     *
+     * @since 3.18.0
+     *
+     * @param string $value WordLift's country code.
+     */
+    public function set_country_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
+
+    }
+
+    /**
+     * Get the publisher entity post id.
+     *
+     * The publisher entity post id points to an entity post which contains the data for the publisher used in schema.org
+     * Article markup.
+     *
+     * @since 3.9.0
+     *
+     * @return int|NULL The publisher entity post id or NULL if not set.
+     */
+    public function get_publisher_id() {
+
+        return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+    }
+
+    /**
+     * Set the publisher entity post id.
+     *
+     * @since 3.9.0
+     *
+     * @param int $value The publisher entity post id.
+     */
+    public function set_publisher_id( $value ) {
+
+        $this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+
+    }
+
+    /**
+     * Get the dataset URI.
+     *
+     * @since 3.10.0
+     *
+     * @return string The dataset URI or an empty string if not set.
+     */
+    public function get_dataset_uri() {
+
+        return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+    }
+
+    /**
+     * Set the dataset URI.
+     *
+     * @since 3.10.0
+     *
+     * @param string $value The dataset URI.
+     */
+    public function set_dataset_uri( $value ) {
+
+        $this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+    }
+
+    /**
+     * Get the package type.
+     *
+     * @since 3.20.0
+     *
+     * @return string The package type or an empty string if not set.
+     */
+    public function get_package_type() {
+
+        return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+    }
+
+    /**
+     * Set the package type.
+     *
+     * @since 3.20.0
+     *
+     * @param string $value The package type.
+     */
+    public function set_package_type( $value ) {
+
+        $this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+    }
+
+    /**
+     * Intercept the change of the WordLift key in order to set the dataset URI.
+     *
+     *
+     * @since 3.20.0 as of #761, we save settings every time a key is set, not only when the key changes, so to
+     *               store the configuration parameters such as country or language.
+     * @since 3.11.0
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/761
+     *
+     * @param array $old_value The old settings.
+     * @param array $new_value The new settings.
+     */
+    public function update_key( $old_value, $new_value ) {
+
+        // Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
+        // $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
+        $new_key = isset( $new_value['key'] ) ? $new_value['key'] : '';
+
+        // If the key hasn't changed, don't do anything.
+        // WARN The 'update_option' hook is fired only if the new and old value are not equal.
+        //		if ( $old_key === $new_key ) {
+        //			return;
+        //		}
+
+        // If the key is empty, empty the dataset URI.
+        if ( '' === $new_key ) {
+            $this->set_dataset_uri( '' );
+        }
+
+        // make the request to the remote server.
+        $this->get_remote_dataset_uri( $new_key );
+
+    }
+
+    /**
+     * Handle retrieving the dataset uri from the remote server.
+     *
+     * If a valid dataset uri is returned it is stored in the appropriate option,
+     * otherwise the option is set to empty string.
+     *
+     * @since 3.17.0 send the site URL and get the dataset URI.
+     * @since 3.12.0
+     *
+     * @param string $key The key to be used.
+     */
+    public function get_remote_dataset_uri( $key ) {
+
+        $this->log->trace( 'Getting the remote dataset URI and package type...' );
+
+        /**
+         * Allow 3rd parties to change the site_url.
+         *
+         * @since 3.20.0
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/850
+         *
+         * @param string $site_url The site url.
+         */
+        $site_url = apply_filters( 'wl_production_site_url', site_url() );
+
+        // Build the URL.
+        $url = $this->get_accounts()
+                . '?key=' . rawurlencode( $key )
+                . '&url=' . rawurlencode( $site_url )
+                . '&country=' . $this->get_country_code()
+                . '&language=' . $this->get_language_code();
+
+        $args     = wp_parse_args( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
+            'method' => 'PUT',
+        ) );
+
+        $response = wp_remote_request( $url, $args );
+
+        // The response is an error.
+        if ( is_wp_error( $response ) ) {
+            $this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        // The response is not OK.
+        if ( 200 !== (int) $response['response']['code'] ) {
+            $this->log->error( "Unexpected status code when opening URL $url: " . $response['response']['code'] );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        /*
 		 * We also store the package type.
 		 *
 		 * @since 3.20.0
 		 */
-		$json         = json_decode( $response['body'] );
-		$dataset_uri  = $json->datasetURI;
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
-
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
-
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
-
-	}
-
-	/**
-	 * Handle the edge case where a user submits the same key again
-	 * when he does not have the dataset uri to regain it.
-	 *
-	 * This can not be handled in the normal option update hook because
-	 * it is not being triggered when the save value equals to the one already
-	 * in the DB.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @param mixed $value The new, unserialized option value.
-	 * @param mixed $old_value The old option value.
-	 *
-	 * @return mixed The same value in the $value parameter
-	 */
-	function maybe_update_dataset_uri( $value, $old_value ) {
-
-		// Check the old key value and the new one. Here we're only handling the
-		// case where the key hasn't changed and the dataset URI isn't set. The
-		// other case, i.e. a new key is inserted, is handled at `update_key`.
-		$old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $value['key'] ) ? $value['key'] : '';
-
-		$dataset_uri = $this->get_dataset_uri();
-
-		if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
-
-			// make the request to the remote server to try to get the dataset uri.
-			$this->get_remote_dataset_uri( $new_key );
-		}
-
-		return $value;
-	}
-
-	/**
-	 * Get the API URI to retrieve the dataset URI using the WordLift Key.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param string $key The WordLift key to use.
-	 *
-	 * @return string The API URI.
-	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
-	}
+        $json         = json_decode( $response['body'] );
+        $dataset_uri  = $json->datasetURI;
+        $package_type = isset( $json->packageType ) ? $json->packageType : null;
+
+        $this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+
+        $this->set_dataset_uri( $dataset_uri );
+        $this->set_package_type( $package_type );
+
+    }
+
+    /**
+     * Handle the edge case where a user submits the same key again
+     * when he does not have the dataset uri to regain it.
+     *
+     * This can not be handled in the normal option update hook because
+     * it is not being triggered when the save value equals to the one already
+     * in the DB.
+     *
+     * @since 3.12.0
+     *
+     * @param mixed $value The new, unserialized option value.
+     * @param mixed $old_value The old option value.
+     *
+     * @return mixed The same value in the $value parameter
+     */
+    function maybe_update_dataset_uri( $value, $old_value ) {
+
+        // Check the old key value and the new one. Here we're only handling the
+        // case where the key hasn't changed and the dataset URI isn't set. The
+        // other case, i.e. a new key is inserted, is handled at `update_key`.
+        $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
+        $new_key = isset( $value['key'] ) ? $value['key'] : '';
+
+        $dataset_uri = $this->get_dataset_uri();
+
+        if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
+
+            // make the request to the remote server to try to get the dataset uri.
+            $this->get_remote_dataset_uri( $new_key );
+        }
+
+        return $value;
+    }
+
+    /**
+     * Get the API URI to retrieve the dataset URI using the WordLift Key.
+     *
+     * @since 3.11.0
+     *
+     * @param string $key The WordLift key to use.
+     *
+     * @return string The API URI.
+     */
+    public function get_accounts_by_key_dataset_uri( $key ) {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+    }
 
     /**
      * Get the API URI to retrieve the account info using the WordLift Key.
@@ -590,123 +590,123 @@ 
         return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/info";
     }
 
-	/**
-	 * Get the `accounts` end point.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @return string The `accounts` end point.
-	 */
-	public function get_accounts() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
-	}
-
-	/**
-	 * Get the `link by default` option.
-	 *
-	 * @since 3.13.0
-	 *
-	 * @return bool True if entities must be linked by default otherwise false.
-	 */
-	public function is_link_by_default() {
-
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
-	}
-
-	/**
-	 * Set the `link by default` option.
-	 *
-	 * @since 3.13.0
-	 *
-	 * @param bool $value True to enabling linking by default, otherwise false.
-	 */
-	public function set_link_by_default( $value ) {
-
-		$this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Get the 'analytics-enable' option.
-	 *
-	 * @since 3.21.0
-	 *
-	 * @return string 'no' or 'yes' representing bool.
-	 */
-	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
-	}
-
-	/**
-	 * Set the `analytics-enable` option.
-	 *
-	 * @since 3.21.0
-	 *
-	 * @param bool $value True to enabling analytics, otherwise false.
-	 */
-	public function set_is_analytics_enable( $value ) {
-
-		$this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
-	}
-
-	/**
-	 * Get the 'analytics-entity-uri-dimention' option.
-	 *
-	 * @since 3.21.0
-	 *
-	 * @return int
-	 */
-	public function get_analytics_entity_uri_dimension() {
-		return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
-	}
-
-	/**
-	 * Get the 'analytics-entity-type-dimension' option.
-	 *
-	 * @since 3.21.0
-	 *
-	 * @return int
-	 */
-	public function get_analytics_entity_type_dimension() {
-		return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
-	}
-
-	/**
-	 * Get the URL to perform autocomplete request.
-	 *
-	 * @since 3.15.0
-	 *
-	 * @return string The URL to call to perform the autocomplete request.
-	 */
-	public function get_autocomplete_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
-
-	}
-
-	/**
-	 * Get the URL to perform feedback deactivation request.
-	 *
-	 * @since 3.19.0
-	 *
-	 * @return string The URL to call to perform the feedback deactivation request.
-	 */
-	public function get_deactivation_feedback_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
-
-	}
-
-	/**
-	 * Get the base API URL.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @return string The base API URL.
-	 */
-	public function get_api_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
-	}
+    /**
+     * Get the `accounts` end point.
+     *
+     * @since 3.16.0
+     *
+     * @return string The `accounts` end point.
+     */
+    public function get_accounts() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+    }
+
+    /**
+     * Get the `link by default` option.
+     *
+     * @since 3.13.0
+     *
+     * @return bool True if entities must be linked by default otherwise false.
+     */
+    public function is_link_by_default() {
+
+        return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+    }
+
+    /**
+     * Set the `link by default` option.
+     *
+     * @since 3.13.0
+     *
+     * @param bool $value True to enabling linking by default, otherwise false.
+     */
+    public function set_link_by_default( $value ) {
+
+        $this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Get the 'analytics-enable' option.
+     *
+     * @since 3.21.0
+     *
+     * @return string 'no' or 'yes' representing bool.
+     */
+    public function is_analytics_enable() {
+        return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+    }
+
+    /**
+     * Set the `analytics-enable` option.
+     *
+     * @since 3.21.0
+     *
+     * @param bool $value True to enabling analytics, otherwise false.
+     */
+    public function set_is_analytics_enable( $value ) {
+
+        $this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
+    }
+
+    /**
+     * Get the 'analytics-entity-uri-dimention' option.
+     *
+     * @since 3.21.0
+     *
+     * @return int
+     */
+    public function get_analytics_entity_uri_dimension() {
+        return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
+    }
+
+    /**
+     * Get the 'analytics-entity-type-dimension' option.
+     *
+     * @since 3.21.0
+     *
+     * @return int
+     */
+    public function get_analytics_entity_type_dimension() {
+        return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
+    }
+
+    /**
+     * Get the URL to perform autocomplete request.
+     *
+     * @since 3.15.0
+     *
+     * @return string The URL to call to perform the autocomplete request.
+     */
+    public function get_autocomplete_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+
+    }
+
+    /**
+     * Get the URL to perform feedback deactivation request.
+     *
+     * @since 3.19.0
+     *
+     * @return string The URL to call to perform the feedback deactivation request.
+     */
+    public function get_deactivation_feedback_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+
+    }
+
+    /**
+     * Get the base API URL.
+     *
+     * @since 3.20.0
+     *
+     * @return string The base API URL.
+     */
+    public function get_api_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
+    }
 
 }

Spacing +85 added lines, -85 removed lines

@@ -10,7 +10,7 @@ 
  * @since      3.6.0
  */
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -138,7 +138,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		self::$instance = $this;
 
@@ -168,11 +168,11 @@ 
 	 *
 	 * @return mixed The configuration value or the default value if not found.
 	 */
-	private function get( $option, $key, $default = '' ) {
+	private function get($option, $key, $default = '') {
 
-		$options = get_option( $option, array() );
+		$options = get_option($option, array());
 
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+		return isset($options[$key]) ? $options[$key] : $default;
 	}
 
 	/**
@@ -184,12 +184,12 @@ 
 	 * @param string $key The value key.
 	 * @param mixed  $value The value.
 	 */
-	private function set( $option, $key, $value ) {
+	private function set($option, $key, $value) {
 
-		$values         = get_option( $option );
-		$values         = isset( $values ) ? $values : array();
-		$values[ $key ] = $value;
-		update_option( $option, $values );
+		$values         = get_option($option);
+		$values         = isset($values) ? $values : array();
+		$values[$key] = $value;
+		update_option($option, $values);
 
 	}
 
@@ -202,7 +202,7 @@ 
 	 */
 	public function get_entity_base_path() {
 
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+		return $this->get('wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity');
 	}
 
 	/**
@@ -212,9 +212,9 @@ 
 	 *
 	 * @param string $value The entity base path.
 	 */
-	public function set_entity_base_path( $value ) {
+	public function set_entity_base_path($value) {
 
-		$this->set( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value );
+		$this->set('wl_general_settings', self::ENTITY_BASE_PATH_KEY, $value);
 
 	}
 
@@ -227,7 +227,7 @@ 
 	 */
 	public function is_skip_wizard() {
 
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+		return $this->get('wl_general_settings', self::SKIP_WIZARD, false);
 	}
 
 	/**
@@ -237,9 +237,9 @@ 
 	 *
 	 * @param bool $value True to skip the wizard. We expect a boolean value.
 	 */
-	public function set_skip_wizard( $value ) {
+	public function set_skip_wizard($value) {
 
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
+		$this->set('wl_general_settings', self::SKIP_WIZARD, true === $value);
 
 	}
 
@@ -252,7 +252,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -262,9 +262,9 @@ 
 	 *
 	 * @param string $value WordLift's key.
 	 */
-	public function set_key( $value ) {
+	public function set_key($value) {
 
-		$this->set( 'wl_general_settings', self::KEY, $value );
+		$this->set('wl_general_settings', self::KEY, $value);
 	}
 
 	/**
@@ -278,7 +278,7 @@ 
 	 */
 	public function get_language_code() {
 
-		return $this->get( 'wl_general_settings', self::LANGUAGE, 'en' );
+		return $this->get('wl_general_settings', self::LANGUAGE, 'en');
 	}
 
 	/**
@@ -288,9 +288,9 @@ 
 	 *
 	 * @param string $value WordLift's language code.
 	 */
-	public function set_language_code( $value ) {
+	public function set_language_code($value) {
 
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
+		$this->set('wl_general_settings', self::LANGUAGE, $value);
 
 	}
 
@@ -301,9 +301,9 @@ 
 	 *
 	 * @param string $value The user preferences(yes/no).
 	 */
-	public function set_diagnostic_preferences( $value ) {
+	public function set_diagnostic_preferences($value) {
 
-		$this->set( 'wl_general_settings', self::SEND_DIAGNOSTIC, $value );
+		$this->set('wl_general_settings', self::SEND_DIAGNOSTIC, $value);
 
 	}
 
@@ -314,7 +314,7 @@ 
 	 */
 	public function get_diagnostic_preferences() {
 
-		return $this->get( 'wl_general_settings', self::SEND_DIAGNOSTIC, 'no' );
+		return $this->get('wl_general_settings', self::SEND_DIAGNOSTIC, 'no');
 	}
 
 	/**
@@ -326,7 +326,7 @@ 
 	 */
 	public function get_country_code() {
 
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+		return $this->get('wl_general_settings', self::COUNTRY_CODE, 'us');
 	}
 
 	/**
@@ -336,9 +336,9 @@ 
 	 *
 	 * @param string $value WordLift's country code.
 	 */
-	public function set_country_code( $value ) {
+	public function set_country_code($value) {
 
-		$this->set( 'wl_general_settings', self::COUNTRY_CODE, $value );
+		$this->set('wl_general_settings', self::COUNTRY_CODE, $value);
 
 	}
 
@@ -354,7 +354,7 @@ 
 	 */
 	public function get_publisher_id() {
 
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+		return $this->get('wl_general_settings', self::PUBLISHER_ID, null);
 	}
 
 	/**
@@ -364,9 +364,9 @@ 
 	 *
 	 * @param int $value The publisher entity post id.
 	 */
-	public function set_publisher_id( $value ) {
+	public function set_publisher_id($value) {
 
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+		$this->set('wl_general_settings', self::PUBLISHER_ID, $value);
 
 	}
 
@@ -379,7 +379,7 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 	}
 
 	/**
@@ -389,9 +389,9 @@ 
 	 *
 	 * @param string $value The dataset URI.
 	 */
-	public function set_dataset_uri( $value ) {
+	public function set_dataset_uri($value) {
 
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+		$this->set('wl_advanced_settings', self::DATASET_URI, $value);
 	}
 
 	/**
@@ -403,7 +403,7 @@ 
 	 */
 	public function get_package_type() {
 
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+		return $this->get('wl_advanced_settings', self::PACKAGE_TYPE, null);
 	}
 
 	/**
@@ -413,9 +413,9 @@ 
 	 *
 	 * @param string $value The package type.
 	 */
-	public function set_package_type( $value ) {
+	public function set_package_type($value) {
 
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+		$this->set('wl_advanced_settings', self::PACKAGE_TYPE, $value);
 	}
 
 	/**
@@ -431,11 +431,11 @@ 
 	 * @param array $old_value The old settings.
 	 * @param array $new_value The new settings.
 	 */
-	public function update_key( $old_value, $new_value ) {
+	public function update_key($old_value, $new_value) {
 
 		// Check the old key value and the new one. We're going to ask for the dataset URI only if the key has changed.
 		// $old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $new_value['key'] ) ? $new_value['key'] : '';
+		$new_key = isset($new_value['key']) ? $new_value['key'] : '';
 
 		// If the key hasn't changed, don't do anything.
 		// WARN The 'update_option' hook is fired only if the new and old value are not equal.
@@ -444,12 +444,12 @@ 
 		//		}
 
 		// If the key is empty, empty the dataset URI.
-		if ( '' === $new_key ) {
-			$this->set_dataset_uri( '' );
+		if ('' === $new_key) {
+			$this->set_dataset_uri('');
 		}
 
 		// make the request to the remote server.
-		$this->get_remote_dataset_uri( $new_key );
+		$this->get_remote_dataset_uri($new_key);
 
 	}
 
@@ -464,9 +464,9 @@ 
 	 *
 	 * @param string $key The key to be used.
 	 */
-	public function get_remote_dataset_uri( $key ) {
+	public function get_remote_dataset_uri($key) {
 
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
+		$this->log->trace('Getting the remote dataset URI and package type...');
 
 		/**
 		 * Allow 3rd parties to change the site_url.
@@ -477,37 +477,37 @@ 
 		 *
 		 * @param string $site_url The site url.
 		 */
-		$site_url = apply_filters( 'wl_production_site_url', site_url() );
+		$site_url = apply_filters('wl_production_site_url', site_url());
 
 		// Build the URL.
 		$url = $this->get_accounts()
-		       . '?key=' . rawurlencode( $key )
-		       . '&url=' . rawurlencode( $site_url )
-		       . '&country=' . $this->get_country_code()
-		       . '&language=' . $this->get_language_code();
+		       . '?key='.rawurlencode($key)
+		       . '&url='.rawurlencode($site_url)
+		       . '&country='.$this->get_country_code()
+		       . '&language='.$this->get_language_code();
 
-		$args     = wp_parse_args( unserialize( WL_REDLINK_API_HTTP_OPTIONS ), array(
+		$args = wp_parse_args(unserialize(WL_REDLINK_API_HTTP_OPTIONS), array(
 			'method' => 'PUT',
-		) );
+		));
 
-		$response = wp_remote_request( $url, $args );
+		$response = wp_remote_request($url, $args);
 
 		// The response is an error.
-		if ( is_wp_error( $response ) ) {
-			$this->log->error( 'An error occurred setting the dataset URI: ' . $response->get_error_message() );
+		if (is_wp_error($response)) {
+			$this->log->error('An error occurred setting the dataset URI: '.$response->get_error_message());
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
 
 		// The response is not OK.
-		if ( 200 !== (int) $response['response']['code'] ) {
-			$this->log->error( "Unexpected status code when opening URL $url: " . $response['response']['code'] );
+		if (200 !== (int) $response['response']['code']) {
+			$this->log->error("Unexpected status code when opening URL $url: ".$response['response']['code']);
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -517,14 +517,14 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$json         = json_decode( $response['body'] );
+		$json         = json_decode($response['body']);
 		$dataset_uri  = $json->datasetURI;
-		$package_type = isset( $json->packageType ) ? $json->packageType : null;
+		$package_type = isset($json->packageType) ? $json->packageType : null;
 
-		$this->log->info( "Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]..." );
+		$this->log->info("Updating [ dataset uri :: $dataset_uri ][ package type :: $package_type ]...");
 
-		$this->set_dataset_uri( $dataset_uri );
-		$this->set_package_type( $package_type );
+		$this->set_dataset_uri($dataset_uri);
+		$this->set_package_type($package_type);
 
 	}
 
@@ -543,20 +543,20 @@ 
 	 *
 	 * @return mixed The same value in the $value parameter
 	 */
-	function maybe_update_dataset_uri( $value, $old_value ) {
+	function maybe_update_dataset_uri($value, $old_value) {
 
 		// Check the old key value and the new one. Here we're only handling the
 		// case where the key hasn't changed and the dataset URI isn't set. The
 		// other case, i.e. a new key is inserted, is handled at `update_key`.
-		$old_key = isset( $old_value['key'] ) ? $old_value['key'] : '';
-		$new_key = isset( $value['key'] ) ? $value['key'] : '';
+		$old_key = isset($old_value['key']) ? $old_value['key'] : '';
+		$new_key = isset($value['key']) ? $value['key'] : '';
 
 		$dataset_uri = $this->get_dataset_uri();
 
-		if ( ! empty( $new_key ) && $new_key === $old_key && empty( $dataset_uri ) ) {
+		if ( ! empty($new_key) && $new_key === $old_key && empty($dataset_uri)) {
 
 			// make the request to the remote server to try to get the dataset uri.
-			$this->get_remote_dataset_uri( $new_key );
+			$this->get_remote_dataset_uri($new_key);
 		}
 
 		return $value;
@@ -571,9 +571,9 @@ 
 	 *
 	 * @return string The API URI.
 	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
+	public function get_accounts_by_key_dataset_uri($key) {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE."accounts/key=$key/dataset_uri";
 	}
 
     /**
@@ -585,9 +585,9 @@ 
      *
      * @return string The API URI.
      */
-    public function get_accounts_info_by_key( $key ) {
+    public function get_accounts_info_by_key($key) {
 
-        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/info";
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE."accounts/info";
     }
 
 	/**
@@ -599,7 +599,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -611,7 +611,7 @@ 
 	 */
 	public function is_link_by_default() {
 
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+		return 'yes' === $this->get('wl_general_settings', self::LINK_BY_DEFAULT, 'yes');
 	}
 
 	/**
@@ -621,9 +621,9 @@ 
 	 *
 	 * @param bool $value True to enabling linking by default, otherwise false.
 	 */
-	public function set_link_by_default( $value ) {
+	public function set_link_by_default($value) {
 
-		$this->set( 'wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no' );
+		$this->set('wl_general_settings', self::LINK_BY_DEFAULT, true === $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -634,7 +634,7 @@ 
 	 * @return string 'no' or 'yes' representing bool.
 	 */
 	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+		return 'yes' === $this->get('wl_analytics_settings', self::ANALYTICS_ENABLE, 'no');
 	}
 
 	/**
@@ -644,9 +644,9 @@ 
 	 *
 	 * @param bool $value True to enabling analytics, otherwise false.
 	 */
-	public function set_is_analytics_enable( $value ) {
+	public function set_is_analytics_enable($value) {
 
-		$this->set( 'wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no' );
+		$this->set('wl_general_settings', self::ANALYTICS_ENABLE, true === $value ? 'yes' : 'no');
 	}
 
 	/**
@@ -657,7 +657,7 @@ 
 	 * @return int
 	 */
 	public function get_analytics_entity_uri_dimension() {
-		return (int) $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1 );
+		return (int) $this->get('wl_analytics_settings', self::ANALYTICS_ENTITY_URI_DIMENSION, 1);
 	}
 
 	/**
@@ -668,7 +668,7 @@ 
 	 * @return int
 	 */
 	public function get_analytics_entity_type_dimension() {
-		return $this->get( 'wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2 );
+		return $this->get('wl_analytics_settings', self::ANALYTICS_ENTITY_TYPE_DIMENSION, 2);
 	}
 
 	/**
@@ -680,7 +680,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -693,7 +693,7 @@ 
 	 */
 	public function get_deactivation_feedback_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'feedbacks';
 
 	}
 

src/includes/class-wordlift-key-validation-service.php

Indentation +63 added lines, -63 removed lines

@@ -17,55 +17,55 @@ 
  */
 class Wordlift_Key_Validation_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * Create a {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since 3.14.0
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	public function __construct( $configuration_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
-
-		$this->configuration_service = $configuration_service;
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * Create a {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since 3.14.0
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    public function __construct( $configuration_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+
+        $this->configuration_service = $configuration_service;
         add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
         add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
 
-	}
+    }
 
-	/**
-	 * Validate the provided key.
-	 *
-	 * @since 3.9.0
-	 *
-	 * @param string $key WordLift's key to validate.
-	 *
-	 * @return bool True if the key is valid, otherwise false.
-	 */
-	public function is_valid( $key ) {
+    /**
+     * Validate the provided key.
+     *
+     * @since 3.9.0
+     *
+     * @param string $key WordLift's key to validate.
+     *
+     * @return bool True if the key is valid, otherwise false.
+     */
+    public function is_valid( $key ) {
 
-		$this->log->debug( 'Validating key...' );
+        $this->log->debug( 'Validating key...' );
 
-		// Request the account info as a way to validate the key
+        // Request the account info as a way to validate the key
 
         $args = array_merge_recursive(
                     unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
@@ -79,22 +79,22 @@ 
         $response = wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
 
         return $response;
-	}
-
-	/**
-	 * This function is hooked to the `wl_validate_key` AJAX call.
-	 *
-	 * @since 3.9.0
-	 */
-	public function validate_key() {
-
-		// Ensure we don't have garbage before us.
-		ob_clean();
-
-		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {
-			wp_send_json_error( 'The key parameter is required.' );
-		}
+    }
+
+    /**
+     * This function is hooked to the `wl_validate_key` AJAX call.
+     *
+     * @since 3.9.0
+     */
+    public function validate_key() {
+
+        // Ensure we don't have garbage before us.
+        ob_clean();
+
+        // Check if we have a key.
+        if ( ! isset( $_POST['key'] ) ) {
+            wp_send_json_error( 'The key parameter is required.' );
+        }
         $response = $this->is_valid( $_POST['key'] );
         $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
         $url = $res_body['url'];
@@ -116,10 +116,10 @@ 
             $message = "";
         }
 
-		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success( array( 'valid' => $is_valid, 'message' => $message ) );
+        // Set a response with valid set to true or false according to the key validity with message.
+        wp_send_json_success( array( 'valid' => $is_valid, 'message' => $message ) );
 
-	}
+    }
 
     /**
      * This function is hooked `admin_init` to check _wl_blog_url.
@@ -129,7 +129,7 @@ 
     {
         $wl_blog_url = get_option( '_wl_blog_url' );
         if ( !$wl_blog_url ) {
-           update_option( '_wl_blog_url', site_url(), true );
+            update_option( '_wl_blog_url', site_url(), true );
         }
         if ( $wl_blog_url != site_url() ) {
             Wordlift_Configuration_Service::get_instance()->set_key( '' );  

Spacing +26 added lines, -26 removed lines

@@ -42,13 +42,13 @@ 
 	 *
 	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Key_Validation_Service');
 
 		$this->configuration_service = $configuration_service;
-        add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-        add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+        add_action('admin_init', array($this, 'wl_load_plugin'));
+        add_action('admin_notices', array($this, 'wl_key_update_notice'));
 
 	}
 
@@ -61,14 +61,14 @@ 
 	 *
 	 * @return bool True if the key is valid, otherwise false.
 	 */
-	public function is_valid( $key ) {
+	public function is_valid($key) {
 
-		$this->log->debug( 'Validating key...' );
+		$this->log->debug('Validating key...');
 
 		// Request the account info as a way to validate the key
 
         $args = array_merge_recursive(
-                    unserialize( WL_REDLINK_API_HTTP_OPTIONS ),
+                    unserialize(WL_REDLINK_API_HTTP_OPTIONS),
                             array(
                             'headers' => array( 
                                 'Content-Type'    => 'application/json; charset=utf-8',
@@ -76,7 +76,7 @@ 
                             ) 
                 );
 
-        $response = wp_remote_get( $this->configuration_service->get_accounts_info_by_key( $key ), $args );
+        $response = wp_remote_get($this->configuration_service->get_accounts_info_by_key($key), $args);
 
         return $response;
 	}
@@ -92,32 +92,32 @@ 
 		ob_clean();
 
 		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {
-			wp_send_json_error( 'The key parameter is required.' );
+		if ( ! isset($_POST['key'])) {
+			wp_send_json_error('The key parameter is required.');
 		}
-        $response = $this->is_valid( $_POST['key'] );
-        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+        $response = $this->is_valid($_POST['key']);
+        $res_body = json_decode(wp_remote_retrieve_body($response), true);
         $url = $res_body['url'];
         
         //Set a response with valid set to true and messgae according to the key validity with url match
-        if ( ! is_wp_error( $response ) && 200 === (int) $response['response']['code'] && $url == site_url() ) {
+        if ( ! is_wp_error($response) && 200 === (int) $response['response']['code'] && $url == site_url()) {
             $is_valid = true;
             $message = " ";           
         }
 
-        if ( ! is_wp_error( $response ) && 200 === (int) $response['response']['code'] && $url != site_url() ) {
+        if ( ! is_wp_error($response) && 200 === (int) $response['response']['code'] && $url != site_url()) {
             $is_valid = false;
-            $message = __( "The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.", 'wordlift' );
-            Wordlift_Configuration_Service::get_instance()->set_key( '' );         
+            $message = __("The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.", 'wordlift');
+            Wordlift_Configuration_Service::get_instance()->set_key('');         
         }
         
-        if ( is_wp_error( $response ) || 500 === (int) $response['response']['code'] ) {
+        if (is_wp_error($response) || 500 === (int) $response['response']['code']) {
             $is_valid = false;
             $message = "";
         }
 
 		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success( array( 'valid' => $is_valid, 'message' => $message ) );
+		wp_send_json_success(array('valid' => $is_valid, 'message' => $message));
 
 	}
 
@@ -127,13 +127,13 @@ 
      */
     public function wl_load_plugin()
     {
-        $wl_blog_url = get_option( '_wl_blog_url' );
-        if ( !$wl_blog_url ) {
-           update_option( '_wl_blog_url', site_url(), true );
+        $wl_blog_url = get_option('_wl_blog_url');
+        if ( ! $wl_blog_url) {
+           update_option('_wl_blog_url', site_url(), true);
         }
-        if ( $wl_blog_url != site_url() ) {
-            Wordlift_Configuration_Service::get_instance()->set_key( '' );  
-            set_transient( 'wl-key-error-msg' , __( "Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift' ), 10 );
+        if ($wl_blog_url != site_url()) {
+            Wordlift_Configuration_Service::get_instance()->set_key('');  
+            set_transient('wl-key-error-msg', __("Your web site URL has changed. To avoid data corruption, WordLift's key has been removed. Please provide a new key in WordLift Settings. If you believe this to be an error, please contact us at hello@wordlift.io", 'wordlift'), 10);
         }
     }
 
@@ -142,10 +142,10 @@ 
      *
      */
     public function wl_key_update_notice() {
-        if ( get_transient( 'wl-key-error-msg' ) ) {
+        if (get_transient('wl-key-error-msg')) {
         ?>
             <div class="updated notice is-dismissible error">
-                <p><?php _e( get_transient('wl-key-error-msg'), 'wordlift' ); ?></p>
+                <p><?php _e(get_transient('wl-key-error-msg'), 'wordlift'); ?></p>
             </div>
         <?php
         }