insideout10 / wordlift-plugin

src/includes/cache/intf-wordlift-cache-service.php

Indentation +43 added lines, -43 removed lines

@@ -17,52 +17,52 @@
  */
 interface Wordlift_Cache_Service {
 
-	/**
-	 * Get the cached response for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id The cache `id`.
-	 *
-	 * @return mixed|false The cached contents or false if the cache isn't found.
-	 */
-	public function get_cache( $id );
+    /**
+     * Get the cached response for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id The cache `id`.
+     *
+     * @return mixed|false The cached contents or false if the cache isn't found.
+     */
+    public function get_cache( $id );
 
-	/**
-	 * Check whether we have cached results for the provided id.
-	 *
-	 * @since 3.16.3
-	 *
-	 * @param string $id The cache `id`.
-	 *
-	 * @return bool True if we have cached results otherwise false.
-	 */
-	public function has_cache( $id );
+    /**
+     * Check whether we have cached results for the provided id.
+     *
+     * @since 3.16.3
+     *
+     * @param string $id The cache `id`.
+     *
+     * @return bool True if we have cached results otherwise false.
+     */
+    public function has_cache( $id );
 
-	/**
-	 * Set the cache contents for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id       The cache id.
-	 * @param mixed  $contents The cache contents.
-	 */
-	public function set_cache( $id, $contents );
+    /**
+     * Set the cache contents for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id       The cache id.
+     * @param mixed  $contents The cache contents.
+     */
+    public function set_cache( $id, $contents );
 
-	/**
-	 * Delete the cache for the specified `id`.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @param string $id The cache `id`.
-	 */
-	public function delete_cache( $id );
+    /**
+     * Delete the cache for the specified `id`.
+     *
+     * @since 3.16.0
+     *
+     * @param string $id The cache `id`.
+     */
+    public function delete_cache( $id );
 
-	/**
-	 * Flush the whole cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function flush();
+    /**
+     * Flush the whole cache.
+     *
+     * @since 3.16.0
+     */
+    public function flush();
 
 }

Spacing +4 added lines, -4 removed lines

@@ -26,7 +26,7 @@ 
 	 *
 	 * @return mixed|false The cached contents or false if the cache isn't found.
 	 */
-	public function get_cache( $id );
+	public function get_cache($id);
 
 	/**
 	 * Check whether we have cached results for the provided id.
@@ -37,7 +37,7 @@ 
 	 *
 	 * @return bool True if we have cached results otherwise false.
 	 */
-	public function has_cache( $id );
+	public function has_cache($id);
 
 	/**
 	 * Set the cache contents for the specified `id`.
@@ -47,7 +47,7 @@ 
 	 * @param string $id       The cache id.
 	 * @param mixed  $contents The cache contents.
 	 */
-	public function set_cache( $id, $contents );
+	public function set_cache($id, $contents);
 
 	/**
 	 * Delete the cache for the specified `id`.
@@ -56,7 +56,7 @@ 
 	 *
 	 * @param string $id The cache `id`.
 	 */
-	public function delete_cache( $id );
+	public function delete_cache($id);
 
 	/**
 	 * Flush the whole cache.

src/includes/cache/require.php

Spacing +4 added lines, -4 removed lines

@@ -8,7 +8,7 @@
  * @package    Wordlift
  * @subpackage Wordlift/includes/cache
  */
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/intf-wordlift-cache-service.php';
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/class-wordlift-file-cache-service.php';
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/class-wordlift-cached-post-converter.php';
-require_once plugin_dir_path( dirname( __DIR__ ) ) . 'includes/cache/class-wordlift-cached-entity-uri-service.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/intf-wordlift-cache-service.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/class-wordlift-file-cache-service.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/class-wordlift-cached-post-converter.php';
+require_once plugin_dir_path(dirname(__DIR__)).'includes/cache/class-wordlift-cached-entity-uri-service.php';

src/includes/cache/class-wordlift-cached-entity-uri-service.php

Indentation +198 added lines, -198 removed lines

@@ -14,203 +14,203 @@
  */
 class Wordlift_Cached_Entity_Uri_Service extends Wordlift_Entity_Uri_Service {
 
-	/**
-	 * The {@link Wordlift_Cache_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Cache_Service $cache_service The {@link Wordlift_Cache_Service} instance.
-	 */
-	private $cache_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_Cached_Entity_Uri_Service} instance.
-	 *
-	 * @param \Wordlift_Cache_Service $cache_service
-	 *
-	 * @since 3.16.3
-	 */
-	public function __construct( $cache_service ) {
-		parent::__construct();
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Add hooks for meta being added/modified/deleted.
-		$this->cache_service = $cache_service;
-
-		add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
-		add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-		add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-
-	}
-
-	/**
-	 * Preload the URIs.
-	 *
-	 * @param array $uris Preload an array of URIs.
-	 *
-	 * @since 3.16.3
-	 */
-	public function preload_uris( $uris ) {
-
-		// Filter the URIs which aren't yet cached.
-		$cache_service = $this->cache_service;
-		$uris_to_cache = array_filter(
-			(array) $uris,
-			function ( $item ) use ( $cache_service ) {
-				return ! $cache_service->has_cache( $item );
-			}
-		);
-
-		// Preload the URIs.
-		parent::preload_uris( $uris_to_cache );
-
-		// Store them in cache.
-		if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
-			foreach ( $this->uri_to_post as $uri => $post_id ) {
-				$this->set_cache( $uri, $post_id );
-			}
-		}
-
-	}
-
-	/**
-	 * Get the entity post for the specified URI.
-	 *
-	 * @param string $uri The URI.
-	 *
-	 * @return null|WP_Post The {@link WP_Post} or null if not found.
-	 * @since 3.16.3
-	 */
-	public function get_entity( $uri ) {
-
-		$this->log->trace( "Getting entity for uri $uri..." );
-
-		// Get the cached post for the specified URI.
-		$cache = $this->cache_service->get_cache( $uri );
-
-		// Return the cached data if valid.
-		if ( false !== $cache && is_numeric( $cache ) ) {
-			$this->log->debug( "Cached entity $cache for uri $uri found." );
-
-			return get_post( $cache );
-		}
-
-		// Get the actual result.
-		$post = parent::get_entity( $uri );
-
-		// Cache the result.
-		if ( null !== $post ) {
-			$this->set_cache( $uri, $post->ID );
-		}
-
-		// Return the result.
-		return $post;
-	}
-
-	/**
-	 * Set the cached URI for the specified {@link WP_Post}.
-	 *
-	 * @param string $uri The URI.
-	 * @param int    $post_id The post ID.
-	 *
-	 * @since 3.16.3
-	 * @since 3.29.0 takes a post ID as input.
-	 */
-	private function set_cache( $uri, $post_id ) {
-
-		// Cache the result.
-		$this->cache_service->set_cache( $uri, $post_id );
-
-	}
-
-	/**
-	 * Delete the cache for the specified URIs.
-	 *
-	 * @param array $uris An array of URIs.
-	 *
-	 * @since 3.16.3
-	 */
-	private function delete_cache( $uris ) {
-
-		// Delete the cache for each URI.
-		foreach ( $uris as $uri ) {
-			// Delete the single cache file.
-			$this->cache_service->delete_cache( $uri );
-		}
-
-	}
-
-	/**
-	 * Before post meta change.
-	 *
-	 * When a post meta is going to be changed, we check if the `meta_key` is
-	 * either the `entity_url` or the `same_as` in which case we delete the cache
-	 * for all the associated URIs.
-	 *
-	 * @param int|array $meta_ids The {@link WP_Post} meta id(s).
-	 * @param int       $post_id The {@link WP_Post} id.
-	 * @param string    $meta_key The meta key.
-	 * @param mixed     $meta_value The meta value(s).
-	 *
-	 * @since 3.16.3
-	 */
-	public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
-
-		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
-			return;
-		}
-
-		$this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
-
-		// The list of existing URIs, plus the list of URIs being deleted/updated.
-		$old_value = get_post_meta( $post_id, $meta_key );
-
-		// We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
-		// because of filters. So if it's not we return an empty array.
-		if ( ! is_array( $old_value ) ) {
-			$old_value = array();
-		}
-		$new_value = isset( $meta_value ) ? (array) $meta_value : array();
-		$uris      = array_merge( $old_value, $new_value );
-
-		// Delete the cache for those URIs.
-		$this->delete_cache( $uris );
-
-	}
-
-	/**
-	 * Hook to meta add for a {@link WP_Post}, will cause the cache to
-	 * invalidate.
-	 *
-	 * @param int    $post_id The {@link WP_Post} id.
-	 * @param string $meta_key The meta key.
-	 * @param mixed  $meta_value The meta value(s).
-	 *
-	 * @since 3.16.3
-	 */
-	public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
-
-		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
-			return;
-		}
-
-		$this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
-
-		// Delete the cache for the URIs being added.
-		$this->delete_cache( (array) $meta_value );
-
-	}
+    /**
+     * The {@link Wordlift_Cache_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Cache_Service $cache_service The {@link Wordlift_Cache_Service} instance.
+     */
+    private $cache_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_Cached_Entity_Uri_Service} instance.
+     *
+     * @param \Wordlift_Cache_Service $cache_service
+     *
+     * @since 3.16.3
+     */
+    public function __construct( $cache_service ) {
+        parent::__construct();
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Add hooks for meta being added/modified/deleted.
+        $this->cache_service = $cache_service;
+
+        add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
+        add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+        add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+
+    }
+
+    /**
+     * Preload the URIs.
+     *
+     * @param array $uris Preload an array of URIs.
+     *
+     * @since 3.16.3
+     */
+    public function preload_uris( $uris ) {
+
+        // Filter the URIs which aren't yet cached.
+        $cache_service = $this->cache_service;
+        $uris_to_cache = array_filter(
+            (array) $uris,
+            function ( $item ) use ( $cache_service ) {
+                return ! $cache_service->has_cache( $item );
+            }
+        );
+
+        // Preload the URIs.
+        parent::preload_uris( $uris_to_cache );
+
+        // Store them in cache.
+        if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
+            foreach ( $this->uri_to_post as $uri => $post_id ) {
+                $this->set_cache( $uri, $post_id );
+            }
+        }
+
+    }
+
+    /**
+     * Get the entity post for the specified URI.
+     *
+     * @param string $uri The URI.
+     *
+     * @return null|WP_Post The {@link WP_Post} or null if not found.
+     * @since 3.16.3
+     */
+    public function get_entity( $uri ) {
+
+        $this->log->trace( "Getting entity for uri $uri..." );
+
+        // Get the cached post for the specified URI.
+        $cache = $this->cache_service->get_cache( $uri );
+
+        // Return the cached data if valid.
+        if ( false !== $cache && is_numeric( $cache ) ) {
+            $this->log->debug( "Cached entity $cache for uri $uri found." );
+
+            return get_post( $cache );
+        }
+
+        // Get the actual result.
+        $post = parent::get_entity( $uri );
+
+        // Cache the result.
+        if ( null !== $post ) {
+            $this->set_cache( $uri, $post->ID );
+        }
+
+        // Return the result.
+        return $post;
+    }
+
+    /**
+     * Set the cached URI for the specified {@link WP_Post}.
+     *
+     * @param string $uri The URI.
+     * @param int    $post_id The post ID.
+     *
+     * @since 3.16.3
+     * @since 3.29.0 takes a post ID as input.
+     */
+    private function set_cache( $uri, $post_id ) {
+
+        // Cache the result.
+        $this->cache_service->set_cache( $uri, $post_id );
+
+    }
+
+    /**
+     * Delete the cache for the specified URIs.
+     *
+     * @param array $uris An array of URIs.
+     *
+     * @since 3.16.3
+     */
+    private function delete_cache( $uris ) {
+
+        // Delete the cache for each URI.
+        foreach ( $uris as $uri ) {
+            // Delete the single cache file.
+            $this->cache_service->delete_cache( $uri );
+        }
+
+    }
+
+    /**
+     * Before post meta change.
+     *
+     * When a post meta is going to be changed, we check if the `meta_key` is
+     * either the `entity_url` or the `same_as` in which case we delete the cache
+     * for all the associated URIs.
+     *
+     * @param int|array $meta_ids The {@link WP_Post} meta id(s).
+     * @param int       $post_id The {@link WP_Post} id.
+     * @param string    $meta_key The meta key.
+     * @param mixed     $meta_value The meta value(s).
+     *
+     * @since 3.16.3
+     */
+    public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
+
+        // Bail out if we're not interested in the meta key.
+        if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+            return;
+        }
+
+        $this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
+
+        // The list of existing URIs, plus the list of URIs being deleted/updated.
+        $old_value = get_post_meta( $post_id, $meta_key );
+
+        // We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
+        // because of filters. So if it's not we return an empty array.
+        if ( ! is_array( $old_value ) ) {
+            $old_value = array();
+        }
+        $new_value = isset( $meta_value ) ? (array) $meta_value : array();
+        $uris      = array_merge( $old_value, $new_value );
+
+        // Delete the cache for those URIs.
+        $this->delete_cache( $uris );
+
+    }
+
+    /**
+     * Hook to meta add for a {@link WP_Post}, will cause the cache to
+     * invalidate.
+     *
+     * @param int    $post_id The {@link WP_Post} id.
+     * @param string $meta_key The meta key.
+     * @param mixed  $meta_value The meta value(s).
+     *
+     * @since 3.16.3
+     */
+    public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
+
+        // Bail out if we're not interested in the meta key.
+        if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+            return;
+        }
+
+        $this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
+
+        // Delete the cache for the URIs being added.
+        $this->delete_cache( (array) $meta_value );
+
+    }
 
 }

Spacing +38 added lines, -38 removed lines

