insideout10 / wordlift-plugin

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

Indentation +184 added lines, -184 removed lines

@@ -20,192 +20,192 @@
  */
 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;
-
-	/**
-	 * @var Ttl_Cache
-	 */
-	private $ttl_cache_service;
-
-	/**
-	 * Create a {@link Wordlift_Key_Validation_Service} instance.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
-
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
-		/**
-		 * Filter: wl_feature__enable__notices.
-		 *
-		 * @param bool whether notices need to be enabled or not.
-		 *
-		 * @return bool
-		 * @since 3.27.6
-		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
-		}
-
-		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
-
-	}
-
-	/**
-	 * Validate the provided key.
-	 *
-	 * @param string $key WordLift's key to validate.
-	 *
-	 * @return WP_Error|array The response or WP_Error on failure.
-	 * @since 3.9.0
-	 */
-	public function get_account_info( $key ) {
-
-		$this->log->debug( 'Validating key...' );
-
-		return Default_Api_Service::get_instance()->get(
-			'/accounts/info',
-			array(
-				'Authorization' => "Key $key",
-			)
-		)->get_response();
-	}
-
-	/**
-	 * Check if key is valid
-	 *
-	 * @param $key string
-	 *
-	 * @return bool
-	 */
-	public function is_key_valid( $key ) {
-
-		$response = $this->get_account_info( $key );
-
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			return false;
-		}
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		$url = $res_body['url'];
-
-		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-		if ( $url === null || $url === $site_url ) {
-			return true;
-		}
-
-		return false;
-	}
-
-	/**
-	 * 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'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The key parameter is required.' );
-		}
-
-		$response = $this->get_account_info( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) );  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-
-		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
-			wp_send_json_success(
-				array(
-					'valid'    => false,
-					'message'  => '',
-					'response' => $response,
-					'api_url'  => Default_Api_Service::get_instance()->get_base_url(),
-				)
-			);
-		}
-
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
-
-		// The URL stored in WLS. If this is the initial install the URL may be null.
-		$url = $res_body['url'];
-
-		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		// If the URL isn't set or matches, then it's valid.
-		if ( $url === null || $url === $site_url ) {
-			// Invalidate the cache key
-			$this->ttl_cache_service->delete( 'is_key_valid' );
-			wp_send_json_success(
-				array(
-					'valid'   => true,
-					'message' => '',
-				)
-			);
-		}
-
-		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== $site_url ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
-			wp_send_json_success(
-				array(
-					'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' ),
-				)
-			);
-		}
-
-		// Set a response with valid set to true or false according to the key validity with message.
-		wp_send_json_success(
-			array(
-				'valid'   => false,
-				'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
-			)
-		);
-	}
-
-	/**
-	 * This function is hooked `admin_init` to check _wl_blog_url.
-	 */
-	public function wl_load_plugin() {
-
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = get_option( 'home' );
-
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} elseif ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			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 );
-		}
-
-	}
-
-	/**
-	 * This function is hooked to the `admin_notices` to show admin notification.
-	 */
-	public function wl_key_update_notice() {
-		if ( get_transient( 'wl-key-error-msg' ) ) {
-			?>
+    /**
+     * 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;
+
+    /**
+     * @var Ttl_Cache
+     */
+    private $ttl_cache_service;
+
+    /**
+     * Create a {@link Wordlift_Key_Validation_Service} instance.
+     *
+     * @since 3.14.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+
+        add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+        /**
+         * Filter: wl_feature__enable__notices.
+         *
+         * @param bool whether notices need to be enabled or not.
+         *
+         * @return bool
+         * @since 3.27.6
+         */
+        if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
+            add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+        }
+
+        $this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
+
+    }
+
+    /**
+     * Validate the provided key.
+     *
+     * @param string $key WordLift's key to validate.
+     *
+     * @return WP_Error|array The response or WP_Error on failure.
+     * @since 3.9.0
+     */
+    public function get_account_info( $key ) {
+
+        $this->log->debug( 'Validating key...' );
+
+        return Default_Api_Service::get_instance()->get(
+            '/accounts/info',
+            array(
+                'Authorization' => "Key $key",
+            )
+        )->get_response();
+    }
+
+    /**
+     * Check if key is valid
+     *
+     * @param $key string
+     *
+     * @return bool
+     */
+    public function is_key_valid( $key ) {
+
+        $response = $this->get_account_info( $key );
+
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            return false;
+        }
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        $url = $res_body['url'];
+
+        // Considering that production URL may be filtered.
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+        if ( $url === null || $url === $site_url ) {
+            return true;
+        }
+
+        return false;
+    }
+
+    /**
+     * 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'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+            wp_send_json_error( 'The key parameter is required.' );
+        }
+
+        $response = $this->get_account_info( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) );  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+
+        // If we got an error, return invalid.
+        if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+            wp_send_json_success(
+                array(
+                    'valid'    => false,
+                    'message'  => '',
+                    'response' => $response,
+                    'api_url'  => Default_Api_Service::get_instance()->get_base_url(),
+                )
+            );
+        }
+
+        $res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+
+        // The URL stored in WLS. If this is the initial install the URL may be null.
+        $url = $res_body['url'];
+
+        // Considering that production URL may be filtered.
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        // If the URL isn't set or matches, then it's valid.
+        if ( $url === null || $url === $site_url ) {
+            // Invalidate the cache key
+            $this->ttl_cache_service->delete( 'is_key_valid' );
+            wp_send_json_success(
+                array(
+                    'valid'   => true,
+                    'message' => '',
+                )
+            );
+        }
+
+        // If the URL doesn't match it means that this key has been configured elsewhere already.
+        if ( $url !== $site_url ) {
+            Wordlift_Configuration_Service::get_instance()->set_key( '' );
+            wp_send_json_success(
+                array(
+                    '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' ),
+                )
+            );
+        }
+
+        // Set a response with valid set to true or false according to the key validity with message.
+        wp_send_json_success(
+            array(
+                'valid'   => false,
+                'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
+            )
+        );
+    }
+
+    /**
+     * This function is hooked `admin_init` to check _wl_blog_url.
+     */
+    public function wl_load_plugin() {
+
+        $wl_blog_url = get_option( '_wl_blog_url' );
+        $home_url    = get_option( 'home' );
+
+        if ( ! $wl_blog_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+        } elseif ( $wl_blog_url !== $home_url ) {
+            update_option( '_wl_blog_url', $home_url, true );
+            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 );
+        }
+
+    }
+
+    /**
+     * This function is hooked to the `admin_notices` to show admin notification.
+     */
+    public function wl_key_update_notice() {
+        if ( get_transient( 'wl-key-error-msg' ) ) {
+            ?>
 			<div class="updated notice is-dismissible error">
 				<p><?php esc_html( get_transient( 'wl-key-error-msg' ) ); ?></p>
 			</div>
 			<?php
-		}
-	}
+        }
+    }
 }

Spacing +37 added lines, -37 removed lines

@@ -41,9 +41,9 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Key_Validation_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Key_Validation_Service');
 
-		add_action( 'admin_init', array( $this, 'wl_load_plugin' ) );
+		add_action('admin_init', array($this, 'wl_load_plugin'));
 		/**
 		 * Filter: wl_feature__enable__notices.
 		 *
@@ -52,11 +52,11 @@ 
 		 * @return bool
 		 * @since 3.27.6
 		 */
-		if ( apply_filters( 'wl_feature__enable__notices', true ) ) {
-			add_action( 'admin_notices', array( $this, 'wl_key_update_notice' ) );
+		if (apply_filters('wl_feature__enable__notices', true)) {
+			add_action('admin_notices', array($this, 'wl_key_update_notice'));
 		}
 
-		$this->ttl_cache_service = new Ttl_Cache( 'key-validation-notification' );
+		$this->ttl_cache_service = new Ttl_Cache('key-validation-notification');
 
 	}
 
@@ -68,9 +68,9 @@ 
 	 * @return WP_Error|array The response or WP_Error on failure.
 	 * @since 3.9.0
 	 */
