insideout10 / wordlift-plugin

src/shortcodes/wordlift_shortcode_faceted_search.php

Indentation +229 added lines, -229 removed lines

@@ -18,30 +18,30 @@ 
  */
 function wl_shortcode_faceted_search( $request ) {
 
-	// Create the cache key.
-	$cache_key = array(
-		'request_params' => $_GET,
-	);
+    // Create the cache key.
+    $cache_key = array(
+        'request_params' => $_GET,
+    );
 
-	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( "faceted-search", 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+    // Create the TTL cache and try to get the results.
+    $cache         = new Ttl_Cache( "faceted-search", 8 * 60 * 60 ); // 8 hours.
+    $cache_results = $cache->get( $cache_key );
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
-		wl_core_send_json( $cache_results );
+    if ( isset( $cache_results ) ) {
+        header( 'X-WordLift-Cache: HIT' );
+        wl_core_send_json( $cache_results );
 
-		return;
-	}
+        return;
+    }
 
-	header( 'X-WordLift-Cache: MISS' );
+    header( 'X-WordLift-Cache: MISS' );
 
-	$results = wl_shortcode_faceted_search_origin( $request );
+    $results = wl_shortcode_faceted_search_origin( $request );
 
-	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+    // Put the result before sending the json to the client, since sending the json will terminate us.
+    $cache->put( $cache_key, $results );
 
-	wl_core_send_json( $results );
+    wl_core_send_json( $results );
 
 }
 
@@ -52,128 +52,128 @@ 
  * @since        3.26.0
  */
 function wl_shortcode_faceted_search_origin( $request ) {
-	// Post ID must be defined.
-	if ( ! isset( $_GET['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
-
-		return;
-	}
-
-	$current_post_id = $_GET['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
-
-	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
-
-		return;
-	}
-
-	// If the current post is an entity,
-	// the current post is used as main entity.
-	// Otherwise, current post related entities are used.
-	$entity_service = Wordlift_Entity_Service::get_instance();
-	$entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		$entity_service->get_related_entities( $current_post->ID );
-
-	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
-		wp_die( 'No entities available' );
-
-		return;
-	}
-
-	$limit = ( isset( $_GET['limit'] ) ) ? (int) $_GET['limit'] : 4;  // WPCS: input var ok; CSRF ok.
-	$amp   = ( isset( $_GET['amp'] ) ) ? true : false;
-
-
-	/**
-	 * see https://github.com/insideout10/wordlift-plugin/issues/1181
-	 * The ordering should be descending by date on default.
-	 */
-	$order_by = 'DESC';
-	if ( isset( $_GET['sort'] ) && is_string( $_GET['sort'] ) ) {
-		$order_by = (string) $_GET['sort'];
-	}
-
-	$referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-		$entity_ids,
-		'*',
-		null,
-		'publish',
-		array( $current_post_id ),
-		$limit,
-		null,
-		$order_by
-	);
-
-	$referencing_post_ids = array_map( function ( $p ) {
-		return $p->ID;
-	}, $referencing_posts );
-
-	$post_results   = array();
-	$entity_results = array();
-
-	// Populate $post_results
-
-	$filtered_posts = ( empty( $filtering_entity_uris ) ) ?
-		$referencing_posts :
-		Wordlift_Relation_Service::get_instance()->get_article_subjects(
-			wl_get_entity_post_ids_by_uris( $filtering_entity_uris ),
-			'*',
-			null,
-			null,
-			array(),
-			null,
-			$referencing_post_ids
-		);
-
-	if ( $filtered_posts ) {
-		foreach ( $filtered_posts as $post_obj ) {
-
-			/**
-			 * Use the thumbnail.
-			 *
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
-			 * @see https://github.com/insideout10/wordlift-plugin/issues/837
-			 *
-			 * @since 3.19.3 We're using the medium size image.
-			 */
-			$thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail = ( $thumbnail ) ?
-				$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->permalink = get_permalink( $post_obj->ID );
-
-			$result         = $post_obj;
-			$post_results[] = $result;
-		}
-	}
-
-	// Add filler posts if needed
-
-	$filler_count         = $limit - count( $post_results );
-	$filler_posts         = wl_shortcode_faceted_search_filler_posts( $filler_count, $current_post_id, $referencing_post_ids );
-	$post_results         = array_merge( $post_results, $filler_posts );
-	$referencing_post_ids = array_map( function ( $post ) {
-		return $post->ID;
-	}, $post_results );
-
-	// Populate $entity_results
-
-	global $wpdb;
-
-	// Retrieve Wordlift relation instances table name.
-	$table_name = wl_core_get_relation_instances_table_name();
-
-	/*
+    // Post ID must be defined.
+    if ( ! isset( $_GET['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
+        wp_die( 'No post_id given' );
+
+        return;
+    }
+
+    $current_post_id = $_GET['post_id']; // WPCS: input var ok; CSRF ok.
+    $current_post    = get_post( $current_post_id );
+
+    // Post ID has to match an existing item.
+    if ( null === $current_post ) {
+        wp_die( 'No valid post_id given' );
+
+        return;
+    }
+
+    // If the current post is an entity,
+    // the current post is used as main entity.
+    // Otherwise, current post related entities are used.
+    $entity_service = Wordlift_Entity_Service::get_instance();
+    $entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
+        array( $current_post->ID ) :
+        $entity_service->get_related_entities( $current_post->ID );
+
+    // If there are no entities we cannot render the widget.
+    if ( 0 === count( $entity_ids ) ) {
+        wp_die( 'No entities available' );
+
+        return;
+    }
+
+    $limit = ( isset( $_GET['limit'] ) ) ? (int) $_GET['limit'] : 4;  // WPCS: input var ok; CSRF ok.
+    $amp   = ( isset( $_GET['amp'] ) ) ? true : false;
+
+
+    /**
+     * see https://github.com/insideout10/wordlift-plugin/issues/1181
+     * The ordering should be descending by date on default.
+     */
+    $order_by = 'DESC';
+    if ( isset( $_GET['sort'] ) && is_string( $_GET['sort'] ) ) {
+        $order_by = (string) $_GET['sort'];
+    }
+
+    $referencing_posts = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+        $entity_ids,
+        '*',
+        null,
+        'publish',
+        array( $current_post_id ),
+        $limit,
+        null,
+        $order_by
+    );
+
+    $referencing_post_ids = array_map( function ( $p ) {
+        return $p->ID;
+    }, $referencing_posts );
+
+    $post_results   = array();
+    $entity_results = array();
+
+    // Populate $post_results
+
+    $filtered_posts = ( empty( $filtering_entity_uris ) ) ?
+        $referencing_posts :
+        Wordlift_Relation_Service::get_instance()->get_article_subjects(
+            wl_get_entity_post_ids_by_uris( $filtering_entity_uris ),
+            '*',
+            null,
+            null,
+            array(),
+            null,
+            $referencing_post_ids
+        );
+
+    if ( $filtered_posts ) {
+        foreach ( $filtered_posts as $post_obj ) {
+
+            /**
+             * Use the thumbnail.
+             *
+             * @see https://github.com/insideout10/wordlift-plugin/issues/825 related issue.
+             * @see https://github.com/insideout10/wordlift-plugin/issues/837
+             *
+             * @since 3.19.3 We're using the medium size image.
+             */
+            $thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
+            $post_obj->thumbnail = ( $thumbnail ) ?
+                $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+            $post_obj->permalink = get_permalink( $post_obj->ID );
+
+            $result         = $post_obj;
+            $post_results[] = $result;
+        }
+    }
+
+    // Add filler posts if needed
+
+    $filler_count         = $limit - count( $post_results );
+    $filler_posts         = wl_shortcode_faceted_search_filler_posts( $filler_count, $current_post_id, $referencing_post_ids );
+    $post_results         = array_merge( $post_results, $filler_posts );
+    $referencing_post_ids = array_map( function ( $post ) {
+        return $post->ID;
+    }, $post_results );
+
+    // Populate $entity_results
+
+    global $wpdb;
+
+    // Retrieve Wordlift relation instances table name.
+    $table_name = wl_core_get_relation_instances_table_name();
+
+    /*
 	 * Make sure we have some referenced post, otherwise the IN parts of
 	 * the SQL will produce an SQL error.
 	 */
