insideout10 / wordlift-plugin

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

Indentation +243 added lines, -243 removed lines

@@ -17,98 +17,98 @@ 
  */
 class Wordlift_Entity_Uri_Service {
 
-	/**
-	 * 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;
-
-	/**
-	 * 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;
-
-	/**
-	 * The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.16.3
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * 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.
-	 *
-	 * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since 3.16.3
-	 *
-	 */
-	public function __construct( $configuration_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
-
-		$this->configuration_service = $configuration_service;
-
-		// 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' ) );
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton.
-	 *
-	 * @return Wordlift_Entity_Uri_Service The singleton instance.
-	 * @since 3.21.5
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * 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            = "
+    /**
+     * 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;
+
+    /**
+     * 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;
+
+    /**
+     * The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.16.3
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * 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.
+     *
+     * @param \Wordlift_Configuration_Service $configuration_service The {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since 3.16.3
+     *
+     */
+    public function __construct( $configuration_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( get_class() );
+
+        $this->configuration_service = $configuration_service;
+
+        // 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' ) );
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton.
+     *
+     * @return Wordlift_Entity_Uri_Service The singleton instance.
+     * @since 3.21.5
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * 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
@@ -118,156 +118,156 @@ 
 			  AND p.post_status IN ( 'publish', 'draft', 'private', 'future' )
   		";
 
-		// Get the posts.
-		$posts = $wpdb->get_col( $sql );
-
-		// 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 = array_merge(
-				get_post_meta( $item, WL_ENTITY_URL_META_NAME ),
-				get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS )
-			);
-
-			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..." );
-
-		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
-			return null;
-		}
-
-		$this->log->debug( "Querying post for $uri..." );
-
-		$query_args = array(
-			// See https://github.com/insideout10/wordlift-plugin/issues/654.
-			'ignore_sticky_posts' => 1,
-			'posts_per_page'      => 1,
-			'post_status'         => 'any',
-			'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
-			'meta_query'          => array(
-				array(
-					'key'     => WL_ENTITY_URL_META_NAME,
-					'value'   => $uri,
-					'compare' => '=',
-				),
-			),
-		);
-
-		// Only if the current uri is not an internal uri, entity search is
-		// performed also looking at sameAs values.
-		//
-		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal( $uri ) ) {
-
-			$query_args['meta_query']['relation'] = 'OR';
-			$query_args['meta_query'][]           = array(
-				'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
-				'value'   => $uri,
-				'compare' => '=',
-			);
-		}
-
-		$posts = get_posts( $query_args );
-
-		// Attempt to find post by URI (only for local entity URLs)
-		if ( empty( $posts ) ) {
-
-			$this->log->debug( "Finding post by $uri..." );
-			$postid = url_to_postid( $uri );
-			if ( $postid !== 0 ) {
-				$this->log->trace( "Found post $postid by URL" );
-
-				return get_post( $postid );
-			}
-
-		}
-
-		// Return null if no post is found.
-		if ( empty( $posts ) ) {
-			$this->log->warn( "No post for URI $uri." );
-
-			return null;
-		}
-
-		// Return the found post.
-		return current( $posts );
-	}
-
-	/**
-	 * 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) $this->configuration_service->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;
-	}
+        // Get the posts.
+        $posts = $wpdb->get_col( $sql );
+
+        // 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 = array_merge(
+                get_post_meta( $item, WL_ENTITY_URL_META_NAME ),
+                get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS )
+            );
+
+            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..." );
+
+        // Check if we've been provided with a value otherwise return null.
+        if ( empty( $uri ) ) {
+            return null;
+        }
+
+        $this->log->debug( "Querying post for $uri..." );
+
+        $query_args = array(
+            // See https://github.com/insideout10/wordlift-plugin/issues/654.
+            'ignore_sticky_posts' => 1,
+            'posts_per_page'      => 1,
+            'post_status'         => 'any',
+            'post_type'           => Wordlift_Entity_Service::valid_entity_post_types(),
+            'meta_query'          => array(
+                array(
+                    'key'     => WL_ENTITY_URL_META_NAME,
+                    'value'   => $uri,
+                    'compare' => '=',
+                ),
+            ),
+        );
+
+        // Only if the current uri is not an internal uri, entity search is
+        // performed also looking at sameAs values.
+        //
+        // This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
+        if ( ! $this->is_internal( $uri ) ) {
+
+            $query_args['meta_query']['relation'] = 'OR';
+            $query_args['meta_query'][]           = array(
+                'key'     => Wordlift_Schema_Service::FIELD_SAME_AS,
+                'value'   => $uri,
+                'compare' => '=',
+            );
+        }
+
+        $posts = get_posts( $query_args );
+
+        // Attempt to find post by URI (only for local entity URLs)
+        if ( empty( $posts ) ) {
+
+            $this->log->debug( "Finding post by $uri..." );
+            $postid = url_to_postid( $uri );
+            if ( $postid !== 0 ) {
+                $this->log->trace( "Found post $postid by URL" );
+
+                return get_post( $postid );
+            }
+
+        }
+
+        // Return null if no post is found.
+        if ( empty( $posts ) ) {
+            $this->log->warn( "No post for URI $uri." );
+
+            return null;
+        }
+
+        // Return the found post.
+        return current( $posts );
+    }
+
+    /**
+     * 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) $this->configuration_service->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;
+    }
 
 }

Spacing +37 added lines, -37 removed lines

@@ -61,14 +61,14 @@ 
 	 * @since 3.16.3
 	 *
 	 */