-	public function get_account_info( $key ) {
+	public function get_account_info($key) {
 
-		$this->log->debug( 'Validating key...' );
+		$this->log->debug('Validating key...');
 
 		return Default_Api_Service::get_instance()->get(
 			'/accounts/info',
@@ -87,21 +87,21 @@ 
 	 *
 	 * @return bool
 	 */
-	public function is_key_valid( $key ) {
+	public function is_key_valid($key) {
 
-		$response = $this->get_account_info( $key );
+		$response = $this->get_account_info($key);
 
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
 			return false;
 		}
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		$url = $res_body['url'];
 
 		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-		if ( $url === null || $url === $site_url ) {
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
+		if ($url === null || $url === $site_url) {
 			return true;
 		}
 
@@ -119,14 +119,14 @@ 
 		ob_clean();
 
 		// Check if we have a key.
-		if ( ! isset( $_POST['key'] ) ) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
-			wp_send_json_error( 'The key parameter is required.' );
+		if ( ! isset($_POST['key'])) {  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+			wp_send_json_error('The key parameter is required.');
 		}
 
-		$response = $this->get_account_info( sanitize_text_field( wp_unslash( (string) $_POST['key'] ) ) );  //phpcs:ignore WordPress.Security.NonceVerification.Missing
+		$response = $this->get_account_info(sanitize_text_field(wp_unslash((string) $_POST['key']))); //phpcs:ignore WordPress.Security.NonceVerification.Missing
 
 		// If we got an error, return invalid.
-		if ( is_wp_error( $response ) || 2 !== (int) $response['response']['code'] / 100 ) {
+		if (is_wp_error($response) || 2 !== (int) $response['response']['code'] / 100) {
 			wp_send_json_success(
 				array(
 					'valid'    => false,
@@ -137,19 +137,19 @@ 
 			);
 		}
 
-		$res_body = json_decode( wp_remote_retrieve_body( $response ), true );
+		$res_body = json_decode(wp_remote_retrieve_body($response), true);
 
 		// The URL stored in WLS. If this is the initial install the URL may be null.
 		$url = $res_body['url'];
 
 		// Considering that production URL may be filtered.
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
 
 		// If the URL isn't set or matches, then it's valid.
-		if ( $url === null || $url === $site_url ) {
+		if ($url === null || $url === $site_url) {
 			// Invalidate the cache key
-			$this->ttl_cache_service->delete( 'is_key_valid' );
+			$this->ttl_cache_service->delete('is_key_valid');
 			wp_send_json_success(
 				array(
 					'valid'   => true,
@@ -159,12 +159,12 @@ 
 		}
 
 		// If the URL doesn't match it means that this key has been configured elsewhere already.
-		if ( $url !== $site_url ) {
-			Wordlift_Configuration_Service::get_instance()->set_key( '' );
+		if ($url !== $site_url) {
+			Wordlift_Configuration_Service::get_instance()->set_key('');
 			wp_send_json_success(
 				array(
 					'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' ),
+					'message' => __('The key is already used on another site, please contact us at hello@wordlift.io to move the key to another site.', 'wordlift'),
 				)
 			);
 		}
@@ -173,7 +173,7 @@ 
 		wp_send_json_success(
 			array(
 				'valid'   => false,
-				'message' => __( 'An error occurred, please contact us at hello@wordlift.io', 'wordlift' ),
+				'message' => __('An error occurred, please contact us at hello@wordlift.io', 'wordlift'),
 			)
 		);
 	}
@@ -183,15 +183,15 @@ 
 	 */
 	public function wl_load_plugin() {
 
-		$wl_blog_url = get_option( '_wl_blog_url' );
-		$home_url    = get_option( 'home' );
+		$wl_blog_url = get_option('_wl_blog_url');
+		$home_url    = get_option('home');
 
-		if ( ! $wl_blog_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-		} elseif ( $wl_blog_url !== $home_url ) {
-			update_option( '_wl_blog_url', $home_url, true );
-			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) {
+			update_option('_wl_blog_url', $home_url, true);
+		} elseif ($wl_blog_url !== $home_url) {
+			update_option('_wl_blog_url', $home_url, true);
+			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);
 		}
 
 	}
@@ -200,10 +200,10 @@ 
 	 * This function is hooked to the `admin_notices` to show admin notification.
 	 */
 	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 esc_html( get_transient( 'wl-key-error-msg' ) ); ?></p>
+				<p><?php esc_html(get_transient('wl-key-error-msg')); ?></p>
 			</div>
 			<?php
 		}

src/includes/class-wordlift-google-analytics-export-service.php

Indentation +135 added lines, -135 removed lines

@@ -18,103 +18,103 @@ 
  */
 class Wordlift_Google_Analytics_Export_Service {
 
-	/**
-	 * Export the site data that could be imported in Google Analytics.
-	 * It will works only when permalink structure is set to "Postname".
-	 *
-	 * @since 3.16.0
-	 *
-	 * @return void
-	 */
-	public function export() {
-		// Bail if the permalink structure is different from "Post name".
-		if ( ! $this->is_postname_permalink_structure() ) {
-			wp_die( 'The current permalink structure do not allow to export your data. Please change the permalink structure to "Post name".' );
-		}
-
-		// Output the file data. @codingStandardsIgnoreLine
-		@ob_end_clean();
-
-		// Generate unique filename using current timestamp.
-		$filename = 'wl-ga-export-' . gmdate( 'Y-m-d-H-i-s' ) . '.csv';
-
-		// Add proper file headers.
-		header( "Content-Disposition: attachment; filename=$filename" );
-		header( 'Content-Type: text/csv; charset=' . get_bloginfo( 'charset' ) );
-
-		// Do not cache the file.
-		header( 'Pragma: no-cache' );
-		header( 'Expires: 0' );
-
-		// Build the CSV file.
-		$this->create_csv();
-
-		wp_die();
-	}
-
-	/**
-	 * Return site path. Some installations are in subdirectories
-	 * and we need add them to expported permalinks.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @return string The site path.
-	 */
-	public function get_site_path() {
-		// Get home url from database.
-		$home_url = home_url( '/' );
-
-		// Parse the url.
-		$parsed = wp_parse_url( $home_url );
-
-		// Return the path.
-		return $parsed['path'];
-	}
-
-	/**
-	 * Check if the current permalink structure is set to "Post name".
-	 *
-	 * @since 3.16.0
-	 *
-	 * @return bool whether the structure is "Post name" or not.
-	 */
-	public static function is_postname_permalink_structure() {
-		// Get current permalink structure.
-		$structure = get_option( 'permalink_structure' );
-
-		// The regular expression. It will check if the site structure contains postname.
-		$regex = '~^/\%postname\%/$~';
-
-		// Check if the site structure match the rquired one.
-		preg_match( $regex, $structure, $matches );
-
-		// Bail if the site have different structure.
-		if ( empty( $matches ) ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Generate array data, that should be exported as csv.
-	 * The data contains the post/page title, entity name and type.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @return array $items Content data.
-	 */
-	public function get_content_data() {
-		// Get the global $wpdb.
-		global $wpdb;
-
-		// Site path (optional).
-		$path = $this->get_site_path();
-
-		// Get the data.
-		$items = $wpdb->get_results(
-			$wpdb->prepare(
-				"SELECT
+    /**
+     * Export the site data that could be imported in Google Analytics.
+     * It will works only when permalink structure is set to "Postname".
+     *
+     * @since 3.16.0
+     *
+     * @return void
+     */
+    public function export() {
+        // Bail if the permalink structure is different from "Post name".
+        if ( ! $this->is_postname_permalink_structure() ) {
+            wp_die( 'The current permalink structure do not allow to export your data. Please change the permalink structure to "Post name".' );
+        }
+
+        // Output the file data. @codingStandardsIgnoreLine
+        @ob_end_clean();
+
+        // Generate unique filename using current timestamp.
+        $filename = 'wl-ga-export-' . gmdate( 'Y-m-d-H-i-s' ) . '.csv';
+
+        // Add proper file headers.
+        header( "Content-Disposition: attachment; filename=$filename" );
+        header( 'Content-Type: text/csv; charset=' . get_bloginfo( 'charset' ) );
+
+        // Do not cache the file.
+        header( 'Pragma: no-cache' );
+        header( 'Expires: 0' );
+
+        // Build the CSV file.
+        $this->create_csv();
+
+        wp_die();
+    }
+
+    /**
+     * Return site path. Some installations are in subdirectories
+     * and we need add them to expported permalinks.
+     *
+     * @since 3.16.0
+     *
+     * @return string The site path.
+     */
+    public function get_site_path() {
+        // Get home url from database.
+        $home_url = home_url( '/' );
+
+        // Parse the url.
+        $parsed = wp_parse_url( $home_url );
+
+        // Return the path.
+        return $parsed['path'];
+    }
+
+    /**
+     * Check if the current permalink structure is set to "Post name".
+     *
+     * @since 3.16.0
+     *
+     * @return bool whether the structure is "Post name" or not.
+     */
+    public static function is_postname_permalink_structure() {
+        // Get current permalink structure.
+        $structure = get_option( 'permalink_structure' );
+
+        // The regular expression. It will check if the site structure contains postname.
+        $regex = '~^/\%postname\%/$~';
+
+        // Check if the site structure match the rquired one.
+        preg_match( $regex, $structure, $matches );
+
+        // Bail if the site have different structure.
+        if ( empty( $matches ) ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Generate array data, that should be exported as csv.
+     * The data contains the post/page title, entity name and type.
+     *
+     * @since 3.16.0
+     *
+     * @return array $items Content data.
+     */
+    public function get_content_data() {
+        // Get the global $wpdb.
+        global $wpdb;
+
+        // Site path (optional).
+        $path = $this->get_site_path();
+
+        // Get the data.
+        $items = $wpdb->get_results(
+            $wpdb->prepare(
+                "SELECT
 					CONCAT( %s, p.post_name, '/' ) AS 'post_name',
 					p1.post_name AS 'entity_name',
 					t.slug AS 'entity_type'
@@ -131,43 +131,43 @@ 
 					INNER JOIN {$wpdb->prefix}terms t
 						ON t.term_id = tt.term_id
 					WHERE p.post_type IN ( 'page', 'post' );",
-				$path
-			)
-		); // db call ok; no-cache ok.
-
-		return $items;
-	}
-
-	/**
-	 * Create the CSV file that will be downloaded.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @return void
-	 */
-	public function create_csv() {
-		// Create a file pointer connected to the output stream.
-		// Ignoring linter notices below that complain about file output which do not actually happen.
-		$file = fopen( 'php://output', 'w' );
-
-		// Add the column headers. @codingStandardsIgnoreLine
-		fputcsv(
-			$file,
-			array(
-				'ga:pagePath',
-				'ga:dimension1',
-				'ga:dimension2',
-			)
-		);
-
-		// Cycle through items and add each item data to the file.
-		foreach ( $this->get_content_data() as $row ) {
-			// Add new line in the file. @codingStandardsIgnoreLine
-			fputcsv(
-				$file,
-				(array) $row // convert the object to array.
-			);
-		}
-	}
+                $path
+            )
+        ); // db call ok; no-cache ok.
+
+        return $items;
+    }
+
+    /**
+     * Create the CSV file that will be downloaded.
+     *
+     * @since 3.16.0
+     *
+     * @return void
+     */
+    public function create_csv() {
+        // Create a file pointer connected to the output stream.
+        // Ignoring linter notices below that complain about file output which do not actually happen.
+        $file = fopen( 'php://output', 'w' );
+
+        // Add the column headers. @codingStandardsIgnoreLine
+        fputcsv(
+            $file,
+            array(
+                'ga:pagePath',
+                'ga:dimension1',
+                'ga:dimension2',
+            )
+        );
+
+        // Cycle through items and add each item data to the file.
+        foreach ( $this->get_content_data() as $row ) {
+            // Add new line in the file. @codingStandardsIgnoreLine
+            fputcsv(
+                $file,
+                (array) $row // convert the object to array.
+            );
+        }
+    }
 
 }

Spacing +14 added lines, -14 removed lines

@@ -28,23 +28,23 @@ 
 	 */
 	public function export() {
 		// Bail if the permalink structure is different from "Post name".
-		if ( ! $this->is_postname_permalink_structure() ) {
-			wp_die( 'The current permalink structure do not allow to export your data. Please change the permalink structure to "Post name".' );
+		if ( ! $this->is_postname_permalink_structure()) {
+			wp_die('The current permalink structure do not allow to export your data. Please change the permalink structure to "Post name".');
 		}
 
 		// Output the file data. @codingStandardsIgnoreLine
 		@ob_end_clean();
 
 		// Generate unique filename using current timestamp.
-		$filename = 'wl-ga-export-' . gmdate( 'Y-m-d-H-i-s' ) . '.csv';
+		$filename = 'wl-ga-export-'.gmdate('Y-m-d-H-i-s').'.csv';
 
 		// Add proper file headers.
-		header( "Content-Disposition: attachment; filename=$filename" );
-		header( 'Content-Type: text/csv; charset=' . get_bloginfo( 'charset' ) );
+		header("Content-Disposition: attachment; filename=$filename");
+		header('Content-Type: text/csv; charset='.get_bloginfo('charset'));
 
 		// Do not cache the file.
-		header( 'Pragma: no-cache' );
-		header( 'Expires: 0' );
+		header('Pragma: no-cache');
+		header('Expires: 0');
 
 		// Build the CSV file.
 		$this->create_csv();
@@ -62,10 +62,10 @@ 
 	 */
 	public function get_site_path() {
 		// Get home url from database.
-		$home_url = home_url( '/' );
+		$home_url = home_url('/');
 
 		// Parse the url.
-		$parsed = wp_parse_url( $home_url );
+		$parsed = wp_parse_url($home_url);
 
 		// Return the path.
 		return $parsed['path'];
@@ -80,16 +80,16 @@ 
 	 */
 	public static function is_postname_permalink_structure() {
 		// Get current permalink structure.
-		$structure = get_option( 'permalink_structure' );
+		$structure = get_option('permalink_structure');
 
 		// The regular expression. It will check if the site structure contains postname.
 		$regex = '~^/\%postname\%/$~';
 
 		// Check if the site structure match the rquired one.
-		preg_match( $regex, $structure, $matches );
+		preg_match($regex, $structure, $matches);
 
 		// Bail if the site have different structure.
-		if ( empty( $matches ) ) {
+		if (empty($matches)) {
 			return false;
 		}
 
@@ -148,7 +148,7 @@ 
 	public function create_csv() {
 		// Create a file pointer connected to the output stream.
 		// Ignoring linter notices below that complain about file output which do not actually happen.
-		$file = fopen( 'php://output', 'w' );
+		$file = fopen('php://output', 'w');
 
 		// Add the column headers. @codingStandardsIgnoreLine
 		fputcsv(
@@ -161,7 +161,7 @@ 
 		);
 
 		// Cycle through items and add each item data to the file.
-		foreach ( $this->get_content_data() as $row ) {
+		foreach ($this->get_content_data() as $row) {
 			// Add new line in the file. @codingStandardsIgnoreLine
 			fputcsv(
 				$file,

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

Indentation +695 added lines, -695 removed lines

@@ -13,7 +13,7 @@ 
 use Wordlift\Api\Default_Api_Service;
 
 if ( ! defined( 'ABSPATH' ) ) {
-	exit;
+    exit;
 }
 
 /**
@@ -23,703 +23,703 @@ 
  */
 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;
-
-	/**
-	 * Create a Wordlift_Configuration_Service's instance.
-	 *
-	 * @since 3.6.0
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-	}
-
-	/**
-	 * 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 = null;
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Configuration_Service
-	 * @since 3.6.0
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			self::$instance = new self();
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get a configuration given the option name and a key. The option value is
-	 * expected to be an array.
-	 *
-	 * @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.
-	 * @since 3.6.0
-	 */
-	private function get( $option, $key, $default = '' ) {
-
-		$options = get_option( $option, array() );
-
-		return isset( $options[ $key ] ) ? $options[ $key ] : $default;
-	}
-
-	/**
-	 * Set a configuration parameter.
-	 *
-	 * @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.
-	 *
-	 * @since 3.9.0
-	 */
-	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'.
-	 *
-	 * @return string The entity base path.
-	 * @since 3.6.0
-	 */
-	public function get_entity_base_path() {
-
-		return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
-	}
-
-	/**
-	 * Get the entity base path.
-	 *
-	 * @param string $value The entity base path.
-	 *
-	 * @since 3.9.0
-	 */
-	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.
-	 *
-	 * @return bool True if it should be skipped otherwise false.
-	 * @since 3.9.0
-	 */
-	public function is_skip_wizard() {
-
-		return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
-	}
-
-	/**
-	 * Set the skip wizard parameter.
-	 *
-	 * @param bool $value True to skip the wizard. We expect a boolean value.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_skip_wizard( $value ) {
-
-		$this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
-
-	}
-
-	/**
-	 * Get WordLift's key.
-	 *
-	 * @return string WordLift's key or an empty string if not set.
-	 * @since 3.9.0
-	 */
-	public function get_key() {
-
-		return $this->get( 'wl_general_settings', self::KEY, '' );
-	}
-
-	/**
-	 * Set WordLift's key.
-	 *
-	 * @param string $value WordLift's key.
-	 *
-	 * @since 3.9.0
-	 */
-	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.
-	 *
-	 * @return string WordLift's configured language code ('en' by default).
-	 * @since 3.9.0
-	 */
-	public function get_language_code() {
-
-		$language = get_locale();
-		if ( ! $language ) {
-			return 'en';
-		}
-
-		return substr( $language, 0, 2 );
-	}
-
-	/**
-	 * @param string $value WordLift's language code.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/1466
-	 *
-	 * Set WordLift's language code, used when storing strings to the Linked Data dataset.
-	 *
-	 * @deprecated As of 3.32.7 this below method has no effect on setting the language, we use the
-	 * language code form WordPress directly.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_language_code( $value ) {
-
-		$this->set( 'wl_general_settings', self::LANGUAGE, $value );
-
-	}
-
-	/**
-	 * Set the user preferences about sharing diagnostic with us.
-	 *
-	 * @param string $value The user preferences(yes/no).
-	 *
-	 * @since 3.19.0
-	 */
-	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'.
-	 *
-	 * @return string WordLift's configured country code ('us' by default).
-	 * @since 3.18.0
-	 */
-	public function get_country_code() {
-
-		return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
-	}
-
-	/**
-	 * Set WordLift's country code.
-	 *
-	 * @param string $value WordLift's country code.
-	 *
-	 * @since 3.18.0
-	 */
-	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.
-	 *
-	 * @return int|NULL The publisher entity post id or NULL if not set.
-	 * @since 3.9.0
-	 */
-	public function get_publisher_id() {
-
-		return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
-	}
-
-	/**
-	 * Set the publisher entity post id.
-	 *
-	 * @param int $value The publisher entity post id.
-	 *
-	 * @since 3.9.0
-	 */
-	public function set_publisher_id( $value ) {
-
-		$this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
-
-	}
-
-	/**
-	 * Get the dataset URI.
-	 *
-	 * @return string The dataset URI or an empty string if not set.
-	 * @since 3.10.0
-	 * @since 3.27.7 Always return null if `wl_features__enable__dataset` is disabled.
-	 */
-	public function get_dataset_uri() {
-
-		if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
-		} else {
-			return null;
-		}
-	}
-
-	/**
-	 * Set the dataset URI.
-	 *
-	 * @param string $value The dataset URI.
-	 *
-	 * @since 3.10.0
-	 */
-	public function set_dataset_uri( $value ) {
-
-		$this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
-	}
-
-	/**
-	 * Get the package type.
-	 *
-	 * @return string The package type or an empty string if not set.
-	 * @since 3.20.0
-	 */
-	public function get_package_type() {
-
-		return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
-	}
-
-	/**
-	 * Set the package type.
-	 *
-	 * @param string $value The package type.
-	 *
-	 * @since 3.20.0
-	 */
-	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 );
-
-		do_action( 'wl_key_updated' );
-
-	}
-
-	/**
-	 * 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.
-	 *
-	 * @param string $key The key to be used.
-	 *
-	 * @since 3.12.0
-	 *
-	 * @since 3.17.0 send the site URL and get the dataset URI.
-	 */
-	public function get_remote_dataset_uri( $key ) {
-
-		$this->log->trace( 'Getting the remote dataset URI and package type...' );
-
-		if ( empty( $key ) ) {
-			$this->log->warn( 'Key set to empty value.' );
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		/**
-		 * Allow 3rd parties to change the site_url.
-		 *
-		 * @param string $site_url The site url.
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-		 *
-		 * @since 3.20.0
-		 */
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
-
-		// Build the URL.
-		$url = '/accounts'
-			   . '?key=' . rawurlencode( $key )
-			   . '&url=' . rawurlencode( $site_url )
-			   . '&country=' . $this->get_country_code()
-			   . '&language=' . $this->get_language_code();
-
-		$api_service = Default_Api_Service::get_instance();
-		/**
-		 * @since 3.27.7.1
-		 * The Key should be passed to headers, otherwise api would return null.
-		 */
-		$headers  = array(
-			'Authorization' => "Key $key",
-		);
-		$response = $api_service->request( 'PUT', $url, $headers )->get_response();
-
-		// 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 ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
-			$base_url = $api_service->get_base_url();
-
-			if ( ! is_array( $response ) ) {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
-			} else {
-				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
-			}
-
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
-
-			return;
-		}
-
-		/*
+    /**
+     * 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;
+
+    /**
+     * Create a Wordlift_Configuration_Service's instance.
+     *
+     * @since 3.6.0
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+    }
+
+    /**
+     * 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 = null;
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Configuration_Service
+     * @since 3.6.0
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            self::$instance = new self();
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Get a configuration given the option name and a key. The option value is
+     * expected to be an array.
+     *
+     * @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.
+     * @since 3.6.0
+     */
+    private function get( $option, $key, $default = '' ) {
+
+        $options = get_option( $option, array() );
+
+        return isset( $options[ $key ] ) ? $options[ $key ] : $default;
+    }
+
+    /**
+     * Set a configuration parameter.
+     *
+     * @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.
+     *
+     * @since 3.9.0
+     */
+    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'.
+     *
+     * @return string The entity base path.
+     * @since 3.6.0
+     */
+    public function get_entity_base_path() {
+
+        return $this->get( 'wl_general_settings', self::ENTITY_BASE_PATH_KEY, 'entity' );
+    }
+
+    /**
+     * Get the entity base path.
+     *
+     * @param string $value The entity base path.
+     *
+     * @since 3.9.0
+     */
+    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.
+     *
+     * @return bool True if it should be skipped otherwise false.
+     * @since 3.9.0
+     */
+    public function is_skip_wizard() {
+
+        return $this->get( 'wl_general_settings', self::SKIP_WIZARD, false );
+    }
+
+    /**
+     * Set the skip wizard parameter.
+     *
+     * @param bool $value True to skip the wizard. We expect a boolean value.
+     *
+     * @since 3.9.0
+     */
+    public function set_skip_wizard( $value ) {
+
+        $this->set( 'wl_general_settings', self::SKIP_WIZARD, true === $value );
+
+    }
+
+    /**
+     * Get WordLift's key.
+     *
+     * @return string WordLift's key or an empty string if not set.
+     * @since 3.9.0
+     */
+    public function get_key() {
+
+        return $this->get( 'wl_general_settings', self::KEY, '' );
+    }
+
+    /**
+     * Set WordLift's key.
+     *
+     * @param string $value WordLift's key.
+     *
+     * @since 3.9.0
+     */
+    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.
+     *
+     * @return string WordLift's configured language code ('en' by default).
+     * @since 3.9.0
+     */
+    public function get_language_code() {
+
+        $language = get_locale();
+        if ( ! $language ) {
+            return 'en';
+        }
+
+        return substr( $language, 0, 2 );
+    }
+
+    /**
+     * @param string $value WordLift's language code.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/1466
+     *
+     * Set WordLift's language code, used when storing strings to the Linked Data dataset.
+     *
+     * @deprecated As of 3.32.7 this below method has no effect on setting the language, we use the
+     * language code form WordPress directly.
+     *
+     * @since 3.9.0
+     */
+    public function set_language_code( $value ) {
+
+        $this->set( 'wl_general_settings', self::LANGUAGE, $value );
+
+    }
+
+    /**
+     * Set the user preferences about sharing diagnostic with us.
+     *
+     * @param string $value The user preferences(yes/no).
+     *
+     * @since 3.19.0
+     */
+    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'.
+     *
+     * @return string WordLift's configured country code ('us' by default).
+     * @since 3.18.0
+     */
+    public function get_country_code() {
+
+        return $this->get( 'wl_general_settings', self::COUNTRY_CODE, 'us' );
+    }
+
+    /**
+     * Set WordLift's country code.
+     *
+     * @param string $value WordLift's country code.
+     *
+     * @since 3.18.0
+     */
+    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.
+     *
+     * @return int|NULL The publisher entity post id or NULL if not set.
+     * @since 3.9.0
+     */
+    public function get_publisher_id() {
+
+        return $this->get( 'wl_general_settings', self::PUBLISHER_ID, null );
+    }
+
+    /**
+     * Set the publisher entity post id.
+     *
+     * @param int $value The publisher entity post id.
+     *
+     * @since 3.9.0
+     */
+    public function set_publisher_id( $value ) {
+
+        $this->set( 'wl_general_settings', self::PUBLISHER_ID, $value );
+
+    }
+
+    /**
+     * Get the dataset URI.
+     *
+     * @return string The dataset URI or an empty string if not set.
+     * @since 3.10.0
+     * @since 3.27.7 Always return null if `wl_features__enable__dataset` is disabled.
+     */
+    public function get_dataset_uri() {
+
+        if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
+            return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+        } else {
+            return null;
+        }
+    }
+
+    /**
+     * Set the dataset URI.
+     *
+     * @param string $value The dataset URI.
+     *
+     * @since 3.10.0
+     */
+    public function set_dataset_uri( $value ) {
+
+        $this->set( 'wl_advanced_settings', self::DATASET_URI, $value );
+    }
+
+    /**
+     * Get the package type.
+     *
+     * @return string The package type or an empty string if not set.
+     * @since 3.20.0
+     */
+    public function get_package_type() {
+
+        return $this->get( 'wl_advanced_settings', self::PACKAGE_TYPE, null );
+    }
+
+    /**
+     * Set the package type.
+     *
+     * @param string $value The package type.
+     *
+     * @since 3.20.0
+     */
+    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 );
+
+        do_action( 'wl_key_updated' );
+
+    }
+
+    /**
+     * 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.
+     *
+     * @param string $key The key to be used.
+     *
+     * @since 3.12.0
+     *
+     * @since 3.17.0 send the site URL and get the dataset URI.
+     */
+    public function get_remote_dataset_uri( $key ) {
+
+        $this->log->trace( 'Getting the remote dataset URI and package type...' );
+
+        if ( empty( $key ) ) {
+            $this->log->warn( 'Key set to empty value.' );
+
+            $this->set_dataset_uri( '' );
+            $this->set_package_type( null );
+
+            return;
+        }
+
+        /**
+         * Allow 3rd parties to change the site_url.
+         *
+         * @param string $site_url The site url.
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/850
+         *
+         * @since 3.20.0
+         */
+        $home_url = get_option( 'home' );
+        $site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+
+        // Build the URL.
+        $url = '/accounts'
+                . '?key=' . rawurlencode( $key )
+                . '&url=' . rawurlencode( $site_url )
+                . '&country=' . $this->get_country_code()
+                . '&language=' . $this->get_language_code();
+
+        $api_service = Default_Api_Service::get_instance();
+        /**
+         * @since 3.27.7.1
+         * The Key should be passed to headers, otherwise api would return null.
+         */
+        $headers  = array(
+            'Authorization' => "Key $key",
+        );
+        $response = $api_service->request( 'PUT', $url, $headers )->get_response();
+
+        // 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 ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
+            $base_url = $api_service->get_base_url();
+
+            if ( ! is_array( $response ) ) {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                $this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+            } else {
+                // phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
+                $this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
+            }
+
+            $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'] );
-		/**
-		 * @since 3.27.7
-		 * Remove the trailing slash returned from the new platform api.
-		 */
-		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$dataset_uri = untrailingslashit( $json->datasetURI );
-		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$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.
-	 *
-	 * @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
-	 * @since 3.12.0
-	 */
-	public 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.
-	 *
-	 * @param string $key The WordLift key to use.
-	 *
-	 * @return string The API URI.
-	 * @since 3.11.0
-	 */
-	public function get_accounts_by_key_dataset_uri( $key ) {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
-	}
-
-	/**
-	 * Get the `accounts` end point.
-	 *
-	 * @return string The `accounts` end point.
-	 * @since 3.16.0
-	 */
-	public function get_accounts() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
-	}
-
-	/**
-	 * Get the `link by default` option.
-	 *
-	 * @return bool True if entities must be linked by default otherwise false.
-	 * @since 3.13.0
-	 */
-	public function is_link_by_default() {
-
-		return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
-	}
-
-	/**
-	 * Set the `link by default` option.
-	 *
-	 * @param bool $value True to enabling linking by default, otherwise false.
-	 *
-	 * @since 3.13.0
-	 */
-	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.
-	 *
-	 * @return string 'no' or 'yes' representing bool.
-	 * @since 3.21.0
-	 */
-	public function is_analytics_enable() {
-		return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
-	}
-
-	/**
-	 * Set the `analytics-enable` option.
-	 *
-	 * @param bool $value True to enabling analytics, otherwise false.
-	 *
-	 * @since 3.21.0
-	 */
-	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.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	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.
-	 *
-	 * @return int
-	 * @since 3.21.0
-	 */
-	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.
-	 *
-	 * @return string The URL to call to perform the autocomplete request.
-	 * @since 3.15.0
-	 */
-	public function get_autocomplete_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
-
-	}
-
-	/**
-	 * Get the URL to perform feedback deactivation request.
-	 *
-	 * @return string The URL to call to perform the feedback deactivation request.
-	 * @since 3.19.0
-	 */
-	public function get_deactivation_feedback_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
-
-	}
-
-	/**
-	 * Get the base API URL.
-	 *
-	 * @return string The base API URL.
-	 * @since 3.20.0
-	 */
-	public function get_api_url() {
-
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
-	}
+        $json = json_decode( $response['body'] );
+        /**
+         * @since 3.27.7
+         * Remove the trailing slash returned from the new platform api.
+         */
+        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $dataset_uri = untrailingslashit( $json->datasetURI );
+        // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
+        $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.
+     *
+     * @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
+     * @since 3.12.0
+     */
+    public 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.
+     *
+     * @param string $key The WordLift key to use.
+     *
+     * @return string The API URI.
+     * @since 3.11.0
+     */
+    public function get_accounts_by_key_dataset_uri( $key ) {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . "accounts/key=$key/dataset_uri";
+    }
+
+    /**
+     * Get the `accounts` end point.
+     *
+     * @return string The `accounts` end point.
+     * @since 3.16.0
+     */
+    public function get_accounts() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+    }
+
+    /**
+     * Get the `link by default` option.
+     *
+     * @return bool True if entities must be linked by default otherwise false.
+     * @since 3.13.0
+     */
+    public function is_link_by_default() {
+
+        return 'yes' === $this->get( 'wl_general_settings', self::LINK_BY_DEFAULT, 'yes' );
+    }
+
+    /**
+     * Set the `link by default` option.
+     *
+     * @param bool $value True to enabling linking by default, otherwise false.
+     *
+     * @since 3.13.0
+     */
+    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.
+     *
+     * @return string 'no' or 'yes' representing bool.
+     * @since 3.21.0
+     */
+    public function is_analytics_enable() {
+        return 'yes' === $this->get( 'wl_analytics_settings', self::ANALYTICS_ENABLE, 'no' );
+    }
+
+    /**
+     * Set the `analytics-enable` option.
+     *
+     * @param bool $value True to enabling analytics, otherwise false.
+     *
+     * @since 3.21.0
+     */
+    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.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    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.
+     *
+     * @return int
+     * @since 3.21.0
+     */
+    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.
+     *
+     * @return string The URL to call to perform the autocomplete request.
+     * @since 3.15.0
+     */
+    public function get_autocomplete_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+
+    }
+
+    /**
+     * Get the URL to perform feedback deactivation request.
+     *
+     * @return string The URL to call to perform the feedback deactivation request.
+     * @since 3.19.0
+     */
+    public function get_deactivation_feedback_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'feedbacks';
+
+    }
+
+    /**
+     * Get the base API URL.
+     *
+     * @return string The base API URL.
+     * @since 3.20.0
+     */
+    public function get_api_url() {
+
+        return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE;
+    }
 
 }

Spacing +93 added lines, -93 removed lines

@@ -12,7 +12,7 @@ 
 
 use Wordlift\Api\Default_Api_Service;
 
-if ( ! defined( 'ABSPATH' ) ) {
+if ( ! defined('ABSPATH')) {
 	exit;
 }
 
@@ -130,7 +130,7 @@ 
 	 */
 	protected function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 	}
 
@@ -152,7 +152,7 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
+		if ( ! isset(self::$instance)) {
 			self::$instance = new self();
 		}
 
@@ -170,11 +170,11 @@ 
 	 * @return mixed The configuration value or the default value if not found.
 	 * @since 3.6.0
 	 */
-	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;
 	}
 
 	/**
@@ -186,12 +186,12 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	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);
 
 	}
 
@@ -203,7 +203,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');
 	}
 
 	/**
@@ -213,9 +213,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	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 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	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);
 
 	}
 
@@ -251,7 +251,7 @@ 
 	 */
 	public function get_key() {
 
-		return $this->get( 'wl_general_settings', self::KEY, '' );
+		return $this->get('wl_general_settings', self::KEY, '');
 	}
 
 	/**
@@ -261,9 +261,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	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);
 	}
 
 	/**
@@ -277,11 +277,11 @@ 
 	public function get_language_code() {
 
 		$language = get_locale();
-		if ( ! $language ) {
+		if ( ! $language) {
 			return 'en';
 		}
 
-		return substr( $language, 0, 2 );
+		return substr($language, 0, 2);
 	}
 
 	/**
@@ -296,9 +296,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	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);
 
 	}
 
@@ -309,9 +309,9 @@ 
 	 *
 	 * @since 3.19.0
 	 */
-	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);
 
 	}
 
@@ -322,7 +322,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');
 	}
 
 	/**
@@ -333,7 +333,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');
 	}
 
 	/**
@@ -343,9 +343,9 @@ 
 	 *
 	 * @since 3.18.0
 	 */
-	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);
 
 	}
 
@@ -360,7 +360,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);
 	}
 
 	/**
@@ -370,9 +370,9 @@ 
 	 *
 	 * @since 3.9.0
 	 */
-	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);
 
 	}
 
