insideout10 / wordlift-plugin

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

Indentation +264 added lines, -264 removed lines

@@ -17,274 +17,274 @@
  */
 class Wordlift_Jsonld_Service {
 
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 *
-	 * @since  3.32.0
-	 * @access private
-	 * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
-	 */
-	private $term_jsonld_adapter;
-
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-	/**
-	 * A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	private $website_converter;
-
-	/**
-	 * The singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a JSON-LD service.
-	 *
-	 * @param \Wordlift_Entity_Service           $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Post_Converter           $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
-	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
-	 *
-	 * @since 3.8.0
-	 */
-	public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
-
-		$this->entity_service      = $entity_service;
-		$this->converter           = $converter;
-		$this->website_converter   = $website_converter;
-		$this->term_jsonld_adapter = $term_jsonld_adapter;
-		self::$instance            = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance for the JSON-LD service.
-	 *
-	 * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
-	 * @since 3.15.1
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Process calls to the AJAX 'wl_jsonld' endpoint.
-	 *
-	 * @since 3.8.0
-	 */
-	public function get() {
-		// Clear the buffer to be sure someone doesn't mess with our response.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/406.
-		// See https://codex.wordpress.org/AJAX_in_Plugins.
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     *
+     * @since  3.32.0
+     * @access private
+     * @var Wordlift_Term_JsonLd_Adapter $entity_service A {@link Wordlift_Term_JsonLd_Adapter} instance.
+     */
+    private $term_jsonld_adapter;
+
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+    /**
+     * A {@link Wordlift_Website_Jsonld_Converter} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    private $website_converter;
+
+    /**
+     * The singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
+     */
+    private static $instance;
+
+    /**
+     * Create a JSON-LD service.
+     *
+     * @param \Wordlift_Entity_Service           $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Post_Converter           $converter A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
+     * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     * @param \Wordlift_Term_JsonLd_Adapter      $term_jsonld_adapter
+     *
+     * @since 3.8.0
+     */
+    public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
+
+        $this->entity_service      = $entity_service;
+        $this->converter           = $converter;
+        $this->website_converter   = $website_converter;
+        $this->term_jsonld_adapter = $term_jsonld_adapter;
+        self::$instance            = $this;
+
+    }
+
+    /**
+     * Get the singleton instance for the JSON-LD service.
+     *
+     * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
+     * @since 3.15.1
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Process calls to the AJAX 'wl_jsonld' endpoint.
+     *
+     * @since 3.8.0
+     */
+    public function get() {
+        // Clear the buffer to be sure someone doesn't mess with our response.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/406.
+        // See https://codex.wordpress.org/AJAX_in_Plugins.
         // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@ob_clean();
-
-		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-
-		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
-
-	}
-
-	/**
-	 * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
-	 *
-	 * @param mixed $response Variable (usually an array or object) to encode as JSON,
-	 *                           then print and die.
-	 *
-	 * @since 3.18.5
-	 */
-	private function send_jsonld( $response ) {
+        @ob_clean();
+
+        // Get the parameter from the request.
+        $is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+
+        // Send the generated JSON-LD.
+        $this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+
+    }
+
+    /**
+     * A close of WP's own `wp_send_json` function which uses `application/ld+json` as content type.
+     *
+     * @param mixed $response Variable (usually an array or object) to encode as JSON,
+     *                           then print and die.
+     *
+     * @since 3.18.5
+     */
+    private function send_jsonld( $response ) {
         // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
-			wp_die();
-		} else {
-			die;
-		}
-	}
-
-	/**
-	 * Get the JSON-LD.
-	 *
-	 * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
-	 * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
-	 * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
-	 *
-	 * @return array A JSON-LD structure.
-	 * @since 3.15.1
-	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
-
-		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
-		// e-mails with a low apdex score.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/521
-		Wordlift_NewRelic_Adapter::ignore_apdex();
-
-		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
-			/**
-			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
-			 *
-			 * @since  3.14.0
-			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
-			 */
-			if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
-				return array();
-			}
-
-			// Set a reference to the website_converter.
-			$website_converter = $this->website_converter;
-
-			// Send JSON-LD.
-			return $website_converter->create_schema();
-		}
-
-		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
-			return array();
-		}
-
-		// An array of references which is captured when converting an URI to a
-		// json which we gather to further expand our json-ld.
-		$references       = array();
-		$references_infos = array();
-
-		// Set a reference to the entity_to_jsonld_converter to use in the closures.
-		$entity_to_jsonld_converter = $this->converter;
-
-		$jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) );
-
-		$that                       = $this;
-		$expanded_references_jsonld = array_map(
-			function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) {
-				// "2nd level properties" may not output here, e.g. a post
-				// mentioning an event, located in a place: the place is referenced
-				// via the `@id` but no other properties are loaded.
-				$ignored = array();
-				if ( $item instanceof Term_Reference ) {
+        @header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
+        echo wp_json_encode( $response );
+        if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+            wp_die();
+        } else {
+            die;
+        }
+    }
+
+    /**
+     * Get the JSON-LD.
+     *
+     * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
+     * @param int|null $post_id The JSON-LD for the specified {@link WP_Post} id.
+     * @param int      $context A context for the JSON-LD generation, valid values in Jsonld_Context_Enum.
+     *
+     * @return array A JSON-LD structure.
+     * @since 3.15.1
+     */
+    public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
+
+        // Tell NewRelic to ignore us, otherwise NewRelic customers might receive
+        // e-mails with a low apdex score.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/521
+        Wordlift_NewRelic_Adapter::ignore_apdex();
+
+        // Switch to Website converter if is home page.
+        if ( $is_homepage ) {
+            /**
+             * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
+             *
+             * @since  3.14.0
+             * @api    bool $display_search Whether or not to display json+ld search on the frontend.
+             */
+            if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+                return array();
+            }
+
+            // Set a reference to the website_converter.
+            $website_converter = $this->website_converter;
+
+            // Send JSON-LD.
+            return $website_converter->create_schema();
+        }
+
+        // If no id has been provided return an empty array.
+        if ( ! isset( $post_id ) ) {
+            return array();
+        }
+
+        // An array of references which is captured when converting an URI to a
+        // json which we gather to further expand our json-ld.
+        $references       = array();
+        $references_infos = array();
+
+        // Set a reference to the entity_to_jsonld_converter to use in the closures.
+        $entity_to_jsonld_converter = $this->converter;
+
+        $jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) );
+
+        $that                       = $this;
+        $expanded_references_jsonld = array_map(
+            function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) {
+                // "2nd level properties" may not output here, e.g. a post
+                // mentioning an event, located in a place: the place is referenced
+                // via the `@id` but no other properties are loaded.
+                $ignored = array();
+                if ( $item instanceof Term_Reference ) {
                     // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					  $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context );
-
-					  // For term references, we publish a jsonld array on the page, use only the first item.
-					  return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false;
-				} elseif ( $item instanceof Post_Reference ) {
-					$item = $item->get_id();
-				}
-
-				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos );
-			},
-			array_unique( $references )
-		);
-
-		// Convert each URI to a JSON-LD array, while gathering referenced entities.
-		// in the references array.
-		$jsonld = array_merge(
-			$jsonld,
-			// Convert each URI in the references array to JSON-LD. We don't output
-			// entities already output above (hence the array_diff).
-			array_filter( $expanded_references_jsonld )
-		);
-
-		$required_references = array_filter(
-			$references_infos,
-			function ( $item ) use ( $references ) {
-
-				return isset( $item['reference'] ) &&
-				   // Check that the reference is required
-				   $item['reference']->get_required() &&
-				   // Check that the reference isn't being output already.
-				   ! in_array( $item['reference']->get_id(), $references, true );
-			}
-		);
-
-		$jsonld = array_merge(
-			$jsonld,
-			array_filter(
-				array_map(
-					function ( $item ) use ( $references, $entity_to_jsonld_converter ) {
-
-						if ( ! isset( $item['reference'] ) ) {
-							  return null;
-						}
-
-						$post_id = $item['reference']->get_id();
-						if ( in_array( $post_id, $references, true ) ) {
-							return null;
-						}
-
-						$references[] = $post_id;
-
-						return $entity_to_jsonld_converter->convert( $post_id, $references );
-					},
-					$required_references
-				)
-			)
-		);
-
-		/**
-		 * Filter name: wl_after_get_jsonld
-		 *
-		 * @return array
-		 * @since 3.27.2
-		 * @var $jsonld array The final jsonld before outputting to page.
-		 * @var $post_id int The post id for which the jsonld is generated.
-		 */
-		$jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context );
-
-		return $jsonld;
-	}
-
-	/**
-	 * Write the JSON-LD in the head.
-	 *
-	 * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
-	 * document head, using the `wp_head` hook.
-	 *
-	 * @since 3.18.5
-	 */
-	public function wp_head() {
-
-		// Determine whether this is the home page or whether we're displaying a single post.
-		$is_homepage = is_home() || is_front_page();
-		$post_id     = is_singular() ? get_the_ID() : null;
-
-		$jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
-		?>
+                        $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context );
+
+                        // For term references, we publish a jsonld array on the page, use only the first item.
+                        return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false;
+                } elseif ( $item instanceof Post_Reference ) {
+                    $item = $item->get_id();
+                }
+
+                // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
+                return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos );
+            },
+            array_unique( $references )
+        );
+
+        // Convert each URI to a JSON-LD array, while gathering referenced entities.
+        // in the references array.
+        $jsonld = array_merge(
+            $jsonld,
+            // Convert each URI in the references array to JSON-LD. We don't output
+            // entities already output above (hence the array_diff).
+            array_filter( $expanded_references_jsonld )
+        );
+
+        $required_references = array_filter(
+            $references_infos,
+            function ( $item ) use ( $references ) {
+
+                return isset( $item['reference'] ) &&
+                   // Check that the reference is required
+                   $item['reference']->get_required() &&
+                   // Check that the reference isn't being output already.
+                   ! in_array( $item['reference']->get_id(), $references, true );
+            }
+        );
+
+        $jsonld = array_merge(
+            $jsonld,
+            array_filter(
+                array_map(
+                    function ( $item ) use ( $references, $entity_to_jsonld_converter ) {
+
+                        if ( ! isset( $item['reference'] ) ) {
+                                return null;
+                        }
+
+                        $post_id = $item['reference']->get_id();
+                        if ( in_array( $post_id, $references, true ) ) {
+                            return null;
+                        }
+
+                        $references[] = $post_id;
+
+                        return $entity_to_jsonld_converter->convert( $post_id, $references );
+                    },
+                    $required_references
+                )
+            )
+        );
+
+        /**
+         * Filter name: wl_after_get_jsonld
+         *
+         * @return array
+         * @since 3.27.2
+         * @var $jsonld array The final jsonld before outputting to page.
+         * @var $post_id int The post id for which the jsonld is generated.
+         */
+        $jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context );
+
+        return $jsonld;
+    }
+
+    /**
+     * Write the JSON-LD in the head.
+     *
+     * This function isn't actually used, but may be used to quickly enable writing the JSON-LD synchronously to the
+     * document head, using the `wp_head` hook.
+     *
+     * @since 3.18.5
+     */
+    public function wp_head() {
+
+        // Determine whether this is the home page or whether we're displaying a single post.
+        $is_homepage = is_home() || is_front_page();
+        $post_id     = is_singular() ? get_the_ID() : null;
+
+        $jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
+        ?>
 		<script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script>
 													  <?php
-	}
+    }
 
 }