-	if ( ! empty( $referencing_post_ids ) ) {
-		$subject_ids = implode( ',', $referencing_post_ids );
+    if ( ! empty( $referencing_post_ids ) ) {
+        $subject_ids = implode( ',', $referencing_post_ids );
 
-		$query = "
+        $query = "
 				SELECT
 					object_id AS ID,
 					count( object_id ) AS counter
@@ -185,116 +185,116 @@ 
 				LIMIT $limit;
 			";
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+        wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
 
-		$entities = $wpdb->get_results( $query, OBJECT ); // No cache ok.
+        $entities = $wpdb->get_results( $query, OBJECT ); // No cache ok.
 
-		wl_write_log( 'Entities found ' . count( $entities ) );
+        wl_write_log( 'Entities found ' . count( $entities ) );
 
-		foreach ( $entities as $obj ) {
+        foreach ( $entities as $obj ) {
 
-			$entity = get_post( $obj->ID );
+            $entity = get_post( $obj->ID );
 
-			// Ensure only valid and published entities are returned.
-			if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+            // Ensure only valid and published entities are returned.
+            if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
 
-				$serialized_entity                    = wl_serialize_entity( $entity );
-				$serialized_entity['label']           = wl_shortcode_faceted_search_get_the_title( $obj->ID );
-				$serialized_entity['counter']         = $obj->counter;
-				$serialized_entity['createdAt']       = $entity->post_date;
-				$serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
-					$obj->ID,
-					'ids',
-					null,
-					null,
-					array(),
-					null,
-					$referencing_post_ids
-				);
-				$entity_results[]                     = $serialized_entity;
-			}
-		}
-	}
+                $serialized_entity                    = wl_serialize_entity( $entity );
+                $serialized_entity['label']           = wl_shortcode_faceted_search_get_the_title( $obj->ID );
+                $serialized_entity['counter']         = $obj->counter;
+                $serialized_entity['createdAt']       = $entity->post_date;
+                $serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
+                    $obj->ID,
+                    'ids',
+                    null,
+                    null,
+                    array(),
+                    null,
+                    $referencing_post_ids
+                );
+                $entity_results[]                     = $serialized_entity;
+            }
+        }
+    }
 
-	return array(
-		'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
-		'entities' => $entity_results
-	);
+    return array(
+        'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
+        'entities' => $entity_results
+    );
 
 }
 
 function wl_shortcode_faceted_search_get_the_title( $post_id ) {
 
-	$title = get_the_title( $post_id );
+    $title = get_the_title( $post_id );
 
-	if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+    if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
+        $alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
 
-		if ( count( $alternative_labels ) > 0 ) {
-			$title = $alternative_labels[0];
-		}
-	}
+        if ( count( $alternative_labels ) > 0 ) {
+            $title = $alternative_labels[0];
+        }
+    }
 
-	return remove_accents( $title );
+    return remove_accents( $title );
 
 }
 
 function wl_shortcode_faceted_search_filler_posts( $filler_count, $current_post_id, $referencing_post_ids ) {
 
-	$filler_posts = array();
-
-	// First add latest posts from same categories as the current post
-	if ( $filler_count > 0 ) {
-
-		$current_post_categories = wp_get_post_categories( $current_post_id );
-
-		$args = array(
-			'meta_query'          => array(
-				array(
-					'key' => '_thumbnail_id'
-				)
-			),
-			'category__in'        => $current_post_categories,
-			'numberposts'         => $filler_count,
-			'post__not_in'        => array_merge( array( $current_post_id ), $referencing_post_ids ),
-			'ignore_sticky_posts' => 1
-		);
-
-		$filler_posts = get_posts( $args );
-	}
-
-	$filler_count    = $filler_count - count( $filler_posts );
-	$filler_post_ids = array_map( function ( $post ) {
-		return $post->ID;
-	}, $filler_posts );
-
-	// If that does not fill, add latest posts irrespective of category
-	if ( $filler_count > 0 ) {
-
-		$args = array(
-			'meta_query'          => array(
-				array(
-					'key' => '_thumbnail_id'
-				)
-			),
-			'numberposts'         => $filler_count,
-			'post__not_in'        => array_merge( array( $current_post_id ), $referencing_post_ids, $filler_post_ids ),
-			'ignore_sticky_posts' => 1
-		);
-
-		$filler_posts = array_merge( $filler_posts, get_posts( $args ) );
-
-	}
-
-	// Add thumbnail and permalink to filler posts
-	foreach ( $filler_posts as $post_obj ) {
-		$thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
-		$post_obj->thumbnail = ( $thumbnail ) ?
-			$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-		$post_obj->permalink = get_permalink( $post_obj->ID );
-	}
-
-	return $filler_posts;
+    $filler_posts = array();
+
+    // First add latest posts from same categories as the current post
+    if ( $filler_count > 0 ) {
+
+        $current_post_categories = wp_get_post_categories( $current_post_id );
+
+        $args = array(
+            'meta_query'          => array(
+                array(
+                    'key' => '_thumbnail_id'
+                )
+            ),
+            'category__in'        => $current_post_categories,
+            'numberposts'         => $filler_count,
+            'post__not_in'        => array_merge( array( $current_post_id ), $referencing_post_ids ),
+            'ignore_sticky_posts' => 1
+        );
+
+        $filler_posts = get_posts( $args );
+    }
+
+    $filler_count    = $filler_count - count( $filler_posts );
+    $filler_post_ids = array_map( function ( $post ) {
+        return $post->ID;
+    }, $filler_posts );
+
+    // If that does not fill, add latest posts irrespective of category
+    if ( $filler_count > 0 ) {
+
+        $args = array(
+            'meta_query'          => array(
+                array(
+                    'key' => '_thumbnail_id'
+                )
+            ),
+            'numberposts'         => $filler_count,
+            'post__not_in'        => array_merge( array( $current_post_id ), $referencing_post_ids, $filler_post_ids ),
+            'ignore_sticky_posts' => 1
+        );
+
+        $filler_posts = array_merge( $filler_posts, get_posts( $args ) );
+
+    }
+
+    // Add thumbnail and permalink to filler posts
+    foreach ( $filler_posts as $post_obj ) {
+        $thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
+        $post_obj->thumbnail = ( $thumbnail ) ?
+            $thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
+        $post_obj->permalink = get_permalink( $post_obj->ID );
+    }
+
+    return $filler_posts;
 
 }
 
@@ -302,8 +302,8 @@ 
  * Adding `rest_api_init` action for network faceted-search
  */
 add_action( 'rest_api_init', function () {
-	register_rest_route( WL_REST_ROUTE_DEFAULT_NAMESPACE, '/faceted-search', array(
-		'methods'  => 'GET',
-		'callback' => 'wl_shortcode_faceted_search',
-	) );
+    register_rest_route( WL_REST_ROUTE_DEFAULT_NAMESPACE, '/faceted-search', array(
+        'methods'  => 'GET',
+        'callback' => 'wl_shortcode_faceted_search',
+    ) );
 } );

Spacing +75 added lines, -77 removed lines

@@ -16,7 +16,7 @@ 
  * @since 3.21.4 fix the cache key by also using the request body.
  * @since 3.21.2 add a caching layer.
  */