@@ -39,17 +39,17 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function __construct( $cache_service ) {
+	public function __construct($cache_service) {
 		parent::__construct();
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Add hooks for meta being added/modified/deleted.
 		$this->cache_service = $cache_service;
 
-		add_action( 'add_post_meta', array( $this, 'on_before_post_meta_add' ), 10, 3 );
-		add_action( 'update_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
-		add_action( 'delete_post_meta', array( $this, 'on_before_post_meta_change' ), 10, 4 );
+		add_action('add_post_meta', array($this, 'on_before_post_meta_add'), 10, 3);
+		add_action('update_post_meta', array($this, 'on_before_post_meta_change'), 10, 4);
+		add_action('delete_post_meta', array($this, 'on_before_post_meta_change'), 10, 4);
 
 	}
 
@@ -60,24 +60,24 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Filter the URIs which aren't yet cached.
 		$cache_service = $this->cache_service;
 		$uris_to_cache = array_filter(
 			(array) $uris,
-			function ( $item ) use ( $cache_service ) {
-				return ! $cache_service->has_cache( $item );
+			function($item) use ($cache_service) {
+				return ! $cache_service->has_cache($item);
 			}
 		);
 
 		// Preload the URIs.
-		parent::preload_uris( $uris_to_cache );
+		parent::preload_uris($uris_to_cache);
 
 		// Store them in cache.
-		if ( is_array( $this->uri_to_post ) && ! empty( $this->uri_to_post ) ) {
-			foreach ( $this->uri_to_post as $uri => $post_id ) {
-				$this->set_cache( $uri, $post_id );
+		if (is_array($this->uri_to_post) && ! empty($this->uri_to_post)) {
+			foreach ($this->uri_to_post as $uri => $post_id) {
+				$this->set_cache($uri, $post_id);
 			}
 		}
 
@@ -91,26 +91,26 @@ 
 	 * @return null|WP_Post The {@link WP_Post} or null if not found.
 	 * @since 3.16.3
 	 */
-	public function get_entity( $uri ) {
+	public function get_entity($uri) {
 
-		$this->log->trace( "Getting entity for uri $uri..." );
+		$this->log->trace("Getting entity for uri $uri...");
 
 		// Get the cached post for the specified URI.
-		$cache = $this->cache_service->get_cache( $uri );
+		$cache = $this->cache_service->get_cache($uri);
 
 		// Return the cached data if valid.
-		if ( false !== $cache && is_numeric( $cache ) ) {
-			$this->log->debug( "Cached entity $cache for uri $uri found." );
+		if (false !== $cache && is_numeric($cache)) {
+			$this->log->debug("Cached entity $cache for uri $uri found.");
 
-			return get_post( $cache );
+			return get_post($cache);
 		}
 
 		// Get the actual result.
-		$post = parent::get_entity( $uri );
+		$post = parent::get_entity($uri);
 
 		// Cache the result.
-		if ( null !== $post ) {
-			$this->set_cache( $uri, $post->ID );
+		if (null !== $post) {
+			$this->set_cache($uri, $post->ID);
 		}
 
 		// Return the result.
@@ -126,10 +126,10 @@ 
 	 * @since 3.16.3
 	 * @since 3.29.0 takes a post ID as input.
 	 */
-	private function set_cache( $uri, $post_id ) {
+	private function set_cache($uri, $post_id) {
 
 		// Cache the result.
-		$this->cache_service->set_cache( $uri, $post_id );
+		$this->cache_service->set_cache($uri, $post_id);
 
 	}
 
@@ -140,12 +140,12 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	private function delete_cache( $uris ) {
+	private function delete_cache($uris) {
 
 		// Delete the cache for each URI.
-		foreach ( $uris as $uri ) {
+		foreach ($uris as $uri) {
 			// Delete the single cache file.
-			$this->cache_service->delete_cache( $uri );
+			$this->cache_service->delete_cache($uri);
 		}
 
 	}
@@ -164,28 +164,28 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function on_before_post_meta_change( $meta_ids, $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_change($meta_ids, $post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Updating/deleting $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// The list of existing URIs, plus the list of URIs being deleted/updated.
-		$old_value = get_post_meta( $post_id, $meta_key );
+		$old_value = get_post_meta($post_id, $meta_key);
 
 		// We expect an array here from the `get_post_meta` signature. However `get_post_meta` is prone to side effects
 		// because of filters. So if it's not we return an empty array.
-		if ( ! is_array( $old_value ) ) {
+		if ( ! is_array($old_value)) {
 			$old_value = array();
 		}
-		$new_value = isset( $meta_value ) ? (array) $meta_value : array();
-		$uris      = array_merge( $old_value, $new_value );
+		$new_value = isset($meta_value) ? (array) $meta_value : array();
+		$uris      = array_merge($old_value, $new_value);
 
 		// Delete the cache for those URIs.
-		$this->delete_cache( $uris );
+		$this->delete_cache($uris);
 
 	}
 
@@ -199,17 +199,17 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function on_before_post_meta_add( $post_id, $meta_key, $meta_value ) {
+	public function on_before_post_meta_add($post_id, $meta_key, $meta_value) {
 
 		// Bail out if we're not interested in the meta key.
-		if ( WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key ) {
+		if (WL_ENTITY_URL_META_NAME !== $meta_key && Wordlift_Schema_Service::FIELD_SAME_AS !== $meta_key) {
 			return;
 		}
 
-		$this->log->trace( "Adding $meta_key for post $post_id ($meta_key), invalidating cache..." );
+		$this->log->trace("Adding $meta_key for post $post_id ($meta_key), invalidating cache...");
 
 		// Delete the cache for the URIs being added.
-		$this->delete_cache( (array) $meta_value );
+		$this->delete_cache((array) $meta_value);
 
 	}
 

src/includes/cache/class-wordlift-cached-post-converter.php

Indentation +349 added lines, -349 removed lines

@@ -21,354 +21,354 @@
  */
 class Wordlift_Cached_Post_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var \Wordlift_Post_Converter $converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.16.0
-	 *
-	 * @var Wordlift_Log_Service \$log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * A list of meta keys that do not cause the cache to update.
-	 *
-	 * @since 3.17.3
-	 * @var array An array of ignored meta keys.
-	 */
-	private static $ignored_meta_keys = array(
-		'_edit_lock',
-		'_edit_last',
-		'_wp_page_template',
-		'_wp_attachment_is_custom_background',
-		'_wp_attachment_backup_sizes',
-		'_wp_attachment_is_custom_header',
-	);
-	/**
-	 * @var Ttl_Cache
-	 */
-	private $cache;
-	/**
-	 * @var Reference_Processor
-	 */
-	private $reference_processor;
-
-	/**
-	 * Wordlift_Cached_Post_Converter constructor.
-	 *
-	 * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
-	 * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
-	 */
-	public function __construct( $converter, $cache ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->cache               = $cache;
-		$this->converter           = $converter;
-		$this->reference_processor = Reference_Processor::get_instance();
-		$this->init_hooks();
-
-	}
-
-	/**
-	 * Hooks to catch post/post meta changes in order to invalidate the cache.
-	 *
-	 * @since 3.16.0
-	 */
-	private function init_hooks() {
-
-		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
-
-		add_action(
-			'added_post_meta',
-			array(
-				$this,
-				'changed_post_meta',
-			),
-			10,
-			3
-		);
-		add_action(
-			'updated_post_meta',
-			array(
-				$this,
-				'changed_post_meta',
-			),
-			10,
-			3
-		);
-		add_action(
-			'deleted_post_meta',
-			array(
-				$this,
-				'changed_post_meta',
-			),
-			10,
-			3
-		);
-
-		// Flush cache when wordlift settings were updated.
-		add_action(
-			'update_option_wl_general_settings',
-			array(
-				$this,
-				'update_option_wl_general_settings',
-			)
-		);
-
-		// Flushes the cache when permalink structure is changed.
-		add_action(
-			'update_option_permalink_structure',
-			array(
-				$this,
-				'permalinks_structure_changed',
-			)
-		);
-
-		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
-
-	}
-
-	/**
-	 * Note that the `&$cache` parameter here is used only to report whether the response comes from the cache. It
-	 * used by `test-issue-626.php` and nowhere else in code.
-	 *
-	 * @inheritdoc
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
-
-		// Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
-		// key var types.
-		$post_id = (int) $post_id;
-
-		$this->log->trace( "Converting post $post_id..." );
-
-		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
-
-		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
-
-			// Inform the caller that this is cached result.
-			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-			$cache = true;
-			$this->add_http_header( $post_id, true );
-
-			// Return the contents.
-			return $contents;
-		}
-
-		// Set cached to false.
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$cache = false;
-		$this->add_http_header( $post_id, false );
-
-		// Convert the post.
-		$jsonld = $this->converter->convert( $post_id, $references, $references_infos );
-
-		/**
-		 * @since 3.32.0
-		 * We cant apply json_encode on the objects {@link \Wordlift\Jsonld\Reference}, so we decode
-		 * it here before saving it on cache.
-		 */
-		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
-
-		// Finally return the JSON-LD.
-		return $jsonld;
-	}
-
-	/**
-	 * Try to get the cached contents.
-	 *
-	 * @param int   $post_id The {@link WP_Post} id.
-	 * @param array $references The referenced posts.
-	 *
-	 * @return mixed|bool The cached contents or false if the cached isn't found.
-	 * @since 3.16.0
-	 */
-	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_cache( $post_id, &$references = array() ) {
-
-		// Ensure post ID is int, because cache is strict about var types.
-		$post_id = (int) $post_id;
-
-		$this->log->trace( "Getting cached contents for post $post_id..." );
-
-		// Get the cache.
-		$contents = $this->cache->get( $post_id );
-
-		// Bail out if we don't have cached contents or the cached contents are
-		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
-
-			return false;
-		}
-
-		// Remap the cache.
-		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = $this->reference_processor->deserialize_references( $contents['references'] );
-
-		return $contents['jsonld'];
-	}
-
-	/**
-	 * Set the cache with the provided results.
-	 *
-	 * The function will prepare the provided results and will ask the {@link Ttl_Cache} to cache them.
-	 *
-	 * @param int   $post_id The {@link WP_Post} id.
-	 * @param array $references An array of references.
-	 * @param array $jsonld A JSON-LD structure.
-	 *
-	 * @since 3.16.0
-	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
-
-		$this->log->trace( "Caching result for post $post_id..." );
-
-		$this->cache->put(
-			$post_id,
-			array(
-				'references' => $this->reference_processor->serialize_references( $references ),
-				'jsonld'     => $jsonld,
-			)
-		);
-
-	}
-
-	/**
-	 * Hook to 'save_post', will invalidate the cache for that post.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @since 3.16.0
-	 */
-	public function save_post( $post_id ) {
-
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
-
-		$this->cache->delete( $post_id );
-
-		$this->flush_cache_if_publisher( $post_id );
-
-	}
-
-	/**
-	 * Hook to meta changed for a {@link WP_Post}, will cause the cause to
-	 * invalidate.
-	 *
-	 * @param int    $id The {@link WP_Post} meta id.
-	 * @param int    $post_id The {@link WP_Post} id.
-	 * @param string $meta_key The meta key.
-	 *
-	 * @since 3.16.0
-	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
-
-		if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
-
-			return;
-		}
-
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
-
-		// Delete the single cache file.
-		$this->cache->delete( $post_id );
-
-		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
-
-	}
-
-	/**
-	 * Hook to WordLift's options changes, will flush the cache.
-	 *
-	 * @since 3.16.0
-	 */
-	public function update_option_wl_general_settings() {
-		$this->log->trace( 'WordLift options changed, flushing cache...' );
-
-		$this->cache->flush();
-	}
-
-	/**
-	 * Hook when permalinks are changed, will flush the cache.
-	 *
-	 * @since 3.17.0
-	 */
-	public function permalinks_structure_changed() {
-		$this->log->trace( 'Permalinks structure changed, flushing cache...' );
-
-		$this->cache->flush();
-	}
-
-	/**
-	 * Hook to WordLift's post/entity relation changes, will invalidate the cache.
-	 *
-	 * @param int $post_id The {@link WP_Post} id.
-	 *
-	 * @since 3.16.0
-	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
-
-		$this->cache->delete( $post_id );
-	}
-
-	/**
-	 * When in Ajax, prints an http header with the information whether the
-	 * response is cached or not.
-	 *
-	 * @param int  $post_id The {@link WP_Post} id.
-	 * @param bool $cache Whether the response fragment is cached.
-	 *
-	 * @since 3.16.0
-	 */
-	private function add_http_header( $post_id, $cache ) {
-
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
-			return;
-		}
-
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
-
-	}
-
-	/**
-	 * Call the `flush` operation on the {@link Ttl_Cache} if
-	 * the publisher has changed.
-	 *
-	 * @param int $post_id The changed {@link WP_Post}'s id.
-	 *
-	 * @since 3.16.0
-	 */
-	private function flush_cache_if_publisher( $post_id ) {
-
-		// Bail out if it's not the publisher.
-		if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
-			return;
-		}
-
-		// Flush the cache, since the publisher has changed.
-		$this->cache->flush();
-
-	}
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var \Wordlift_Post_Converter $converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.16.0
+     *
+     * @var Wordlift_Log_Service \$log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * A list of meta keys that do not cause the cache to update.
+     *
+     * @since 3.17.3
+     * @var array An array of ignored meta keys.
+     */
+    private static $ignored_meta_keys = array(
+        '_edit_lock',
+        '_edit_last',
+        '_wp_page_template',
+        '_wp_attachment_is_custom_background',
+        '_wp_attachment_backup_sizes',
+        '_wp_attachment_is_custom_header',
+    );
+    /**
+     * @var Ttl_Cache
+     */
+    private $cache;
+    /**
+     * @var Reference_Processor
+     */
+    private $reference_processor;
+
+    /**
+     * Wordlift_Cached_Post_Converter constructor.
+     *
+     * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
+     * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
+     */
+    public function __construct( $converter, $cache ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->cache               = $cache;
+        $this->converter           = $converter;
+        $this->reference_processor = Reference_Processor::get_instance();
+        $this->init_hooks();
+
+    }
+
+    /**
+     * Hooks to catch post/post meta changes in order to invalidate the cache.
+     *
+     * @since 3.16.0
+     */
+    private function init_hooks() {
+
+        // Hook on post save to flush relevant cache.
+        add_action( 'save_post', array( $this, 'save_post' ) );
+
+        add_action(
+            'added_post_meta',
+            array(
+                $this,
+                'changed_post_meta',
+            ),
+            10,
+            3
+        );
+        add_action(
+            'updated_post_meta',
+            array(
+                $this,
+                'changed_post_meta',
+            ),
+            10,
+            3
+        );
+        add_action(
+            'deleted_post_meta',
+            array(
+                $this,
+                'changed_post_meta',
+            ),
+            10,
+            3
+        );
+
+        // Flush cache when wordlift settings were updated.
+        add_action(
+            'update_option_wl_general_settings',
+            array(
+                $this,
+                'update_option_wl_general_settings',
+            )
+        );
+
+        // Flushes the cache when permalink structure is changed.
+        add_action(
+            'update_option_permalink_structure',
+            array(
+                $this,
+                'permalinks_structure_changed',
+            )
+        );
+
+        // Invalid cache on relationship change.
+        add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
+        add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+
+    }
+
+    /**
+     * Note that the `&$cache` parameter here is used only to report whether the response comes from the cache. It
+     * used by `test-issue-626.php` and nowhere else in code.
+     *
+     * @inheritdoc
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
+
+        // Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
+        // key var types.
+        $post_id = (int) $post_id;
+
+        $this->log->trace( "Converting post $post_id..." );
+
+        // Try to get a cached result.
+        $contents = $this->get_cache( $post_id, $references );
+
+        // Return the cached contents if any.
+        if ( false !== $contents ) {
+            $this->log->debug( "Cached contents found for post $post_id." );
+
+            // Inform the caller that this is cached result.
+            // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+            $cache = true;
+            $this->add_http_header( $post_id, true );
+
+            // Return the contents.
+            return $contents;
+        }
+
+        // Set cached to false.
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $cache = false;
+        $this->add_http_header( $post_id, false );
+
+        // Convert the post.
+        $jsonld = $this->converter->convert( $post_id, $references, $references_infos );
+
+        /**
+         * @since 3.32.0
+         * We cant apply json_encode on the objects {@link \Wordlift\Jsonld\Reference}, so we decode
+         * it here before saving it on cache.
+         */
+        // Cache the results.
+        $this->set_cache( $post_id, $references, $jsonld );
+
+        // Finally return the JSON-LD.
+        return $jsonld;
+    }
+
+    /**
+     * Try to get the cached contents.
+     *
+     * @param int   $post_id The {@link WP_Post} id.
+     * @param array $references The referenced posts.
+     *
+     * @return mixed|bool The cached contents or false if the cached isn't found.
+     * @since 3.16.0
+     */
+    // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+    private function get_cache( $post_id, &$references = array() ) {
+
+        // Ensure post ID is int, because cache is strict about var types.
+        $post_id = (int) $post_id;
+
+        $this->log->trace( "Getting cached contents for post $post_id..." );
+
+        // Get the cache.
+        $contents = $this->cache->get( $post_id );
+
+        // Bail out if we don't have cached contents or the cached contents are
+        // invalid.
+        if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
+            $this->log->debug( "Cached contents for post $post_id not found." );
+
+            return false;
+        }
+
+        // Remap the cache.
+        // phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
+        $references = $this->reference_processor->deserialize_references( $contents['references'] );
+
+        return $contents['jsonld'];
+    }
+
+    /**
+     * Set the cache with the provided results.
+     *
+     * The function will prepare the provided results and will ask the {@link Ttl_Cache} to cache them.
+     *
+     * @param int   $post_id The {@link WP_Post} id.
+     * @param array $references An array of references.
+     * @param array $jsonld A JSON-LD structure.
+     *
+     * @since 3.16.0
+     */
+    private function set_cache( $post_id, $references, $jsonld ) {
+
+        $this->log->trace( "Caching result for post $post_id..." );
+
+        $this->cache->put(
+            $post_id,
+            array(
+                'references' => $this->reference_processor->serialize_references( $references ),
+                'jsonld'     => $jsonld,
+            )
+        );
+
+    }
+
+    /**
+     * Hook to 'save_post', will invalidate the cache for that post.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @since 3.16.0
+     */
+    public function save_post( $post_id ) {
+
+        $this->log->trace( "Post $post_id saved, invalidating cache..." );
+
+        $this->cache->delete( $post_id );
+
+        $this->flush_cache_if_publisher( $post_id );
+
+    }
+
+    /**
+     * Hook to meta changed for a {@link WP_Post}, will cause the cause to
+     * invalidate.
+     *
+     * @param int    $id The {@link WP_Post} meta id.
+     * @param int    $post_id The {@link WP_Post} id.
+     * @param string $meta_key The meta key.
+     *
+     * @since 3.16.0
+     */
+    public function changed_post_meta( $id, $post_id, $meta_key ) {
+
+        if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
+            $this->log->trace( "Post $post_id meta $meta_key ignored." );
+
+            return;
+        }
+
+        $this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+
+        // Delete the single cache file.
+        $this->cache->delete( $post_id );
+
+        // Flush the cache if it's the publisher.
+        $this->flush_cache_if_publisher( $post_id );
+
+    }
+
+    /**
+     * Hook to WordLift's options changes, will flush the cache.
+     *
+     * @since 3.16.0
+     */
+    public function update_option_wl_general_settings() {
+        $this->log->trace( 'WordLift options changed, flushing cache...' );
+
+        $this->cache->flush();
+    }
+
+    /**
+     * Hook when permalinks are changed, will flush the cache.
+     *
+     * @since 3.17.0
+     */
+    public function permalinks_structure_changed() {
+        $this->log->trace( 'Permalinks structure changed, flushing cache...' );
+
+        $this->cache->flush();
+    }
+
+    /**
+     * Hook to WordLift's post/entity relation changes, will invalidate the cache.
+     *
+     * @param int $post_id The {@link WP_Post} id.
+     *
+     * @since 3.16.0
+     */
+    public function relation_changed( $post_id ) {
+        $this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+
+        $this->cache->delete( $post_id );
+    }
+
+    /**
+     * When in Ajax, prints an http header with the information whether the
+     * response is cached or not.
+     *
+     * @param int  $post_id The {@link WP_Post} id.
+     * @param bool $cache Whether the response fragment is cached.
+     *
+     * @since 3.16.0
+     */
+    private function add_http_header( $post_id, $cache ) {
+
+        if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+            return;
+        }
+
+        header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+
+    }
+
+    /**
+     * Call the `flush` operation on the {@link Ttl_Cache} if
+     * the publisher has changed.
+     *
+     * @param int $post_id The changed {@link WP_Post}'s id.
+     *
+     * @since 3.16.0
+     */
+    private function flush_cache_if_publisher( $post_id ) {
+
+        // Bail out if it's not the publisher.
+        if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
+            return;
+        }
+
+        // Flush the cache, since the publisher has changed.
+        $this->cache->flush();
+
+    }
 
 }

Spacing +43 added lines, -43 removed lines

@@ -68,9 +68,9 @@ 
 	 * @param \Wordlift_Post_Converter $converter The {@link Wordlift_Post_Converter} implementation.
 	 * @param Ttl_Cache                $cache The {@link Ttl_Cache} cache instance.
 	 */
-	public function __construct( $converter, $cache ) {
+	public function __construct($converter, $cache) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->cache               = $cache;
 		$this->converter           = $converter;
@@ -87,7 +87,7 @@ 
 	private function init_hooks() {
 
 		// Hook on post save to flush relevant cache.
-		add_action( 'save_post', array( $this, 'save_post' ) );
+		add_action('save_post', array($this, 'save_post'));
 
 		add_action(
 			'added_post_meta',
@@ -136,8 +136,8 @@ 
 		);
 
 		// Invalid cache on relationship change.
-		add_action( 'wl_relation_added', array( $this, 'relation_changed' ) );
-		add_action( 'wl_relation_deleted', array( $this, 'relation_changed' ) );
+		add_action('wl_relation_added', array($this, 'relation_changed'));
+		add_action('wl_relation_deleted', array($this, 'relation_changed'));
 
 	}
 
@@ -148,25 +148,25 @@ 
 	 * @inheritdoc
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	public function convert( $post_id, &$references = array(), &$references_infos = array(), &$cache = false ) {
+	public function convert($post_id, &$references = array(), &$references_infos = array(), &$cache = false) {
 
 		// Ensure post ID is `int`. Otherwise we may have issues with caching, since caching is strict about
 		// key var types.
 		$post_id = (int) $post_id;
 
-		$this->log->trace( "Converting post $post_id..." );
+		$this->log->trace("Converting post $post_id...");
 
 		// Try to get a cached result.
-		$contents = $this->get_cache( $post_id, $references );
+		$contents = $this->get_cache($post_id, $references);
 
 		// Return the cached contents if any.
-		if ( false !== $contents ) {
-			$this->log->debug( "Cached contents found for post $post_id." );
+		if (false !== $contents) {
+			$this->log->debug("Cached contents found for post $post_id.");
 
 			// Inform the caller that this is cached result.
 			// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 			$cache = true;
-			$this->add_http_header( $post_id, true );
+			$this->add_http_header($post_id, true);
 
 			// Return the contents.
 			return $contents;
@@ -175,10 +175,10 @@ 
 		// Set cached to false.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
 		$cache = false;
-		$this->add_http_header( $post_id, false );
+		$this->add_http_header($post_id, false);
 
 		// Convert the post.
-		$jsonld = $this->converter->convert( $post_id, $references, $references_infos );
+		$jsonld = $this->converter->convert($post_id, $references, $references_infos);
 
 		/**
 		 * @since 3.32.0
@@ -186,7 +186,7 @@ 
 		 * it here before saving it on cache.
 		 */
 		// Cache the results.
-		$this->set_cache( $post_id, $references, $jsonld );
+		$this->set_cache($post_id, $references, $jsonld);
 
 		// Finally return the JSON-LD.
 		return $jsonld;
@@ -202,27 +202,27 @@ 
 	 * @since 3.16.0
 	 */
 	// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-	private function get_cache( $post_id, &$references = array() ) {
+	private function get_cache($post_id, &$references = array()) {
 
 		// Ensure post ID is int, because cache is strict about var types.
 		$post_id = (int) $post_id;
 
-		$this->log->trace( "Getting cached contents for post $post_id..." );
+		$this->log->trace("Getting cached contents for post $post_id...");
 
 		// Get the cache.
-		$contents = $this->cache->get( $post_id );
+		$contents = $this->cache->get($post_id);
 
 		// Bail out if we don't have cached contents or the cached contents are
 		// invalid.
-		if ( null === $contents || ! isset( $contents['jsonld'] ) || ! isset( $contents['references'] ) ) {
-			$this->log->debug( "Cached contents for post $post_id not found." );
+		if (null === $contents || ! isset($contents['jsonld']) || ! isset($contents['references'])) {
+			$this->log->debug("Cached contents for post $post_id not found.");
 
 			return false;
 		}
 
 		// Remap the cache.
 		// phpcs:ignore VariableAnalysis.CodeAnalysis.VariableAnalysis.UnusedVariable
-		$references = $this->reference_processor->deserialize_references( $contents['references'] );
+		$references = $this->reference_processor->deserialize_references($contents['references']);
 
 		return $contents['jsonld'];
 	}
@@ -238,14 +238,14 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function set_cache( $post_id, $references, $jsonld ) {
+	private function set_cache($post_id, $references, $jsonld) {
 
-		$this->log->trace( "Caching result for post $post_id..." );
+		$this->log->trace("Caching result for post $post_id...");
 
 		$this->cache->put(
 			$post_id,
 			array(
-				'references' => $this->reference_processor->serialize_references( $references ),
+				'references' => $this->reference_processor->serialize_references($references),
 				'jsonld'     => $jsonld,
 			)
 		);
@@ -259,13 +259,13 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function save_post( $post_id ) {
+	public function save_post($post_id) {
 
-		$this->log->trace( "Post $post_id saved, invalidating cache..." );
+		$this->log->trace("Post $post_id saved, invalidating cache...");
 
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -279,21 +279,21 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function changed_post_meta( $id, $post_id, $meta_key ) {
+	public function changed_post_meta($id, $post_id, $meta_key) {
 
-		if ( in_array( $meta_key, self::$ignored_meta_keys, true ) ) {
-			$this->log->trace( "Post $post_id meta $meta_key ignored." );
+		if (in_array($meta_key, self::$ignored_meta_keys, true)) {
+			$this->log->trace("Post $post_id meta $meta_key ignored.");
 
 			return;
 		}
 
-		$this->log->trace( "Post $post_id meta $meta_key changed, invalidating cache..." );
+		$this->log->trace("Post $post_id meta $meta_key changed, invalidating cache...");
 
 		// Delete the single cache file.
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 
 		// Flush the cache if it's the publisher.
-		$this->flush_cache_if_publisher( $post_id );
+		$this->flush_cache_if_publisher($post_id);
 
 	}
 
@@ -303,7 +303,7 @@ 
 	 * @since 3.16.0
 	 */
 	public function update_option_wl_general_settings() {
-		$this->log->trace( 'WordLift options changed, flushing cache...' );
+		$this->log->trace('WordLift options changed, flushing cache...');
 
 		$this->cache->flush();
 	}
@@ -314,7 +314,7 @@ 
 	 * @since 3.17.0
 	 */
 	public function permalinks_structure_changed() {
-		$this->log->trace( 'Permalinks structure changed, flushing cache...' );
+		$this->log->trace('Permalinks structure changed, flushing cache...');
 
 		$this->cache->flush();
 	}
@@ -326,10 +326,10 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	public function relation_changed( $post_id ) {
-		$this->log->trace( "Post $post_id relations changed, invalidating cache..." );
+	public function relation_changed($post_id) {
+		$this->log->trace("Post $post_id relations changed, invalidating cache...");
 
-		$this->cache->delete( $post_id );
+		$this->cache->delete($post_id);
 	}
 
 	/**
@@ -341,13 +341,13 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function add_http_header( $post_id, $cache ) {
+	private function add_http_header($post_id, $cache) {
 
-		if ( ! defined( 'DOING_AJAX' ) || ! DOING_AJAX || headers_sent() ) {
+		if ( ! defined('DOING_AJAX') || ! DOING_AJAX || headers_sent()) {
 			return;
 		}
 
-		header( "X-WordLift-JsonLd-Cache-$post_id: " . ( $cache ? 'HIT' : 'MISS' ) );
+		header("X-WordLift-JsonLd-Cache-$post_id: ".($cache ? 'HIT' : 'MISS'));
 
 	}
 
@@ -359,10 +359,10 @@ 
 	 *
 	 * @since 3.16.0
 	 */
-	private function flush_cache_if_publisher( $post_id ) {
+	private function flush_cache_if_publisher($post_id) {
 
 		// Bail out if it's not the publisher.
-		if ( Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id ) {
+		if (Wordlift_Configuration_Service::get_instance()->get_publisher_id() !== $post_id) {
 			return;
 		}
 

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

Indentation +180 added lines, -180 removed lines

@@ -16,185 +16,185 @@
  */
 class Wordlift_Http_Api {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.3
-	 *
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Create a {@link Wordlift_End_Point} instance.
-	 *
-	 * @since 3.15.3
-	 */
-	public function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
-		add_action( 'template_redirect', array( $this, 'template_redirect' ) );
-
-		// region SAMPLE ACTIONS.
-		add_action(
-			'admin_post_wl_hello_world',
-			array(
-				$this,
-				'hello_world',
-			)
-		);
-		add_action(
-			'admin_post_nopriv_wl_hello_world',
-			array(
-				$this,
-				'nopriv_hello_world',
-			)
-		);
-		// endregion
-	}
-
-	/**
-	 * Add the `wl-api` rewrite end-point.
-	 *
-	 * @since 3.15.3
-	 */
-	public function add_rewrite_endpoint() {
-
-		add_rewrite_endpoint( 'wl-api', EP_ROOT );
-		$this->ensure_rewrite_rules_are_flushed();
-
-	}
-
-	/**
-	 * Handle `template_redirect` hooks.
-	 *
-	 * @since 3.15.3
-	 */
-	public function template_redirect() {
-
-		global $wp_query;
-
-		if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
-			$this->log->trace( 'Skipping, not a `wl-api` call.' );
-
-			return;
-		}
-
-		$action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$this->do_action( $action );
-
-		exit;
-
-	}
-
-	/**
-	 * Do the requested action.
-	 *
-	 * @param string $action The action to execute.
-	 *
-	 * @since 3.15.3
-	 */
-	private function do_action( $action ) {
-
-		if ( empty( $action ) ) {
-			return;
-		}
-
-		if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
-			/**
-			 * Fires on a non-authenticated admin post request for the given action.
-			 *
-			 * The dynamic portion of the hook name, `$action`, refers to the given
-			 * request action.
-			 *
-			 * @since 2.6.0
-			 */
-			do_action( "admin_post_nopriv_{$action}" );
-		} else {
-			/**
-			 * Fires on an authenticated admin post request for the given action.
-			 *
-			 * The dynamic portion of the hook name, `$action`, refers to the given
-			 * request action.
-			 *
-			 * @since 2.6.0
-			 */
-			do_action( "admin_post_{$action}" );
-		}
-
-	}
-
-	/**
-	 * Test function, anonymous.
-	 *
-	 * @since 3.15.3
-	 */
-	public function nopriv_hello_world() {
-
-		wp_die( 'Hello World! (from anonymous)' );
-
-	}
-
-	/**
-	 * Test function, authenticated.
-	 *
-	 * @since 3.15.3
-	 */
-	public function hello_world() {
-
-		wp_die( 'Hello World! (from authenticated)' );
-
-	}
-
-	/**
-	 * Ensure that the rewrite rules are flushed the first time.
-	 *
-	 * @since 3.16.0 changed the value from 1 to `yes` to avoid type juggling issues.
-	 * @since 3.15.3
-	 */
-	public static function ensure_rewrite_rules_are_flushed() {
-
-		// See https://github.com/insideout10/wordlift-plugin/issues/698.
-		if ( 'yes' !== get_option( 'wl_http_api' ) ) {
-			update_option( 'wl_http_api', 'yes' );
-			add_action(
-				'wp_loaded',
-				function () {
-					flush_rewrite_rules();
-				}
-			);
-		}
-
-	}
-
-	/**
-	 * Called by {@see activate_wordlift}, resets the `wl_http_api` option flag in order to force WordLift to
-	 * reinitialize the `wl-api` route.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
-	 *
-	 * @since 3.19.2
-	 */
-	public static function activate() {
-
-		// Force the plugin to reinitialize the rewrite rules.
-		update_option( 'wl_http_api', 'no' );
-
-	}
-
-	/**
-	 * Delete the option when the plugin is deactivated.
-	 *
-	 * @since 3.19.4
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/846
-	 */
-	public static function deactivate() {
-
-		delete_option( 'wl_http_api' );
-
-	}
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.3
+     *
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Create a {@link Wordlift_End_Point} instance.
+     *
+     * @since 3.15.3
+     */
+    public function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
+        add_action( 'template_redirect', array( $this, 'template_redirect' ) );
+
+        // region SAMPLE ACTIONS.
+        add_action(
+            'admin_post_wl_hello_world',
+            array(
+                $this,
+                'hello_world',
+            )
+        );
+        add_action(
+            'admin_post_nopriv_wl_hello_world',
+            array(
+                $this,
+                'nopriv_hello_world',
+            )
+        );
+        // endregion
+    }
+
+    /**
+     * Add the `wl-api` rewrite end-point.
+     *
+     * @since 3.15.3
+     */
+    public function add_rewrite_endpoint() {
+
+        add_rewrite_endpoint( 'wl-api', EP_ROOT );
+        $this->ensure_rewrite_rules_are_flushed();
+
+    }
+
+    /**
+     * Handle `template_redirect` hooks.
+     *
+     * @since 3.15.3
+     */
+    public function template_redirect() {
+
+        global $wp_query;
+
+        if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
+            $this->log->trace( 'Skipping, not a `wl-api` call.' );
+
+            return;
+        }
+
+        $action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $this->do_action( $action );
+
+        exit;
+
+    }
+
+    /**
+     * Do the requested action.
+     *
+     * @param string $action The action to execute.
+     *
+     * @since 3.15.3
+     */
+    private function do_action( $action ) {
+
+        if ( empty( $action ) ) {
+            return;
+        }
+
+        if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
+            /**
+             * Fires on a non-authenticated admin post request for the given action.
+             *
+             * The dynamic portion of the hook name, `$action`, refers to the given
+             * request action.
+             *
+             * @since 2.6.0
+             */
+            do_action( "admin_post_nopriv_{$action}" );
+        } else {
+            /**
+             * Fires on an authenticated admin post request for the given action.
+             *
+             * The dynamic portion of the hook name, `$action`, refers to the given
+             * request action.
+             *
+             * @since 2.6.0
+             */
+            do_action( "admin_post_{$action}" );
+        }
+
+    }
+
+    /**
+     * Test function, anonymous.
+     *
+     * @since 3.15.3
+     */
+    public function nopriv_hello_world() {
+
+        wp_die( 'Hello World! (from anonymous)' );
+
+    }
+
+    /**
+     * Test function, authenticated.
+     *
+     * @since 3.15.3
+     */
+    public function hello_world() {
+
+        wp_die( 'Hello World! (from authenticated)' );
+
+    }
+
+    /**
+     * Ensure that the rewrite rules are flushed the first time.
+     *
+     * @since 3.16.0 changed the value from 1 to `yes` to avoid type juggling issues.
+     * @since 3.15.3
+     */
+    public static function ensure_rewrite_rules_are_flushed() {
+
+        // See https://github.com/insideout10/wordlift-plugin/issues/698.
+        if ( 'yes' !== get_option( 'wl_http_api' ) ) {
+            update_option( 'wl_http_api', 'yes' );
+            add_action(
+                'wp_loaded',
+                function () {
+                    flush_rewrite_rules();
+                }
+            );
+        }
+
+    }
+
+    /**
+     * Called by {@see activate_wordlift}, resets the `wl_http_api` option flag in order to force WordLift to
+     * reinitialize the `wl-api` route.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/820 related issue.
+     *
+     * @since 3.19.2
+     */
+    public static function activate() {
+
+        // Force the plugin to reinitialize the rewrite rules.
+        update_option( 'wl_http_api', 'no' );
+
+    }
+
+    /**
+     * Delete the option when the plugin is deactivated.
+     *
+     * @since 3.19.4
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/846
+     */
+    public static function deactivate() {
+
+        delete_option( 'wl_http_api' );
+
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -32,10 +32,10 @@ 
 	 */
 	public function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
-		add_action( 'init', array( $this, 'add_rewrite_endpoint' ) );
-		add_action( 'template_redirect', array( $this, 'template_redirect' ) );
+		add_action('init', array($this, 'add_rewrite_endpoint'));
+		add_action('template_redirect', array($this, 'template_redirect'));
 
 		// region SAMPLE ACTIONS.
 		add_action(
@@ -62,7 +62,7 @@ 
 	 */
 	public function add_rewrite_endpoint() {
 
-		add_rewrite_endpoint( 'wl-api', EP_ROOT );
+		add_rewrite_endpoint('wl-api', EP_ROOT);
 		$this->ensure_rewrite_rules_are_flushed();
 
 	}
@@ -76,14 +76,14 @@ 
 
 		global $wp_query;
 
-		if ( ! isset( $wp_query->query_vars['wl-api'] ) ) {
-			$this->log->trace( 'Skipping, not a `wl-api` call.' );
+		if ( ! isset($wp_query->query_vars['wl-api'])) {
+			$this->log->trace('Skipping, not a `wl-api` call.');
 
 			return;
 		}
 
-		$action = isset( $_REQUEST['action'] ) ? sanitize_text_field( wp_unslash( (string) $_REQUEST['action'] ) ) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$this->do_action( $action );
+		$action = isset($_REQUEST['action']) ? sanitize_text_field(wp_unslash((string) $_REQUEST['action'])) : ''; //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$this->do_action($action);
 
 		exit;
 
@@ -96,13 +96,13 @@ 
 	 *
 	 * @since 3.15.3
 	 */
-	private function do_action( $action ) {
+	private function do_action($action) {
 
-		if ( empty( $action ) ) {
+		if (empty($action)) {
 			return;
 		}
 
-		if ( ! wp_validate_auth_cookie( '', 'logged_in' ) ) {
+		if ( ! wp_validate_auth_cookie('', 'logged_in')) {
 			/**
 			 * Fires on a non-authenticated admin post request for the given action.
 			 *
@@ -111,7 +111,7 @@ 
 			 *
 			 * @since 2.6.0
 			 */
-			do_action( "admin_post_nopriv_{$action}" );
+			do_action("admin_post_nopriv_{$action}");
 		} else {
 			/**
 			 * Fires on an authenticated admin post request for the given action.
@@ -121,7 +121,7 @@ 
 			 *
 			 * @since 2.6.0
 			 */
-			do_action( "admin_post_{$action}" );
+			do_action("admin_post_{$action}");
 		}
 
 	}
@@ -133,7 +133,7 @@ 
 	 */
 	public function nopriv_hello_world() {
 
-		wp_die( 'Hello World! (from anonymous)' );
+		wp_die('Hello World! (from anonymous)');
 
 	}
 
@@ -144,7 +144,7 @@ 
 	 */
 	public function hello_world() {
 
-		wp_die( 'Hello World! (from authenticated)' );
+		wp_die('Hello World! (from authenticated)');
 
 	}
 
@@ -157,11 +157,11 @@ 
 	public static function ensure_rewrite_rules_are_flushed() {
 
 		// See https://github.com/insideout10/wordlift-plugin/issues/698.
-		if ( 'yes' !== get_option( 'wl_http_api' ) ) {
-			update_option( 'wl_http_api', 'yes' );
+		if ('yes' !== get_option('wl_http_api')) {
+			update_option('wl_http_api', 'yes');
 			add_action(
 				'wp_loaded',
-				function () {
+				function() {
 					flush_rewrite_rules();
 				}
 			);
@@ -180,7 +180,7 @@ 
 	public static function activate() {
 
 		// Force the plugin to reinitialize the rewrite rules.
-		update_option( 'wl_http_api', 'no' );
+		update_option('wl_http_api', 'no');
 
 	}
 
@@ -193,7 +193,7 @@ 
 	 */
 	public static function deactivate() {
 
-		delete_option( 'wl_http_api' );
+		delete_option('wl_http_api');
 
 	}
 

src/includes/mapping/class-wordlift-mapping-ajax-adapter.php

Indentation +54 added lines, -54 removed lines

@@ -8,80 +8,80 @@
 
 class Wordlift_Mapping_Ajax_Adapter {
 
-	/**
-	 * The {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
-	 */
-	private $mapping_service;
+    /**
+     * The {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
+     */
+    private $mapping_service;
 
-	/**
-	 * Create a {@link Wordlift_Mapping_Ajax_Adapter} instance.
-	 *
-	 * @param Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 */
-	public function __construct( $mapping_service ) {
+    /**
+     * Create a {@link Wordlift_Mapping_Ajax_Adapter} instance.
+     *
+     * @param Wordlift_Mapping_Service $mapping_service The {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     */
+    public function __construct( $mapping_service ) {
 
-		$this->mapping_service = $mapping_service;
+        $this->mapping_service = $mapping_service;
 
-		add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
-		add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
+        add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
+        add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
 
-	}
+    }
 
-	public function set_entity_types_for_post_type() {
+    public function set_entity_types_for_post_type() {
 
-		if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-			return;
-		}
+        if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+            return;
+        }
 
-		$post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+        $entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
+        $this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
 
-		wp_send_json_success();
+        wp_send_json_success();
 
-	}
+    }
 
-	public function update_post_type_entity_types() {
+    public function update_post_type_entity_types() {
 
-		// If the nonce is invalid, return an error.
-		$nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
-		}
+        // If the nonce is invalid, return an error.
+        $nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
+        if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
+            wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+        }
 
-		if ( empty( $_REQUEST['post_type'] ) ) {
-			wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
-		}
+        if ( empty( $_REQUEST['post_type'] ) ) {
+            wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
+        }
 
-		if ( empty( $_REQUEST['entity_types'] ) ) {
-			wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
-		}
+        if ( empty( $_REQUEST['entity_types'] ) ) {
+            wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
+        }
 
-		// Get the post type.
-		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
+        // Get the post type.
+        $post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
 
-		// Get the entity types URIs.
-		$entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
+        // Get the entity types URIs.
+        $entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
 
-		// Get the offset.
-		$offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
+        // Get the offset.
+        $offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
 
-		// Update and get the results.
-		$result = $this->mapping_service->update( $post_type, $entity_types, $offset );
+        // Update and get the results.
+        $result = $this->mapping_service->update( $post_type, $entity_types, $offset );
 
-		// Add our nonce to the result.
-		$result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
+        // Add our nonce to the result.
+        $result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
 
-		// Finally send the results.
-		wp_send_json_success( $result );
+        // Finally send the results.
+        wp_send_json_success( $result );
 
-	}
+    }
 
 }

Spacing +20 added lines, -20 removed lines

@@ -24,25 +24,25 @@ 
 	 *
 	 * @since 3.20.0
 	 */
-	public function __construct( $mapping_service ) {
+	public function __construct($mapping_service) {
 
 		$this->mapping_service = $mapping_service;
 
-		add_action( 'wp_ajax_wl_set_entity_types_for_post_type', array( $this, 'set_entity_types_for_post_type' ) );
-		add_action( 'wp_ajax_wl_update_post_type_entity_types', array( $this, 'update_post_type_entity_types' ) );
+		add_action('wp_ajax_wl_set_entity_types_for_post_type', array($this, 'set_entity_types_for_post_type'));
+		add_action('wp_ajax_wl_update_post_type_entity_types', array($this, 'update_post_type_entity_types'));
 
 	}
 
 	public function set_entity_types_for_post_type() {
 
-		if ( ! isset( $_REQUEST['post_type'] ) || ! isset( $_REQUEST['entity_types'] ) ) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		if ( ! isset($_REQUEST['post_type']) || ! isset($_REQUEST['entity_types'])) { //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 			return;
 		}
 
-		$post_type    = sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
-		$entity_types = array_map( 'sanitize_text_field', wp_unslash( (array) $_REQUEST['entity_types'] ) ); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$post_type    = sanitize_text_field(wp_unslash($_REQUEST['post_type'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
+		$entity_types = array_map('sanitize_text_field', wp_unslash((array) $_REQUEST['entity_types'])); //phpcs:ignore WordPress.Security.NonceVerification.Recommended
 
-		$this->mapping_service->set_entity_types_for_post_type( $post_type, $entity_types );
+		$this->mapping_service->set_entity_types_for_post_type($post_type, $entity_types);
 
 		wp_send_json_success();
 
@@ -51,36 +51,36 @@ 
 	public function update_post_type_entity_types() {
 
 		// If the nonce is invalid, return an error.
-		$nonce = isset( $_REQUEST['_nonce'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['_nonce'] ) ) : '';
-		if ( ! wp_verify_nonce( $nonce, 'update_post_type_entity_types' ) ) {
-			wp_send_json_error( __( 'Nonce Security Check Failed!', 'wordlift' ) );
+		$nonce = isset($_REQUEST['_nonce']) ? sanitize_text_field(wp_unslash($_REQUEST['_nonce'])) : '';
+		if ( ! wp_verify_nonce($nonce, 'update_post_type_entity_types')) {
+			wp_send_json_error(__('Nonce Security Check Failed!', 'wordlift'));
 		}
 
-		if ( empty( $_REQUEST['post_type'] ) ) {
-			wp_send_json_error( __( '`post_type` is required', 'wordlift' ) );
+		if (empty($_REQUEST['post_type'])) {
+			wp_send_json_error(__('`post_type` is required', 'wordlift'));
 		}
 
-		if ( empty( $_REQUEST['entity_types'] ) ) {
-			wp_send_json_error( __( '`entity_types` is required', 'wordlift' ) );
+		if (empty($_REQUEST['entity_types'])) {
+			wp_send_json_error(__('`entity_types` is required', 'wordlift'));
 		}
 
 		// Get the post type.
-		$post_type = isset( $_REQUEST['post_type'] ) ? sanitize_text_field( wp_unslash( $_REQUEST['post_type'] ) ) : '';
+		$post_type = isset($_REQUEST['post_type']) ? sanitize_text_field(wp_unslash($_REQUEST['post_type'])) : '';
 
 		// Get the entity types URIs.
-		$entity_types = isset( $_REQUEST['entity_types'] ) ? filter_var( wp_unslash( $_REQUEST['entity_types'] ), FILTER_REQUIRE_ARRAY ) : array();
+		$entity_types = isset($_REQUEST['entity_types']) ? filter_var(wp_unslash($_REQUEST['entity_types']), FILTER_REQUIRE_ARRAY) : array();
 
 		// Get the offset.
-		$offset = isset( $_REQUEST['offset'] ) ? intval( $_REQUEST['offset'] ) : 0;
+		$offset = isset($_REQUEST['offset']) ? intval($_REQUEST['offset']) : 0;
 
 		// Update and get the results.
-		$result = $this->mapping_service->update( $post_type, $entity_types, $offset );
+		$result = $this->mapping_service->update($post_type, $entity_types, $offset);
 
 		// Add our nonce to the result.
-		$result['_nonce'] = wp_create_nonce( 'update_post_type_entity_types' );
+		$result['_nonce'] = wp_create_nonce('update_post_type_entity_types');
 
 		// Finally send the results.
-		wp_send_json_success( $result );
+		wp_send_json_success($result);
 
 	}
 

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

Indentation +218 added lines, -218 removed lines

@@ -14,223 +14,223 @@
  */
 class Wordlift_Mapping_Service {
 
-	/**
-	 * The mapping's options.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var array $options The mapping's options.
-	 */
-	private $options;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * The singleton instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Mapping_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a {@link Wordlift_Mapping_Service} instance.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	public function __construct( $entity_type_service ) {
-
-		// Set the entity type service instance.
-		$this->entity_type_service = $entity_type_service;
-
-		// Load the options.
-		$this->options = get_option( 'wl_mappings', array() );
-
-		// Hook to `wl_valid_entity_post_types` and to `wl_default_entity_types_for_post_type`.
-		add_filter( 'wl_valid_entity_post_types', array( $this, 'valid_entity_post_types' ), 9 );
-		add_filter(
-			'wl_default_entity_types_for_post_type',
-			array(
-				$this,
-				'default_entity_types_for_post_type',
-			),
-			9,
-			2
-		);
-
-		// Set the singleton instance.
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @return \Wordlift_Mapping_Service The singleton instance.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Save the options.
-	 *
-	 * @since 3.20.0
-	 */
-	private function save_options() {
-
-		update_option( 'wl_mappings', $this->options, true );
-
-	}
-
-	/**
-	 * Set the default entity types for a post type.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $post_type Post type.
-	 * @param array  $entity_types An array of entity types slugs.
-	 */
-	public function set_entity_types_for_post_type( $post_type, $entity_types ) {
-
-		$this->options[ $post_type ] = $entity_types;
-		$this->save_options();
-
-	}
-
-	/**
-	 * Hook to `wl_valid_entity_post_types` to declare schema.org support for the configured post types.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array $post_types The default post types.
-	 *
-	 * @return array The supported post types.
-	 */
-	public function valid_entity_post_types( $post_types ) {
-
-		return array_merge( $post_types, array_keys( $this->options ) );
-	}
-
-	/**
-	 * Hook to `wl_default_entity_types_for_post_type` to declare the entity types for a post type.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array  $default The default entity types.
-	 * @param string $post_type The post type.
-	 *
-	 * @return array The default entity types.
-	 */
-	public function default_entity_types_for_post_type( $default, $post_type ) {
-
-		return isset( $this->options[ $post_type ] ) ? $this->options[ $post_type ] : $default;
-	}
-
-	/**
-	 * Update the post type with the entity types, starting at the specified offset.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $post_type The post type.
-	 * @param array  $entity_types The entity types.
-	 * @param int    $offset The offset (0 by default).
-	 *
-	 * @return array {
-	 * The result array.
-	 *
-	 * @type int     $current The current offset.
-	 * @type int     $next The next offset.
-	 * @type int     $count The total element count.
-	 * }
-	 */
-	public function update( $post_type, $entity_types, $offset = 0 ) {
-
-		$entity_type_service = $this->entity_type_service;
-		$tax_query           = $this->get_tax_query( $entity_types );
-
-		return Wordlift_Batch_Action::process(
-			$post_type,
-			$offset,
-			$tax_query,
-			function ( $post_id ) use ( $entity_type_service, $entity_types ) {
-				foreach ( $entity_types as $entity_type ) {
-					$entity_type_service->set( $post_id, $entity_type, false );
-				}
-			}
-		);
-	}
-
-	/**
-	 * Count the number of posts that need to be assigned with the entity types.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $post_type The post type.
-	 * @param array  $entity_types An array of entity types.
-	 *
-	 * @return int The number of posts to be assigned with entity types.
-	 */
-	public function count( $post_type, $entity_types ) {
-
-		$tax_query = $this->get_tax_query( $entity_types );
-
-		return Wordlift_Batch_Action::count( $post_type, $tax_query );
-	}
-
-	/**
-	 * Get the taxonomy query for the specified entity types.
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param array $entity_types The entity types.
-	 *
-	 * @return array The tax query.
-	 */
-	private function get_tax_query( $entity_types ) {
-
-		$entity_type_service = $this->entity_type_service;
-		$entity_types_terms  = array_filter(
-			array_map(
-				function ( $item ) use ( $entity_type_service ) {
-					return $entity_type_service->get_term_by_uri( $item );
-				},
-				$entity_types
-			)
-		);
-
-		$entity_types_terms_ids = array_map(
-			function ( $term ) {
-				return $term->term_id;
-			},
-			$entity_types_terms
-		);
-
-		$tax_query = array(
-			'tax_query' => array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'term_id',
-					'terms'    => $entity_types_terms_ids,
-					'operator' => 'NOT IN',
-				),
-			),
-		);
-
-		return $tax_query;
-	}
+    /**
+     * The mapping's options.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var array $options The mapping's options.
+     */
+    private $options;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * The singleton instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Mapping_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a {@link Wordlift_Mapping_Service} instance.
+     *
+     * @since 3.20.0
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    public function __construct( $entity_type_service ) {
+
+        // Set the entity type service instance.
+        $this->entity_type_service = $entity_type_service;
+
+        // Load the options.
+        $this->options = get_option( 'wl_mappings', array() );
+
+        // Hook to `wl_valid_entity_post_types` and to `wl_default_entity_types_for_post_type`.
+        add_filter( 'wl_valid_entity_post_types', array( $this, 'valid_entity_post_types' ), 9 );
+        add_filter(
+            'wl_default_entity_types_for_post_type',
+            array(
+                $this,
+                'default_entity_types_for_post_type',
+            ),
+            9,
+            2
+        );
+
+        // Set the singleton instance.
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @since 3.20.0
+     *
+     * @return \Wordlift_Mapping_Service The singleton instance.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Save the options.
+     *
+     * @since 3.20.0
+     */
+    private function save_options() {
+
+        update_option( 'wl_mappings', $this->options, true );
+
+    }
+
+    /**
+     * Set the default entity types for a post type.
+     *
+     * @since 3.20.0
+     *
+     * @param string $post_type Post type.
+     * @param array  $entity_types An array of entity types slugs.
+     */
+    public function set_entity_types_for_post_type( $post_type, $entity_types ) {
+
+        $this->options[ $post_type ] = $entity_types;
+        $this->save_options();
+
+    }
+
+    /**
+     * Hook to `wl_valid_entity_post_types` to declare schema.org support for the configured post types.
+     *
+     * @since 3.20.0
+     *
+     * @param array $post_types The default post types.
+     *
+     * @return array The supported post types.
+     */
+    public function valid_entity_post_types( $post_types ) {
+
+        return array_merge( $post_types, array_keys( $this->options ) );
+    }
+
+    /**
+     * Hook to `wl_default_entity_types_for_post_type` to declare the entity types for a post type.
+     *
+     * @since 3.20.0
+     *
+     * @param array  $default The default entity types.
+     * @param string $post_type The post type.
+     *
+     * @return array The default entity types.
+     */
+    public function default_entity_types_for_post_type( $default, $post_type ) {
+
+        return isset( $this->options[ $post_type ] ) ? $this->options[ $post_type ] : $default;
+    }
+
+    /**
+     * Update the post type with the entity types, starting at the specified offset.
+     *
+     * @since 3.20.0
+     *
+     * @param string $post_type The post type.
+     * @param array  $entity_types The entity types.
+     * @param int    $offset The offset (0 by default).
+     *
+     * @return array {
+     * The result array.
+     *
+     * @type int     $current The current offset.
+     * @type int     $next The next offset.
+     * @type int     $count The total element count.
+     * }
+     */
+    public function update( $post_type, $entity_types, $offset = 0 ) {
+
+        $entity_type_service = $this->entity_type_service;
+        $tax_query           = $this->get_tax_query( $entity_types );
+
+        return Wordlift_Batch_Action::process(
+            $post_type,
+            $offset,
+            $tax_query,
+            function ( $post_id ) use ( $entity_type_service, $entity_types ) {
+                foreach ( $entity_types as $entity_type ) {
+                    $entity_type_service->set( $post_id, $entity_type, false );
+                }
+            }
+        );
+    }
+
+    /**
+     * Count the number of posts that need to be assigned with the entity types.
+     *
+     * @since 3.20.0
+     *
+     * @param string $post_type The post type.
+     * @param array  $entity_types An array of entity types.
+     *
+     * @return int The number of posts to be assigned with entity types.
+     */
+    public function count( $post_type, $entity_types ) {
+
+        $tax_query = $this->get_tax_query( $entity_types );
+
+        return Wordlift_Batch_Action::count( $post_type, $tax_query );
+    }
+
+    /**
+     * Get the taxonomy query for the specified entity types.
+     *
+     * @since 3.20.0
+     *
+     * @param array $entity_types The entity types.
+     *
+     * @return array The tax query.
+     */
+    private function get_tax_query( $entity_types ) {
+
+        $entity_type_service = $this->entity_type_service;
+        $entity_types_terms  = array_filter(
+            array_map(
+                function ( $item ) use ( $entity_type_service ) {
+                    return $entity_type_service->get_term_by_uri( $item );
+                },
+                $entity_types
+            )
+        );
+
+        $entity_types_terms_ids = array_map(
+            function ( $term ) {
+                return $term->term_id;
+            },
+            $entity_types_terms
+        );
+
+        $tax_query = array(
+            'tax_query' => array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'term_id',
+                    'terms'    => $entity_types_terms_ids,
+                    'operator' => 'NOT IN',
+                ),
+            ),
+        );
+
+        return $tax_query;
+    }
 
 }

Spacing +22 added lines, -22 removed lines

@@ -48,16 +48,16 @@ 
 	 *
 	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
 	 */
-	public function __construct( $entity_type_service ) {
+	public function __construct($entity_type_service) {
 
 		// Set the entity type service instance.
 		$this->entity_type_service = $entity_type_service;
 
 		// Load the options.
-		$this->options = get_option( 'wl_mappings', array() );
+		$this->options = get_option('wl_mappings', array());
 
 		// Hook to `wl_valid_entity_post_types` and to `wl_default_entity_types_for_post_type`.
-		add_filter( 'wl_valid_entity_post_types', array( $this, 'valid_entity_post_types' ), 9 );
+		add_filter('wl_valid_entity_post_types', array($this, 'valid_entity_post_types'), 9);
 		add_filter(
 			'wl_default_entity_types_for_post_type',
 			array(
@@ -92,7 +92,7 @@ 
 	 */
 	private function save_options() {
 
-		update_option( 'wl_mappings', $this->options, true );
+		update_option('wl_mappings', $this->options, true);
 
 	}
 
@@ -104,9 +104,9 @@ 
 	 * @param string $post_type Post type.
 	 * @param array  $entity_types An array of entity types slugs.
 	 */
-	public function set_entity_types_for_post_type( $post_type, $entity_types ) {
+	public function set_entity_types_for_post_type($post_type, $entity_types) {
 
-		$this->options[ $post_type ] = $entity_types;
+		$this->options[$post_type] = $entity_types;
 		$this->save_options();
 
 	}
@@ -120,9 +120,9 @@ 
 	 *
 	 * @return array The supported post types.
 	 */
-	public function valid_entity_post_types( $post_types ) {
+	public function valid_entity_post_types($post_types) {
 
-		return array_merge( $post_types, array_keys( $this->options ) );
+		return array_merge($post_types, array_keys($this->options));
 	}
 
 	/**
@@ -135,9 +135,9 @@ 
 	 *
 	 * @return array The default entity types.
 	 */
-	public function default_entity_types_for_post_type( $default, $post_type ) {
+	public function default_entity_types_for_post_type($default, $post_type) {
 
-		return isset( $this->options[ $post_type ] ) ? $this->options[ $post_type ] : $default;
+		return isset($this->options[$post_type]) ? $this->options[$post_type] : $default;
 	}
 
 	/**
@@ -157,18 +157,18 @@ 
 	 * @type int     $count The total element count.
 	 * }
 	 */
-	public function update( $post_type, $entity_types, $offset = 0 ) {
+	public function update($post_type, $entity_types, $offset = 0) {
 
 		$entity_type_service = $this->entity_type_service;
-		$tax_query           = $this->get_tax_query( $entity_types );
+		$tax_query           = $this->get_tax_query($entity_types);
 
 		return Wordlift_Batch_Action::process(
 			$post_type,
 			$offset,
 			$tax_query,
-			function ( $post_id ) use ( $entity_type_service, $entity_types ) {
-				foreach ( $entity_types as $entity_type ) {
-					$entity_type_service->set( $post_id, $entity_type, false );
+			function($post_id) use ($entity_type_service, $entity_types) {
+				foreach ($entity_types as $entity_type) {
+					$entity_type_service->set($post_id, $entity_type, false);
 				}
 			}
 		);
@@ -184,11 +184,11 @@ 
 	 *
 	 * @return int The number of posts to be assigned with entity types.
 	 */
-	public function count( $post_type, $entity_types ) {
+	public function count($post_type, $entity_types) {
 
-		$tax_query = $this->get_tax_query( $entity_types );
+		$tax_query = $this->get_tax_query($entity_types);
 
-		return Wordlift_Batch_Action::count( $post_type, $tax_query );
+		return Wordlift_Batch_Action::count($post_type, $tax_query);
 	}
 
 	/**
@@ -200,20 +200,20 @@ 
 	 *
 	 * @return array The tax query.
 	 */
-	private function get_tax_query( $entity_types ) {
+	private function get_tax_query($entity_types) {
 
 		$entity_type_service = $this->entity_type_service;
 		$entity_types_terms  = array_filter(
 			array_map(
-				function ( $item ) use ( $entity_type_service ) {
-					return $entity_type_service->get_term_by_uri( $item );
+				function($item) use ($entity_type_service) {
+					return $entity_type_service->get_term_by_uri($item);
 				},
 				$entity_types
 			)
 		);
 
 		$entity_types_terms_ids = array_map(
-			function ( $term ) {
+			function($term) {
 				return $term->term_id;
 			},
 			$entity_types_terms

src/includes/class-wordlift-post-adapter.php

Indentation +248 added lines, -248 removed lines

@@ -19,258 +19,258 @@
  */
 class Wordlift_Post_Adapter {
 
-	/**
-	 * The post id to which the adopter relates.
-	 *
-	 * @since 3.14.0
-	 *
-	 * @var integer $post_id .
-	 */
-	private $post_id;
-
-	const TYPE_ENTITY_LINK = 0;
-	const TYPE_TERM_LINK   = 1;
-
-	/**
-	 * Create the {@link Wordlift_Post_Adatpter} instance.
-	 *
-	 * @param integer $post_id the post ID of the post the adopter relates to.
-	 *
-	 * @since 3.14.0
-	 */
-	public function __construct( $post_id ) {
-
-		$this->post_id = $post_id;
-
-	}
-
-	/**
-	 * Get the word count of the post content.
-	 *
-	 * The count is calculated over the post content after stripping shortcodes and html tags.
-	 *
-	 * @return integer the number of words in the content after stripping shortcodes and html tags..
-	 * @since 3.14.0
-	 */
-	public function word_count() {
-
-		$post = get_post( $this->post_id );
-
-		/*
+    /**
+     * The post id to which the adopter relates.
+     *
+     * @since 3.14.0
+     *
+     * @var integer $post_id .
+     */
+    private $post_id;
+
+    const TYPE_ENTITY_LINK = 0;
+    const TYPE_TERM_LINK   = 1;
+
+    /**
+     * Create the {@link Wordlift_Post_Adatpter} instance.
+     *
+     * @param integer $post_id the post ID of the post the adopter relates to.
+     *
+     * @since 3.14.0
+     */
+    public function __construct( $post_id ) {
+
+        $this->post_id = $post_id;
+
+    }
+
+    /**
+     * Get the word count of the post content.
+     *
+     * The count is calculated over the post content after stripping shortcodes and html tags.
+     *
+     * @return integer the number of words in the content after stripping shortcodes and html tags..
+     * @since 3.14.0
+     */
+    public function word_count() {
+
+        $post = get_post( $this->post_id );
+
+        /*
 		 * Apply the `wl_post_content` filter, in case 3rd parties want to change the post content, e.g.
 		 * because the content is written elsewhere.
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-
-		return self::str_word_count_utf8( wp_strip_all_tags( strip_shortcodes( $post_content ) ) );
-	}
-
-	/**
-	 * Count words in the string, taking into account UTF-8 characters.
-	 *
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/884
-	 *
-	 * @since 3.20.0
-	 *
-	 * @param string $str The target string.
-	 *
-	 * @return int The number of words.
-	 */
-	private static function str_word_count_utf8( $str ) {
-
-		$words = preg_split( '~[^\p{L}\p{N}\']+~u', $str );
-
-		return $words ? count( $words ) : 0;
-	}
-
-	/**
-	 * Get the {@link WP_Post} permalink allowing 3rd parties to alter the URL.
-	 *
-	 * @param int $post_id Post ID.
-	 *
-	 * @return string The post permalink.
-	 * @since 3.20.0
-	 */
-	public static function get_production_permalink( $post_id, $object_type = Object_Type_Enum::POST ) {
-
-		$object_link_service = Object_Link_Provider::get_instance();
-		$permalink           = $object_link_service->get_permalink( $post_id, $object_type );
-
-		/**
-		 * WordPress 4.4 doesn't support meta queries for terms, therefore we only support post permalinks here.
-		 *
-		 * Later on for WordPress 4.5+ we look for terms bound to the entity and we use the term link instead of the
-		 * post permalink if we find them.
-		 */
-		global $wp_version;
-		if ( version_compare( $wp_version, '4.5', '<' ) ) {
-			return apply_filters( 'wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null );
-		}
-
-		/**
-		 * The `wl_production_permalink` filter allows to change the permalink, this is useful in contexts
-		 * when the production environment is copied over from a staging environment with staging
-		 * URLs.
-		 *
-		 * @param string $permalink_url The default permalink.
-		 * @param int $post_id The post id.
-		 *
-		 * @since 3.23.0 we check whether the entity is bound to a term and, in that case, we link to the term.
-		 * @since 3.20.0
-		 *
-		 * @see https://github.com/insideout10/wordlift-plugin/issues/850
-		 */
-
-		$uris = $object_link_service->get_same_as_uris(
-			$post_id,
-			$object_type
-		);
-
-		// Only try to link a term if `WL_ENABLE_TERM_LINKING` is enabled.
-		$terms = array();
-		if ( defined( 'WL_ENABLE_TERM_LINKING' ) && WL_ENABLE_TERM_LINKING ) {
-			// Try to find one term matching the entity.
-			$terms = get_terms(
-				array(
-					'number'                 => 1,
-					'hide_empty'             => false,
-					'update_term_meta_cache' => false,
-					'meta_key'               => '_wl_entity_id',
-					'meta_value'             => $uris,
-					'meta_compare'           => 'IN',
-				)
-			);
-		}
-
-		$type = self::TYPE_ENTITY_LINK;
-		$term = null;
-		// If found use the term link, otherwise the permalink.
-		if ( 1 === count( $terms ) ) {
-			$term      = current( $terms );
-			$permalink = get_term_link( $term );
-			$type      = self::TYPE_TERM_LINK;
-		}
-
-		/**
-		 * Apply the `wl_production_permalink` filter.
-		 *
-		 * @param string $permalink The permalink.
-		 * @param int $post_id The post id.
-		 * @param int $type The permalink type: 0 = entity permalink, 1 = term link.
-		 * @param WP_Term $term The term if type is term link, otherwise null.
-		 *
-		 * @since 3.23.0 add the permalink type and term parameters.
-		 */
-		return apply_filters( 'wl_production_permalink', $permalink, $post_id, $type, $term );
-	}
-
-	/**
-	 * Get comma separated tags to be used as keywords
-	 *
-	 * @return string|void Comma separated tags
-	 *
-	 * @since 3.27.2
-	 */
-	public function keywords() {
-		$tags = get_the_tags( $this->post_id );
-
-		if ( empty( $tags ) ) {
-			return;
-		}
-
-		return implode(
-			',',
-			array_map(
-				function ( $tag ) {
-					return $tag->name;
-				},
-				$tags
-			)
-		);
-	}
-
-	/**
-	 * Get comma separated categories to be used as article section
-	 *
-	 * @return string[] Comma separated categories
-	 *
-	 * @since 3.27.2
-	 */
-	public function article_section() {
-		$categories = get_the_category( $this->post_id );
-
-		return wp_list_pluck( $categories, 'cat_name' );
-	}
-
-	/**
-	 * Get comment count
-	 *
-	 * @return string|void Comment count
-	 *
-	 * @since 3.27.2
-	 */
-	public function comment_count() {
-		return get_comments_number( $this->post_id );
-	}
-
-	/**
-	 * Get Language
-	 * Try WPML, Polylang for post specific languages, else fallback on get_locale()
-	 *
-	 * @return string|void Language code (locale)
-	 *
-	 * @since 3.27.2
-	 */
-	public function locale() {
-		$language = 'en-US';
-
-		if ( function_exists( 'wpml_get_language_information' ) ) {
-			// WPML handling
-			// WPML: Updated function signature.
-			// function wpml_get_language_information( $empty_value = null, $post_id = null )
-			$post_language = wpml_get_language_information( null, $this->post_id );
-			if ( ! $post_language instanceof WP_Error ) {
-				$language = $post_language['locale'];
-			}
-		} elseif ( function_exists( 'pll_get_post_language' ) ) {
-			// Polylang handling
-			$language = pll_get_post_language( $this->post_id, 'locale' );
-		} else {
-			$language = get_locale();
-		}
-
-		return str_replace( '_', '-', $language );
-	}
-
-	/**
-	 * Add mentions to an article.
-	 * To add mentions we just push the referenced entities to mentions.
-	 *
-	 * @param $post_id int
-	 * @param $references int[]
-	 */
-	public function add_references( $post_id, &$references ) {
-		$tags = get_the_tags( $post_id );
-
-		if ( $tags && ! is_wp_error( $tags ) ) {
-			// Loop through the tags and push it to references.
-			foreach ( $tags as $tag ) {
-				/**
-				 * @var $tag WP_Term
-				 */
-				$entity_uris = get_term_meta( $tag->term_id, '_wl_entity_id' );
-				foreach ( $entity_uris as $uri ) {
-					$referenced_entity = Wordlift_Entity_Uri_Service::get_instance()->get_entity( $uri );
-					if ( $referenced_entity instanceof WP_Post ) {
-						// push the referenced entities to references.
-						$references[] = $referenced_entity->ID;
-					}
-				}
-			}
-		}
-
-	}
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+
+        return self::str_word_count_utf8( wp_strip_all_tags( strip_shortcodes( $post_content ) ) );
+    }
+
+    /**
+     * Count words in the string, taking into account UTF-8 characters.
+     *
+     * @see https://github.com/insideout10/wordlift-plugin/issues/884
+     *
+     * @since 3.20.0
+     *
+     * @param string $str The target string.
+     *
+     * @return int The number of words.
+     */
+    private static function str_word_count_utf8( $str ) {
+
+        $words = preg_split( '~[^\p{L}\p{N}\']+~u', $str );
+
+        return $words ? count( $words ) : 0;
+    }
+
+    /**
+     * Get the {@link WP_Post} permalink allowing 3rd parties to alter the URL.
+     *
+     * @param int $post_id Post ID.
+     *
+     * @return string The post permalink.
+     * @since 3.20.0
+     */
+    public static function get_production_permalink( $post_id, $object_type = Object_Type_Enum::POST ) {
+
+        $object_link_service = Object_Link_Provider::get_instance();
+        $permalink           = $object_link_service->get_permalink( $post_id, $object_type );
+
+        /**
+         * WordPress 4.4 doesn't support meta queries for terms, therefore we only support post permalinks here.
+         *
+         * Later on for WordPress 4.5+ we look for terms bound to the entity and we use the term link instead of the
+         * post permalink if we find them.
+         */
+        global $wp_version;
+        if ( version_compare( $wp_version, '4.5', '<' ) ) {
+            return apply_filters( 'wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null );
+        }
+
+        /**
+         * The `wl_production_permalink` filter allows to change the permalink, this is useful in contexts
+         * when the production environment is copied over from a staging environment with staging
+         * URLs.
+         *
+         * @param string $permalink_url The default permalink.
+         * @param int $post_id The post id.
+         *
+         * @since 3.23.0 we check whether the entity is bound to a term and, in that case, we link to the term.
+         * @since 3.20.0
+         *
+         * @see https://github.com/insideout10/wordlift-plugin/issues/850
+         */
+
+        $uris = $object_link_service->get_same_as_uris(
+            $post_id,
+            $object_type
+        );
+
+        // Only try to link a term if `WL_ENABLE_TERM_LINKING` is enabled.
+        $terms = array();
+        if ( defined( 'WL_ENABLE_TERM_LINKING' ) && WL_ENABLE_TERM_LINKING ) {
+            // Try to find one term matching the entity.
+            $terms = get_terms(
+                array(
+                    'number'                 => 1,
+                    'hide_empty'             => false,
+                    'update_term_meta_cache' => false,
+                    'meta_key'               => '_wl_entity_id',
+                    'meta_value'             => $uris,
+                    'meta_compare'           => 'IN',
+                )
+            );
+        }
+
+        $type = self::TYPE_ENTITY_LINK;
+        $term = null;
+        // If found use the term link, otherwise the permalink.
+        if ( 1 === count( $terms ) ) {
+            $term      = current( $terms );
+            $permalink = get_term_link( $term );
+            $type      = self::TYPE_TERM_LINK;
+        }
+
+        /**
+         * Apply the `wl_production_permalink` filter.
+         *
+         * @param string $permalink The permalink.
+         * @param int $post_id The post id.
+         * @param int $type The permalink type: 0 = entity permalink, 1 = term link.
+         * @param WP_Term $term The term if type is term link, otherwise null.
+         *
+         * @since 3.23.0 add the permalink type and term parameters.
+         */
+        return apply_filters( 'wl_production_permalink', $permalink, $post_id, $type, $term );
+    }
+
+    /**
+     * Get comma separated tags to be used as keywords
+     *
+     * @return string|void Comma separated tags
+     *
+     * @since 3.27.2
+     */
+    public function keywords() {
+        $tags = get_the_tags( $this->post_id );
+
+        if ( empty( $tags ) ) {
+            return;
+        }
+
+        return implode(
+            ',',
+            array_map(
+                function ( $tag ) {
+                    return $tag->name;
+                },
+                $tags
+            )
+        );
+    }
+
+    /**
+     * Get comma separated categories to be used as article section
+     *
+     * @return string[] Comma separated categories
+     *
+     * @since 3.27.2
+     */
+    public function article_section() {
+        $categories = get_the_category( $this->post_id );
+
+        return wp_list_pluck( $categories, 'cat_name' );
+    }
+
+    /**
+     * Get comment count
+     *
+     * @return string|void Comment count
+     *
+     * @since 3.27.2
+     */
+    public function comment_count() {
+        return get_comments_number( $this->post_id );
+    }
+
+    /**
+     * Get Language
+     * Try WPML, Polylang for post specific languages, else fallback on get_locale()
+     *
+     * @return string|void Language code (locale)
+     *
+     * @since 3.27.2
+     */
+    public function locale() {
+        $language = 'en-US';
+
+        if ( function_exists( 'wpml_get_language_information' ) ) {
+            // WPML handling
+            // WPML: Updated function signature.
+            // function wpml_get_language_information( $empty_value = null, $post_id = null )
+            $post_language = wpml_get_language_information( null, $this->post_id );
+            if ( ! $post_language instanceof WP_Error ) {
+                $language = $post_language['locale'];
+            }
+        } elseif ( function_exists( 'pll_get_post_language' ) ) {
+            // Polylang handling
+            $language = pll_get_post_language( $this->post_id, 'locale' );
+        } else {
+            $language = get_locale();
+        }
+
+        return str_replace( '_', '-', $language );
+    }
+
+    /**
+     * Add mentions to an article.
+     * To add mentions we just push the referenced entities to mentions.
+     *
+     * @param $post_id int
+     * @param $references int[]
+     */
+    public function add_references( $post_id, &$references ) {
+        $tags = get_the_tags( $post_id );
+
+        if ( $tags && ! is_wp_error( $tags ) ) {
+            // Loop through the tags and push it to references.
+            foreach ( $tags as $tag ) {
+                /**
+                 * @var $tag WP_Term
+                 */
+                $entity_uris = get_term_meta( $tag->term_id, '_wl_entity_id' );
+                foreach ( $entity_uris as $uri ) {
+                    $referenced_entity = Wordlift_Entity_Uri_Service::get_instance()->get_entity( $uri );
+                    if ( $referenced_entity instanceof WP_Post ) {
+                        // push the referenced entities to references.
+                        $references[] = $referenced_entity->ID;
+                    }
+                }
+            }
+        }
+
+    }
 
 }

Spacing +36 added lines, -36 removed lines

@@ -38,7 +38,7 @@ 
 	 *
 	 * @since 3.14.0
 	 */
-	public function __construct( $post_id ) {
+	public function __construct($post_id) {
 
 		$this->post_id = $post_id;
 
@@ -54,7 +54,7 @@ 
 	 */
 	public function word_count() {
 
-		$post = get_post( $this->post_id );
+		$post = get_post($this->post_id);
 
 		/*
 		 * Apply the `wl_post_content` filter, in case 3rd parties want to change the post content, e.g.
@@ -62,9 +62,9 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
 
-		return self::str_word_count_utf8( wp_strip_all_tags( strip_shortcodes( $post_content ) ) );
+		return self::str_word_count_utf8(wp_strip_all_tags(strip_shortcodes($post_content)));
 	}
 
 	/**
@@ -78,11 +78,11 @@ 
 	 *
 	 * @return int The number of words.
 	 */
-	private static function str_word_count_utf8( $str ) {
+	private static function str_word_count_utf8($str) {
 
-		$words = preg_split( '~[^\p{L}\p{N}\']+~u', $str );
+		$words = preg_split('~[^\p{L}\p{N}\']+~u', $str);
 
-		return $words ? count( $words ) : 0;
+		return $words ? count($words) : 0;
 	}
 
 	/**
@@ -93,10 +93,10 @@ 
 	 * @return string The post permalink.
 	 * @since 3.20.0
 	 */
-	public static function get_production_permalink( $post_id, $object_type = Object_Type_Enum::POST ) {
+	public static function get_production_permalink($post_id, $object_type = Object_Type_Enum::POST) {
 
 		$object_link_service = Object_Link_Provider::get_instance();
-		$permalink           = $object_link_service->get_permalink( $post_id, $object_type );
+		$permalink           = $object_link_service->get_permalink($post_id, $object_type);
 
 		/**
 		 * WordPress 4.4 doesn't support meta queries for terms, therefore we only support post permalinks here.
@@ -105,8 +105,8 @@ 
 		 * post permalink if we find them.
 		 */
 		global $wp_version;
-		if ( version_compare( $wp_version, '4.5', '<' ) ) {
-			return apply_filters( 'wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null );
+		if (version_compare($wp_version, '4.5', '<')) {
+			return apply_filters('wl_production_permalink', $permalink, $post_id, self::TYPE_ENTITY_LINK, null);
 		}
 
 		/**
@@ -130,7 +130,7 @@ 
 
 		// Only try to link a term if `WL_ENABLE_TERM_LINKING` is enabled.
 		$terms = array();
-		if ( defined( 'WL_ENABLE_TERM_LINKING' ) && WL_ENABLE_TERM_LINKING ) {
+		if (defined('WL_ENABLE_TERM_LINKING') && WL_ENABLE_TERM_LINKING) {
 			// Try to find one term matching the entity.
 			$terms = get_terms(
 				array(
@@ -147,9 +147,9 @@ 
 		$type = self::TYPE_ENTITY_LINK;
 		$term = null;
 		// If found use the term link, otherwise the permalink.
-		if ( 1 === count( $terms ) ) {
-			$term      = current( $terms );
-			$permalink = get_term_link( $term );
+		if (1 === count($terms)) {
+			$term      = current($terms);
+			$permalink = get_term_link($term);
 			$type      = self::TYPE_TERM_LINK;
 		}
 
@@ -163,7 +163,7 @@ 
 		 *
 		 * @since 3.23.0 add the permalink type and term parameters.
 		 */
-		return apply_filters( 'wl_production_permalink', $permalink, $post_id, $type, $term );
+		return apply_filters('wl_production_permalink', $permalink, $post_id, $type, $term);
 	}
 
 	/**
@@ -174,16 +174,16 @@ 
 	 * @since 3.27.2
 	 */
 	public function keywords() {
-		$tags = get_the_tags( $this->post_id );
+		$tags = get_the_tags($this->post_id);
 
-		if ( empty( $tags ) ) {
+		if (empty($tags)) {
 			return;
 		}
 
 		return implode(
 			',',
 			array_map(
-				function ( $tag ) {
+				function($tag) {
 					return $tag->name;
 				},
 				$tags
@@ -199,9 +199,9 @@ 
 	 * @since 3.27.2
 	 */
 	public function article_section() {
-		$categories = get_the_category( $this->post_id );
+		$categories = get_the_category($this->post_id);
 
-		return wp_list_pluck( $categories, 'cat_name' );
+		return wp_list_pluck($categories, 'cat_name');
 	}
 
 	/**
@@ -212,7 +212,7 @@ 
 	 * @since 3.27.2
 	 */
 	public function comment_count() {
-		return get_comments_number( $this->post_id );
+		return get_comments_number($this->post_id);
 	}
 
 	/**
@@ -226,22 +226,22 @@ 
 	public function locale() {
 		$language = 'en-US';
 
-		if ( function_exists( 'wpml_get_language_information' ) ) {
+		if (function_exists('wpml_get_language_information')) {
 			// WPML handling
 			// WPML: Updated function signature.
 			// function wpml_get_language_information( $empty_value = null, $post_id = null )
-			$post_language = wpml_get_language_information( null, $this->post_id );
-			if ( ! $post_language instanceof WP_Error ) {
+			$post_language = wpml_get_language_information(null, $this->post_id);
+			if ( ! $post_language instanceof WP_Error) {
 				$language = $post_language['locale'];
 			}
-		} elseif ( function_exists( 'pll_get_post_language' ) ) {
+		} elseif (function_exists('pll_get_post_language')) {
 			// Polylang handling
-			$language = pll_get_post_language( $this->post_id, 'locale' );
+			$language = pll_get_post_language($this->post_id, 'locale');
 		} else {
 			$language = get_locale();
 		}
 
-		return str_replace( '_', '-', $language );
+		return str_replace('_', '-', $language);
 	}
 
 	/**
@@ -251,19 +251,19 @@ 
 	 * @param $post_id int
 	 * @param $references int[]
 	 */
-	public function add_references( $post_id, &$references ) {
-		$tags = get_the_tags( $post_id );
+	public function add_references($post_id, &$references) {
+		$tags = get_the_tags($post_id);
 
-		if ( $tags && ! is_wp_error( $tags ) ) {
+		if ($tags && ! is_wp_error($tags)) {
 			// Loop through the tags and push it to references.
-			foreach ( $tags as $tag ) {
+			foreach ($tags as $tag) {
 				/**
 				 * @var $tag WP_Term
 				 */
-				$entity_uris = get_term_meta( $tag->term_id, '_wl_entity_id' );
-				foreach ( $entity_uris as $uri ) {
-					$referenced_entity = Wordlift_Entity_Uri_Service::get_instance()->get_entity( $uri );
-					if ( $referenced_entity instanceof WP_Post ) {
+				$entity_uris = get_term_meta($tag->term_id, '_wl_entity_id');
+				foreach ($entity_uris as $uri) {
+					$referenced_entity = Wordlift_Entity_Uri_Service::get_instance()->get_entity($uri);
+					if ($referenced_entity instanceof WP_Post) {
 						// push the referenced entities to references.
 						$references[] = $referenced_entity->ID;
 					}

src/includes/class-wordlift-entity-uri-service.php

Indentation +239 added lines, -239 removed lines

@@ -20,100 +20,100 @@ 
  */
 class Wordlift_Entity_Uri_Service {
 
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * An array of URIs to post ID valid for the current request.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var array $uri_to_post An array of URIs to post ID valid for the current request.
-	 */
-	protected $uri_to_post;
-
-	/**
-	 * Create a {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.16.3
-	 */
-	protected function __construct() {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		// Add a filter to the `rest_post_dispatch` filter to add the wl_entity_url meta as `wl:entity_url`.
-		add_filter( 'rest_post_dispatch', array( $this, 'rest_post_dispatch' ) );
-		add_filter( 'wl_content_service__post__not_found', array( $this, 'content_service__post__not_found' ), 10, 2 );
-
-	}
-
-	/**
-	 * Holds the {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.21.5
-	 * @access private
-	 * @var Wordlift_Entity_Uri_Service $instance The {@link Wordlift_Entity_Uri_Service} singleton.
-	 */
-	private static $instance = null;
-
-	/**
-	 * Get the singleton.
-	 *
-	 * @return Wordlift_Entity_Uri_Service The singleton instance.
-	 * @since 3.21.5
-	 */
-	public static function get_instance() {
-
-		if ( ! isset( self::$instance ) ) {
-			$entity_uri_cache_service = new Wordlift_File_Cache_Service( WL_TEMP_DIR . 'entity_uri/' );
-			self::$instance           = new Wordlift_Cached_Entity_Uri_Service( $entity_uri_cache_service );
-
-		}
-
-		return self::$instance;
-	}
-
-	/**
-	 * Try to find a post when the content service doesn't find it.
-	 *
-	 * @param WP_Post|null $post
-	 * @param string       $uri
-	 *
-	 * @return false|int
-	 */
-	public function content_service__post__not_found( $post, $uri ) {
-		return $this->get_post_id_from_url( $uri );
-	}
-
-	/**
-	 * Preload the provided URIs in the local cache.
-	 *
-	 * This function will populate the local `$uri_to_post` array by running a
-	 * single query with all the URIs and returning the mappings in the array.
-	 *
-	 * @param array $uris An array of URIs.
-	 *
-	 * @since 3.16.3
-	 */
-	public function preload_uris( $uris ) {
-
-		// Bail out if there are no URIs.
-		if ( 0 === count( $uris ) ) {
-			return;
-		}
-
-		$this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
-
-		global $wpdb;
-		$in_post_types  = implode( "','", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) );
-		$in_entity_uris = implode( "','", array_map( 'esc_sql', $uris ) );
-		$sql            = "
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * An array of URIs to post ID valid for the current request.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var array $uri_to_post An array of URIs to post ID valid for the current request.
+     */
+    protected $uri_to_post;
+
+    /**
+     * Create a {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.16.3
+     */
+    protected function __construct() {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        // Add a filter to the `rest_post_dispatch` filter to add the wl_entity_url meta as `wl:entity_url`.
+        add_filter( 'rest_post_dispatch', array( $this, 'rest_post_dispatch' ) );
+        add_filter( 'wl_content_service__post__not_found', array( $this, 'content_service__post__not_found' ), 10, 2 );
+
+    }
+
+    /**
+     * Holds the {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.21.5
+     * @access private
+     * @var Wordlift_Entity_Uri_Service $instance The {@link Wordlift_Entity_Uri_Service} singleton.
+     */
+    private static $instance = null;
+
+    /**
+     * Get the singleton.
+     *
+     * @return Wordlift_Entity_Uri_Service The singleton instance.
+     * @since 3.21.5
+     */
+    public static function get_instance() {
+
+        if ( ! isset( self::$instance ) ) {
+            $entity_uri_cache_service = new Wordlift_File_Cache_Service( WL_TEMP_DIR . 'entity_uri/' );
+            self::$instance           = new Wordlift_Cached_Entity_Uri_Service( $entity_uri_cache_service );
+
+        }
+
+        return self::$instance;
+    }
+
+    /**
+     * Try to find a post when the content service doesn't find it.
+     *
+     * @param WP_Post|null $post
+     * @param string       $uri
+     *
+     * @return false|int
+     */
+    public function content_service__post__not_found( $post, $uri ) {
+        return $this->get_post_id_from_url( $uri );
+    }
+
+    /**
+     * Preload the provided URIs in the local cache.
+     *
+     * This function will populate the local `$uri_to_post` array by running a
+     * single query with all the URIs and returning the mappings in the array.
+     *
+     * @param array $uris An array of URIs.
+     *
+     * @since 3.16.3
+     */
+    public function preload_uris( $uris ) {
+
+        // Bail out if there are no URIs.
+        if ( 0 === count( $uris ) ) {
+            return;
+        }
+
+        $this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
+
+        global $wpdb;
+        $in_post_types  = implode( "','", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) );
+        $in_entity_uris = implode( "','", array_map( 'esc_sql', $uris ) );
+        $sql            = "
 			SELECT ID FROM $wpdb->posts p
 			INNER JOIN $wpdb->postmeta pm
 			 ON pm.post_id = p.ID
@@ -123,150 +123,150 @@ 
 			  AND p.post_status IN ( 'publish', 'draft', 'private', 'future' )
   		";
 
-		// Get the posts.
-		$posts = $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
-
-		// Populate the array. We reinitialize the array on purpose because
-		// we don't want these data to long live.
-		$this->uri_to_post = array_reduce(
-			$posts,
-			function ( $carry, $item ) {
-				$uris = get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS );
-
-				$uri = Wordpress_Content_Service::get_instance()
-											->get_entity_id( Wordpress_Content_Id::create_post( $item ) );
-
-				if ( isset( $uri ) ) {
-					$uris[] = $uri;
-				}
-
-				return $carry
-				   // Get the URI related to the post and fill them with the item id.
-				   + array_fill_keys( $uris, $item );
-			},
-			array()
-		);
-
-		// Add the not found URIs.
-		$this->uri_to_post += array_fill_keys( $uris, null );
-
-		$this->log->debug( count( $this->uri_to_post ) . ' URI(s) preloaded.' );
-
-	}
-
-	/**
-	 * Reset the URI to post local cache.
-	 *
-	 * @since 3.16.3
-	 */
-	public function reset_uris() {
-
-		$this->uri_to_post = array();
-
-	}
-
-	/**
-	 * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
-	 *
-	 * @param string $uri The entity URI.
-	 *
-	 * @return WP_Post|null A WP_Post instance or null if not found.
-	 * @since 3.2.0
-	 */
-	public function get_entity( $uri ) {
-
-		$this->log->trace( "Getting an entity post for URI $uri..." );
-
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
-
-		// Return null if the content isn't found or isn't a post.
-		if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
-			return null;
-		}
-
-		return $content->get_bag();
-	}
-
-	/**
-	 * Determines whether a given uri is an internal uri or not.
-	 *
-	 * @param string $uri An uri.
-	 *
-	 * @return true if the uri internal to the current dataset otherwise false.
-	 * @since 3.16.3
-	 */
-	public function is_internal( $uri ) {
-
-		return ( 0 === strrpos( $uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) );
-	}
-
-	/**
-	 * Hook to `rest_post_dispatch` to alter the response and add the `wl_entity_url` post meta as `wl:entity_url`.
-	 *
-	 * We're using this filter instead of the well known `register_meta` / `register_rest_field` because we still need
-	 * to provide full compatibility with WordPress 4.4+.
-	 *
-	 * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response.
-	 *
-	 * @return WP_HTTP_Response The result to send to the client.
-	 *
-	 * @since 3.23.0
-	 */
-	public function rest_post_dispatch( $result ) {
-
-		// Get a reference to the actual data.
-		$data = &$result->data;
-
-		// Bail out if we don't have the required parameters, or if the type is not a valid entity.
-		if ( ! is_array( $data ) || ! isset( $data['id'] ) || ! isset( $data['type'] )
-			 || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $data['type'] ) ) {
-			return $result;
-		}
-
-		// Add the `wl:entity_url`.
-		$data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri( $data['id'] );
-
-		return $result;
-	}
-
-	/**
-	 * Helper function to fetch post_id from a WordPress URL
-	 * Primarily used when dataset is not enabled
-	 *
-	 * @param $url
-	 *
-	 * @return int Post ID | bool false
-	 */
-	public function get_post_id_from_url( $url ) {
-
-		// Try url_to_postid
-		$post_id = url_to_postid( htmlspecialchars_decode( $url ) );
-		if ( 0 !== $post_id ) {
-			return $post_id;
-		}
-
-		$parsed_url = wp_parse_url( $url );
-
-		if ( ! isset( $parsed_url['query'] ) ) {
-			return false;
-		}
-
-		parse_str( $parsed_url['query'], $parsed_query );
-
-		// Try to parse WooCommerce non-pretty product URL
-		if ( $parsed_query['product'] ) {
-			$posts = get_posts(
-				array(
-					'name'      => $parsed_query['product'],
-					'post_type' => 'product',
-				)
-			);
-			if ( count( $posts ) > 0 ) {
-				return $posts[0]->ID;
-			}
-		}
-
-		return false;
-	}
+        // Get the posts.
+        $posts = $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+
+        // Populate the array. We reinitialize the array on purpose because
+        // we don't want these data to long live.
+        $this->uri_to_post = array_reduce(
+            $posts,
+            function ( $carry, $item ) {
+                $uris = get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS );
+
+                $uri = Wordpress_Content_Service::get_instance()
+                                            ->get_entity_id( Wordpress_Content_Id::create_post( $item ) );
+
+                if ( isset( $uri ) ) {
+                    $uris[] = $uri;
+                }
+
+                return $carry
+                    // Get the URI related to the post and fill them with the item id.
+                   + array_fill_keys( $uris, $item );
+            },
+            array()
+        );
+
+        // Add the not found URIs.
+        $this->uri_to_post += array_fill_keys( $uris, null );
+
+        $this->log->debug( count( $this->uri_to_post ) . ' URI(s) preloaded.' );
+
+    }
+
+    /**
+     * Reset the URI to post local cache.
+     *
+     * @since 3.16.3
+     */
+    public function reset_uris() {
+
+        $this->uri_to_post = array();
+
+    }
+
+    /**
+     * Find entity posts by the entity URI. Entity as searched by their entity URI or same as.
+     *
+     * @param string $uri The entity URI.
+     *
+     * @return WP_Post|null A WP_Post instance or null if not found.
+     * @since 3.2.0
+     */
+    public function get_entity( $uri ) {
+
+        $this->log->trace( "Getting an entity post for URI $uri..." );
+
+        $content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+
+        // Return null if the content isn't found or isn't a post.
+        if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
+            return null;
+        }
+
+        return $content->get_bag();
+    }
+
+    /**
+     * Determines whether a given uri is an internal uri or not.
+     *
+     * @param string $uri An uri.
+     *
+     * @return true if the uri internal to the current dataset otherwise false.
+     * @since 3.16.3
+     */
+    public function is_internal( $uri ) {
+
+        return ( 0 === strrpos( $uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) );
+    }
+
+    /**
+     * Hook to `rest_post_dispatch` to alter the response and add the `wl_entity_url` post meta as `wl:entity_url`.
+     *
+     * We're using this filter instead of the well known `register_meta` / `register_rest_field` because we still need
+     * to provide full compatibility with WordPress 4.4+.
+     *
+     * @param WP_HTTP_Response $result Result to send to the client. Usually a WP_REST_Response.
+     *
+     * @return WP_HTTP_Response The result to send to the client.
+     *
+     * @since 3.23.0
+     */
+    public function rest_post_dispatch( $result ) {
+
+        // Get a reference to the actual data.
+        $data = &$result->data;
+
+        // Bail out if we don't have the required parameters, or if the type is not a valid entity.
+        if ( ! is_array( $data ) || ! isset( $data['id'] ) || ! isset( $data['type'] )
+             || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $data['type'] ) ) {
+            return $result;
+        }
+
+        // Add the `wl:entity_url`.
+        $data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri( $data['id'] );
+
+        return $result;
+    }
+
+    /**
+     * Helper function to fetch post_id from a WordPress URL
+     * Primarily used when dataset is not enabled
+     *
+     * @param $url
+     *
+     * @return int Post ID | bool false
+     */
+    public function get_post_id_from_url( $url ) {
+
+        // Try url_to_postid
+        $post_id = url_to_postid( htmlspecialchars_decode( $url ) );
+        if ( 0 !== $post_id ) {
+            return $post_id;
+        }
+
+        $parsed_url = wp_parse_url( $url );
+
+        if ( ! isset( $parsed_url['query'] ) ) {
+            return false;
+        }
+
+        parse_str( $parsed_url['query'], $parsed_query );
+
+        // Try to parse WooCommerce non-pretty product URL
+        if ( $parsed_query['product'] ) {
+            $posts = get_posts(
+                array(
+                    'name'      => $parsed_query['product'],
+                    'post_type' => 'product',
+                )
+            );
+            if ( count( $posts ) > 0 ) {
+                return $posts[0]->ID;
+            }
+        }
+
+        return false;
+    }
 
 }

Spacing +39 added lines, -39 removed lines

@@ -45,11 +45,11 @@ 
 	 */
 	protected function __construct() {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		// Add a filter to the `rest_post_dispatch` filter to add the wl_entity_url meta as `wl:entity_url`.
-		add_filter( 'rest_post_dispatch', array( $this, 'rest_post_dispatch' ) );
-		add_filter( 'wl_content_service__post__not_found', array( $this, 'content_service__post__not_found' ), 10, 2 );
+		add_filter('rest_post_dispatch', array($this, 'rest_post_dispatch'));
+		add_filter('wl_content_service__post__not_found', array($this, 'content_service__post__not_found'), 10, 2);
 
 	}
 
@@ -70,9 +70,9 @@ 
 	 */
 	public static function get_instance() {
 
-		if ( ! isset( self::$instance ) ) {
-			$entity_uri_cache_service = new Wordlift_File_Cache_Service( WL_TEMP_DIR . 'entity_uri/' );
-			self::$instance           = new Wordlift_Cached_Entity_Uri_Service( $entity_uri_cache_service );
+		if ( ! isset(self::$instance)) {
+			$entity_uri_cache_service = new Wordlift_File_Cache_Service(WL_TEMP_DIR.'entity_uri/');
+			self::$instance           = new Wordlift_Cached_Entity_Uri_Service($entity_uri_cache_service);
 
 		}
 
@@ -87,8 +87,8 @@ 
 	 *
 	 * @return false|int
 	 */
-	public function content_service__post__not_found( $post, $uri ) {
-		return $this->get_post_id_from_url( $uri );
+	public function content_service__post__not_found($post, $uri) {
+		return $this->get_post_id_from_url($uri);
 	}
 
 	/**
@@ -101,18 +101,18 @@ 
 	 *
 	 * @since 3.16.3
 	 */
-	public function preload_uris( $uris ) {
+	public function preload_uris($uris) {
 
 		// Bail out if there are no URIs.
-		if ( 0 === count( $uris ) ) {
+		if (0 === count($uris)) {
 			return;
 		}
 
-		$this->log->trace( 'Preloading ' . count( $uris ) . ' URI(s)...' );
+		$this->log->trace('Preloading '.count($uris).' URI(s)...');
 
 		global $wpdb;
-		$in_post_types  = implode( "','", array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() ) );
-		$in_entity_uris = implode( "','", array_map( 'esc_sql', $uris ) );
+		$in_post_types  = implode("','", array_map('esc_sql', Wordlift_Entity_Service::valid_entity_post_types()));
+		$in_entity_uris = implode("','", array_map('esc_sql', $uris));
 		$sql            = "
 			SELECT ID FROM $wpdb->posts p
 			INNER JOIN $wpdb->postmeta pm
@@ -124,33 +124,33 @@ 
   		";
 
 		// Get the posts.
-		$posts = $wpdb->get_col( $sql ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
+		$posts = $wpdb->get_col($sql); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
 
 		// Populate the array. We reinitialize the array on purpose because
 		// we don't want these data to long live.
 		$this->uri_to_post = array_reduce(
 			$posts,
-			function ( $carry, $item ) {
-				$uris = get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS );
+			function($carry, $item) {
+				$uris = get_post_meta($item, Wordlift_Schema_Service::FIELD_SAME_AS);
 
 				$uri = Wordpress_Content_Service::get_instance()
-											->get_entity_id( Wordpress_Content_Id::create_post( $item ) );
+											->get_entity_id(Wordpress_Content_Id::create_post($item));
 
-				if ( isset( $uri ) ) {
+				if (isset($uri)) {
 					$uris[] = $uri;
 				}
 
 				return $carry
 				   // Get the URI related to the post and fill them with the item id.
-				   + array_fill_keys( $uris, $item );
+				   + array_fill_keys($uris, $item);
 			},
 			array()
 		);
 
 		// Add the not found URIs.
-		$this->uri_to_post += array_fill_keys( $uris, null );
+		$this->uri_to_post += array_fill_keys($uris, null);
 
-		$this->log->debug( count( $this->uri_to_post ) . ' URI(s) preloaded.' );
+		$this->log->debug(count($this->uri_to_post).' URI(s) preloaded.');
 
 	}
 
@@ -173,14 +173,14 @@ 
 	 * @return WP_Post|null A WP_Post instance or null if not found.
 	 * @since 3.2.0
 	 */
-	public function get_entity( $uri ) {
+	public function get_entity($uri) {
 
-		$this->log->trace( "Getting an entity post for URI $uri..." );
+		$this->log->trace("Getting an entity post for URI $uri...");
 
-		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as( $uri );
+		$content = Wordpress_Content_Service::get_instance()->get_by_entity_id_or_same_as($uri);
 
 		// Return null if the content isn't found or isn't a post.
-		if ( ! isset( $content ) || ! is_a( $content->get_bag(), '\WP_Post' ) ) {
+		if ( ! isset($content) || ! is_a($content->get_bag(), '\WP_Post')) {
 			return null;
 		}
 
@@ -195,9 +195,9 @@ 
 	 * @return true if the uri internal to the current dataset otherwise false.
 	 * @since 3.16.3
 	 */
-	public function is_internal( $uri ) {
+	public function is_internal($uri) {
 
-		return ( 0 === strrpos( $uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri() ) );
+		return (0 === strrpos($uri, (string) Wordlift_Configuration_Service::get_instance()->get_dataset_uri()));
 	}
 
 	/**
@@ -212,19 +212,19 @@ 
 	 *
 	 * @since 3.23.0
 	 */
-	public function rest_post_dispatch( $result ) {
+	public function rest_post_dispatch($result) {
 
 		// Get a reference to the actual data.
 		$data = &$result->data;
 
 		// Bail out if we don't have the required parameters, or if the type is not a valid entity.
-		if ( ! is_array( $data ) || ! isset( $data['id'] ) || ! isset( $data['type'] )
-			 || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type( $data['type'] ) ) {
+		if ( ! is_array($data) || ! isset($data['id']) || ! isset($data['type'])
+			 || ! Wordlift_Entity_Type_Service::is_valid_entity_post_type($data['type'])) {
 			return $result;
 		}
 
 		// Add the `wl:entity_url`.
-		$data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri( $data['id'] );
+		$data['wl:entity_url'] = Wordlift_Entity_Service::get_instance()->get_uri($data['id']);
 
 		return $result;
 	}
@@ -237,31 +237,31 @@ 
 	 *
 	 * @return int Post ID | bool false
 	 */
-	public function get_post_id_from_url( $url ) {
+	public function get_post_id_from_url($url) {
 
 		// Try url_to_postid
-		$post_id = url_to_postid( htmlspecialchars_decode( $url ) );
-		if ( 0 !== $post_id ) {
+		$post_id = url_to_postid(htmlspecialchars_decode($url));
+		if (0 !== $post_id) {
 			return $post_id;
 		}
 
-		$parsed_url = wp_parse_url( $url );
+		$parsed_url = wp_parse_url($url);
 
-		if ( ! isset( $parsed_url['query'] ) ) {
+		if ( ! isset($parsed_url['query'])) {
 			return false;
 		}
 
-		parse_str( $parsed_url['query'], $parsed_query );
+		parse_str($parsed_url['query'], $parsed_query);
 
 		// Try to parse WooCommerce non-pretty product URL
-		if ( $parsed_query['product'] ) {
+		if ($parsed_query['product']) {
 			$posts = get_posts(
 				array(
 					'name'      => $parsed_query['product'],
 					'post_type' => 'product',
 				)
 			);
-			if ( count( $posts ) > 0 ) {
+			if (count($posts) > 0) {
 				return $posts[0]->ID;
 			}
 		}