-	public function __construct( $configuration_service ) {
+	public function __construct($configuration_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( get_class() );
+		$this->log = Wordlift_Log_Service::get_logger(get_class());
 
 		$this->configuration_service = $configuration_service;
 
 		// 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('rest_post_dispatch', array($this, 'rest_post_dispatch'));
 
 		self::$instance = $this;
 
@@ -96,18 +96,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
@@ -119,25 +119,25 @@ 
   		";
 
 		// Get the posts.
-		$posts = $wpdb->get_col( $sql );
+		$posts = $wpdb->get_col($sql);
 
 		// 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 ) {
+		$this->uri_to_post = array_reduce($posts, function($carry, $item) {
 			$uris = array_merge(
-				get_post_meta( $item, WL_ENTITY_URL_META_NAME ),
-				get_post_meta( $item, Wordlift_Schema_Service::FIELD_SAME_AS )
+				get_post_meta($item, WL_ENTITY_URL_META_NAME),
+				get_post_meta($item, Wordlift_Schema_Service::FIELD_SAME_AS)
 			);
 
 			return $carry
 			       // Get the URI related to the post and fill them with the item id.
-			       + array_fill_keys( $uris, $item );
-		}, array() );
+			       + 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.");
 
 	}
 
@@ -161,16 +161,16 @@ 
 	 * @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...");
 
 		// Check if we've been provided with a value otherwise return null.
-		if ( empty( $uri ) ) {
+		if (empty($uri)) {
 			return null;
 		}
 
-		$this->log->debug( "Querying post for $uri..." );
+		$this->log->debug("Querying post for $uri...");
 
 		$query_args = array(
 			// See https://github.com/insideout10/wordlift-plugin/issues/654.
@@ -191,7 +191,7 @@ 
 		// performed also looking at sameAs values.
 		//
 		// This solve issues like https://github.com/insideout10/wordlift-plugin/issues/237
-		if ( ! $this->is_internal( $uri ) ) {
+		if ( ! $this->is_internal($uri)) {
 
 			$query_args['meta_query']['relation'] = 'OR';
 			$query_args['meta_query'][]           = array(
@@ -201,30 +201,30 @@ 
 			);
 		}
 
-		$posts = get_posts( $query_args );
+		$posts = get_posts($query_args);
 
 		// Attempt to find post by URI (only for local entity URLs)
-		if ( empty( $posts ) ) {
+		if (empty($posts)) {
 
-			$this->log->debug( "Finding post by $uri..." );
-			$postid = url_to_postid( $uri );
-			if ( $postid !== 0 ) {
-				$this->log->trace( "Found post $postid by URL" );
+			$this->log->debug("Finding post by $uri...");
+			$postid = url_to_postid($uri);
+			if ($postid !== 0) {
+				$this->log->trace("Found post $postid by URL");
 
-				return get_post( $postid );
+				return get_post($postid);
 			}
 
 		}
 
 		// Return null if no post is found.
-		if ( empty( $posts ) ) {
-			$this->log->warn( "No post for URI $uri." );
+		if (empty($posts)) {
+			$this->log->warn("No post for URI $uri.");
 
 			return null;
 		}
 
 		// Return the found post.
-		return current( $posts );
+		return current($posts);
 	}
 
 	/**
@@ -236,9 +236,9 @@ 
 	 * @since 3.16.3
 	 *
 	 */
-	public function is_internal( $uri ) {
+	public function is_internal($uri) {
 
-		return ( 0 === strrpos( $uri, (string) $this->configuration_service->get_dataset_uri() ) );
+		return (0 === strrpos($uri, (string) $this->configuration_service->get_dataset_uri()));
 	}
 
 	/**
@@ -253,19 +253,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;
 	}