@@ -385,8 +385,8 @@ 
 	 */
 	public function get_dataset_uri() {
 
-		if ( apply_filters( 'wl_feature__enable__dataset', true ) ) {
-			return $this->get( 'wl_advanced_settings', self::DATASET_URI, null );
+		if (apply_filters('wl_feature__enable__dataset', true)) {
+			return $this->get('wl_advanced_settings', self::DATASET_URI, null);
 		} else {
 			return null;
 		}
@@ -399,9 +399,9 @@ 
 	 *
 	 * @since 3.10.0
 	 */
-	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);
 	}
 
 	/**
@@ -412,7 +412,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);
 	}
 
 	/**
@@ -422,8 +422,8 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function set_package_type( $value ) {
-		$this->set( 'wl_advanced_settings', self::PACKAGE_TYPE, $value );
+	public function set_package_type($value) {
+		$this->set('wl_advanced_settings', self::PACKAGE_TYPE, $value);
 	}
 
 	/**
@@ -438,11 +438,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.
@@ -451,14 +451,14 @@ 
 		// }
 
 		// 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);
 
-		do_action( 'wl_key_updated' );
+		do_action('wl_key_updated');
 
 	}
 
@@ -474,15 +474,15 @@ 
 	 *
 	 * @since 3.17.0 send the site URL and get the dataset URI.
 	 */