-function wl_shortcode_faceted_search( $request ) {
+function wl_shortcode_faceted_search($request) {
 
 	// Create the cache key.
 	$cache_key = array(
@@ -24,24 +24,24 @@ 
 	);
 
 	// Create the TTL cache and try to get the results.
-	$cache         = new Ttl_Cache( "faceted-search", 8 * 60 * 60 ); // 8 hours.
-	$cache_results = $cache->get( $cache_key );
+	$cache         = new Ttl_Cache("faceted-search", 8 * 60 * 60); // 8 hours.
+	$cache_results = $cache->get($cache_key);
 
-	if ( isset( $cache_results ) ) {
-		header( 'X-WordLift-Cache: HIT' );
-		wl_core_send_json( $cache_results );
+	if (isset($cache_results)) {
+		header('X-WordLift-Cache: HIT');
+		wl_core_send_json($cache_results);
 
 		return;
 	}
 
-	header( 'X-WordLift-Cache: MISS' );
+	header('X-WordLift-Cache: MISS');
 
-	$results = wl_shortcode_faceted_search_origin( $request );
+	$results = wl_shortcode_faceted_search_origin($request);
 
 	// Put the result before sending the json to the client, since sending the json will terminate us.
-	$cache->put( $cache_key, $results );
+	$cache->put($cache_key, $results);
 
-	wl_core_send_json( $results );
+	wl_core_send_json($results);
 
 }
 
@@ -51,20 +51,20 @@ 
  * @return array $results
  * @since        3.26.0
  */
-function wl_shortcode_faceted_search_origin( $request ) {
+function wl_shortcode_faceted_search_origin($request) {
 	// Post ID must be defined.
-	if ( ! isset( $_GET['post_id'] ) ) { // WPCS: input var ok; CSRF ok.
-		wp_die( 'No post_id given' );
+	if ( ! isset($_GET['post_id'])) { // WPCS: input var ok; CSRF ok.
+		wp_die('No post_id given');
 
 		return;
 	}
 
 	$current_post_id = $_GET['post_id']; // WPCS: input var ok; CSRF ok.
-	$current_post    = get_post( $current_post_id );
+	$current_post    = get_post($current_post_id);
 
 	// Post ID has to match an existing item.
-	if ( null === $current_post ) {
-		wp_die( 'No valid post_id given' );
+	if (null === $current_post) {
+		wp_die('No valid post_id given');
 
 		return;
 	}
@@ -73,19 +73,18 @@ 
 	// the current post is used as main entity.
 	// Otherwise, current post related entities are used.
 	$entity_service = Wordlift_Entity_Service::get_instance();
-	$entity_ids     = $entity_service->is_entity( $current_post->ID ) ?
-		array( $current_post->ID ) :
-		$entity_service->get_related_entities( $current_post->ID );
+	$entity_ids     = $entity_service->is_entity($current_post->ID) ?
+		array($current_post->ID) : $entity_service->get_related_entities($current_post->ID);
 
 	// If there are no entities we cannot render the widget.
-	if ( 0 === count( $entity_ids ) ) {
-		wp_die( 'No entities available' );
+	if (0 === count($entity_ids)) {
+		wp_die('No entities available');
 
 		return;
 	}
 
-	$limit = ( isset( $_GET['limit'] ) ) ? (int) $_GET['limit'] : 4;  // WPCS: input var ok; CSRF ok.
-	$amp   = ( isset( $_GET['amp'] ) ) ? true : false;
+	$limit = (isset($_GET['limit'])) ? (int) $_GET['limit'] : 4; // WPCS: input var ok; CSRF ok.
+	$amp   = (isset($_GET['amp'])) ? true : false;
 
 
 	/**
@@ -93,7 +92,7 @@ 
 	 * The ordering should be descending by date on default.
 	 */
 	$order_by = 'DESC';
-	if ( isset( $_GET['sort'] ) && is_string( $_GET['sort'] ) ) {
+	if (isset($_GET['sort']) && is_string($_GET['sort'])) {
 		$order_by = (string) $_GET['sort'];
 	}
 
@@ -102,25 +101,24 @@ 
 		'*',
 		null,
 		'publish',
-		array( $current_post_id ),
+		array($current_post_id),
 		$limit,
 		null,
 		$order_by
 	);
 
-	$referencing_post_ids = array_map( function ( $p ) {
+	$referencing_post_ids = array_map(function($p) {
 		return $p->ID;
-	}, $referencing_posts );
+	}, $referencing_posts);
 
 	$post_results   = array();
 	$entity_results = array();
 
 	// Populate $post_results
 
-	$filtered_posts = ( empty( $filtering_entity_uris ) ) ?
-		$referencing_posts :
-		Wordlift_Relation_Service::get_instance()->get_article_subjects(
-			wl_get_entity_post_ids_by_uris( $filtering_entity_uris ),
+	$filtered_posts = (empty($filtering_entity_uris)) ?
+		$referencing_posts : Wordlift_Relation_Service::get_instance()->get_article_subjects(
+			wl_get_entity_post_ids_by_uris($filtering_entity_uris),
 			'*',
 			null,
 			null,
@@ -129,8 +127,8 @@ 
 			$referencing_post_ids
 		);
 
-	if ( $filtered_posts ) {
-		foreach ( $filtered_posts as $post_obj ) {
+	if ($filtered_posts) {
+		foreach ($filtered_posts as $post_obj) {
 
 			/**
 			 * Use the thumbnail.
@@ -140,10 +138,10 @@ 
 			 *
 			 * @since 3.19.3 We're using the medium size image.
 			 */
-			$thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
-			$post_obj->thumbnail = ( $thumbnail ) ?
+			$thumbnail           = get_the_post_thumbnail_url($post_obj, 'medium');
+			$post_obj->thumbnail = ($thumbnail) ?
 				$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-			$post_obj->permalink = get_permalink( $post_obj->ID );
+			$post_obj->permalink = get_permalink($post_obj->ID);
 
 			$result         = $post_obj;
 			$post_results[] = $result;
@@ -152,12 +150,12 @@ 
 
 	// Add filler posts if needed
 
-	$filler_count         = $limit - count( $post_results );
-	$filler_posts         = wl_shortcode_faceted_search_filler_posts( $filler_count, $current_post_id, $referencing_post_ids );
-	$post_results         = array_merge( $post_results, $filler_posts );
-	$referencing_post_ids = array_map( function ( $post ) {
+	$filler_count         = $limit - count($post_results);
+	$filler_posts         = wl_shortcode_faceted_search_filler_posts($filler_count, $current_post_id, $referencing_post_ids);
+	$post_results         = array_merge($post_results, $filler_posts);
+	$referencing_post_ids = array_map(function($post) {
 		return $post->ID;
-	}, $post_results );
+	}, $post_results);
 
 	// Populate $entity_results
 
@@ -170,8 +168,8 @@ 
 	 * Make sure we have some referenced post, otherwise the IN parts of
 	 * the SQL will produce an SQL error.
 	 */
-	if ( ! empty( $referencing_post_ids ) ) {
-		$subject_ids = implode( ',', $referencing_post_ids );
+	if ( ! empty($referencing_post_ids)) {
+		$subject_ids = implode(',', $referencing_post_ids);
 
 		$query = "
 				SELECT
@@ -185,21 +183,21 @@ 
 				LIMIT $limit;
 			";
 
-		wl_write_log( "Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]" );
+		wl_write_log("Going to find related entities for the current post [ post ID :: $current_post_id ] [ query :: $query ]");
 
-		$entities = $wpdb->get_results( $query, OBJECT ); // No cache ok.
+		$entities = $wpdb->get_results($query, OBJECT); // No cache ok.
 
-		wl_write_log( 'Entities found ' . count( $entities ) );
+		wl_write_log('Entities found '.count($entities));
 
-		foreach ( $entities as $obj ) {
+		foreach ($entities as $obj) {
 
-			$entity = get_post( $obj->ID );
+			$entity = get_post($obj->ID);
 
 			// Ensure only valid and published entities are returned.
-			if ( ( null !== $entity ) && ( 'publish' === $entity->post_status ) ) {
+			if ((null !== $entity) && ('publish' === $entity->post_status)) {
 
-				$serialized_entity                    = wl_serialize_entity( $entity );
-				$serialized_entity['label']           = wl_shortcode_faceted_search_get_the_title( $obj->ID );
+				$serialized_entity                    = wl_serialize_entity($entity);
+				$serialized_entity['label']           = wl_shortcode_faceted_search_get_the_title($obj->ID);
 				$serialized_entity['counter']         = $obj->counter;
 				$serialized_entity['createdAt']       = $entity->post_date;
 				$serialized_entity['referencedPosts'] = Wordlift_Relation_Service::get_instance()->get_article_subjects(
@@ -211,42 +209,42 @@ 
 					null,
 					$referencing_post_ids
 				);
-				$entity_results[]                     = $serialized_entity;
+				$entity_results[] = $serialized_entity;
 			}
 		}
 	}
 
 	return array(
-		'posts'    => $amp ? array( array( 'values' => $post_results ) ) : $post_results,
+		'posts'    => $amp ? array(array('values' => $post_results)) : $post_results,
 		'entities' => $entity_results
 	);
 
 }
 
-function wl_shortcode_faceted_search_get_the_title( $post_id ) {
+function wl_shortcode_faceted_search_get_the_title($post_id) {
 
-	$title = get_the_title( $post_id );
+	$title = get_the_title($post_id);
 
-	if ( get_post_type( $post_id ) !== Wordlift_Entity_Service::TYPE_NAME ) {
-		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels( $post_id );
+	if (get_post_type($post_id) !== Wordlift_Entity_Service::TYPE_NAME) {
+		$alternative_labels = Wordlift_Entity_Service::get_instance()->get_alternative_labels($post_id);
 
-		if ( count( $alternative_labels ) > 0 ) {
+		if (count($alternative_labels) > 0) {
 			$title = $alternative_labels[0];
 		}
 	}
 
-	return remove_accents( $title );
+	return remove_accents($title);
 
 }
 
-function wl_shortcode_faceted_search_filler_posts( $filler_count, $current_post_id, $referencing_post_ids ) {
+function wl_shortcode_faceted_search_filler_posts($filler_count, $current_post_id, $referencing_post_ids) {
 
 	$filler_posts = array();
 
 	// First add latest posts from same categories as the current post
-	if ( $filler_count > 0 ) {
+	if ($filler_count > 0) {
 
-		$current_post_categories = wp_get_post_categories( $current_post_id );
+		$current_post_categories = wp_get_post_categories($current_post_id);
 
 		$args = array(
 			'meta_query'          => array(
@@ -256,20 +254,20 @@ 
 			),
 			'category__in'        => $current_post_categories,
 			'numberposts'         => $filler_count,
-			'post__not_in'        => array_merge( array( $current_post_id ), $referencing_post_ids ),
+			'post__not_in'        => array_merge(array($current_post_id), $referencing_post_ids),
 			'ignore_sticky_posts' => 1
 		);
 
-		$filler_posts = get_posts( $args );
+		$filler_posts = get_posts($args);
 	}
 
-	$filler_count    = $filler_count - count( $filler_posts );
-	$filler_post_ids = array_map( function ( $post ) {
+	$filler_count    = $filler_count - count($filler_posts);
+	$filler_post_ids = array_map(function($post) {
 		return $post->ID;
-	}, $filler_posts );
+	}, $filler_posts);
 
 	// If that does not fill, add latest posts irrespective of category
-	if ( $filler_count > 0 ) {
+	if ($filler_count > 0) {
 
 		$args = array(
 			'meta_query'          => array(
@@ -278,20 +276,20 @@ 
 				)
 			),
 			'numberposts'         => $filler_count,
-			'post__not_in'        => array_merge( array( $current_post_id ), $referencing_post_ids, $filler_post_ids ),
+			'post__not_in'        => array_merge(array($current_post_id), $referencing_post_ids, $filler_post_ids),
 			'ignore_sticky_posts' => 1
 		);
 
-		$filler_posts = array_merge( $filler_posts, get_posts( $args ) );
+		$filler_posts = array_merge($filler_posts, get_posts($args));
 
 	}
 
 	// Add thumbnail and permalink to filler posts
-	foreach ( $filler_posts as $post_obj ) {
-		$thumbnail           = get_the_post_thumbnail_url( $post_obj, 'medium' );
-		$post_obj->thumbnail = ( $thumbnail ) ?
+	foreach ($filler_posts as $post_obj) {
+		$thumbnail           = get_the_post_thumbnail_url($post_obj, 'medium');
+		$post_obj->thumbnail = ($thumbnail) ?
 			$thumbnail : WL_DEFAULT_THUMBNAIL_PATH;
-		$post_obj->permalink = get_permalink( $post_obj->ID );
+		$post_obj->permalink = get_permalink($post_obj->ID);
 	}
 
 	return $filler_posts;
@@ -301,9 +299,9 @@ 
 /**
  * Adding `rest_api_init` action for network faceted-search
  */
-add_action( 'rest_api_init', function () {
-	register_rest_route( WL_REST_ROUTE_DEFAULT_NAMESPACE, '/faceted-search', array(
+add_action('rest_api_init', function() {
+	register_rest_route(WL_REST_ROUTE_DEFAULT_NAMESPACE, '/faceted-search', array(
 		'methods'  => 'GET',
 		'callback' => 'wl_shortcode_faceted_search',
-	) );
+	));
 } );

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

Indentation +413 added lines, -413 removed lines

@@ -18,398 +18,398 @@ 
  */
 class Wordlift_Relation_Service {
 
-	/**
-	 * The singleton instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Relation_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * The relation table name in MySQL, set during instantiation.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var string $relation_table The relation table name.
-	 */
-	private $relation_table;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since 3.15.3
-	 *
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private static $log;
-
-	/**
-	 * Create a {@link Wordlift_Relation_Service} instance.
-	 *
-	 * @since 3.15.0
-	 */
-	public function __construct() {
-
-		self::$log = Wordlift_Log_Service::get_logger( get_class() );
-
-		global $wpdb;
-
-		// The relations table.
-		$this->relation_table = "{$wpdb->prefix}wl_relation_instances";
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance.
-	 *
-	 * @return \Wordlift_Relation_Service The {@link Wordlift_Relation_Service}
-	 *                                    singleton instance.
-	 * @since  3.15.0
-	 * @access public
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Get the articles referencing the specified entity {@link WP_Post}.
-	 *
-	 * @param int|array $object_id The entity {@link WP_Post}'s id.
-	 * @param string $fields The fields to return, 'ids' to only return ids or
-	 *                               '*' to return all fields, by default '*'.
-	 * @param null|string $predicate The predicate (who|what|...), by default all.
-	 * @param null|string $status The status, by default all.
-	 * @param array $excludes An array of ids to exclude from the results.
-	 * @param null|int $limit The maximum number of results, by default
-	 *                               no limit.
-	 * @param null|array $include The {@link WP_Post}s' ids to include.
-	 *
-	 * @param null | string $order_by
-	 *
-	 * @return array|object|null Database query results
-	 * @since 3.15.0
-	 *
-	 */
-	public function get_article_subjects( $object_id, $fields = '*', $predicate = null, $status = null, $excludes = array(), $limit = null, $include = null, $order_by = null ) {
-		global $wpdb;
-
-		// The output fields.
-		$actual_fields = self::fields( $fields );
-
-		self::$log->trace( 'Getting article subjects for object ' . implode( ', ', (array) $object_id ) . '...' );
-
-		$objects = $this->article_id_to_entity_id( $object_id );
-
-		// If there are no related objects, return an empty array.
-		if ( empty( $objects ) ) {
-			self::$log->debug( 'No entities found for object ' . implode( ', ', (array) $object_id ) . '.' );
-
-			return array();
-		}
-
-		self::$log->debug( count( $objects ) . ' entity id(s) found for object ' . implode( ', ', (array) $object_id ) . '.' );
-
-		$sql =
-			"
+    /**
+     * The singleton instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Relation_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * The relation table name in MySQL, set during instantiation.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var string $relation_table The relation table name.
+     */
+    private $relation_table;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since 3.15.3
+     *
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private static $log;
+
+    /**
+     * Create a {@link Wordlift_Relation_Service} instance.
+     *
+     * @since 3.15.0
+     */
+    public function __construct() {
+
+        self::$log = Wordlift_Log_Service::get_logger( get_class() );
+
+        global $wpdb;
+
+        // The relations table.
+        $this->relation_table = "{$wpdb->prefix}wl_relation_instances";
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance.
+     *
+     * @return \Wordlift_Relation_Service The {@link Wordlift_Relation_Service}
+     *                                    singleton instance.
+     * @since  3.15.0
+     * @access public
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Get the articles referencing the specified entity {@link WP_Post}.
+     *
+     * @param int|array $object_id The entity {@link WP_Post}'s id.
+     * @param string $fields The fields to return, 'ids' to only return ids or
+     *                               '*' to return all fields, by default '*'.
+     * @param null|string $predicate The predicate (who|what|...), by default all.
+     * @param null|string $status The status, by default all.
+     * @param array $excludes An array of ids to exclude from the results.
+     * @param null|int $limit The maximum number of results, by default
+     *                               no limit.
+     * @param null|array $include The {@link WP_Post}s' ids to include.
+     *
+     * @param null | string $order_by
+     *
+     * @return array|object|null Database query results
+     * @since 3.15.0
+     *
+     */
+    public function get_article_subjects( $object_id, $fields = '*', $predicate = null, $status = null, $excludes = array(), $limit = null, $include = null, $order_by = null ) {
+        global $wpdb;
+
+        // The output fields.
+        $actual_fields = self::fields( $fields );
+
+        self::$log->trace( 'Getting article subjects for object ' . implode( ', ', (array) $object_id ) . '...' );
+
+        $objects = $this->article_id_to_entity_id( $object_id );
+
+        // If there are no related objects, return an empty array.
+        if ( empty( $objects ) ) {
+            self::$log->debug( 'No entities found for object ' . implode( ', ', (array) $object_id ) . '.' );
+
+            return array();
+        }
+
+        self::$log->debug( count( $objects ) . ' entity id(s) found for object ' . implode( ', ', (array) $object_id ) . '.' );
+
+        $sql =
+            "
 			SELECT DISTINCT p.$actual_fields
 			FROM {$this->relation_table} r
 			INNER JOIN $wpdb->posts p
 				ON p.id = r.subject_id
 			"
-			// Add the status clause.
-			. self::and_status( $status )
-			. self::inner_join_is_article()
-			. self::where_object_id( $objects )
-			// Since `object_id` can be an article ID we need to exclude it from
-			// the results.
-			. self::and_article_not_in( array_merge( $excludes, (array) $object_id ) )
-			. self::and_article_in( $include )
-			. self::and_post_type_in()
-			. self::and_predicate( $predicate )
-			. self::order_by( $order_by )
-			. self::limit( $limit );
-
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
-	}
-
-	/**
-	 * The `post_type IN` clause.
-	 *
-	 * @return string The `post_type IN` clause.
-	 * @since 3.15.3
-	 *
-	 */
-	private static function and_post_type_in() {
-
-		return " AND p.post_type IN ( '"
-		       . implode(
-			       "','",
-			       array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() )
-		       )
-		       . "' )";
-	}
-
-	/**
-	 * Add the limit clause if specified.
-	 *
-	 * @param null|int $limit The maximum number of results.
-	 *
-	 * @return string The limit clause (empty if no limit has been specified).
-	 * @since 3.15.0
-	 *
-	 */
-	private static function limit( $limit = null ) {
-
-		if ( null === $limit ) {
-			return '';
-		}
-
-		return "LIMIT $limit";
-	}
-
-	/**
-	 * @param $order_by string | null
-	 *
-	 * @return string
-	 */
-	private static function order_by( $order_by ) {
-		if ( ! $order_by ) {
-			return '';
-		}
-		$order_by         = (string) $order_by;
-		$order_by_clauses = array( 'DESC', 'ASC' );
-
-		if ( in_array( $order_by, $order_by_clauses, true ) ) {
-			return " ORDER BY p.post_modified ${order_by} ";
-		} else {
-			return ' ORDER BY p.post_modified DESC ';
-		}
-	}
-
-	/**
-	 * Map the provided ids into entities (i.e. return the id if it's an entity
-	 * or get the entities if it's a post).
-	 *
-	 * @param int|array $object_id An array of posts/entities' ids.
-	 *
-	 * @return array An array of entities' ids.
-	 * @since 3.15.0
-	 *
-	 */
-	private function article_id_to_entity_id( $object_id ) {
-
-		$entity_service = Wordlift_Entity_Service::get_instance();
-
-		$relation_service = $this;
-
-		return array_reduce( (array) $object_id, function ( $carry, $item ) use ( $entity_service, $relation_service ) {
-			if ( $entity_service->is_entity( $item ) ) {
-				return array_merge( $carry, (array) $item );
-			}
-
-			return array_merge( $carry, $relation_service->get_objects( $item, 'ids' ) );
-		}, array() );
-
-	}
-
-	/**
-	 * Add the WHERE clause.
-	 *
-	 * @param int|array $object_id An array of {@link WP_Post}s' ids.
-	 *
-	 * @return string The WHERE clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function where_object_id( $object_id ) {
-
-		if ( empty( $object_id ) ) {
-			// self::$log->warn( sprintf( "%s `where_object_id` called with empty `object_id`.", var_export( debug_backtrace( false, 3 ), true ) ) );
-
-			return ' WHERE 1 = 1';
-		}
-
-		return ' WHERE r.object_id IN ( ' . implode( ',', wp_parse_id_list( (array) $object_id ) ) . ' )';
-	}
-
-	/**
-	 * Add the exclude clause.
-	 *
-	 * @param int|array $exclude An array of {@link WP_Post}s' ids to exclude.
-	 *
-	 * @return string The exclude clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function and_article_not_in( $exclude ) {
-
-		return ' AND NOT p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $exclude ) ) . ' )';
-	}
-
-	/**
-	 * Add the include clause.
-	 *
-	 * @param null|int|array $include An array of {@link WP_Post}s' ids.
-	 *
-	 * @return string An empty string if $include is null otherwise the include
-	 *                clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function and_article_in( $include = null ) {
-
-		if ( null === $include ) {
-			return '';
-		}
-
-		return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $include ) ) . ' )';
-	}
-
-	/**
-	 * Get the entities' {@link WP_Post}s' ids referencing the specified {@link WP_Post}.
-	 *
-	 * @param int $object_id The object {@link WP_Post}'s id.
-	 * @param string $fields The fields to return, 'ids' to only return ids or
-	 *                               '*' to return all fields, by default '*'.
-	 * @param null|string $status The status, by default all.
-	 *
-	 * @return array|object|null Database query results
-	 * @since 3.15.0
-	 *
-	 */
-	public function get_non_article_subjects( $object_id, $fields = '*', $status = null ) {
-		global $wpdb;
-
-		// The output fields.
-		$actual_fields = self::fields( $fields );
-
-		$sql = $wpdb->prepare(
-			"
+            // Add the status clause.
+            . self::and_status( $status )
+            . self::inner_join_is_article()
+            . self::where_object_id( $objects )
+            // Since `object_id` can be an article ID we need to exclude it from
+            // the results.
+            . self::and_article_not_in( array_merge( $excludes, (array) $object_id ) )
+            . self::and_article_in( $include )
+            . self::and_post_type_in()
+            . self::and_predicate( $predicate )
+            . self::order_by( $order_by )
+            . self::limit( $limit );
+
+        return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
+    }
+
+    /**
+     * The `post_type IN` clause.
+     *
+     * @return string The `post_type IN` clause.
+     * @since 3.15.3
+     *
+     */
+    private static function and_post_type_in() {
+
+        return " AND p.post_type IN ( '"
+                . implode(
+                    "','",
+                    array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() )
+                )
+                . "' )";
+    }
+
+    /**
+     * Add the limit clause if specified.
+     *
+     * @param null|int $limit The maximum number of results.
+     *
+     * @return string The limit clause (empty if no limit has been specified).
+     * @since 3.15.0
+     *
+     */
+    private static function limit( $limit = null ) {
+
+        if ( null === $limit ) {
+            return '';
+        }
+
+        return "LIMIT $limit";
+    }
+
+    /**
+     * @param $order_by string | null
+     *
+     * @return string
+     */
+    private static function order_by( $order_by ) {
+        if ( ! $order_by ) {
+            return '';
+        }
+        $order_by         = (string) $order_by;
+        $order_by_clauses = array( 'DESC', 'ASC' );
+
+        if ( in_array( $order_by, $order_by_clauses, true ) ) {
+            return " ORDER BY p.post_modified ${order_by} ";
+        } else {
+            return ' ORDER BY p.post_modified DESC ';
+        }
+    }
+
+    /**
+     * Map the provided ids into entities (i.e. return the id if it's an entity
+     * or get the entities if it's a post).
+     *
+     * @param int|array $object_id An array of posts/entities' ids.
+     *
+     * @return array An array of entities' ids.
+     * @since 3.15.0
+     *
+     */
+    private function article_id_to_entity_id( $object_id ) {
+
+        $entity_service = Wordlift_Entity_Service::get_instance();
+
+        $relation_service = $this;
+
+        return array_reduce( (array) $object_id, function ( $carry, $item ) use ( $entity_service, $relation_service ) {
+            if ( $entity_service->is_entity( $item ) ) {
+                return array_merge( $carry, (array) $item );
+            }
+
+            return array_merge( $carry, $relation_service->get_objects( $item, 'ids' ) );
+        }, array() );
+
+    }
+
+    /**
+     * Add the WHERE clause.
+     *
+     * @param int|array $object_id An array of {@link WP_Post}s' ids.
+     *
+     * @return string The WHERE clause.
+     * @since 3.15.0
+     *
+     */
+    private static function where_object_id( $object_id ) {
+
+        if ( empty( $object_id ) ) {
+            // self::$log->warn( sprintf( "%s `where_object_id` called with empty `object_id`.", var_export( debug_backtrace( false, 3 ), true ) ) );
+
+            return ' WHERE 1 = 1';
+        }
+
+        return ' WHERE r.object_id IN ( ' . implode( ',', wp_parse_id_list( (array) $object_id ) ) . ' )';
+    }
+
+    /**
+     * Add the exclude clause.
+     *
+     * @param int|array $exclude An array of {@link WP_Post}s' ids to exclude.
+     *
+     * @return string The exclude clause.
+     * @since 3.15.0
+     *
+     */
+    private static function and_article_not_in( $exclude ) {
+
+        return ' AND NOT p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $exclude ) ) . ' )';
+    }
+
+    /**
+     * Add the include clause.
+     *
+     * @param null|int|array $include An array of {@link WP_Post}s' ids.
+     *
+     * @return string An empty string if $include is null otherwise the include
+     *                clause.
+     * @since 3.15.0
+     *
+     */
+    private static function and_article_in( $include = null ) {
+
+        if ( null === $include ) {
+            return '';
+        }
+
+        return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $include ) ) . ' )';
+    }
+
+    /**
+     * Get the entities' {@link WP_Post}s' ids referencing the specified {@link WP_Post}.
+     *
+     * @param int $object_id The object {@link WP_Post}'s id.
+     * @param string $fields The fields to return, 'ids' to only return ids or
+     *                               '*' to return all fields, by default '*'.
+     * @param null|string $status The status, by default all.
+     *
+     * @return array|object|null Database query results
+     * @since 3.15.0
+     *
+     */
+    public function get_non_article_subjects( $object_id, $fields = '*', $status = null ) {
+        global $wpdb;
+
+        // The output fields.
+        $actual_fields = self::fields( $fields );
+
+        $sql = $wpdb->prepare(
+            "
 			SELECT p.$actual_fields
 			FROM {$this->relation_table} r
 			INNER JOIN $wpdb->posts p
 				ON p.id = r.subject_id
 			"
-			// Add the status clause.
-			. self::and_status( $status )
-			. self::inner_join_is_not_article()
-			. " WHERE r.object_id = %d "
-			. self::and_post_type_in()
-			,
-			$object_id
-		);
-
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
-	}
-
-	/**
-	 * Get the entities referenced by the specified {@link WP_Post}.
-	 *
-	 * @param int $subject_id The {@link WP_Post}'s id.
-	 * @param string $fields The fields to return, 'ids' to only return ids or
-	 *                                '*' to return all fields, by default '*'.
-	 * @param null|string $predicate The predicate (who|what|...), by default all.
-	 * @param null|string $status The status, by default all.
-	 *
-	 * @return array|object|null Database query results
-	 * @since 3.15.0
-	 *
-	 */
-	public function get_objects( $subject_id, $fields = '*', $predicate = null, $status = null ) {
-		global $wpdb;
-
-		// The output fields.
-		$actual_fields = self::fields( $fields );
-
-		$sql = $wpdb->prepare(
-			"
+            // Add the status clause.
+            . self::and_status( $status )
+            . self::inner_join_is_not_article()
+            . " WHERE r.object_id = %d "
+            . self::and_post_type_in()
+            ,
+            $object_id
+        );
+
+        return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
+    }
+
+    /**
+     * Get the entities referenced by the specified {@link WP_Post}.
+     *
+     * @param int $subject_id The {@link WP_Post}'s id.
+     * @param string $fields The fields to return, 'ids' to only return ids or
+     *                                '*' to return all fields, by default '*'.
+     * @param null|string $predicate The predicate (who|what|...), by default all.
+     * @param null|string $status The status, by default all.
+     *
+     * @return array|object|null Database query results
+     * @since 3.15.0
+     *
+     */
+    public function get_objects( $subject_id, $fields = '*', $predicate = null, $status = null ) {
+        global $wpdb;
+
+        // The output fields.
+        $actual_fields = self::fields( $fields );
+
+        $sql = $wpdb->prepare(
+            "
 			SELECT p.$actual_fields
 			FROM {$this->relation_table} r
 			INNER JOIN $wpdb->posts p
 				ON p.id = r.object_id
 			"
-			// Add the status clause.
-			. self::and_status( $status )
-			. self::inner_join_is_not_article()
-			. " WHERE r.subject_id = %d "
-			. self::and_post_type_in()
-			. self::and_predicate( $predicate )
-			,
-			$subject_id
-		);
-
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
-	}
-
-	/**
-	 * Add the `post_status` clause.
-	 *
-	 * @param null|string|array $status The status values.
-	 *
-	 * @return string An empty string if $status is null, otherwise the status clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function and_status( $status = null ) {
-
-		if ( null === $status ) {
-			return '';
-		}
-
-		return " AND p.post_status IN ('" . implode( "', '", array_map( 'esc_sql', (array) $status ) ) . "')";
-	}
-
-	/**
-	 * Add the `predicate` clause.
-	 *
-	 * @param null|string|array $predicate An array of predicates.
-	 *
-	 * @return string An empty string if $predicate is null otherwise the predicate
-	 *                clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function and_predicate( $predicate = null ) {
-
-		if ( null === $predicate ) {
-			return '';
-		}
-
-		return " AND r.predicate IN ('" . implode( "', '", array_map( 'esc_sql', (array) $predicate ) ) . "')";
-	}
-
-	/**
-	 * The select fields.
-	 *
-	 * @param string $fields Either 'ids' or '*', by default '*'.
-	 *
-	 * @return string The `id` field if `ids` otherwise `*`.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function fields( $fields = '*' ) {
-
-		// The output fields.
-		return 'ids' === $fields ? 'id' : '*';
-	}
-
-	/**
-	 * The inner join clause for articles.
-	 *
-	 * @return string The articles inner join clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function inner_join_is_article() {
-		global $wpdb;
-
-		return $wpdb->prepare(
-			"
+            // Add the status clause.
+            . self::and_status( $status )
+            . self::inner_join_is_not_article()
+            . " WHERE r.subject_id = %d "
+            . self::and_post_type_in()
+            . self::and_predicate( $predicate )
+            ,
+            $subject_id
+        );
+
+        return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
+    }
+
+    /**
+     * Add the `post_status` clause.
+     *
+     * @param null|string|array $status The status values.
+     *
+     * @return string An empty string if $status is null, otherwise the status clause.
+     * @since 3.15.0
+     *
+     */
+    private static function and_status( $status = null ) {
+
+        if ( null === $status ) {
+            return '';
+        }
+
+        return " AND p.post_status IN ('" . implode( "', '", array_map( 'esc_sql', (array) $status ) ) . "')";
+    }
+
+    /**
+     * Add the `predicate` clause.
+     *
+     * @param null|string|array $predicate An array of predicates.
+     *
+     * @return string An empty string if $predicate is null otherwise the predicate
+     *                clause.
+     * @since 3.15.0
+     *
+     */
+    private static function and_predicate( $predicate = null ) {
+
+        if ( null === $predicate ) {
+            return '';
+        }
+
+        return " AND r.predicate IN ('" . implode( "', '", array_map( 'esc_sql', (array) $predicate ) ) . "')";
+    }
+
+    /**
+     * The select fields.
+     *
+     * @param string $fields Either 'ids' or '*', by default '*'.
+     *
+     * @return string The `id` field if `ids` otherwise `*`.
+     * @since 3.15.0
+     *
+     */
+    private static function fields( $fields = '*' ) {
+
+        // The output fields.
+        return 'ids' === $fields ? 'id' : '*';
+    }
+
+    /**
+     * The inner join clause for articles.
+     *
+     * @return string The articles inner join clause.
+     * @since 3.15.0
+     *
+     */
+    private static function inner_join_is_article() {
+        global $wpdb;
+
+        return $wpdb->prepare(
+            "
 			INNER JOIN $wpdb->term_relationships tr
 			 ON p.id = tr.object_id
 			INNER JOIN $wpdb->term_taxonomy tt
@@ -419,23 +419,23 @@ 
 			 ON t.term_id = tt.term_id
 			  AND t.slug = %s
 			",
-			'wl_entity_type',
-			'article'
-		);
-	}
-
-	/**
-	 * The inner join clause for non-articles.
-	 *
-	 * @return string The non-articles inner join clause.
-	 * @since 3.15.0
-	 *
-	 */
-	private static function inner_join_is_not_article() {
-		global $wpdb;
-
-		return $wpdb->prepare(
-			"
+            'wl_entity_type',
+            'article'
+        );
+    }
+
+    /**
+     * The inner join clause for non-articles.
+     *
+     * @return string The non-articles inner join clause.
+     * @since 3.15.0
+     *
+     */
+    private static function inner_join_is_not_article() {
+        global $wpdb;
+
+        return $wpdb->prepare(
+            "
 			INNER JOIN $wpdb->term_relationships tr
 			 ON p.id = tr.object_id
 			INNER JOIN $wpdb->term_taxonomy tt
@@ -445,29 +445,29 @@ 
 			 ON t.term_id = tt.term_id
 			  AND NOT t.slug = %s
 			",
-			'wl_entity_type',
-			'article'
-		);
-	}
-
-	/**
-	 * Find all the subject IDs and their referenced/related object IDs. The
-	 * object IDs are returned as comma separated IDs in the `object_ids` key.
-	 *
-	 * @return mixed Database query results
-	 * @since 3.18.0
-	 */
-	public function find_all_grouped_by_subject_id() {
-		global $wpdb;
-
-		return $wpdb->get_results(
-			"
+            'wl_entity_type',
+            'article'
+        );
+    }
+
+    /**
+     * Find all the subject IDs and their referenced/related object IDs. The
+     * object IDs are returned as comma separated IDs in the `object_ids` key.
+     *
+     * @return mixed Database query results
+     * @since 3.18.0
+     */
+    public function find_all_grouped_by_subject_id() {
+        global $wpdb;
+
+        return $wpdb->get_results(
+            "
 			SELECT subject_id, GROUP_CONCAT( DISTINCT object_id ORDER BY object_id SEPARATOR ',' ) AS object_ids
 			FROM $this->relation_table
 			GROUP BY subject_id
 			"
-		);
+        );
 
-	}
+    }
 
 }

Spacing +53 added lines, -53 removed lines

@@ -52,7 +52,7 @@ 
 	 */
 	public function __construct() {
 
-		self::$log = Wordlift_Log_Service::get_logger( get_class() );
+		self::$log = Wordlift_Log_Service::get_logger(get_class());
 
 		global $wpdb;
 
@@ -95,24 +95,24 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public function get_article_subjects( $object_id, $fields = '*', $predicate = null, $status = null, $excludes = array(), $limit = null, $include = null, $order_by = null ) {
+	public function get_article_subjects($object_id, $fields = '*', $predicate = null, $status = null, $excludes = array(), $limit = null, $include = null, $order_by = null) {
 		global $wpdb;
 
 		// The output fields.
-		$actual_fields = self::fields( $fields );
+		$actual_fields = self::fields($fields);
 
-		self::$log->trace( 'Getting article subjects for object ' . implode( ', ', (array) $object_id ) . '...' );
+		self::$log->trace('Getting article subjects for object '.implode(', ', (array) $object_id).'...');
 
-		$objects = $this->article_id_to_entity_id( $object_id );
+		$objects = $this->article_id_to_entity_id($object_id);
 
 		// If there are no related objects, return an empty array.
-		if ( empty( $objects ) ) {
-			self::$log->debug( 'No entities found for object ' . implode( ', ', (array) $object_id ) . '.' );
+		if (empty($objects)) {
+			self::$log->debug('No entities found for object '.implode(', ', (array) $object_id).'.');
 
 			return array();
 		}
 
-		self::$log->debug( count( $objects ) . ' entity id(s) found for object ' . implode( ', ', (array) $object_id ) . '.' );
+		self::$log->debug(count($objects).' entity id(s) found for object '.implode(', ', (array) $object_id).'.');
 
 		$sql =
 			"
@@ -122,19 +122,19 @@ 
 				ON p.id = r.subject_id
 			"
 			// Add the status clause.
-			. self::and_status( $status )
+			. self::and_status($status)
 			. self::inner_join_is_article()
-			. self::where_object_id( $objects )
+			. self::where_object_id($objects)
 			// Since `object_id` can be an article ID we need to exclude it from
 			// the results.
-			. self::and_article_not_in( array_merge( $excludes, (array) $object_id ) )
-			. self::and_article_in( $include )
+			. self::and_article_not_in(array_merge($excludes, (array) $object_id))
+			. self::and_article_in($include)
 			. self::and_post_type_in()
-			. self::and_predicate( $predicate )
-			. self::order_by( $order_by )
-			. self::limit( $limit );
+			. self::and_predicate($predicate)
+			. self::order_by($order_by)
+			. self::limit($limit);
 
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
+		return '*' === $actual_fields ? $wpdb->get_results($sql) : $wpdb->get_col($sql);
 	}
 
 	/**
@@ -149,7 +149,7 @@ 
 		return " AND p.post_type IN ( '"
 		       . implode(
 			       "','",
-			       array_map( 'esc_sql', Wordlift_Entity_Service::valid_entity_post_types() )
+			       array_map('esc_sql', Wordlift_Entity_Service::valid_entity_post_types())
 		       )
 		       . "' )";
 	}
@@ -163,9 +163,9 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function limit( $limit = null ) {
+	private static function limit($limit = null) {
 
-		if ( null === $limit ) {
+		if (null === $limit) {
 			return '';
 		}
 
@@ -177,14 +177,14 @@ 
 	 *
 	 * @return string
 	 */
-	private static function order_by( $order_by ) {
-		if ( ! $order_by ) {
+	private static function order_by($order_by) {
+		if ( ! $order_by) {
 			return '';
 		}
 		$order_by         = (string) $order_by;
-		$order_by_clauses = array( 'DESC', 'ASC' );
+		$order_by_clauses = array('DESC', 'ASC');
 
-		if ( in_array( $order_by, $order_by_clauses, true ) ) {
+		if (in_array($order_by, $order_by_clauses, true)) {
 			return " ORDER BY p.post_modified ${order_by} ";
 		} else {
 			return ' ORDER BY p.post_modified DESC ';
@@ -201,19 +201,19 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private function article_id_to_entity_id( $object_id ) {
+	private function article_id_to_entity_id($object_id) {
 
 		$entity_service = Wordlift_Entity_Service::get_instance();
 
 		$relation_service = $this;
 
-		return array_reduce( (array) $object_id, function ( $carry, $item ) use ( $entity_service, $relation_service ) {
-			if ( $entity_service->is_entity( $item ) ) {
-				return array_merge( $carry, (array) $item );
+		return array_reduce((array) $object_id, function($carry, $item) use ($entity_service, $relation_service) {
+			if ($entity_service->is_entity($item)) {
+				return array_merge($carry, (array) $item);
 			}
 
-			return array_merge( $carry, $relation_service->get_objects( $item, 'ids' ) );
-		}, array() );
+			return array_merge($carry, $relation_service->get_objects($item, 'ids'));
+		}, array());
 
 	}
 
@@ -226,15 +226,15 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function where_object_id( $object_id ) {
+	private static function where_object_id($object_id) {
 
-		if ( empty( $object_id ) ) {
+		if (empty($object_id)) {
 			// self::$log->warn( sprintf( "%s `where_object_id` called with empty `object_id`.", var_export( debug_backtrace( false, 3 ), true ) ) );
 
 			return ' WHERE 1 = 1';
 		}
 
-		return ' WHERE r.object_id IN ( ' . implode( ',', wp_parse_id_list( (array) $object_id ) ) . ' )';
+		return ' WHERE r.object_id IN ( '.implode(',', wp_parse_id_list((array) $object_id)).' )';
 	}
 
 	/**
@@ -246,9 +246,9 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function and_article_not_in( $exclude ) {
+	private static function and_article_not_in($exclude) {
 
-		return ' AND NOT p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $exclude ) ) . ' )';
+		return ' AND NOT p.ID IN ( '.implode(',', wp_parse_id_list((array) $exclude)).' )';
 	}
 
 	/**
@@ -261,13 +261,13 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function and_article_in( $include = null ) {
+	private static function and_article_in($include = null) {
 
-		if ( null === $include ) {
+		if (null === $include) {
 			return '';
 		}
 
-		return ' AND p.ID IN ( ' . implode( ',', wp_parse_id_list( (array) $include ) ) . ' )';
+		return ' AND p.ID IN ( '.implode(',', wp_parse_id_list((array) $include)).' )';
 	}
 
 	/**
@@ -282,11 +282,11 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public function get_non_article_subjects( $object_id, $fields = '*', $status = null ) {
+	public function get_non_article_subjects($object_id, $fields = '*', $status = null) {
 		global $wpdb;
 
 		// The output fields.
-		$actual_fields = self::fields( $fields );
+		$actual_fields = self::fields($fields);
 
 		$sql = $wpdb->prepare(
 			"
@@ -296,7 +296,7 @@ 
 				ON p.id = r.subject_id
 			"
 			// Add the status clause.
-			. self::and_status( $status )
+			. self::and_status($status)
 			. self::inner_join_is_not_article()
 			. " WHERE r.object_id = %d "
 			. self::and_post_type_in()
@@ -304,7 +304,7 @@ 
 			$object_id
 		);
 
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
+		return '*' === $actual_fields ? $wpdb->get_results($sql) : $wpdb->get_col($sql);
 	}
 
 	/**
@@ -320,11 +320,11 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	public function get_objects( $subject_id, $fields = '*', $predicate = null, $status = null ) {
+	public function get_objects($subject_id, $fields = '*', $predicate = null, $status = null) {
 		global $wpdb;
 
 		// The output fields.
-		$actual_fields = self::fields( $fields );
+		$actual_fields = self::fields($fields);
 
 		$sql = $wpdb->prepare(
 			"
@@ -334,16 +334,16 @@ 
 				ON p.id = r.object_id
 			"
 			// Add the status clause.
-			. self::and_status( $status )
+			. self::and_status($status)
 			. self::inner_join_is_not_article()
 			. " WHERE r.subject_id = %d "
 			. self::and_post_type_in()
-			. self::and_predicate( $predicate )
+			. self::and_predicate($predicate)
 			,
 			$subject_id
 		);
 
-		return '*' === $actual_fields ? $wpdb->get_results( $sql ) : $wpdb->get_col( $sql );
+		return '*' === $actual_fields ? $wpdb->get_results($sql) : $wpdb->get_col($sql);
 	}
 
 	/**
@@ -355,13 +355,13 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function and_status( $status = null ) {
+	private static function and_status($status = null) {
 
-		if ( null === $status ) {
+		if (null === $status) {
 			return '';
 		}
 
-		return " AND p.post_status IN ('" . implode( "', '", array_map( 'esc_sql', (array) $status ) ) . "')";
+		return " AND p.post_status IN ('".implode("', '", array_map('esc_sql', (array) $status))."')";
 	}
 
 	/**
@@ -374,13 +374,13 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function and_predicate( $predicate = null ) {
+	private static function and_predicate($predicate = null) {
 
-		if ( null === $predicate ) {
+		if (null === $predicate) {
 			return '';
 		}
 
-		return " AND r.predicate IN ('" . implode( "', '", array_map( 'esc_sql', (array) $predicate ) ) . "')";
+		return " AND r.predicate IN ('".implode("', '", array_map('esc_sql', (array) $predicate))."')";
 	}
 
 	/**
@@ -392,7 +392,7 @@ 
 	 * @since 3.15.0
 	 *
 	 */
-	private static function fields( $fields = '*' ) {
+	private static function fields($fields = '*') {
 
 		// The output fields.
 		return 'ids' === $fields ? 'id' : '*';