Spacing +31 added lines, -31 removed lines

@@ -72,7 +72,7 @@ 
 	 *
 	 * @since 3.8.0
 	 */
-	public function __construct( $entity_service, $converter, $website_converter, $term_jsonld_adapter ) {
+	public function __construct($entity_service, $converter, $website_converter, $term_jsonld_adapter) {
 
 		$this->entity_service      = $entity_service;
 		$this->converter           = $converter;
@@ -107,11 +107,11 @@ 
 		@ob_clean();
 
 		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$is_homepage = isset($_REQUEST['homepage']); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$post_id     = isset($_REQUEST['id']) && is_numeric($_REQUEST['id']) ? intval($_REQUEST['id']) : null; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
 		// Send the generated JSON-LD.
-		$this->send_jsonld( $this->get_jsonld( $is_homepage, $post_id ) );
+		$this->send_jsonld($this->get_jsonld($is_homepage, $post_id));
 
 	}
 
@@ -123,11 +123,11 @@ 
 	 *
 	 * @since 3.18.5
 	 */
-	private function send_jsonld( $response ) {
+	private function send_jsonld($response) {
         // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@header( 'Content-Type: application/ld+json; charset=' . get_option( 'blog_charset' ) );
-		echo wp_json_encode( $response );
-		if ( apply_filters( 'wp_doing_ajax', defined( 'DOING_AJAX' ) && DOING_AJAX ) ) {
+		@header('Content-Type: application/ld+json; charset='.get_option('blog_charset'));
+		echo wp_json_encode($response);
+		if (apply_filters('wp_doing_ajax', defined('DOING_AJAX') && DOING_AJAX)) {
 			wp_die();
 		} else {
 			die;
@@ -144,7 +144,7 @@ 
 	 * @return array A JSON-LD structure.
 	 * @since 3.15.1
 	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN ) {
+	public function get_jsonld($is_homepage = false, $post_id = null, $context = Jsonld_Context_Enum::UNKNOWN) {
 
 		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
 		// e-mails with a low apdex score.
@@ -153,14 +153,14 @@ 
 		Wordlift_NewRelic_Adapter::ignore_apdex();
 
 		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
+		if ($is_homepage) {
 			/**
 			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
 			 *
 			 * @since  3.14.0
 			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
 			 */
-			if ( apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+			if (apply_filters('wordlift_disable_website_json_ld', false)) {
 				return array();
 			}
 
@@ -172,7 +172,7 @@ 
 		}
 
 		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
+		if ( ! isset($post_id)) {
 			return array();
 		}
 
@@ -184,29 +184,29 @@ 
 		// Set a reference to the entity_to_jsonld_converter to use in the closures.
 		$entity_to_jsonld_converter = $this->converter;
 
-		$jsonld = array( $entity_to_jsonld_converter->convert( $post_id, $references, $references_infos ) );
+		$jsonld = array($entity_to_jsonld_converter->convert($post_id, $references, $references_infos));
 
 		$that                       = $this;
 		$expanded_references_jsonld = array_map(
-			function ( $item ) use ( $context, $entity_to_jsonld_converter, &$references_infos, $that ) {
+			function($item) use ($context, $entity_to_jsonld_converter, &$references_infos, $that) {
 				// "2nd level properties" may not output here, e.g. a post
 				// mentioning an event, located in a place: the place is referenced
 				// via the `@id` but no other properties are loaded.
 				$ignored = array();
-				if ( $item instanceof Term_Reference ) {
+				if ($item instanceof Term_Reference) {
                     // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-					  $term_jsonld = $that->term_jsonld_adapter->get( $item->get_id(), $context );
+					  $term_jsonld = $that->term_jsonld_adapter->get($item->get_id(), $context);
 
 					  // For term references, we publish a jsonld array on the page, use only the first item.
-					  return count( $term_jsonld ) > 0 ? $term_jsonld[0] : false;
-				} elseif ( $item instanceof Post_Reference ) {
+					  return count($term_jsonld) > 0 ? $term_jsonld[0] : false;
+				} elseif ($item instanceof Post_Reference) {
 					$item = $item->get_id();
 				}
 
 				// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UndefinedVariable
-				return $entity_to_jsonld_converter->convert( $item, $ignored, $references_infos );
+				return $entity_to_jsonld_converter->convert($item, $ignored, $references_infos);
 			},
-			array_unique( $references )
+			array_unique($references)
 		);
 
 		// Convert each URI to a JSON-LD array, while gathering referenced entities.
@@ -215,18 +215,18 @@ 
 			$jsonld,
 			// Convert each URI in the references array to JSON-LD. We don't output
 			// entities already output above (hence the array_diff).
-			array_filter( $expanded_references_jsonld )
+			array_filter($expanded_references_jsonld)
 		);
 
 		$required_references = array_filter(
 			$references_infos,
-			function ( $item ) use ( $references ) {
+			function($item) use ($references) {
 
-				return isset( $item['reference'] ) &&
+				return isset($item['reference']) &&
 				   // Check that the reference is required
 				   $item['reference']->get_required() &&
 				   // Check that the reference isn't being output already.
-				   ! in_array( $item['reference']->get_id(), $references, true );
+				   ! in_array($item['reference']->get_id(), $references, true);
 			}
 		);
 
@@ -234,20 +234,20 @@ 
 			$jsonld,
 			array_filter(
 				array_map(
-					function ( $item ) use ( $references, $entity_to_jsonld_converter ) {
+					function($item) use ($references, $entity_to_jsonld_converter) {
 
-						if ( ! isset( $item['reference'] ) ) {
+						if ( ! isset($item['reference'])) {
 							  return null;
 						}
 
 						$post_id = $item['reference']->get_id();
-						if ( in_array( $post_id, $references, true ) ) {
+						if (in_array($post_id, $references, true)) {
 							return null;
 						}
 
 						$references[] = $post_id;
 
-						return $entity_to_jsonld_converter->convert( $post_id, $references );
+						return $entity_to_jsonld_converter->convert($post_id, $references);
 					},
 					$required_references
 				)
@@ -262,7 +262,7 @@ 
 		 * @var $jsonld array The final jsonld before outputting to page.
 		 * @var $post_id int The post id for which the jsonld is generated.
 		 */
-		$jsonld = apply_filters( 'wl_after_get_jsonld', $jsonld, $post_id, $context );
+		$jsonld = apply_filters('wl_after_get_jsonld', $jsonld, $post_id, $context);
 
 		return $jsonld;
 	}
@@ -281,9 +281,9 @@ 
 		$is_homepage = is_home() || is_front_page();
 		$post_id     = is_singular() ? get_the_ID() : null;
 
-		$jsonld = wp_json_encode( $this->get_jsonld( $is_homepage, $post_id, Jsonld_Context_Enum::PAGE ) );
+		$jsonld = wp_json_encode($this->get_jsonld($is_homepage, $post_id, Jsonld_Context_Enum::PAGE));
 		?>
-		<script type="application/ld+json"><?php echo esc_html( $jsonld ); ?></script>
+		<script type="application/ld+json"><?php echo esc_html($jsonld); ?></script>
 													  <?php
 	}
 

src/includes/class-wordlift-category-taxonomy-service.php

Indentation +60 added lines, -60 removed lines

@@ -18,75 +18,75 @@
  */
 class Wordlift_Category_Taxonomy_Service {
 
-	/**
-	 * The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 *
-	 * @since  3.11.0
-	 * @access private
-	 * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 */
-	private $entity_post_type_service;
+    /**
+     * The {@link Wordlift_Entity_Post_Type_Service} instance.
+     *
+     * @since  3.11.0
+     * @access private
+     * @var \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
+     */
+    private $entity_post_type_service;
 
-	/**
-	 * Create a {@link Wordlift_Category_Taxonomy_Service} instance.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
-	 */
-	public function __construct( $entity_post_type_service ) {
+    /**
+     * Create a {@link Wordlift_Category_Taxonomy_Service} instance.
+     *
+     * @since 3.11.0
+     *
+     * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
+     */
+    public function __construct( $entity_post_type_service ) {
 
-		$this->entity_post_type_service = $entity_post_type_service;
+        $this->entity_post_type_service = $entity_post_type_service;
 
-	}
+    }
 
-	/**
-	 * Set the entity post types as one to be included in archive pages.
-	 *
-	 * In order to have entities show up in standard WP categories (Posts categories)
-	 * we configure the `entity` post type, but we also need to alter the main
-	 * WP query (which by default queries posts only) to include the `entities`.
-	 *
-	 * @since 3.11.0
-	 *
-	 * @param WP_Query $query WP's {@link WP_Query} instance.
-	 */
-	public function pre_get_posts( $query ) {
+    /**
+     * Set the entity post types as one to be included in archive pages.
+     *
+     * In order to have entities show up in standard WP categories (Posts categories)
+     * we configure the `entity` post type, but we also need to alter the main
+     * WP query (which by default queries posts only) to include the `entities`.
+     *
+     * @since 3.11.0
+     *
+     * @param WP_Query $query WP's {@link WP_Query} instance.
+     */
+    public function pre_get_posts( $query ) {
 
-		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
-			return;
-		}
+        // Only for the main query, avoid problems with widgets and what not.
+        if ( ! $query->is_main_query() ) {
+            return;
+        }
 
-		// We don't want to alter the query if we're in the admin UI, if this is
-		// not a category query, or if the `suppress_filters` is set.
-		//
-		// Note that it is unlikely for `suppress_filter` to be set on the front
-		// end, but let's be safe if it is set the calling code assumes no
-		// modifications of queries.
-		//
-		// is_admin is needed, otherwise category based post filters will show
-		// both types and at the current release (4.7) it causes PHP errors.
-		if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
-			return;
-		}
+        // We don't want to alter the query if we're in the admin UI, if this is
+        // not a category query, or if the `suppress_filters` is set.
+        //
+        // Note that it is unlikely for `suppress_filter` to be set on the front
+        // end, but let's be safe if it is set the calling code assumes no
+        // modifications of queries.
+        //
+        // is_admin is needed, otherwise category based post filters will show
+        // both types and at the current release (4.7) it causes PHP errors.
+        if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
+            return;
+        }
 
-		// Check the current post types, maybe the category archive pages
-		// are already associated with other post types.
-		//
-		// If `post_type` isn't set, WP assumes `post` by default.
-		$post_types = $query->get( 'post_type' );
-		$post_types = (array) ( $post_types ? $post_types : 'post' );
+        // Check the current post types, maybe the category archive pages
+        // are already associated with other post types.
+        //
+        // If `post_type` isn't set, WP assumes `post` by default.
+        $post_types = $query->get( 'post_type' );
+        $post_types = (array) ( $post_types ? $post_types : 'post' );
 
-		// Add the entities post type only if the post post type is used in the query
-		// since we only want `entities` to appear alongside posts.
-		if ( in_array( 'post', $post_types, true ) ) {
-			$post_types[] = $this->entity_post_type_service->get_post_type();
-		}
+        // Add the entities post type only if the post post type is used in the query
+        // since we only want `entities` to appear alongside posts.
+        if ( in_array( 'post', $post_types, true ) ) {
+            $post_types[] = $this->entity_post_type_service->get_post_type();
+        }
 
-		// Update the query post types.
-		$query->set( 'post_type', $post_types );
+        // Update the query post types.
+        $query->set( 'post_type', $post_types );
 
-	}
+    }
 
 }

Spacing +8 added lines, -8 removed lines

@@ -34,7 +34,7 @@ 
 	 *
 	 * @param \Wordlift_Entity_Post_Type_Service $entity_post_type_service The {@link Wordlift_Entity_Post_Type_Service} instance.
 	 */
-	public function __construct( $entity_post_type_service ) {
+	public function __construct($entity_post_type_service) {
 
 		$this->entity_post_type_service = $entity_post_type_service;
 
@@ -51,10 +51,10 @@ 
 	 *
 	 * @param WP_Query $query WP's {@link WP_Query} instance.
 	 */
-	public function pre_get_posts( $query ) {
+	public function pre_get_posts($query) {
 
 		// Only for the main query, avoid problems with widgets and what not.
-		if ( ! $query->is_main_query() ) {
+		if ( ! $query->is_main_query()) {
 			return;
 		}
 
@@ -67,7 +67,7 @@ 
 		//
 		// is_admin is needed, otherwise category based post filters will show
 		// both types and at the current release (4.7) it causes PHP errors.
-		if ( is_admin() || ! is_category() || ! empty( $query->query_vars['suppress_filters'] ) ) {
+		if (is_admin() || ! is_category() || ! empty($query->query_vars['suppress_filters'])) {
 			return;
 		}
 
@@ -75,17 +75,17 @@ 
 		// are already associated with other post types.
 		//
 		// If `post_type` isn't set, WP assumes `post` by default.
-		$post_types = $query->get( 'post_type' );
-		$post_types = (array) ( $post_types ? $post_types : 'post' );
+		$post_types = $query->get('post_type');
+		$post_types = (array) ($post_types ? $post_types : 'post');
 
 		// Add the entities post type only if the post post type is used in the query
 		// since we only want `entities` to appear alongside posts.
-		if ( in_array( 'post', $post_types, true ) ) {
+		if (in_array('post', $post_types, true)) {
 			$post_types[] = $this->entity_post_type_service->get_post_type();
 		}
 
 		// Update the query post types.
-		$query->set( 'post_type', $post_types );
+		$query->set('post_type', $post_types);
 
 	}
 

src/includes/class-wordlift-entity-type-adapter.php

Indentation +141 added lines, -141 removed lines

@@ -20,146 +20,146 @@
  */
 class Wordlift_Entity_Type_Adapter {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * Create a {@link Wordlift_Entity_Type_Adapter} instance.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since 3.15.0
-	 */
-	public function __construct( $entity_type_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' );
-
-		$this->entity_type_service = $entity_type_service;
-
-		add_filter(
-			'wl_default_entity_type_for_post_type',
-			array(
-				$this,
-				'default_entity_type_callback',
-			),
-			10,
-			2
-		);
-
-	}
-
-	/**
-	 * @param $entity_type string Entity type
-	 * @param $post_type string The post type
-	 *
-	 * @return string The default entity type depending on the post type.
-	 */
-	public function default_entity_type_callback( $entity_type, $post_type ) {
-		if ( 'product' === $post_type ) {
-			return 'http://schema.org/Product';
-		}
-
-		return $entity_type;
-	}
-
-	/**
-	 * Hook to `save_post`.
-	 *
-	 * This function is called when the `save_post` action is run. The
-	 * function checks whether an Entity Type term (from the Entity Types
-	 * taxonomy) is already assigned and, if not, it calls {@link Wordlift_Entity_Type_Service}
-	 * to set the default taxonomy term.
-	 *
-	 * @param int     $post_id The {@link WP_Post}'s id.
-	 * @param WP_Post $post The {@link WP_Post} instance.
-	 *
-	 * @since 3.15.0
-	 */
-	public function save_post( $post_id, $post ) {
-
-		if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) {
-			$this->log->debug( "Ignoring `{$post->post_type}` post type." );
-
-			// Bail out if the post can not be an entity.
-			return;
-		}
-
-		// Bail out if the post already has an entity type.
-		if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) {
-			$this->log->debug( "Post $post_id has already an entity type." );
-
-			return;
-		}
-
-		$this->log->debug( "Setting `Article` entity type for post $post_id." );
-
-		// Finally set the default entity type.
-
-		// For entities use a Thing
-		if ( 'entity' === $post->post_type ) {
-			$this->entity_type_service->set( $post_id, 'http://schema.org/Thing' );
-		} else {
-			// Get the entity types.
-			$entity_types = self::get_entity_types( $post->post_type );
-
-			// Set the entity type.
-			foreach ( $entity_types as $entity_type ) {
-				$this->entity_type_service->set( $post_id, $entity_type, false );
-			}
-		}
-
-	}
-
-	/**
-	 * Get the entity types for a post type.
-	 *
-	 * @param string $post_type The post type.
-	 *
-	 * @return array An array of entity types.
-	 * @since 3.20.0
-	 */
-	public static function get_entity_types( $post_type ) {
-
-		/**
-		 * Get the default entity type.
-		 *
-		 * @param string $entity_type The preset entity type.
-		 * @param string $post_type The post type.
-		 *
-		 * @since 3.20.0
-		 */
-		$default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type );
-
-		/**
-		 * Get the default entity types.
-		 *
-		 * Adding support to assign more than one entity type.
-		 *
-		 * @param array $entity_types The default entity types.
-		 * @param string $post_type The post type.
-		 *
-		 * @since 3.20.0
-		 *
-		 * @see Wordlift_Mapping_Service
-		 */
-		$entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type );
-
-		return $entity_types;
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * Create a {@link Wordlift_Entity_Type_Adapter} instance.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since 3.15.0
+     */
+    public function __construct( $entity_type_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' );
+
+        $this->entity_type_service = $entity_type_service;
+
+        add_filter(
+            'wl_default_entity_type_for_post_type',
+            array(
+                $this,
+                'default_entity_type_callback',
+            ),
+            10,
+            2
+        );
+
+    }
+
+    /**
+     * @param $entity_type string Entity type
+     * @param $post_type string The post type
+     *
+     * @return string The default entity type depending on the post type.
+     */
+    public function default_entity_type_callback( $entity_type, $post_type ) {
+        if ( 'product' === $post_type ) {
+            return 'http://schema.org/Product';
+        }
+
+        return $entity_type;
+    }
+
+    /**
+     * Hook to `save_post`.
+     *
+     * This function is called when the `save_post` action is run. The
+     * function checks whether an Entity Type term (from the Entity Types
+     * taxonomy) is already assigned and, if not, it calls {@link Wordlift_Entity_Type_Service}
+     * to set the default taxonomy term.
+     *
+     * @param int     $post_id The {@link WP_Post}'s id.
+     * @param WP_Post $post The {@link WP_Post} instance.
+     *
+     * @since 3.15.0
+     */
+    public function save_post( $post_id, $post ) {
+
+        if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) {
+            $this->log->debug( "Ignoring `{$post->post_type}` post type." );
+
+            // Bail out if the post can not be an entity.
+            return;
+        }
+
+        // Bail out if the post already has an entity type.
+        if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) {
+            $this->log->debug( "Post $post_id has already an entity type." );
+
+            return;
+        }
+
+        $this->log->debug( "Setting `Article` entity type for post $post_id." );
+
+        // Finally set the default entity type.
+
+        // For entities use a Thing
+        if ( 'entity' === $post->post_type ) {
+            $this->entity_type_service->set( $post_id, 'http://schema.org/Thing' );
+        } else {
+            // Get the entity types.
+            $entity_types = self::get_entity_types( $post->post_type );
+
+            // Set the entity type.
+            foreach ( $entity_types as $entity_type ) {
+                $this->entity_type_service->set( $post_id, $entity_type, false );
+            }
+        }
+
+    }
+
+    /**
+     * Get the entity types for a post type.
+     *
+     * @param string $post_type The post type.
+     *
+     * @return array An array of entity types.
+     * @since 3.20.0
+     */
+    public static function get_entity_types( $post_type ) {
+
+        /**
+         * Get the default entity type.
+         *
+         * @param string $entity_type The preset entity type.
+         * @param string $post_type The post type.
+         *
+         * @since 3.20.0
+         */
+        $default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type );
+
+        /**
+         * Get the default entity types.
+         *
+         * Adding support to assign more than one entity type.
+         *
+         * @param array $entity_types The default entity types.
+         * @param string $post_type The post type.
+         *
+         * @since 3.20.0
+         *
+         * @see Wordlift_Mapping_Service
+         */
+        $entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type );
+
+        return $entity_types;
+    }
 
 }

Spacing +18 added lines, -18 removed lines

@@ -45,9 +45,9 @@ 
 	 *
 	 * @since 3.15.0
 	 */
-	public function __construct( $entity_type_service ) {
+	public function __construct($entity_type_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Entity_Type_Adapter' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Entity_Type_Adapter');
 
 		$this->entity_type_service = $entity_type_service;
 
@@ -69,8 +69,8 @@ 
 	 *
 	 * @return string The default entity type depending on the post type.
 	 */
-	public function default_entity_type_callback( $entity_type, $post_type ) {
-		if ( 'product' === $post_type ) {
+	public function default_entity_type_callback($entity_type, $post_type) {
+		if ('product' === $post_type) {
 			return 'http://schema.org/Product';
 		}
 
@@ -90,36 +90,36 @@ 
 	 *
 	 * @since 3.15.0
 	 */
-	public function save_post( $post_id, $post ) {
+	public function save_post($post_id, $post) {
 
-		if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $post->post_type ) ) {
-			$this->log->debug( "Ignoring `{$post->post_type}` post type." );
+		if ( ! Wordlift_Entity_Type_Service::is_valid_entity_post_type($post->post_type)) {
+			$this->log->debug("Ignoring `{$post->post_type}` post type.");
 
 			// Bail out if the post can not be an entity.
 			return;
 		}
 
 		// Bail out if the post already has an entity type.
-		if ( apply_filters( 'wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type( $post_id ) ) ) {
-			$this->log->debug( "Post $post_id has already an entity type." );
+		if (apply_filters('wl_entity_type_adapter__save_post__has_entity_type', $this->entity_type_service->has_entity_type($post_id))) {
+			$this->log->debug("Post $post_id has already an entity type.");
 
 			return;
 		}
 
-		$this->log->debug( "Setting `Article` entity type for post $post_id." );
+		$this->log->debug("Setting `Article` entity type for post $post_id.");
 
 		// Finally set the default entity type.
 
 		// For entities use a Thing
-		if ( 'entity' === $post->post_type ) {
-			$this->entity_type_service->set( $post_id, 'http://schema.org/Thing' );
+		if ('entity' === $post->post_type) {
+			$this->entity_type_service->set($post_id, 'http://schema.org/Thing');
 		} else {
 			// Get the entity types.
-			$entity_types = self::get_entity_types( $post->post_type );
+			$entity_types = self::get_entity_types($post->post_type);
 
 			// Set the entity type.
-			foreach ( $entity_types as $entity_type ) {
-				$this->entity_type_service->set( $post_id, $entity_type, false );
+			foreach ($entity_types as $entity_type) {
+				$this->entity_type_service->set($post_id, $entity_type, false);
 			}
 		}
 
@@ -133,7 +133,7 @@ 
 	 * @return array An array of entity types.
 	 * @since 3.20.0
 	 */
-	public static function get_entity_types( $post_type ) {
+	public static function get_entity_types($post_type) {
 
 		/**
 		 * Get the default entity type.
@@ -143,7 +143,7 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$default_entity_type = apply_filters( 'wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type );
+		$default_entity_type = apply_filters('wl_default_entity_type_for_post_type', 'http://schema.org/Article', $post_type);
 
 		/**
 		 * Get the default entity types.
@@ -157,7 +157,7 @@ 
 		 *
 		 * @see Wordlift_Mapping_Service
 		 */
-		$entity_types = apply_filters( 'wl_default_entity_types_for_post_type', array( $default_entity_type ), $post_type );
+		$entity_types = apply_filters('wl_default_entity_types_for_post_type', array($default_entity_type), $post_type);
 
 		return $entity_types;
 	}

src/includes/class-wordlift-deactivator-feedback.php

Indentation +141 added lines, -141 removed lines

@@ -21,145 +21,145 @@
  */
 class Wordlift_Deactivator_Feedback {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.19.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Wordlift_Deactivator_Feedback constructor.
-	 *
-	 * @since 3.19.0
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' );
-
-	}
-
-	/**
-	 * Checks whether we have permissions to show the popup.
-	 *
-	 * @return  bool `true` if we have permissions, false otherwise.
-	 * @version 3.19.0
-	 */
-	private function has_permission_to_show_popup() {
-		// Get the current page.
-		global $pagenow;
-
-		// Bail if the user doesn't have permissions
-		// or if it's not the plugins page.
-		if ( 'plugins.php' !== $pagenow ) {
-			return false;
-		}
-
-		// Get the user preferences. We shouldn't show the feedback popup
-		// if we don't have permissions for that.
-		$user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences();
-
-		// Bail. We don't have preferences to show the popup.
-		if ( 'yes' !== $user_preferences ) {
-			return false;
-		}
-
-		return true;
-	}
-
-	/**
-	 * Render the feedback popup in the footer.
-	 *
-	 * @return  void
-	 * @version 3.19.0
-	 */
-	public function render_feedback_popup() {
-		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
-			return;
-		}
-		// Include the partial.
-		include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
-	}
-
-	/**
-	 * Enqueue required popup scripts and styles.
-	 *
-	 * @return  void
-	 * @version 3.19.0
-	 */
-	public function enqueue_popup_scripts() {
-		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
-			return;
-		}
-
-		wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION );
-		wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false );
-	}
-
-	/**
-	 * Handle the deactivation ajax call
-	 * and perform a request to external server.
-	 *
-	 * @return  void
-	 * @version 3.19.0
-	 */
-	public function wl_deactivation_feedback() {
-		// Bail if the nonce is not valid.
-		if (
-			empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists.
-			! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid.
-		) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
-		}
-
-		// We allow user to deactivate without providing a reason
-		// so bail and send success response.
-		if ( empty( $_POST['code'] ) ) {
-			wp_send_json_success();
-		}
-
-		$plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false );
-
-		// Prepare the options.
-		$options = array(
-			// The deactivation reason.
-			'code'             => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ),
-			// Additional information if provided.
-			'details'          => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '',
-			// The website url.
-			'url'              => get_bloginfo( 'url' ),
-			// WP version.
-			'wordpressVersion' => get_bloginfo( 'version' ),
-			// WL version.
-			'wordliftVersion'  => $plugin_data['Version'],
-			// The admin email.
-			'email'            => get_bloginfo( 'admin_email' ),
-		);
-
-		$response = wp_remote_post(
-			Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(),
-			array(
-				'method'  => 'POST',
-				'body'    => wp_json_encode( $options ),
-				'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
-			)
-		);
-
-		$code    = wp_remote_retrieve_response_code( $response );
-		$message = wp_remote_retrieve_response_message( $response );
-
-		// Add message to the error log if the response code is not 200.
-		if ( 201 !== $code ) {
-			// Write the error in the logs.
-			$this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message );
-		}
-
-		// We should send success message even when the feedback is not
-		// send, because otherwise the plugin cannot be deactivated.
-		wp_send_json_success();
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.19.0
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Wordlift_Deactivator_Feedback constructor.
+     *
+     * @since 3.19.0
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' );
+
+    }
+
+    /**
+     * Checks whether we have permissions to show the popup.
+     *
+     * @return  bool `true` if we have permissions, false otherwise.
+     * @version 3.19.0
+     */
+    private function has_permission_to_show_popup() {
+        // Get the current page.
+        global $pagenow;
+
+        // Bail if the user doesn't have permissions
+        // or if it's not the plugins page.
+        if ( 'plugins.php' !== $pagenow ) {
+            return false;
+        }
+
+        // Get the user preferences. We shouldn't show the feedback popup
+        // if we don't have permissions for that.
+        $user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences();
+
+        // Bail. We don't have preferences to show the popup.
+        if ( 'yes' !== $user_preferences ) {
+            return false;
+        }
+
+        return true;
+    }
+
+    /**
+     * Render the feedback popup in the footer.
+     *
+     * @return  void
+     * @version 3.19.0
+     */
+    public function render_feedback_popup() {
+        // Bail if we don't have permissions to show the popup.
+        if ( ! $this->has_permission_to_show_popup() ) {
+            return;
+        }
+        // Include the partial.
+        include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
+    }
+
+    /**
+     * Enqueue required popup scripts and styles.
+     *
+     * @return  void
+     * @version 3.19.0
+     */
+    public function enqueue_popup_scripts() {
+        // Bail if we don't have permissions to show the popup.
+        if ( ! $this->has_permission_to_show_popup() ) {
+            return;
+        }
+
+        wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION );
+        wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false );
+    }
+
+    /**
+     * Handle the deactivation ajax call
+     * and perform a request to external server.
+     *
+     * @return  void
+     * @version 3.19.0
+     */
+    public function wl_deactivation_feedback() {
+        // Bail if the nonce is not valid.
+        if (
+            empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists.
+            ! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid.
+        ) {
+            wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+        }
+
+        // We allow user to deactivate without providing a reason
+        // so bail and send success response.
+        if ( empty( $_POST['code'] ) ) {
+            wp_send_json_success();
+        }
+
+        $plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false );
+
+        // Prepare the options.
+        $options = array(
+            // The deactivation reason.
+            'code'             => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ),
+            // Additional information if provided.
+            'details'          => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '',
+            // The website url.
+            'url'              => get_bloginfo( 'url' ),
+            // WP version.
+            'wordpressVersion' => get_bloginfo( 'version' ),
+            // WL version.
+            'wordliftVersion'  => $plugin_data['Version'],
+            // The admin email.
+            'email'            => get_bloginfo( 'admin_email' ),
+        );
+
+        $response = wp_remote_post(
+            Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(),
+            array(
+                'method'  => 'POST',
+                'body'    => wp_json_encode( $options ),
+                'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
+            )
+        );
+
+        $code    = wp_remote_retrieve_response_code( $response );
+        $message = wp_remote_retrieve_response_message( $response );
+
+        // Add message to the error log if the response code is not 200.
+        if ( 201 !== $code ) {
+            // Write the error in the logs.
+            $this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message );
+        }
+
+        // We should send success message even when the feedback is not
+        // send, because otherwise the plugin cannot be deactivated.
+        wp_send_json_success();
+    }
 }

Spacing +24 added lines, -24 removed lines

@@ -37,7 +37,7 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Deactivator_Feedback' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Deactivator_Feedback');
 
 	}
 
@@ -53,7 +53,7 @@ 
 
 		// Bail if the user doesn't have permissions
 		// or if it's not the plugins page.
-		if ( 'plugins.php' !== $pagenow ) {
+		if ('plugins.php' !== $pagenow) {
 			return false;
 		}
 
@@ -62,7 +62,7 @@ 
 		$user_preferences = Wordlift_Configuration_Service::get_instance()->get_diagnostic_preferences();
 
 		// Bail. We don't have preferences to show the popup.
-		if ( 'yes' !== $user_preferences ) {
+		if ('yes' !== $user_preferences) {
 			return false;
 		}
 
@@ -77,11 +77,11 @@ 
 	 */
 	public function render_feedback_popup() {
 		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
+		if ( ! $this->has_permission_to_show_popup()) {
 			return;
 		}
 		// Include the partial.
-		include plugin_dir_path( __FILE__ ) . '../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
+		include plugin_dir_path(__FILE__).'../admin/partials/wordlift-admin-deactivation-feedback-popup.php';
 	}
 
 	/**
@@ -92,12 +92,12 @@ 
 	 */
 	public function enqueue_popup_scripts() {
 		// Bail if we don't have permissions to show the popup.
-		if ( ! $this->has_permission_to_show_popup() ) {
+		if ( ! $this->has_permission_to_show_popup()) {
 			return;
 		}
 
-		wp_enqueue_style( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION );
-		wp_enqueue_script( 'wordlift-admin-feedback-popup', plugin_dir_url( __DIR__ ) . 'admin/js/wordlift-admin-feedback-popup.js', array( 'jquery' ), WORDLIFT_VERSION, false );
+		wp_enqueue_style('wordlift-admin-feedback-popup', plugin_dir_url(__DIR__).'admin/css/wordlift-admin-feedback-popup.css', array(), WORDLIFT_VERSION);
+		wp_enqueue_script('wordlift-admin-feedback-popup', plugin_dir_url(__DIR__).'admin/js/wordlift-admin-feedback-popup.js', array('jquery'), WORDLIFT_VERSION, false);
 	}
 
 	/**
@@ -110,52 +110,52 @@ 
 	public function wl_deactivation_feedback() {
 		// Bail if the nonce is not valid.
 		if (
-			empty( $_POST['wl_deactivation_feedback_nonce'] ) || // The nonce doens't exists.
-			! wp_verify_nonce( sanitize_text_field( wp_unslash( $_POST['wl_deactivation_feedback_nonce'] ) ), 'wl_deactivation_feedback_nonce' ) // The nonce is invalid.
+			empty($_POST['wl_deactivation_feedback_nonce']) || // The nonce doens't exists.
+			! wp_verify_nonce(sanitize_text_field(wp_unslash($_POST['wl_deactivation_feedback_nonce'])), 'wl_deactivation_feedback_nonce') // The nonce is invalid.
 		) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+			wp_send_json_error(__('Nonce Security Check Failed!', 'wordlift'));
 		}
 
 		// We allow user to deactivate without providing a reason
 		// so bail and send success response.
-		if ( empty( $_POST['code'] ) ) {
+		if (empty($_POST['code'])) {
 			wp_send_json_success();
 		}
 
-		$plugin_data = get_plugin_data( plugin_dir_path( __DIR__ ) . 'wordlift.php', false, false );
+		$plugin_data = get_plugin_data(plugin_dir_path(__DIR__).'wordlift.php', false, false);
 
 		// Prepare the options.
 		$options = array(
 			// The deactivation reason.
-			'code'             => sanitize_text_field( wp_unslash( (string) $_POST['code'] ) ),
+			'code'             => sanitize_text_field(wp_unslash((string) $_POST['code'])),
 			// Additional information if provided.
-			'details'          => ( ! empty( $_POST['details'] ) ) ? sanitize_text_field( wp_unslash( (string) $_POST['details'] ) ) : '',
+			'details'          => ( ! empty($_POST['details'])) ? sanitize_text_field(wp_unslash((string) $_POST['details'])) : '',
 			// The website url.
-			'url'              => get_bloginfo( 'url' ),
+			'url'              => get_bloginfo('url'),
 			// WP version.
-			'wordpressVersion' => get_bloginfo( 'version' ),
+			'wordpressVersion' => get_bloginfo('version'),
 			// WL version.
 			'wordliftVersion'  => $plugin_data['Version'],
 			// The admin email.
-			'email'            => get_bloginfo( 'admin_email' ),
+			'email'            => get_bloginfo('admin_email'),
 		);
 
 		$response = wp_remote_post(
 			Wordlift_Configuration_Service::get_instance()->get_deactivation_feedback_url(),
 			array(
 				'method'  => 'POST',
-				'body'    => wp_json_encode( $options ),
-				'headers' => array( 'Content-Type' => 'application/json; charset=utf-8' ),
+				'body'    => wp_json_encode($options),
+				'headers' => array('Content-Type' => 'application/json; charset=utf-8'),
 			)
 		);
 
-		$code    = wp_remote_retrieve_response_code( $response );
-		$message = wp_remote_retrieve_response_message( $response );
+		$code    = wp_remote_retrieve_response_code($response);
+		$message = wp_remote_retrieve_response_message($response);
 
 		// Add message to the error log if the response code is not 200.
-		if ( 201 !== $code ) {
+		if (201 !== $code) {
 			// Write the error in the logs.
-			$this->log->error( 'An error occurred while requesting a feedback endpoint error_code: ' . $code . ' message: ' . $message );
+			$this->log->error('An error occurred while requesting a feedback endpoint error_code: '.$code.' message: '.$message);
 		}
 
 		// We should send success message even when the feedback is not

src/includes/class-wordlift-loader.php

Indentation +102 added lines, -102 removed lines

@@ -23,107 +23,107 @@
  */
 class Wordlift_Loader {
 
-	/**
-	 * The array of actions registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @access   protected
-	 * @var      array    $actions    The actions registered with WordPress to fire when the plugin loads.
-	 */
-	protected $actions;
-
-	/**
-	 * The array of filters registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @access   protected
-	 * @var      array    $filters    The filters registered with WordPress to fire when the plugin loads.
-	 */
-	protected $filters;
-
-	/**
-	 * Initialize the collections used to maintain the actions and filters.
-	 *
-	 * @since    1.0.0
-	 */
-	public function __construct() {
-
-		$this->actions = array();
-		$this->filters = array();
-
-	}
-
-	/**
-	 * Add a new action to the collection to be registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @param    string $hook             The name of the WordPress action that is being registered.
-	 * @param    object $component        A reference to the instance of the object on which the action is defined.
-	 * @param    string $callback         The name of the function definition on the $component.
-	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
-	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1.
-	 */
-	public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_action( $hook, array( $component, $callback ), $priority, $accepted_args );
-	}
-
-	/**
-	 * Add a new filter to the collection to be registered with WordPress.
-	 *
-	 * @since    1.0.0
-	 * @param    string $hook             The name of the WordPress filter that is being registered.
-	 * @param    object $component        A reference to the instance of the object on which the filter is defined.
-	 * @param    string $callback         The name of the function definition on the $component.
-	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
-	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1
-	 */
-	public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_filter( $hook, array( $component, $callback ), $priority, $accepted_args );
-	}
-
-	/**
-	 * A utility function that is used to register the actions and hooks into a single
-	 * collection.
-	 *
-	 * @since    1.0.0
-	 * @access   private
-	 * @param    array  $hooks            The collection of hooks that is being registered (that is, actions or filters).
-	 * @param    string $hook             The name of the WordPress filter that is being registered.
-	 * @param    object $component        A reference to the instance of the object on which the filter is defined.
-	 * @param    string $callback         The name of the function definition on the $component.
-	 * @param    int    $priority         The priority at which the function should be fired.
-	 * @param    int    $accepted_args    The number of arguments that should be passed to the $callback.
-	 * @return   array                                  The collection of actions and filters registered with WordPress.
-	 */
-	private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
-
-		$hooks[] = array(
-			'hook'          => $hook,
-			'component'     => $component,
-			'callback'      => $callback,
-			'priority'      => $priority,
-			'accepted_args' => $accepted_args,
-		);
-
-		return $hooks;
-
-	}
-
-	/**
-	 * Register the filters and actions with WordPress.
-	 *
-	 * @since    1.0.0
-	 */
-	public function run() {
-
-		foreach ( $this->filters as $hook ) {
-			add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
-		}
-
-		foreach ( $this->actions as $hook ) {
-			add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
-		}
-
-	}
+    /**
+     * The array of actions registered with WordPress.
+     *
+     * @since    1.0.0
+     * @access   protected
+     * @var      array    $actions    The actions registered with WordPress to fire when the plugin loads.
+     */
+    protected $actions;
+
+    /**
+     * The array of filters registered with WordPress.
+     *
+     * @since    1.0.0
+     * @access   protected
+     * @var      array    $filters    The filters registered with WordPress to fire when the plugin loads.
+     */
+    protected $filters;
+
+    /**
+     * Initialize the collections used to maintain the actions and filters.
+     *
+     * @since    1.0.0
+     */
+    public function __construct() {
+
+        $this->actions = array();
+        $this->filters = array();
+
+    }
+
+    /**
+     * Add a new action to the collection to be registered with WordPress.
+     *
+     * @since    1.0.0
+     * @param    string $hook             The name of the WordPress action that is being registered.
+     * @param    object $component        A reference to the instance of the object on which the action is defined.
+     * @param    string $callback         The name of the function definition on the $component.
+     * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
+     * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1.
+     */
+    public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
+        add_action( $hook, array( $component, $callback ), $priority, $accepted_args );
+    }
+
+    /**
+     * Add a new filter to the collection to be registered with WordPress.
+     *
+     * @since    1.0.0
+     * @param    string $hook             The name of the WordPress filter that is being registered.
+     * @param    object $component        A reference to the instance of the object on which the filter is defined.
+     * @param    string $callback         The name of the function definition on the $component.
+     * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
+     * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1
+     */
+    public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
+        add_filter( $hook, array( $component, $callback ), $priority, $accepted_args );
+    }
+
+    /**
+     * A utility function that is used to register the actions and hooks into a single
+     * collection.
+     *
+     * @since    1.0.0
+     * @access   private
+     * @param    array  $hooks            The collection of hooks that is being registered (that is, actions or filters).
+     * @param    string $hook             The name of the WordPress filter that is being registered.
+     * @param    object $component        A reference to the instance of the object on which the filter is defined.
+     * @param    string $callback         The name of the function definition on the $component.
+     * @param    int    $priority         The priority at which the function should be fired.
+     * @param    int    $accepted_args    The number of arguments that should be passed to the $callback.
+     * @return   array                                  The collection of actions and filters registered with WordPress.
+     */
+    private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
+
+        $hooks[] = array(
+            'hook'          => $hook,
+            'component'     => $component,
+            'callback'      => $callback,
+            'priority'      => $priority,
+            'accepted_args' => $accepted_args,
+        );
+
+        return $hooks;
+
+    }
+
+    /**
+     * Register the filters and actions with WordPress.
+     *
+     * @since    1.0.0
+     */
+    public function run() {
+
+        foreach ( $this->filters as $hook ) {
+            add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+        }
+
+        foreach ( $this->actions as $hook ) {
+            add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+        }
+
+    }
 
 }