-	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...');
 
-		if ( empty( $key ) ) {
-			$this->log->warn( 'Key set to empty value.' );
+		if (empty($key)) {
+			$this->log->warn('Key set to empty value.');
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -496,15 +496,15 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$home_url = get_option( 'home' );
-		$site_url = apply_filters( 'wl_production_site_url', untrailingslashit( $home_url ) );
+		$home_url = get_option('home');
+		$site_url = apply_filters('wl_production_site_url', untrailingslashit($home_url));
 
 		// Build the URL.
 		$url = '/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();
 
 		$api_service = Default_Api_Service::get_instance();
 		/**
@@ -514,32 +514,32 @@ 
 		$headers  = array(
 			'Authorization' => "Key $key",
 		);
-		$response = $api_service->request( 'PUT', $url, $headers )->get_response();
+		$response = $api_service->request('PUT', $url, $headers)->get_response();
 
 		// 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 ( ! is_array( $response ) || 200 !== (int) $response['response']['code'] ) {
+		if ( ! is_array($response) || 200 !== (int) $response['response']['code']) {
 			$base_url = $api_service->get_base_url();
 
-			if ( ! is_array( $response ) ) {
+			if ( ! is_array($response)) {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected response when opening URL $base_url$url: " . var_export( $response, true ) );
+				$this->log->error("Unexpected response when opening URL $base_url$url: ".var_export($response, true));
 			} else {
 				// phpcs:ignore WordPress.PHP.DevelopmentFunctions.error_log_var_export
-				$this->log->error( "Unexpected status code when opening URL $base_url$url: " . $response['response']['code'] . "\n" . var_export( $response, true ) );
+				$this->log->error("Unexpected status code when opening URL $base_url$url: ".$response['response']['code']."\n".var_export($response, true));
 			}
 
-			$this->set_dataset_uri( '' );
-			$this->set_package_type( null );
+			$this->set_dataset_uri('');
+			$this->set_package_type(null);
 
 			return;
 		}
@@ -549,20 +549,20 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$json = json_decode( $response['body'] );
+		$json = json_decode($response['body']);
 		/**
 		 * @since 3.27.7
 		 * Remove the trailing slash returned from the new platform api.
 		 */
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$dataset_uri = untrailingslashit( $json->datasetURI );
+		$dataset_uri = untrailingslashit($json->datasetURI);
 		// phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
-		$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);
 	}
 
 	/**
@@ -579,20 +579,20 @@ 
 	 * @return mixed The same value in the $value parameter
 	 * @since 3.12.0
 	 */