Spacing +9 added lines, -9 removed lines

@@ -63,8 +63,8 @@ 
 	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
 	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1.
 	 */
-	public function add_action( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_action( $hook, array( $component, $callback ), $priority, $accepted_args );
+	public function add_action($hook, $component, $callback, $priority = 10, $accepted_args = 1) {
+		add_action($hook, array($component, $callback), $priority, $accepted_args);
 	}
 
 	/**
@@ -77,8 +77,8 @@ 
 	 * @param    int    $priority         Optional. he priority at which the function should be fired. Default is 10.
 	 * @param    int    $accepted_args    Optional. The number of arguments that should be passed to the $callback. Default is 1
 	 */
-	public function add_filter( $hook, $component, $callback, $priority = 10, $accepted_args = 1 ) {
-		add_filter( $hook, array( $component, $callback ), $priority, $accepted_args );
+	public function add_filter($hook, $component, $callback, $priority = 10, $accepted_args = 1) {
+		add_filter($hook, array($component, $callback), $priority, $accepted_args);
 	}
 
 	/**
@@ -95,7 +95,7 @@ 
 	 * @param    int    $accepted_args    The number of arguments that should be passed to the $callback.
 	 * @return   array                                  The collection of actions and filters registered with WordPress.
 	 */
-	private function add( $hooks, $hook, $component, $callback, $priority, $accepted_args ) {
+	private function add($hooks, $hook, $component, $callback, $priority, $accepted_args) {
 
 		$hooks[] = array(
 			'hook'          => $hook,
@@ -116,12 +116,12 @@ 
 	 */
 	public function run() {
 
-		foreach ( $this->filters as $hook ) {
-			add_filter( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+		foreach ($this->filters as $hook) {
+			add_filter($hook['hook'], array($hook['component'], $hook['callback']), $hook['priority'], $hook['accepted_args']);
 		}
 
-		foreach ( $this->actions as $hook ) {
-			add_action( $hook['hook'], array( $hook['component'], $hook['callback'] ), $hook['priority'], $hook['accepted_args'] );
+		foreach ($this->actions as $hook) {
+			add_action($hook['hook'], array($hook['component'], $hook['callback']), $hook['priority'], $hook['accepted_args']);
 		}
 
 	}

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

Indentation +187 added lines, -187 removed lines

@@ -17,202 +17,202 @@
  */
 class Wordlift_Api_Service {
 
-	/**
-	 * The {@link Wordlift_Api_Service} singleton instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Api_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * @var Api_Headers_Service|null
-	 */
-	private $headers_service;
-
-	/**
-	 * Create a {@link Wordlift_Api_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct() {
-		self::$instance        = $this;
-		$this->headers_service = Api_Headers_Service::get_instance();
-	}
-
-	/**
-	 * Get the {@link Wordlift_Api_Service} singleton instance.
-	 *
-	 * @return \Wordlift_Api_Service The {@link Wordlift_Api_Service} singleton instance.
-	 * @since 3.20.0
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Perform a `GET` request towards the requested path.
-	 *
-	 * @param string $path The relative path.
-	 *
-	 * @return array|WP_Error
-	 * @since 3.20.0
-	 */
-	public function get( $path ) {
-
-		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
-
-		// Get the response value.
-		$response = wp_remote_get(
-			$url,
-			array(
-				'user-agent' => User_Agent::get_user_agent(),
-				'headers'    => array(
-					'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
-				) + $this->headers_service->get_wp_headers(),
-				/*
+    /**
+     * The {@link Wordlift_Api_Service} singleton instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Api_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * @var Api_Headers_Service|null
+     */
+    private $headers_service;
+
+    /**
+     * Create a {@link Wordlift_Api_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct() {
+        self::$instance        = $this;
+        $this->headers_service = Api_Headers_Service::get_instance();
+    }
+
+    /**
+     * Get the {@link Wordlift_Api_Service} singleton instance.
+     *
+     * @return \Wordlift_Api_Service The {@link Wordlift_Api_Service} singleton instance.
+     * @since 3.20.0
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Perform a `GET` request towards the requested path.
+     *
+     * @param string $path The relative path.
+     *
+     * @return array|WP_Error
+     * @since 3.20.0
+     */
+    public function get( $path ) {
+
+        // Prepare the target URL.
+        $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+
+        // Get the response value.
+        $response = wp_remote_get(
+            $url,
+            array(
+                'user-agent' => User_Agent::get_user_agent(),
+                'headers'    => array(
+                    'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
+                ) + $this->headers_service->get_wp_headers(),
+                /*
 				* Increase the timeout from the default of 5 to 30 secs.
 				*
 				* @see https://github.com/insideout10/wordlift-plugin/issues/906
 				*
 				* @since 3.20.1
 				*/
-				'timeout'    => 30,
-			)
-		);
-
-		return self::get_message_or_error( $response );
-	}
-
-	/**
-	 * Perform a `POST` request towards the requested path.
-	 *
-	 * @param string       $path The relative path.
-	 * @param array|object $body The request body (will be serialized to JSON).
-	 *
-	 * @return array|WP_Error
-	 * @since 3.20.0
-	 */
-	public function post( $path, $body ) {
-
-		return $this->post_custom_content_type(
-			$path,
-			wp_json_encode( $body ),
-			'application/json; ' . get_bloginfo( 'charset' )
-		);
-	}
-
-	public function post_custom_content_type( $path, $body, $content_type ) {
-
-		// Prepare the target URL.
-		$url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path );
-
-		// Give some time for the operation to complete, more than the time we give to the HTTP operation to complete.
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@set_time_limit( 90 );
-
-		// Get the response value.
-		$key      = Wordlift_Configuration_Service::get_instance()->get_key();
-		$response = wp_remote_post(
-			$url,
-			array(
-				'timeout'    => 60,
-				'user-agent' => User_Agent::get_user_agent(),
-				'headers'    => array(
-					'Content-Type'    => $content_type,
-					'X-Authorization' => $key,
-					'Authorization'   => "Key $key",
-					/*
+                'timeout'    => 30,
+            )
+        );
+
+        return self::get_message_or_error( $response );
+    }
+
+    /**
+     * Perform a `POST` request towards the requested path.
+     *
+     * @param string       $path The relative path.
+     * @param array|object $body The request body (will be serialized to JSON).
+     *
+     * @return array|WP_Error
+     * @since 3.20.0
+     */
+    public function post( $path, $body ) {
+
+        return $this->post_custom_content_type(
+            $path,
+            wp_json_encode( $body ),
+            'application/json; ' . get_bloginfo( 'charset' )
+        );
+    }
+
+    public function post_custom_content_type( $path, $body, $content_type ) {
+
+        // Prepare the target URL.
+        $url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path );
+
+        // Give some time for the operation to complete, more than the time we give to the HTTP operation to complete.
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        @set_time_limit( 90 );
+
+        // Get the response value.
+        $key      = Wordlift_Configuration_Service::get_instance()->get_key();
+        $response = wp_remote_post(
+            $url,
+            array(
+                'timeout'    => 60,
+                'user-agent' => User_Agent::get_user_agent(),
+                'headers'    => array(
+                    'Content-Type'    => $content_type,
+                    'X-Authorization' => $key,
+                    'Authorization'   => "Key $key",
+                    /*
 					 * This is required to avoid CURL receiving 502 Bad Gateway errors.
 					 *
 					 * @see https://stackoverflow.com/questions/30601075/curl-to-google-compute-load-balancer-gets-error-502
 					 */
-					'Expect'          => '',
-				) + $this->headers_service->get_wp_headers(),
-				'body'       => $body,
-			)
-		);
-
-		return self::get_message_or_error( $response );
-	}
-
-	public function delete( $path ) {
-
-		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
-
-		// Get the response value.
-		$response = wp_remote_request(
-			$url,
-			array(
-				'method'     => 'DELETE',
-				'user-agent' => User_Agent::get_user_agent(),
-				'headers'    => array(
-					'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
-				) + $this->headers_service->get_wp_headers(),
-			)
-		);
-
-		return self::get_message_or_error( $response );
-	}
-
-	/**
-	 * Return the {@link WP_Error} in case of error or the actual reply if successful.
-	 *
-	 * @param array|WP_Error $response The response of an http call.
-	 *
-	 * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content.
-	 * @since 3.20.0
-	 */
-	private static function get_message_or_error( $response ) {
-
-		// Result is WP_Error.
-		if ( is_wp_error( $response ) ) {
-			return $response;
-		}
-
-		// `code` not set or not numeric.
-		$code = wp_remote_retrieve_response_code( $response );
-		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$message = @wp_remote_retrieve_response_message( $response );
-
-		if ( empty( $code ) || ! is_numeric( $code ) ) {
-			return new WP_Error( 0, $message );
-		}
-
-		// Code not 2xx.
-		if ( 2 !== intval( $code / 100 ) ) {
-			return new WP_Error( $code, $message );
-		}
-
-		// Everything's fine, return the message.
-		return self::try_json_decode( $response );
-	}
-
-	/**
-	 * Try to decode the json response
-	 *
-	 * @param array $response The response array.
-	 *
-	 * @return array|mixed|object The decoded response or the original response body.
-	 * @since 3.20.0
-	 */
-	private static function try_json_decode( $response ) {
-
-		// Get the headers.
-		$content_type = wp_remote_retrieve_header( $response, 'content-type' );
-		$body         = wp_remote_retrieve_body( $response );
-
-		// If it's not an `application/json` return the plain response body.
-		if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) {
-			return $body;
-		}
-
-		// Decode and return the structured result.
-		return json_decode( $body );
-	}
+                    'Expect'          => '',
+                ) + $this->headers_service->get_wp_headers(),
+                'body'       => $body,
+            )
+        );
+
+        return self::get_message_or_error( $response );
+    }
+
+    public function delete( $path ) {
+
+        // Prepare the target URL.
+        $url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+
+        // Get the response value.
+        $response = wp_remote_request(
+            $url,
+            array(
+                'method'     => 'DELETE',
+                'user-agent' => User_Agent::get_user_agent(),
+                'headers'    => array(
+                    'X-Authorization' => Wordlift_Configuration_Service::get_instance()->get_key(),
+                ) + $this->headers_service->get_wp_headers(),
+            )
+        );
+
+        return self::get_message_or_error( $response );
+    }
+
+    /**
+     * Return the {@link WP_Error} in case of error or the actual reply if successful.
+     *
+     * @param array|WP_Error $response The response of an http call.
+     *
+     * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content.
+     * @since 3.20.0
+     */
+    private static function get_message_or_error( $response ) {
+
+        // Result is WP_Error.
+        if ( is_wp_error( $response ) ) {
+            return $response;
+        }
+
+        // `code` not set or not numeric.
+        $code = wp_remote_retrieve_response_code( $response );
+        // phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
+        $message = @wp_remote_retrieve_response_message( $response );
+
+        if ( empty( $code ) || ! is_numeric( $code ) ) {
+            return new WP_Error( 0, $message );
+        }
+
+        // Code not 2xx.
+        if ( 2 !== intval( $code / 100 ) ) {
+            return new WP_Error( $code, $message );
+        }
+
+        // Everything's fine, return the message.
+        return self::try_json_decode( $response );
+    }
+
+    /**
+     * Try to decode the json response
+     *
+     * @param array $response The response array.
+     *
+     * @return array|mixed|object The decoded response or the original response body.
+     * @since 3.20.0
+     */
+    private static function try_json_decode( $response ) {
+
+        // Get the headers.
+        $content_type = wp_remote_retrieve_header( $response, 'content-type' );
+        $body         = wp_remote_retrieve_body( $response );
+
+        // If it's not an `application/json` return the plain response body.
+        if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) {
+            return $body;
+        }
+
+        // Decode and return the structured result.
+        return json_decode( $body );
+    }
 
 }

Spacing +27 added lines, -27 removed lines

@@ -60,10 +60,10 @@ 
 	 * @return array|WP_Error
 	 * @since 3.20.0
 	 */
-	public function get( $path ) {
+	public function get($path) {
 
 		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+		$url = Wordlift_Configuration_Service::get_instance()->get_api_url().$path;
 
 		// Get the response value.
 		$response = wp_remote_get(
@@ -84,7 +84,7 @@ 
 			)
 		);
 
-		return self::get_message_or_error( $response );
+		return self::get_message_or_error($response);
 	}
 
 	/**
@@ -96,23 +96,23 @@ 
 	 * @return array|WP_Error
 	 * @since 3.20.0
 	 */
-	public function post( $path, $body ) {
+	public function post($path, $body) {
 
 		return $this->post_custom_content_type(
 			$path,
-			wp_json_encode( $body ),
-			'application/json; ' . get_bloginfo( 'charset' )
+			wp_json_encode($body),
+			'application/json; '.get_bloginfo('charset')
 		);
 	}
 
-	public function post_custom_content_type( $path, $body, $content_type ) {
+	public function post_custom_content_type($path, $body, $content_type) {
 
 		// Prepare the target URL.
-		$url = apply_filters( 'wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url() . $path );
+		$url = apply_filters('wl_api_service_api_url_path', Wordlift_Configuration_Service::get_instance()->get_api_url().$path);
 
 		// Give some time for the operation to complete, more than the time we give to the HTTP operation to complete.
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		@set_time_limit( 90 );
+		@set_time_limit(90);
 
 		// Get the response value.
 		$key      = Wordlift_Configuration_Service::get_instance()->get_key();
@@ -136,13 +136,13 @@ 
 			)
 		);
 
-		return self::get_message_or_error( $response );
+		return self::get_message_or_error($response);
 	}
 
-	public function delete( $path ) {
+	public function delete($path) {
 
 		// Prepare the target URL.
-		$url = Wordlift_Configuration_Service::get_instance()->get_api_url() . $path;
+		$url = Wordlift_Configuration_Service::get_instance()->get_api_url().$path;
 
 		// Get the response value.
 		$response = wp_remote_request(
@@ -156,7 +156,7 @@ 
 			)
 		);
 
-		return self::get_message_or_error( $response );
+		return self::get_message_or_error($response);
 	}
 
 	/**
@@ -167,29 +167,29 @@ 
 	 * @return string|object|WP_Error A {@link WP_Error} instance or the actual response content.
 	 * @since 3.20.0
 	 */
-	private static function get_message_or_error( $response ) {
+	private static function get_message_or_error($response) {
 
 		// Result is WP_Error.
-		if ( is_wp_error( $response ) ) {
+		if (is_wp_error($response)) {
 			return $response;
 		}
 
 		// `code` not set or not numeric.
-		$code = wp_remote_retrieve_response_code( $response );
+		$code = wp_remote_retrieve_response_code($response);
 		// phpcs:ignore WordPress.PHP.NoSilencedErrors.Discouraged
-		$message = @wp_remote_retrieve_response_message( $response );
+		$message = @wp_remote_retrieve_response_message($response);
 
-		if ( empty( $code ) || ! is_numeric( $code ) ) {
-			return new WP_Error( 0, $message );
+		if (empty($code) || ! is_numeric($code)) {
+			return new WP_Error(0, $message);
 		}
 
 		// Code not 2xx.
-		if ( 2 !== intval( $code / 100 ) ) {
-			return new WP_Error( $code, $message );
+		if (2 !== intval($code / 100)) {
+			return new WP_Error($code, $message);
 		}
 
 		// Everything's fine, return the message.
-		return self::try_json_decode( $response );
+		return self::try_json_decode($response);
 	}
 
 	/**
@@ -200,19 +200,19 @@ 
 	 * @return array|mixed|object The decoded response or the original response body.
 	 * @since 3.20.0
 	 */
-	private static function try_json_decode( $response ) {
+	private static function try_json_decode($response) {
 
 		// Get the headers.
-		$content_type = wp_remote_retrieve_header( $response, 'content-type' );
-		$body         = wp_remote_retrieve_body( $response );
+		$content_type = wp_remote_retrieve_header($response, 'content-type');
+		$body         = wp_remote_retrieve_body($response);
 
 		// If it's not an `application/json` return the plain response body.
-		if ( 0 !== strpos( strtolower( $content_type ), 'application/json' ) ) {
+		if (0 !== strpos(strtolower($content_type), 'application/json')) {
 			return $body;
 		}
 
 		// Decode and return the structured result.
-		return json_decode( $body );
+		return json_decode($body);
 	}
 
 }

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';
 
 	}