-	public function maybe_update_dataset_uri( $value, $old_value ) {
+	public 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;
@@ -606,9 +606,9 @@ 
 	 * @return string The API URI.
 	 * @since 3.11.0
 	 */
-	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";
 	}
 
 	/**
@@ -619,7 +619,7 @@ 
 	 */
 	public function get_accounts() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'accounts';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'accounts';
 	}
 
 	/**
@@ -630,7 +630,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');
 	}
 
 	/**
@@ -640,9 +640,9 @@ 
 	 *
 	 * @since 3.13.0
 	 */
-	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');
 	}
 
 	/**
@@ -652,7 +652,7 @@ 
 	 * @since 3.21.0
 	 */
 	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');
 	}
 
 	/**
@@ -662,9 +662,9 @@ 
 	 *
 	 * @since 3.21.0
 	 */
-	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');
 	}
 
 	/**
@@ -674,7 +674,7 @@ 
 	 * @since 3.21.0
 	 */
 	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);
 	}
 
 	/**
@@ -684,7 +684,7 @@ 
 	 * @since 3.21.0
 	 */
 	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);
 	}
 
 	/**
@@ -695,7 +695,7 @@ 
 	 */
 	public function get_autocomplete_url() {
 
-		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE . 'autocomplete';
+		return WL_CONFIG_WORDLIFT_API_URL_DEFAULT_VALUE.'autocomplete';
 
 	}
 
@@ -707,7 +707,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/properties/class-wordlift-url-property-service.php

Indentation +38 added lines, -38 removed lines

@@ -16,37 +16,37 @@ 
  */
 class Wordlift_Url_Property_Service extends Wordlift_Simple_Property_Service {
 
-	/**
-	 * The meta key for the schema:url property.
-	 */
-	const META_KEY = 'wl_schema_url';
+    /**
+     * The meta key for the schema:url property.
+     */
+    const META_KEY = 'wl_schema_url';
 
-	/**
-	 * Get the URLs associated with the post.
-	 *
-	 * @param int    $id The post id.
-	 * @param string $meta_key The meta key.
-	 *
-	 * @return array An array of URLs.
-	 */
-	public function get( $id, $meta_key, $type ) {
+    /**
+     * Get the URLs associated with the post.
+     *
+     * @param int    $id The post id.
+     * @param string $meta_key The meta key.
+     *
+     * @return array An array of URLs.
+     */
+    public function get( $id, $meta_key, $type ) {
 
-		// Get the meta values and push the <permalink> to
-		// ensure that default url will be added to the schema:url's.
-		/*
+        // Get the meta values and push the <permalink> to
+        // ensure that default url will be added to the schema:url's.
+        /*
 		 * Do not add `<permalink>` if one or more URLs have been provided by the editor.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/913
 		 *
 		 * @since 3.21.1
 		 */
-		$urls = parent::get( $id, $meta_key, $type );
-		$urls = array_filter( $urls ? $urls : array( '<permalink>' ) );
+        $urls = parent::get( $id, $meta_key, $type );
+        $urls = array_filter( $urls ? $urls : array( '<permalink>' ) );
 
-		// Convert <permalink> in actual permalink values.
-		return array_map(
-			function ( $item ) use ( $id, $type ) {
-				/*
+        // Convert <permalink> in actual permalink values.
+        return array_map(
+            function ( $item ) use ( $id, $type ) {
+                /*
 					* If `<permalink>` get the production permalink.
 					*
 					* @since 3.20.0
@@ -54,22 +54,22 @@ 
 					* @see https://github.com/insideout10/wordlift-plugin/issues/850.
 					*/
 
-				if ( '<permalink>' !== $item ) {
-					  return $item;
-				}
+                if ( '<permalink>' !== $item ) {
+                        return $item;
+                }
 
-				// Permalinks.
-				switch ( $type ) {
-					case Object_Type_Enum::POST:
-						return Wordlift_Post_Adapter::get_production_permalink( $id );
-					case Object_Type_Enum::TERM:
-						return get_term_link( $id );
-					default:
-						return $item;
-				}
-			},
-			array_unique( $urls )
-		);
-	}
+                // Permalinks.
+                switch ( $type ) {
+                    case Object_Type_Enum::POST:
+                        return Wordlift_Post_Adapter::get_production_permalink( $id );
+                    case Object_Type_Enum::TERM:
+                        return get_term_link( $id );
+                    default:
+                        return $item;
+                }
+            },
+            array_unique( $urls )
+        );
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -29,7 +29,7 @@ 
 	 *
 	 * @return array An array of URLs.
 	 */
-	public function get( $id, $meta_key, $type ) {
+	public function get($id, $meta_key, $type) {
 
 		// Get the meta values and push the <permalink> to
 		// ensure that default url will be added to the schema:url's.
@@ -40,12 +40,12 @@ 
 		 *
 		 * @since 3.21.1
 		 */
-		$urls = parent::get( $id, $meta_key, $type );
-		$urls = array_filter( $urls ? $urls : array( '<permalink>' ) );
+		$urls = parent::get($id, $meta_key, $type);
+		$urls = array_filter($urls ? $urls : array('<permalink>'));
 
 		// Convert <permalink> in actual permalink values.
 		return array_map(
-			function ( $item ) use ( $id, $type ) {
+			function($item) use ($id, $type) {
 				/*
 					* If `<permalink>` get the production permalink.
 					*
@@ -54,21 +54,21 @@ 
 					* @see https://github.com/insideout10/wordlift-plugin/issues/850.
 					*/
 
-				if ( '<permalink>' !== $item ) {
+				if ('<permalink>' !== $item) {
 					  return $item;
 				}
 
 				// Permalinks.
-				switch ( $type ) {
+				switch ($type) {
 					case Object_Type_Enum::POST:
-						return Wordlift_Post_Adapter::get_production_permalink( $id );
+						return Wordlift_Post_Adapter::get_production_permalink($id);
 					case Object_Type_Enum::TERM:
-						return get_term_link( $id );
+						return get_term_link($id);
 					default:
 						return $item;
 				}
 			},
-			array_unique( $urls )
+			array_unique($urls)
 		);
 	}
 

src/includes/properties/class-wordlift-duration-property-service.php

Indentation +19 added lines, -19 removed lines

@@ -19,31 +19,31 @@
  */
 class Wordlift_Duration_Property_Service extends Wordlift_Simple_Property_Service {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get( $id, $meta_key, $type ) {
+    /**
+     * {@inheritdoc}
+     */
+    public function get( $id, $meta_key, $type ) {
 
-		// Get the values and filter out the empty ones (or the ones with 00:00).
-		$values = array_filter(
-			parent::get( $id, $meta_key, $type ),
-			function ( $item ) {
-				return ! empty( $item ) && '00:00' !== $item;
-			}
-		);
+        // Get the values and filter out the empty ones (or the ones with 00:00).
+        $values = array_filter(
+            parent::get( $id, $meta_key, $type ),
+            function ( $item ) {
+                return ! empty( $item ) && '00:00' !== $item;
+            }
+        );
 
-		/*
+        /*
 		 * Map the value in the meta
 		 * The UI for the meta date enable two forms, a number of minutes
 		 * or an h:mm format.
 		 * Both needs to be adjusted to the iso format.
 		 */
-		return array_map(
-			function ( $value ) {
-				return 'PT' . str_replace( ':', 'H', $value ) . 'M';
-			},
-			$values
-		);
-	}
+        return array_map(
+            function ( $value ) {
+                return 'PT' . str_replace( ':', 'H', $value ) . 'M';
+            },
+            $values
+        );
+    }
 
 }

Spacing +6 added lines, -6 removed lines

@@ -22,13 +22,13 @@ 
 	/**
 	 * {@inheritdoc}
 	 */
-	public function get( $id, $meta_key, $type ) {
+	public function get($id, $meta_key, $type) {
 
 		// Get the values and filter out the empty ones (or the ones with 00:00).
 		$values = array_filter(
-			parent::get( $id, $meta_key, $type ),
-			function ( $item ) {
-				return ! empty( $item ) && '00:00' !== $item;
+			parent::get($id, $meta_key, $type),
+			function($item) {
+				return ! empty($item) && '00:00' !== $item;
 			}
 		);
 
@@ -39,8 +39,8 @@ 
 		 * Both needs to be adjusted to the iso format.
 		 */
 		return array_map(
-			function ( $value ) {
-				return 'PT' . str_replace( ':', 'H', $value ) . 'M';
+			function($value) {
+				return 'PT'.str_replace(':', 'H', $value).'M';
 			},
 			$values
 		);

src/includes/properties/class-wordlift-property-getter.php

Indentation +60 added lines, -60 removed lines

@@ -9,74 +9,74 @@
  */
 class Wordlift_Property_Getter {
 
-	/**
-	 * An array of {@link Wordlift_Simple_Property_Service}s which can access a
-	 * property.
-	 *
-	 * @since 3.8.0
-	 * @access private
-	 * @var Wordlift_Simple_Property_Service[] $services An array of {@link Wordlift_Simple_Property_Service}s.
-	 */
-	private $services = array();
+    /**
+     * An array of {@link Wordlift_Simple_Property_Service}s which can access a
+     * property.
+     *
+     * @since 3.8.0
+     * @access private
+     * @var Wordlift_Simple_Property_Service[] $services An array of {@link Wordlift_Simple_Property_Service}s.
+     */
+    private $services = array();
 
-	/**
-	 * The default {@link Wordlift_Simple_Property_Service} which is used to access
-	 * a property when no specific {@link Wordlift_Simple_Property_Service} is found
-	 * in the {@see $services} array.
-	 *
-	 * @var Wordlift_Simple_Property_Service
-	 */
-	private $default;
+    /**
+     * The default {@link Wordlift_Simple_Property_Service} which is used to access
+     * a property when no specific {@link Wordlift_Simple_Property_Service} is found
+     * in the {@see $services} array.
+     *
+     * @var Wordlift_Simple_Property_Service
+     */
+    private $default;
 
-	/**
-	 * Create a property service with the provided {@link Wordlift_Simple_Property_Service}
-	 * as default.
-	 *
-	 * @param $default
-	 *
-	 * @since 3.8.0
-	 */
-	public function __construct( $default ) {
+    /**
+     * Create a property service with the provided {@link Wordlift_Simple_Property_Service}
+     * as default.
+     *
+     * @param $default
+     *
+     * @since 3.8.0
+     */
+    public function __construct( $default ) {
 
-		$this->default = $default;
+        $this->default = $default;
 
-	}
+    }
 
-	/**
-	 * Register a {@link Wordlift_Simple_Property_Service} for the specified meta keys.
-	 *
-	 * @param \Wordlift_Simple_Property_Service $property_service A {@link Wordlift_Simple_Property_Service} instance.
-	 * @param array                             $meta_keys An array of meta keys that the provided {@link Wordlift_Simple_Property_Service} will handle.
-	 *
-	 * @since 3.8.0
-	 */
-	public function register( $property_service, $meta_keys ) {
+    /**
+     * Register a {@link Wordlift_Simple_Property_Service} for the specified meta keys.
+     *
+     * @param \Wordlift_Simple_Property_Service $property_service A {@link Wordlift_Simple_Property_Service} instance.
+     * @param array                             $meta_keys An array of meta keys that the provided {@link Wordlift_Simple_Property_Service} will handle.
+     *
+     * @since 3.8.0
+     */
+    public function register( $property_service, $meta_keys ) {
 
-		// Register the specified property service for each meta key.
-		foreach ( $meta_keys as $meta_key ) {
-			$this->services[ $meta_key ] = $property_service;
-		}
+        // Register the specified property service for each meta key.
+        foreach ( $meta_keys as $meta_key ) {
+            $this->services[ $meta_key ] = $property_service;
+        }
 
-	}
+    }
 
-	/**
-	 * Get the value for the specified entity post id and WP's meta key.
-	 *
-	 * @param int    $post_id The post id.
-	 * @param string $meta_key The meta key.
-	 *
-	 * @param int    $type Term or Post, by default Post is used.
-	 *
-	 * @return mixed|null The property value or null.
-	 * @since 3.8.0
-	 */
-	public function get( $post_id, $meta_key, $type ) {
+    /**
+     * Get the value for the specified entity post id and WP's meta key.
+     *
+     * @param int    $post_id The post id.
+     * @param string $meta_key The meta key.
+     *
+     * @param int    $type Term or Post, by default Post is used.
+     *
+     * @return mixed|null The property value or null.
+     * @since 3.8.0
+     */
+    public function get( $post_id, $meta_key, $type ) {
 
-		return isset( $this->services[ $meta_key ] )
-			// Use a specific property service.
-			? $this->services[ $meta_key ]->get( $post_id, $meta_key, $type )
-			// Use the default property service.
-			: $this->default->get( $post_id, $meta_key, $type );
-	}
+        return isset( $this->services[ $meta_key ] )
+            // Use a specific property service.
+            ? $this->services[ $meta_key ]->get( $post_id, $meta_key, $type )
+            // Use the default property service.
+            : $this->default->get( $post_id, $meta_key, $type );
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -36,7 +36,7 @@ 
 	 *
 	 * @since 3.8.0
 	 */
-	public function __construct( $default ) {
+	public function __construct($default) {
 
 		$this->default = $default;
 
@@ -50,11 +50,11 @@ 
 	 *
 	 * @since 3.8.0
 	 */
-	public function register( $property_service, $meta_keys ) {
+	public function register($property_service, $meta_keys) {
 
 		// Register the specified property service for each meta key.
-		foreach ( $meta_keys as $meta_key ) {
-			$this->services[ $meta_key ] = $property_service;
+		foreach ($meta_keys as $meta_key) {
+			$this->services[$meta_key] = $property_service;
 		}
 
 	}
@@ -70,13 +70,13 @@ 
 	 * @return mixed|null The property value or null.
 	 * @since 3.8.0
 	 */
-	public function get( $post_id, $meta_key, $type ) {
+	public function get($post_id, $meta_key, $type) {
 
-		return isset( $this->services[ $meta_key ] )
+		return isset($this->services[$meta_key])
 			// Use a specific property service.
-			? $this->services[ $meta_key ]->get( $post_id, $meta_key, $type )
+			? $this->services[$meta_key]->get($post_id, $meta_key, $type)
 			// Use the default property service.
-			: $this->default->get( $post_id, $meta_key, $type );
+			: $this->default->get($post_id, $meta_key, $type);
 	}
 
 }

src/includes/properties/class-wordlift-property-getter-factory.php

Indentation +51 added lines, -51 removed lines

@@ -26,60 +26,60 @@
  */
 class Wordlift_Property_Getter_Factory {
 
-	/**
-	 * Create a {@link Wordlift_Property_Getter} instance.
-	 *
-	 * @return \Wordlift_Property_Getter A {@link Wordlift_Property_Getter} instance.
-	 * @since 3.8.0
-	 */
-	public static function create() {
+    /**
+     * Create a {@link Wordlift_Property_Getter} instance.
+     *
+     * @return \Wordlift_Property_Getter A {@link Wordlift_Property_Getter} instance.
+     * @since 3.8.0
+     */
+    public static function create() {
 
-		$property_getter = new Wordlift_Property_Getter( new Wordlift_Simple_Property_Service() );
-		$property_getter->register(
-			new Wordlift_Entity_Property_Service(),
-			array(
-				Wordlift_Schema_Service::FIELD_FOUNDER,
-				Wordlift_Schema_Service::FIELD_AUTHOR,
-				Wordlift_Schema_Service::FIELD_KNOWS,
-				Wordlift_Schema_Service::FIELD_BIRTH_PLACE,
-				Wordlift_Schema_Service::FIELD_AFFILIATION,
-				Wordlift_Schema_Service::FIELD_PERFORMER,
-				Wordlift_Schema_Service::FIELD_OFFERS,
-				Wordlift_Schema_Service::FIELD_ITEM_OFFERED,
-			)
-		);
-		$property_getter->register(
-			new Wordlift_Location_Property_Service(),
-			array(
-				Wordlift_Schema_Service::FIELD_LOCATION,
-			)
-		);
-		$property_getter->register( new Wordlift_Url_Property_Service(), array( Wordlift_Url_Property_Service::META_KEY ) );
-		$property_getter->register(
-			new Wordlift_Double_Property_Service(),
-			array(
-				Wordlift_Schema_Service::FIELD_GEO_LATITUDE,
-				Wordlift_Schema_Service::FIELD_GEO_LONGITUDE,
-			)
-		);
+        $property_getter = new Wordlift_Property_Getter( new Wordlift_Simple_Property_Service() );
+        $property_getter->register(
+            new Wordlift_Entity_Property_Service(),
+            array(
+                Wordlift_Schema_Service::FIELD_FOUNDER,
+                Wordlift_Schema_Service::FIELD_AUTHOR,
+                Wordlift_Schema_Service::FIELD_KNOWS,
+                Wordlift_Schema_Service::FIELD_BIRTH_PLACE,
+                Wordlift_Schema_Service::FIELD_AFFILIATION,
+                Wordlift_Schema_Service::FIELD_PERFORMER,
+                Wordlift_Schema_Service::FIELD_OFFERS,
+                Wordlift_Schema_Service::FIELD_ITEM_OFFERED,
+            )
+        );
+        $property_getter->register(
+            new Wordlift_Location_Property_Service(),
+            array(
+                Wordlift_Schema_Service::FIELD_LOCATION,
+            )
+        );
+        $property_getter->register( new Wordlift_Url_Property_Service(), array( Wordlift_Url_Property_Service::META_KEY ) );
+        $property_getter->register(
+            new Wordlift_Double_Property_Service(),
+            array(
+                Wordlift_Schema_Service::FIELD_GEO_LATITUDE,
+                Wordlift_Schema_Service::FIELD_GEO_LONGITUDE,
+            )
+        );
 
-		$property_getter->register(
-			new Wordlift_Duration_Property_Service(),
-			array(
-				Wordlift_Schema_Service::FIELD_PREP_TIME,
-				Wordlift_Schema_Service::FIELD_COOK_TIME,
-				Wordlift_Schema_Service::FIELD_TOTAL_TIME,
-			)
-		);
+        $property_getter->register(
+            new Wordlift_Duration_Property_Service(),
+            array(
+                Wordlift_Schema_Service::FIELD_PREP_TIME,
+                Wordlift_Schema_Service::FIELD_COOK_TIME,
+                Wordlift_Schema_Service::FIELD_TOTAL_TIME,
+            )
+        );
 
-		add_action(
-			'after_setup_theme',
-			function () use ( $property_getter ) {
-				$property_getter->register( new Wordlift_Required_Property_Service(), apply_filters( 'wl_required_property', array() ) );
-			}
-		);
+        add_action(
+            'after_setup_theme',
+            function () use ( $property_getter ) {
+                $property_getter->register( new Wordlift_Required_Property_Service(), apply_filters( 'wl_required_property', array() ) );
+            }
+        );
 
-		return $property_getter;
-	}
+        return $property_getter;
+    }
 
 }

Spacing +4 added lines, -4 removed lines

@@ -34,7 +34,7 @@ 
 	 */
 	public static function create() {
 
-		$property_getter = new Wordlift_Property_Getter( new Wordlift_Simple_Property_Service() );
+		$property_getter = new Wordlift_Property_Getter(new Wordlift_Simple_Property_Service());
 		$property_getter->register(
 			new Wordlift_Entity_Property_Service(),
 			array(
@@ -54,7 +54,7 @@ 
 				Wordlift_Schema_Service::FIELD_LOCATION,
 			)
 		);
-		$property_getter->register( new Wordlift_Url_Property_Service(), array( Wordlift_Url_Property_Service::META_KEY ) );
+		$property_getter->register(new Wordlift_Url_Property_Service(), array(Wordlift_Url_Property_Service::META_KEY));
 		$property_getter->register(
 			new Wordlift_Double_Property_Service(),
 			array(
@@ -74,8 +74,8 @@ 
 
 		add_action(
 			'after_setup_theme',
-			function () use ( $property_getter ) {
-				$property_getter->register( new Wordlift_Required_Property_Service(), apply_filters( 'wl_required_property', array() ) );
+			function() use ($property_getter) {
+				$property_getter->register(new Wordlift_Required_Property_Service(), apply_filters('wl_required_property', array()));
 			}
 		);
 

src/includes/properties/class-wordlift-simple-property-service.php

Indentation +26 added lines, -26 removed lines

@@ -12,33 +12,33 @@
  */
 class Wordlift_Simple_Property_Service {
 
-	/**
-	 * The meta key for this property service.
-	 *
-	 * @since 3.8.0
-	 */
-	const META_KEY = '*';
+    /**
+     * The meta key for this property service.
+     *
+     * @since 3.8.0
+     */
+    const META_KEY = '*';
 
-	/**
-	 * Get the property value for the specified post id and meta with the specified key.
-	 *
-	 * @param int                   $id The post id.
-	 * @param string                $meta_key The meta key.
-	 *
-	 * @param $type int Post or Term
-	 *
-	 * @return mixed|null The property value.
-	 * @since 3.8.0
-	 */
-	public function get( $id, $meta_key, $type ) {
+    /**
+     * Get the property value for the specified post id and meta with the specified key.
+     *
+     * @param int                   $id The post id.
+     * @param string                $meta_key The meta key.
+     *
+     * @param $type int Post or Term
+     *
+     * @return mixed|null The property value.
+     * @since 3.8.0
+     */
+    public function get( $id, $meta_key, $type ) {
 
-		if ( Object_Type_Enum::POST === $type ) {
-			// Get the value stored in WP.
-			return get_post_meta( $id, $meta_key );
-		} elseif ( Object_Type_Enum::TERM === $type ) {
-			return get_term_meta( $id, $meta_key );
-		}
-		return null;
-	}
+        if ( Object_Type_Enum::POST === $type ) {
+            // Get the value stored in WP.
+            return get_post_meta( $id, $meta_key );
+        } elseif ( Object_Type_Enum::TERM === $type ) {
+            return get_term_meta( $id, $meta_key );
+        }
+        return null;
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -30,13 +30,13 @@
 	 * @return mixed|null The property value.
 	 * @since 3.8.0
 	 */
-	public function get( $id, $meta_key, $type ) {
+	public function get($id, $meta_key, $type) {
 
-		if ( Object_Type_Enum::POST === $type ) {
+		if (Object_Type_Enum::POST === $type) {
 			// Get the value stored in WP.
-			return get_post_meta( $id, $meta_key );
-		} elseif ( Object_Type_Enum::TERM === $type ) {
-			return get_term_meta( $id, $meta_key );
+			return get_post_meta($id, $meta_key);
+		} elseif (Object_Type_Enum::TERM === $type) {
+			return get_term_meta($id, $meta_key);
 		}
 		return null;
 	}

src/includes/properties/class-wordlift-entity-property-service.php

Indentation +17 added lines, -17 removed lines

@@ -8,25 +8,25 @@
  */
 class Wordlift_Entity_Property_Service extends Wordlift_Simple_Property_Service {
 
-	/**
-	 * {@inheritdoc}
-	 */
-	public function get( $id, $meta_key, $type ) {
+    /**
+     * {@inheritdoc}
+     */
+    public function get( $id, $meta_key, $type ) {
 
-		$entity_service = Wordlift_Entity_Service::get_instance();
+        $entity_service = Wordlift_Entity_Service::get_instance();
 
-		// Map each returned value to a Wordlift_Property_Entity_Reference.
-		return array_map(
-			function ( $item ) use ( $entity_service ) {
+        // Map each returned value to a Wordlift_Property_Entity_Reference.
+        return array_map(
+            function ( $item ) use ( $entity_service ) {
 
-				// If the $item is a number and it's an existing post, return the
-				// URI of the referenced entity. Otherwise return the value.
-				return is_numeric( $item ) && null !== get_post( $item )
-				? new Wordlift_Property_Entity_Reference( $entity_service->get_uri( $item ), (int) $item )
-				: $item;
-			},
-			parent::get( $id, $meta_key, $type )
-		);
-	}
+                // If the $item is a number and it's an existing post, return the
+                // URI of the referenced entity. Otherwise return the value.
+                return is_numeric( $item ) && null !== get_post( $item )
+                ? new Wordlift_Property_Entity_Reference( $entity_service->get_uri( $item ), (int) $item )
+                : $item;
+            },
+            parent::get( $id, $meta_key, $type )
+        );
+    }
 
 }

Spacing +5 added lines, -5 removed lines

@@ -11,21 +11,21 @@
 	/**
 	 * {@inheritdoc}
 	 */
-	public function get( $id, $meta_key, $type ) {
+	public function get($id, $meta_key, $type) {
 
 		$entity_service = Wordlift_Entity_Service::get_instance();
 
 		// Map each returned value to a Wordlift_Property_Entity_Reference.
 		return array_map(
-			function ( $item ) use ( $entity_service ) {
+			function($item) use ($entity_service) {
 
 				// If the $item is a number and it's an existing post, return the
 				// URI of the referenced entity. Otherwise return the value.
-				return is_numeric( $item ) && null !== get_post( $item )
-				? new Wordlift_Property_Entity_Reference( $entity_service->get_uri( $item ), (int) $item )
+				return is_numeric($item) && null !== get_post($item)
+				? new Wordlift_Property_Entity_Reference($entity_service->get_uri($item), (int) $item)
 				: $item;
 			},
-			parent::get( $id, $meta_key, $type )
+			parent::get($id, $meta_key, $type)
 		);
 	}