insideout10 / wordlift-plugin

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

Doc Comments +1 added lines, -1 removed lines

@@ -313,7 +313,7 @@
 	/**
 	 * Convert the date to a date array.
 	 *
-	 * @param $value int A date value.
+	 * @param integer $value int A date value.
 	 *
 	 * @return array An array containing year, month and day values.
 	 * @since 3.7.0

Indentation +358 added lines, -358 removed lines

@@ -16,131 +16,131 @@ 
  */
 class Wordlift_Timeline_Service {
 
-	/**
-	 * The Log service.
-	 *
-	 * @since  3.1.0
-	 * @access private
-	 * @var \Wordlift_Log_Service $log The Log service.
-	 */
-	private $log;
-
-	/**
-	 * The Entity service.
-	 *
-	 * @since  3.1.0
-	 * @access private
-	 * @var \Wordlift_Entity_Service $entity_service The Entity service.
-	 */
-	private $entity_service;
-
-	/**
-	 * The number of words to use for the excerpt, set in the `to_json` function
-	 * and used by a filter.
-	 *
-	 * @since  3.7.0
-	 * @access private
-	 * @var int $excerpt_length The number of words to use for the excerpt.
-	 */
-	private $excerpt_length;
-
-	/**
-	 * The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.15.0
-	 * @access private
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	private $entity_type_service;
-
-	/**
-	 * A singleton instance of the Timeline service (useful for unit tests).
-	 *
-	 * @since  3.1.0
-	 * @access private
-	 * @var \Wordlift_Timeline_Service $instance The singleton instance.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a Wordlift_Timeline_Service instance.
-	 *
-	 * @param \Wordlift_Entity_Service $entity_service The Entity service.
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since 3.1.0
-	 *
-	 */
-	public function __construct( $entity_service, $entity_type_service ) {
-
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
-
-		$this->entity_service      = $entity_service;
-		$this->entity_type_service = $entity_type_service;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance of the Wordlift_Timeline_Service
-	 *
-	 * @return \Wordlift_Timeline_Service The singleton instance of the Wordlift_Timeline_Service.
-	 * @since 3.1.0
-	 *
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Retrieve timeline events and output them in JSON.
-	 *
-	 * @since 3.1.0
-	 */
-	public function ajax_timeline() {
-
-		// Get the ID of the post who requested the timeline.
-		$post_id = ( isset( $_REQUEST['post_id'] ) ? $_REQUEST['post_id'] : null );
-
-		// Get the events and transform them for the JSON response, then send them to the client.
-		wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
-
-	}
-
-	/**
-	 * Retrieve timeline events.
-	 *
-	 * @param int $post_id The post ID.
-	 *
-	 * @return array An array of event posts.
-	 * @since 3.1.0
-	 *
-	 * @uses  wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
-	 *
-	 */
-	public function get_events( $post_id = null ) {
-
-		// Get the entity IDs either from the entities related to the specified post or from the last 50 published
-		// posts if no post has been specified.
-		$ids = ( is_numeric( $post_id )
-			? wl_core_get_related_entity_ids( $post_id )
-			: $this->get_all_related_to_last_50_published_posts() );
-
-		// Add the post itself if it's an entity.
-		if ( is_numeric( $post_id ) && $this->entity_service->is_entity( $post_id ) ) {
-			$ids[] = $post_id;
-		}
-
-		// If there's no entities, return an empty array right away.
-		if ( 0 === sizeof( $ids ) ) {
-			$this->log->trace( "No events found [ post id :: $post_id ]" );
-
-			return array();
-		}
-
-		$this->log->trace( 'Getting events [ entity ids :: ' . join( ', ', $ids ) . ' ]' );
+    /**
+     * The Log service.
+     *
+     * @since  3.1.0
+     * @access private
+     * @var \Wordlift_Log_Service $log The Log service.
+     */
+    private $log;
+
+    /**
+     * The Entity service.
+     *
+     * @since  3.1.0
+     * @access private
+     * @var \Wordlift_Entity_Service $entity_service The Entity service.
+     */
+    private $entity_service;
+
+    /**
+     * The number of words to use for the excerpt, set in the `to_json` function
+     * and used by a filter.
+     *
+     * @since  3.7.0
+     * @access private
+     * @var int $excerpt_length The number of words to use for the excerpt.
+     */
+    private $excerpt_length;
+
+    /**
+     * The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.15.0
+     * @access private
+     * @var \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     */
+    private $entity_type_service;
+
+    /**
+     * A singleton instance of the Timeline service (useful for unit tests).
+     *
+     * @since  3.1.0
+     * @access private
+     * @var \Wordlift_Timeline_Service $instance The singleton instance.
+     */
+    private static $instance;
+
+    /**
+     * Create a Wordlift_Timeline_Service instance.
+     *
+     * @param \Wordlift_Entity_Service $entity_service The Entity service.
+     * @param \Wordlift_Entity_Type_Service $entity_type_service The {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since 3.1.0
+     *
+     */
+    public function __construct( $entity_service, $entity_type_service ) {
+
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
+
+        $this->entity_service      = $entity_service;
+        $this->entity_type_service = $entity_type_service;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance of the Wordlift_Timeline_Service
+     *
+     * @return \Wordlift_Timeline_Service The singleton instance of the Wordlift_Timeline_Service.
+     * @since 3.1.0
+     *
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Retrieve timeline events and output them in JSON.
+     *
+     * @since 3.1.0
+     */
+    public function ajax_timeline() {
+
+        // Get the ID of the post who requested the timeline.
+        $post_id = ( isset( $_REQUEST['post_id'] ) ? $_REQUEST['post_id'] : null );
+
+        // Get the events and transform them for the JSON response, then send them to the client.
+        wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
+
+    }
+
+    /**
+     * Retrieve timeline events.
+     *
+     * @param int $post_id The post ID.
+     *
+     * @return array An array of event posts.
+     * @since 3.1.0
+     *
+     * @uses  wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
+     *
+     */
+    public function get_events( $post_id = null ) {
+
+        // Get the entity IDs either from the entities related to the specified post or from the last 50 published
+        // posts if no post has been specified.
+        $ids = ( is_numeric( $post_id )
+            ? wl_core_get_related_entity_ids( $post_id )
+            : $this->get_all_related_to_last_50_published_posts() );
+
+        // Add the post itself if it's an entity.
+        if ( is_numeric( $post_id ) && $this->entity_service->is_entity( $post_id ) ) {
+            $ids[] = $post_id;
+        }
+
+        // If there's no entities, return an empty array right away.
+        if ( 0 === sizeof( $ids ) ) {
+            $this->log->trace( "No events found [ post id :: $post_id ]" );
+
+            return array();
+        }
+
+        $this->log->trace( 'Getting events [ entity ids :: ' . join( ', ', $ids ) . ' ]' );
 
 //		$entity_type_service = $this->entity_type_service;
 
@@ -152,238 +152,238 @@ 
 //			return $entity_type_service->has_entity_type( $item, 'http://schema.org/Event' );
 //		} ) );
 
-		$args = array(
-			'post__in'       => $ids,
-			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
-			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
-			'meta_query'     => array(
-				'relation' => 'AND',
-				array(
-					'key'     => Wordlift_Schema_Service::FIELD_DATE_START,
-					'value'   => null,
-					'compare' => '!=',
-				),
-				array(
-					'key'     => Wordlift_Schema_Service::FIELD_DATE_END,
-					'value'   => null,
-					'compare' => '!=',
-				),
-			),
-			'tax_query'      => array(
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => 'event',
-				),
-			),
-		);
-
-		return get_posts( $args );
-	}
-
-	/**
-	 * Convert timeline events to JSON. This function sets the global post in order
-	 * to get an automatic excerpt. Since we're being called inside an AJAX request,
-	 * we're not taking care of restoring any previous post: there isn't any.
-	 *
-	 * @param array $posts An array of posts.
-	 *
-	 * @return array|string An array of timeline events or an empty string if no posts are provided.
-	 * @since 3.1.0
-	 *
-	 */
-	public function to_json( $posts ) {
-
-		// If there are no events, return empty JSON
-		if ( empty( $posts ) || is_null( $posts ) ) {
-			return '';
-		}
-
-		// {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
-		$display_images_as = isset( $_REQUEST['display_images_as'] ) ? $_REQUEST['display_images_as'] : 'media';
-
-		// The number of words for the excerpt (by default 55, as WordPress).
-		$this->excerpt_length = $excerpt_length = isset( $_REQUEST['excerpt_length'] ) && is_numeric( $_REQUEST['excerpt_length'] ) ? $_REQUEST['excerpt_length'] : 55;
-		add_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
-
-		// Add a filter to remove the [...] after excerpts, since we're adding
-		// a link to the post itself.
-		add_filter( 'excerpt_more', array( $this, 'excerpt_more' ) );
-
-		// Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
-		$start_at_slide = 0;
-		$event_index    = - 1;
-		$now            = time();
-
-		// Prepare the timeline variable.
-		$timeline = array();
-
-		// Populate the arrays.
-		$timeline['events'] = array_map( function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length ) {
-
-			// Get the start and end dates.
-			$start_date = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true ) );
-			$end_date   = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true ) );
-
-			// Set the starting slide.
-			$event_index ++;
-			if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
-				$start_at_slide = $event_index;
-			}
-
-			// Load thumbnail
-			$thumbnail_id = get_post_thumbnail_id( $item->ID );
-			if ( '' !== $thumbnail_id && 0 !== $thumbnail_id
-			     && false !== ( $attachment = wp_get_attachment_image_src( $thumbnail_id ) )
-			) {
-
-				// Set the thumbnail URL.
-				if ( 'background' === $display_images_as ) {
-					$date['background'] = array( 'url' => $attachment[0] );
-					$date['media']      = array( 'thumbnail' => $attachment[0] );
-				} else {
-					$date['media'] = array(
-						'url'       => $attachment[0],
-						'thumbnail' => $attachment[0],
-					);
-				}
-			}
-
-			// Set the start/end dates by converting them to TimelineJS required format.
-			$date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
-			$date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
-
-			setup_postdata( $GLOBALS['post'] = $item );
-
-			$more_link_text = sprintf(
-				'<span aria-label="%1$s">%2$s</span>',
-				sprintf(
-				/* translators: %s: Name of current post */
-					__( 'Continue reading %s' ),
-					the_title_attribute( array( 'echo' => false ) )
-				),
-				__( '(more&hellip;)' )
-			);
-
-			// Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
-			$date['text'] = array(
-				'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
-			);
-
-			// If we have an excerpt, set it.
-			if ( 0 < $excerpt_length ) {
-				$date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text );
-			}
-
-			return $date;
-
-		}, $posts );
-
-		// Finally remove the excerpt filter.
-		remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
-
-		// The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
-		return array(
-			'timeline'       => $timeline,
-			'start_at_slide' => $start_at_slide,
-		);
-	}
-
-	/**
-	 * This function filters {@link excerpt_more} by removing it, since we're
-	 * adding the 'read more' link. This filter is set by {@see to_json}.
-	 *
-	 * @param string $excerpt_more The excerpt more preset.
-	 *
-	 * @return string An empty string.
-	 * @since 3.7.0
-	 *
-	 */
-	public function excerpt_more( $excerpt_more ) {
-
-		return '';
-	}
-
-	/**
-	 * A filter for the excerpt length, set by the `to_json` function, to tailor
-	 * how many words to return according to the client setting.
-	 *
-	 * @param int $length The preset number of words.
-	 *
-	 * @return int The number of words for the preset.
-	 * @since 3.7.0
-	 *
-	 */
-	public function excerpt_length( $length ) {
-
-		return $this->excerpt_length;
-	}
-
-
-	/**
-	 * Convert the date to a date array.
-	 *
-	 * @param $value int A date value.
-	 *
-	 * @return array An array containing year, month and day values.
-	 * @since 3.7.0
-	 *
-	 */
-	public static function date( $value ) {
-
-		return array(
-			'year'  => (int) date( 'Y', $value ),
-			'month' => (int) date( 'm', $value ),
-			'day'   => (int) date( 'd', $value ),
-
-		);
-	}
-
-	/**
-	 * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to
-	 * its specific function).
-	 *
-	 * @return array An array of post IDs.
-	 * @since 3.1.0
-	 *
-	 */
-	public function get_all_related_to_last_50_published_posts() {
-
-		// Global timeline. Get entities from the latest posts.
-		$latest_posts_ids = get_posts( array(
-			'numberposts' => 50,
-			'fields'      => 'ids', //only get post IDs
-			'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
-			'tax_query'   => array(
-				'relation' => 'OR',
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'operator' => 'NOT EXISTS',
-				),
-				array(
-					'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-					'field'    => 'slug',
-					'terms'    => 'article',
-				),
-			),
-			'post_status' => 'publish',
-		) );
-
-		if ( empty( $latest_posts_ids ) ) {
-			// There are no posts.
-			return array();
-		}
-
-		// Collect entities related to latest posts
-		$entity_ids = array();
-		foreach ( $latest_posts_ids as $id ) {
-			$entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array(
-				'status' => 'publish',
-			) ) );
-		}
-
-		return $entity_ids;
-	}
+        $args = array(
+            'post__in'       => $ids,
+            'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
+            'post_status'    => 'publish',
+            'posts_per_page' => - 1,
+            'meta_query'     => array(
+                'relation' => 'AND',
+                array(
+                    'key'     => Wordlift_Schema_Service::FIELD_DATE_START,
+                    'value'   => null,
+                    'compare' => '!=',
+                ),
+                array(
+                    'key'     => Wordlift_Schema_Service::FIELD_DATE_END,
+                    'value'   => null,
+                    'compare' => '!=',
+                ),
+            ),
+            'tax_query'      => array(
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => 'event',
+                ),
+            ),
+        );
+
+        return get_posts( $args );
+    }
+
+    /**
+     * Convert timeline events to JSON. This function sets the global post in order
+     * to get an automatic excerpt. Since we're being called inside an AJAX request,
+     * we're not taking care of restoring any previous post: there isn't any.
+     *
+     * @param array $posts An array of posts.
+     *
+     * @return array|string An array of timeline events or an empty string if no posts are provided.
+     * @since 3.1.0
+     *
+     */
+    public function to_json( $posts ) {
+
+        // If there are no events, return empty JSON
+        if ( empty( $posts ) || is_null( $posts ) ) {
+            return '';
+        }
+
+        // {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
+        $display_images_as = isset( $_REQUEST['display_images_as'] ) ? $_REQUEST['display_images_as'] : 'media';
+
+        // The number of words for the excerpt (by default 55, as WordPress).
+        $this->excerpt_length = $excerpt_length = isset( $_REQUEST['excerpt_length'] ) && is_numeric( $_REQUEST['excerpt_length'] ) ? $_REQUEST['excerpt_length'] : 55;
+        add_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+
+        // Add a filter to remove the [...] after excerpts, since we're adding
+        // a link to the post itself.
+        add_filter( 'excerpt_more', array( $this, 'excerpt_more' ) );
+
+        // Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
+        $start_at_slide = 0;
+        $event_index    = - 1;
+        $now            = time();
+
+        // Prepare the timeline variable.
+        $timeline = array();
+
+        // Populate the arrays.
+        $timeline['events'] = array_map( function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length ) {
+
+            // Get the start and end dates.
+            $start_date = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true ) );
+            $end_date   = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true ) );
+
+            // Set the starting slide.
+            $event_index ++;
+            if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
+                $start_at_slide = $event_index;
+            }
+
+            // Load thumbnail
+            $thumbnail_id = get_post_thumbnail_id( $item->ID );
+            if ( '' !== $thumbnail_id && 0 !== $thumbnail_id
+                 && false !== ( $attachment = wp_get_attachment_image_src( $thumbnail_id ) )
+            ) {
+
+                // Set the thumbnail URL.
+                if ( 'background' === $display_images_as ) {
+                    $date['background'] = array( 'url' => $attachment[0] );
+                    $date['media']      = array( 'thumbnail' => $attachment[0] );
+                } else {
+                    $date['media'] = array(
+                        'url'       => $attachment[0],
+                        'thumbnail' => $attachment[0],
+                    );
+                }
+            }
+
+            // Set the start/end dates by converting them to TimelineJS required format.
+            $date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
+            $date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
+
+            setup_postdata( $GLOBALS['post'] = $item );
+
+            $more_link_text = sprintf(
+                '<span aria-label="%1$s">%2$s</span>',
+                sprintf(
+                /* translators: %s: Name of current post */
+                    __( 'Continue reading %s' ),
+                    the_title_attribute( array( 'echo' => false ) )
+                ),
+                __( '(more&hellip;)' )
+            );
+
+            // Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
+            $date['text'] = array(
+                'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
+            );
+
+            // If we have an excerpt, set it.
+            if ( 0 < $excerpt_length ) {
+                $date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text );
+            }
+
+            return $date;
+
+        }, $posts );
+
+        // Finally remove the excerpt filter.
+        remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+
+        // The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
+        return array(
+            'timeline'       => $timeline,
+            'start_at_slide' => $start_at_slide,
+        );
+    }
+
+    /**
+     * This function filters {@link excerpt_more} by removing it, since we're
+     * adding the 'read more' link. This filter is set by {@see to_json}.
+     *
+     * @param string $excerpt_more The excerpt more preset.
+     *
+     * @return string An empty string.
+     * @since 3.7.0
+     *
+     */
+    public function excerpt_more( $excerpt_more ) {
+
+        return '';
+    }
+
+    /**
+     * A filter for the excerpt length, set by the `to_json` function, to tailor
+     * how many words to return according to the client setting.
+     *
+     * @param int $length The preset number of words.
+     *
+     * @return int The number of words for the preset.
+     * @since 3.7.0
+     *
+     */
+    public function excerpt_length( $length ) {
+
+        return $this->excerpt_length;
+    }
+
+
+    /**
+     * Convert the date to a date array.
+     *
+     * @param $value int A date value.
+     *
+     * @return array An array containing year, month and day values.
+     * @since 3.7.0
+     *
+     */
+    public static function date( $value ) {
+
+        return array(
+            'year'  => (int) date( 'Y', $value ),
+            'month' => (int) date( 'm', $value ),
+            'day'   => (int) date( 'd', $value ),
+
+        );
+    }
+
+    /**
+     * Get the entities related to the last 50 posts published on this blog (we're keeping a long function name due to
+     * its specific function).
+     *
+     * @return array An array of post IDs.
+     * @since 3.1.0
+     *
+     */
+    public function get_all_related_to_last_50_published_posts() {
+
+        // Global timeline. Get entities from the latest posts.
+        $latest_posts_ids = get_posts( array(
+            'numberposts' => 50,
+            'fields'      => 'ids', //only get post IDs
+            'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
+            'tax_query'   => array(
+                'relation' => 'OR',
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'operator' => 'NOT EXISTS',
+                ),
+                array(
+                    'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                    'field'    => 'slug',
+                    'terms'    => 'article',
+                ),
+            ),
+            'post_status' => 'publish',
+        ) );
+
+        if ( empty( $latest_posts_ids ) ) {
+            // There are no posts.
+            return array();
+        }
+
+        // Collect entities related to latest posts
+        $entity_ids = array();
+        foreach ( $latest_posts_ids as $id ) {
+            $entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array(
+                'status' => 'publish',
+            ) ) );
+        }
+
+        return $entity_ids;
+    }
 
 }

Spacing +54 added lines, -54 removed lines

@@ -71,9 +71,9 @@ 
 	 * @since 3.1.0
 	 *
 	 */
-	public function __construct( $entity_service, $entity_type_service ) {
+	public function __construct($entity_service, $entity_type_service) {
 
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Timeline_Service' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Timeline_Service');
 
 		$this->entity_service      = $entity_service;
 		$this->entity_type_service = $entity_type_service;
@@ -102,10 +102,10 @@ 
 	public function ajax_timeline() {
 
 		// Get the ID of the post who requested the timeline.
-		$post_id = ( isset( $_REQUEST['post_id'] ) ? $_REQUEST['post_id'] : null );
+		$post_id = (isset($_REQUEST['post_id']) ? $_REQUEST['post_id'] : null);
 
 		// Get the events and transform them for the JSON response, then send them to the client.
-		wp_send_json( $this->to_json( $this->get_events( $post_id ) ) );
+		wp_send_json($this->to_json($this->get_events($post_id)));
 
 	}
 
@@ -120,27 +120,27 @@ 
 	 * @uses  wl_core_get_related_entity_ids() to retrieve the entities referenced by the specified post.
 	 *
 	 */
-	public function get_events( $post_id = null ) {
+	public function get_events($post_id = null) {
 
 		// Get the entity IDs either from the entities related to the specified post or from the last 50 published
 		// posts if no post has been specified.
-		$ids = ( is_numeric( $post_id )
-			? wl_core_get_related_entity_ids( $post_id )
-			: $this->get_all_related_to_last_50_published_posts() );
+		$ids = (is_numeric($post_id)
+			? wl_core_get_related_entity_ids($post_id)
+			: $this->get_all_related_to_last_50_published_posts());
 
 		// Add the post itself if it's an entity.
-		if ( is_numeric( $post_id ) && $this->entity_service->is_entity( $post_id ) ) {
+		if (is_numeric($post_id) && $this->entity_service->is_entity($post_id)) {
 			$ids[] = $post_id;
 		}
 
 		// If there's no entities, return an empty array right away.
-		if ( 0 === sizeof( $ids ) ) {
-			$this->log->trace( "No events found [ post id :: $post_id ]" );
+		if (0 === sizeof($ids)) {
+			$this->log->trace("No events found [ post id :: $post_id ]");
 
 			return array();
 		}
 
-		$this->log->trace( 'Getting events [ entity ids :: ' . join( ', ', $ids ) . ' ]' );
+		$this->log->trace('Getting events [ entity ids :: '.join(', ', $ids).' ]');
 
 //		$entity_type_service = $this->entity_type_service;
 
@@ -156,7 +156,7 @@ 
 			'post__in'       => $ids,
 			'post_type'      => Wordlift_Entity_Service::valid_entity_post_types(),
 			'post_status'    => 'publish',
-			'posts_per_page' => - 1,
+			'posts_per_page' => -1,
 			'meta_query'     => array(
 				'relation' => 'AND',
 				array(
@@ -179,7 +179,7 @@ 
 			),
 		);
 
-		return get_posts( $args );
+		return get_posts($args);
 	}
 
 	/**
@@ -193,23 +193,23 @@ 
 	 * @since 3.1.0
 	 *
 	 */
-	public function to_json( $posts ) {
+	public function to_json($posts) {
 
 		// If there are no events, return empty JSON
-		if ( empty( $posts ) || is_null( $posts ) ) {
+		if (empty($posts) || is_null($posts)) {
 			return '';
 		}
 
 		// {media|thumbnail}: if set to 'media' the image is attached to the slide, if set to 'background' the image is set as background.
-		$display_images_as = isset( $_REQUEST['display_images_as'] ) ? $_REQUEST['display_images_as'] : 'media';
+		$display_images_as = isset($_REQUEST['display_images_as']) ? $_REQUEST['display_images_as'] : 'media';
 
 		// The number of words for the excerpt (by default 55, as WordPress).
-		$this->excerpt_length = $excerpt_length = isset( $_REQUEST['excerpt_length'] ) && is_numeric( $_REQUEST['excerpt_length'] ) ? $_REQUEST['excerpt_length'] : 55;
-		add_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+		$this->excerpt_length = $excerpt_length = isset($_REQUEST['excerpt_length']) && is_numeric($_REQUEST['excerpt_length']) ? $_REQUEST['excerpt_length'] : 55;
+		add_filter('excerpt_length', array($this, 'excerpt_length'));
 
 		// Add a filter to remove the [...] after excerpts, since we're adding
 		// a link to the post itself.
-		add_filter( 'excerpt_more', array( $this, 'excerpt_more' ) );
+		add_filter('excerpt_more', array($this, 'excerpt_more'));
 
 		// Prepare for the starting slide data. The starting slide will be the one where *now* is between *start/end* dates.
 		$start_at_slide = 0;
@@ -220,28 +220,28 @@ 
 		$timeline = array();
 
 		// Populate the arrays.
-		$timeline['events'] = array_map( function ( $item ) use ( &$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length ) {
+		$timeline['events'] = array_map(function($item) use (&$timeline, &$event_index, &$start_at_slide, &$now, $display_images_as, $excerpt_length) {
 
 			// Get the start and end dates.
-			$start_date = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true ) );
-			$end_date   = strtotime( get_post_meta( $item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true ) );
+			$start_date = strtotime(get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_DATE_START, true));
+			$end_date   = strtotime(get_post_meta($item->ID, Wordlift_Schema_Service::FIELD_DATE_END, true));
 
 			// Set the starting slide.
-			$event_index ++;
-			if ( 0 === $start_at_slide && $now >= $start_date && $now <= $end_date ) {
+			$event_index++;
+			if (0 === $start_at_slide && $now >= $start_date && $now <= $end_date) {
 				$start_at_slide = $event_index;
 			}
 
 			// Load thumbnail
-			$thumbnail_id = get_post_thumbnail_id( $item->ID );
-			if ( '' !== $thumbnail_id && 0 !== $thumbnail_id
-			     && false !== ( $attachment = wp_get_attachment_image_src( $thumbnail_id ) )
+			$thumbnail_id = get_post_thumbnail_id($item->ID);
+			if ('' !== $thumbnail_id && 0 !== $thumbnail_id
+			     && false !== ($attachment = wp_get_attachment_image_src($thumbnail_id))
 			) {
 
 				// Set the thumbnail URL.
-				if ( 'background' === $display_images_as ) {
-					$date['background'] = array( 'url' => $attachment[0] );
-					$date['media']      = array( 'thumbnail' => $attachment[0] );
+				if ('background' === $display_images_as) {
+					$date['background'] = array('url' => $attachment[0]);
+					$date['media']      = array('thumbnail' => $attachment[0]);
 				} else {
 					$date['media'] = array(
 						'url'       => $attachment[0],
@@ -251,37 +251,37 @@ 
 			}
 
 			// Set the start/end dates by converting them to TimelineJS required format.
-			$date['start_date'] = Wordlift_Timeline_Service::date( $start_date );
-			$date['end_date']   = Wordlift_Timeline_Service::date( $end_date );
+			$date['start_date'] = Wordlift_Timeline_Service::date($start_date);
+			$date['end_date']   = Wordlift_Timeline_Service::date($end_date);
 
-			setup_postdata( $GLOBALS['post'] = $item );
+			setup_postdata($GLOBALS['post'] = $item);
 
 			$more_link_text = sprintf(
 				'<span aria-label="%1$s">%2$s</span>',
 				sprintf(
 				/* translators: %s: Name of current post */
-					__( 'Continue reading %s' ),
-					the_title_attribute( array( 'echo' => false ) )
+					__('Continue reading %s'),
+					the_title_attribute(array('echo' => false))
 				),
-				__( '(more&hellip;)' )
+				__('(more&hellip;)')
 			);
 
 			// Set the event text only with the headline (see https://github.com/insideout10/wordlift-plugin/issues/352).
 			$date['text'] = array(
-				'headline' => '<a href="' . get_permalink( $item->ID ) . '">' . $item->post_title . '</a>',
+				'headline' => '<a href="'.get_permalink($item->ID).'">'.$item->post_title.'</a>',
 			);
 
 			// If we have an excerpt, set it.
-			if ( 0 < $excerpt_length ) {
-				$date['text']['text'] = sprintf( '%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text );
+			if (0 < $excerpt_length) {
+				$date['text']['text'] = sprintf('%s <a href="%s">%s</a>', get_the_excerpt(), get_permalink(), $more_link_text);
 			}
 
 			return $date;
 
-		}, $posts );
+		}, $posts);
 
 		// Finally remove the excerpt filter.
-		remove_filter( 'excerpt_length', array( $this, 'excerpt_length' ) );
+		remove_filter('excerpt_length', array($this, 'excerpt_length'));
 
 		// The JSON format is defined here: https://timeline.knightlab.com/docs/json-format.html
 		return array(
@@ -300,7 +300,7 @@ 
 	 * @since 3.7.0
 	 *
 	 */
-	public function excerpt_more( $excerpt_more ) {
+	public function excerpt_more($excerpt_more) {
 
 		return '';
 	}
@@ -315,7 +315,7 @@ 
 	 * @since 3.7.0
 	 *
 	 */
-	public function excerpt_length( $length ) {
+	public function excerpt_length($length) {
 
 		return $this->excerpt_length;
 	}
@@ -330,12 +330,12 @@ 
 	 * @since 3.7.0
 	 *
 	 */
-	public static function date( $value ) {
+	public static function date($value) {
 
 		return array(
-			'year'  => (int) date( 'Y', $value ),
-			'month' => (int) date( 'm', $value ),
-			'day'   => (int) date( 'd', $value ),
+			'year'  => (int) date('Y', $value),
+			'month' => (int) date('m', $value),
+			'day'   => (int) date('d', $value),
 
 		);
 	}
@@ -351,7 +351,7 @@ 
 	public function get_all_related_to_last_50_published_posts() {
 
 		// Global timeline. Get entities from the latest posts.
-		$latest_posts_ids = get_posts( array(
+		$latest_posts_ids = get_posts(array(
 			'numberposts' => 50,
 			'fields'      => 'ids', //only get post IDs
 			'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
@@ -368,19 +368,19 @@ 
 				),
 			),
 			'post_status' => 'publish',
-		) );
+		));
 
-		if ( empty( $latest_posts_ids ) ) {
+		if (empty($latest_posts_ids)) {
 			// There are no posts.
 			return array();
 		}
 
 		// Collect entities related to latest posts
 		$entity_ids = array();
-		foreach ( $latest_posts_ids as $id ) {
-			$entity_ids = array_merge( $entity_ids, wl_core_get_related_entity_ids( $id, array(
+		foreach ($latest_posts_ids as $id) {
+			$entity_ids = array_merge($entity_ids, wl_core_get_related_entity_ids($id, array(
 				'status' => 'publish',
-			) ) );
+			)));
 		}
 
 		return $entity_ids;

src/includes/linked-data/storage/class-wordlift-post-image-storage.php

Indentation +40 added lines, -40 removed lines

@@ -18,45 +18,45 @@
  */
 class Wordlift_Post_Image_Storage extends Wordlift_Storage {
 
-	/**
-	 * Get the property value.
-	 *
-	 * @param int $post_id The {@link WP_Post}'s id.
-	 *
-	 * @return array|string|null A single string, or an array of values or null
-	 *                           if the property isn't recognized.
-	 * @since 3.15.0
-	 *
-	 */
-	public function get( $post_id ) {
-
-		// Prepare the return array.
-		$image_urls = array();
-
-		// If there is a featured image it has the priority.
-		$featured_image_id = get_post_thumbnail_id( $post_id );
-		if ( is_numeric( $featured_image_id ) && 0 < $featured_image_id ) {
-			$image_url = wp_get_attachment_url( $featured_image_id );
-
-			$image_urls[] = $image_url;
-		}
-
-		$images = get_children( array(
-			'post_parent'    => $post_id,
-			'post_type'      => 'attachment',
-			'post_mime_type' => 'image',
-		) );
-
-		// Collect the URLs.
-		foreach ( $images as $attachment_id => $attachment ) {
-			$image_url = wp_get_attachment_url( $attachment_id );
-			// Ensure the URL isn't collected already.
-			if ( ! in_array( $image_url, $image_urls ) ) {
-				array_push( $image_urls, $image_url );
-			}
-		}
-
-		return $image_urls;
-	}
+    /**
+     * Get the property value.
+     *
+     * @param int $post_id The {@link WP_Post}'s id.
+     *
+     * @return array|string|null A single string, or an array of values or null
+     *                           if the property isn't recognized.
+     * @since 3.15.0
+     *
+     */
+    public function get( $post_id ) {
+
+        // Prepare the return array.
+        $image_urls = array();
+
+        // If there is a featured image it has the priority.
+        $featured_image_id = get_post_thumbnail_id( $post_id );
+        if ( is_numeric( $featured_image_id ) && 0 < $featured_image_id ) {
+            $image_url = wp_get_attachment_url( $featured_image_id );
+
+            $image_urls[] = $image_url;
+        }
+
+        $images = get_children( array(
+            'post_parent'    => $post_id,
+            'post_type'      => 'attachment',
+            'post_mime_type' => 'image',
+        ) );
+
+        // Collect the URLs.
+        foreach ( $images as $attachment_id => $attachment ) {
+            $image_url = wp_get_attachment_url( $attachment_id );
+            // Ensure the URL isn't collected already.
+            if ( ! in_array( $image_url, $image_urls ) ) {
+                array_push( $image_urls, $image_url );
+            }
+        }
+
+        return $image_urls;
+    }
 
 }

Spacing +10 added lines, -10 removed lines

@@ -28,31 +28,31 @@
 	 * @since 3.15.0
 	 *
 	 */
-	public function get( $post_id ) {
+	public function get($post_id) {
 
 		// Prepare the return array.
 		$image_urls = array();
 
 		// If there is a featured image it has the priority.
-		$featured_image_id = get_post_thumbnail_id( $post_id );
-		if ( is_numeric( $featured_image_id ) && 0 < $featured_image_id ) {
-			$image_url = wp_get_attachment_url( $featured_image_id );
+		$featured_image_id = get_post_thumbnail_id($post_id);
+		if (is_numeric($featured_image_id) && 0 < $featured_image_id) {
+			$image_url = wp_get_attachment_url($featured_image_id);
 
 			$image_urls[] = $image_url;
 		}
 
-		$images = get_children( array(
+		$images = get_children(array(
 			'post_parent'    => $post_id,
 			'post_type'      => 'attachment',
 			'post_mime_type' => 'image',
-		) );
+		));
 
 		// Collect the URLs.
-		foreach ( $images as $attachment_id => $attachment ) {
-			$image_url = wp_get_attachment_url( $attachment_id );
+		foreach ($images as $attachment_id => $attachment) {
+			$image_url = wp_get_attachment_url($attachment_id);
 			// Ensure the URL isn't collected already.
-			if ( ! in_array( $image_url, $image_urls ) ) {
-				array_push( $image_urls, $image_url );
+			if ( ! in_array($image_url, $image_urls)) {
+				array_push($image_urls, $image_url);
 			}
 		}
 

src/includes/class-wordlift-post-to-jsonld-converter.php

Indentation +376 added lines, -376 removed lines

@@ -15,393 +15,393 @@
  */
 class Wordlift_Post_To_Jsonld_Converter extends Wordlift_Abstract_Post_To_Jsonld_Converter {
 
-	/**
-	 * A {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 */
-	private $configuration_service;
-
-	/**
-	 * A {@link Wordlift_Log_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
-	 */
-	private $log;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
-	 *
-	 * @since 3.10.0
-	 *
-	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service, $configuration_service ) {
-		parent::__construct( $entity_type_service, $entity_service, $user_service, $attachment_service );
-
-		$this->configuration_service = $configuration_service;
-
-		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $references An array of entity references.
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 *
-	 */
-	public function convert( $post_id, &$references = array() ) {
-
-		// Get the post instance.
-		if ( null === $post = get_post( $post_id ) ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references );
-
-		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
-			$jsonld['@type'] = 'WebPage';
-		}
-
-		// Get the entity name.
-		$jsonld['headline'] = $post->post_title;
-
-		// Set the published and modified dates.
-		/*
+    /**
+     * A {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     */
+    private $configuration_service;
+
+    /**
+     * A {@link Wordlift_Log_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var Wordlift_Log_Service $log A {@link Wordlift_Log_Service} instance.
+     */
+    private $log;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
+     *
+     * @since 3.10.0
+     *
+     */
+    public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service, $configuration_service ) {
+        parent::__construct( $entity_type_service, $entity_service, $user_service, $attachment_service );
+
+        $this->configuration_service = $configuration_service;
+
+        // Set a reference to the logger.
+        $this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int $post_id The post id.
+     * @param array $references An array of entity references.
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     *
+     */
+    public function convert( $post_id, &$references = array() ) {
+
+        // Get the post instance.
+        if ( null === $post = get_post( $post_id ) ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the base JSON-LD and the list of entities referenced by this entity.
+        $jsonld = parent::convert( $post_id, $references );
+
+        // Set WebPage by default.
+        if ( empty( $jsonld['@type'] ) ) {
+            $jsonld['@type'] = 'WebPage';
+        }
+
+        // Get the entity name.
+        $jsonld['headline'] = $post->post_title;
+
+        // Set the published and modified dates.
+        /*
 		 * Set the `datePublished` and `dateModified` using the local timezone.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/887
 		 *
 		 * @since 3.20.0
 		 */
-		try {
-			$default_timezone = date_default_timezone_get();
-			date_default_timezone_set( get_option( 'timezone_string' ) );
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-			date_default_timezone_set( $default_timezone );
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
-		}
-
-		// Get the word count for the post.
-		/*
+        try {
+            $default_timezone = date_default_timezone_get();
+            date_default_timezone_set( get_option( 'timezone_string' ) );
+            $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
+            $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
+            date_default_timezone_set( $default_timezone );
+        } catch ( Exception $e ) {
+            $jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
+            $jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+        }
+
+        // Get the word count for the post.
+        /*
 		 * Do not display the `wordCount` on a `WebPage`.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/888
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
-			$jsonld['wordCount'] = $post_adapter->word_count();
-		}
-
-		// Set the publisher.
-		$this->set_publisher( $jsonld );
-
-		// Process the references if any.
-		if ( 0 < count( $references ) ) {
-
-			// Prepare the `about` and `mentions` array.
-			$about = $mentions = array();
-
-			// If the entity is in the title, then it should be an `about`.
-			foreach ( $references as $reference ) {
-
-				// Get the entity labels.
-				$labels = $this->entity_service->get_labels( $reference );
-
-				// Get the entity URI.
-				$item = array(
-					'@id' => $this->entity_service->get_uri( $reference ),
-				);
-
-				$escaped_labels = array_map( function ( $value ) {
-					return preg_quote( $value, '/' );
-				}, $labels );
-
-				// Check if the labels match any part of the title.
-				$matches = 1 === preg_match( '/' . implode( '|', $escaped_labels ) . '/', $post->post_title );
-
-				// If the title matches, assign the entity to the about, otherwise to the mentions.
-				if ( $matches ) {
-					$about[] = $item;
-				} else {
-					$mentions[] = $item;
-				}
-			}
-
-			// If we have abouts, assign them to the JSON-LD.
-			if ( 0 < count( $about ) ) {
-				$jsonld['about'] = $about;
-			}
-
-			// If we have mentions, assign them to the JSON-LD.
-			if ( 0 < count( $mentions ) ) {
-				$jsonld['mentions'] = $mentions;
-			}
-		}
-
-		// Finally set the author.
-		$jsonld['author'] = $this->get_author( $post->post_author, $references );
-
-		/**
-		 * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
-		 *
-		 * @param array $value {
-		 *
-		 * @type array $jsonld The JSON-LD structure.
-		 * @type int[] $references An array of post IDs.
-		 * }
-		 * @since 3.25.0
-		 *
-		 * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
-		 *
-		 * @api
-		 */
-		$ret_val    = apply_filters( 'wl_post_jsonld_array', array(
-			'jsonld'     => $jsonld,
-			'references' => $references,
-		), $post_id );
-		$jsonld     = $ret_val['jsonld'];
-		$references = $ret_val['references'];
-
-		/**
-		 * Call the `wl_post_jsonld` filter.
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 * @param array $references The array of referenced entities.
-		 *
-		 * @since 3.14.0
-		 *
-		 * @api
-		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
-	}
-
-	/**
-	 * Get the author's JSON-LD fragment.
-	 *
-	 * The JSON-LD fragment is generated using the {@link WP_User}'s data or
-	 * the referenced entity if configured for the {@link WP_User}.
-	 *
-	 * @param int $author_id The author {@link WP_User}'s `id`.
-	 * @param array $references An array of referenced entities.
-	 *
-	 * @return string|array A JSON-LD structure.
-	 * @since 3.14.0
-	 *
-	 */
-	private function get_author( $author_id, &$references ) {
-
-		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
-
-		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
-
-			$author     = get_the_author_meta( 'display_name', $author_id );
-			$author_uri = $this->user_service->get_uri( $author_id );
-
-			return array(
-				'@type' => 'Person',
-				'@id'   => $author_uri,
-				'name'  => $author,
-			);
-		}
-
-		// Add the author to the references.
-		$author_uri   = $this->entity_service->get_uri( $entity_id );
-		$references[] = $entity_id;
-
-		// Return the JSON-LD for the referenced entity.
-		return array(
-			'@id' => $author_uri,
-		);
-	}
-
-	/**
-	 * Enrich the provided params array with publisher data, if available.
-	 *
-	 * @param array $params The parameters array.
-	 *
-	 * @since 3.10.0
-	 *
-	 */
-	protected function set_publisher( &$params ) {
-
-		// If the publisher id isn't set don't do anything.
-		if ( null === $publisher_id = $this->configuration_service->get_publisher_id() ) {
-			return;
-		}
-
-		// Get the post instance.
-		if ( null === $post = get_post( $publisher_id ) ) {
-			// Publisher not found.
-			return;
-		}
-
-		// Get the item id.
-		$id = $this->entity_service->get_uri( $publisher_id );
-
-		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
-
-		// Get the name.
-		$name = $post->post_title;
-
-		// Set the publisher data.
-		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
-			'@id'   => $id,
-			'name'  => $name,
-		);
-
-		// Add the sameAs values associated with the publisher.
-		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
-			$params['publisher']['sameAs'] = $sameas;
-		}
-
-		// Set the logo, only for http://schema.org/Organization as Person doesn't
-		// support the logo property.
-		//
-		// See http://schema.org/logo.
-		if ( 'http://schema.org/Organization' !== $type['uri'] ) {
-			return;
-		}
-
-		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
-
-		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
-			return;
-		}
-
-		// Copy over some useful properties.
-		//
-		// See https://developers.google.com/search/docs/data-types/articles.
-		$params['publisher']['logo']['@type'] = 'ImageObject';
-		$params['publisher']['logo']['url']   = $publisher_logo['url'];
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		$params['publisher']['logo']['width']  = $publisher_logo['width'];
-		$params['publisher']['logo']['height'] = $publisher_logo['height'];
-
-	}
-
-	/**
-	 * Get the publisher logo structure.
-	 *
-	 * The function returns false when the publisher logo cannot be determined, i.e.:
-	 *  - the post has no featured image.
-	 *  - the featured image has no file.
-	 *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
-	 *
-	 * @param int $post_id The post id.
-	 *
-	 * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
-	 *  of errors.
-	 * @since 3.19.2
-	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
-	 *
-	 */
-	private function get_publisher_logo( $post_id ) {
-
-		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
-
-		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
-
-			return false;
-		}
-
-		// Get the uploads base URL.
-		$uploads_dir = wp_upload_dir();
-
-		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
-
-		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
-
-			return false;
-		}
-
-		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
-
-		// Bail out if the file isn't found.
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
-
-			return false;
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
-
-			return false;
-		}
-
-		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
-		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
-
-		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
-		}
-
-		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
-
-			return false;
-		}
-
-		// Get the actual size.
-		$size = $publisher_logo_editor->get_size();
-
-		// Finally return the array with data.
-		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
-			'width'  => $size['width'],
-			'height' => $size['height'],
-		);
-	}
+        if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
+            $post_adapter        = new Wordlift_Post_Adapter( $post_id );
+            $jsonld['wordCount'] = $post_adapter->word_count();
+        }
+
+        // Set the publisher.
+        $this->set_publisher( $jsonld );
+
+        // Process the references if any.
+        if ( 0 < count( $references ) ) {
+
+            // Prepare the `about` and `mentions` array.
+            $about = $mentions = array();
+
+            // If the entity is in the title, then it should be an `about`.
+            foreach ( $references as $reference ) {
+
+                // Get the entity labels.
+                $labels = $this->entity_service->get_labels( $reference );
+
+                // Get the entity URI.
+                $item = array(
+                    '@id' => $this->entity_service->get_uri( $reference ),
+                );
+
+                $escaped_labels = array_map( function ( $value ) {
+                    return preg_quote( $value, '/' );
+                }, $labels );
+
+                // Check if the labels match any part of the title.
+                $matches = 1 === preg_match( '/' . implode( '|', $escaped_labels ) . '/', $post->post_title );
+
+                // If the title matches, assign the entity to the about, otherwise to the mentions.
+                if ( $matches ) {
+                    $about[] = $item;
+                } else {
+                    $mentions[] = $item;
+                }
+            }
+
+            // If we have abouts, assign them to the JSON-LD.
+            if ( 0 < count( $about ) ) {
+                $jsonld['about'] = $about;
+            }
+
+            // If we have mentions, assign them to the JSON-LD.
+            if ( 0 < count( $mentions ) ) {
+                $jsonld['mentions'] = $mentions;
+            }
+        }
+
+        // Finally set the author.
+        $jsonld['author'] = $this->get_author( $post->post_author, $references );
+
+        /**
+         * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
+         *
+         * @param array $value {
+         *
+         * @type array $jsonld The JSON-LD structure.
+         * @type int[] $references An array of post IDs.
+         * }
+         * @since 3.25.0
+         *
+         * @see https://www.geeklab.info/2010/04/wordpress-pass-variables-by-reference-with-apply_filter/
+         *
+         * @api
+         */
+        $ret_val    = apply_filters( 'wl_post_jsonld_array', array(
+            'jsonld'     => $jsonld,
+            'references' => $references,
+        ), $post_id );
+        $jsonld     = $ret_val['jsonld'];
+        $references = $ret_val['references'];
+
+        /**
+         * Call the `wl_post_jsonld` filter.
+         *
+         * @param array $jsonld The JSON-LD structure.
+         * @param int $post_id The {@link WP_Post} `id`.
+         * @param array $references The array of referenced entities.
+         *
+         * @since 3.14.0
+         *
+         * @api
+         */
+        return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+    }
+
+    /**
+     * Get the author's JSON-LD fragment.
+     *
+     * The JSON-LD fragment is generated using the {@link WP_User}'s data or
+     * the referenced entity if configured for the {@link WP_User}.
+     *
+     * @param int $author_id The author {@link WP_User}'s `id`.
+     * @param array $references An array of referenced entities.
+     *
+     * @return string|array A JSON-LD structure.
+     * @since 3.14.0
+     *
+     */
+    private function get_author( $author_id, &$references ) {
+
+        // Get the entity bound to this user.
+        $entity_id = $this->user_service->get_entity( $author_id );
+
+        // If there's no entity bound return a simple author structure.
+        if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+
+            $author     = get_the_author_meta( 'display_name', $author_id );
+            $author_uri = $this->user_service->get_uri( $author_id );
+
+            return array(
+                '@type' => 'Person',
+                '@id'   => $author_uri,
+                'name'  => $author,
+            );
+        }
+
+        // Add the author to the references.
+        $author_uri   = $this->entity_service->get_uri( $entity_id );
+        $references[] = $entity_id;
+
+        // Return the JSON-LD for the referenced entity.
+        return array(
+            '@id' => $author_uri,
+        );
+    }
+
+    /**
+     * Enrich the provided params array with publisher data, if available.
+     *
+     * @param array $params The parameters array.
+     *
+     * @since 3.10.0
+     *
+     */
+    protected function set_publisher( &$params ) {
+
+        // If the publisher id isn't set don't do anything.
+        if ( null === $publisher_id = $this->configuration_service->get_publisher_id() ) {
+            return;
+        }
+
+        // Get the post instance.
+        if ( null === $post = get_post( $publisher_id ) ) {
+            // Publisher not found.
+            return;
+        }
+
+        // Get the item id.
+        $id = $this->entity_service->get_uri( $publisher_id );
+
+        // Get the type.
+        $type = $this->entity_type_service->get( $publisher_id );
+
+        // Get the name.
+        $name = $post->post_title;
+
+        // Set the publisher data.
+        $params['publisher'] = array(
+            '@type' => $this->relative_to_context( $type['uri'] ),
+            '@id'   => $id,
+            'name'  => $name,
+        );
+
+        // Add the sameAs values associated with the publisher.
+        $storage_factory = Wordlift_Storage_Factory::get_instance();
+        $sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
+        if ( ! empty( $sameas ) ) {
+            $params['publisher']['sameAs'] = $sameas;
+        }
+
+        // Set the logo, only for http://schema.org/Organization as Person doesn't
+        // support the logo property.
+        //
+        // See http://schema.org/logo.
+        if ( 'http://schema.org/Organization' !== $type['uri'] ) {
+            return;
+        }
+
+        // Get the publisher logo.
+        $publisher_logo = $this->get_publisher_logo( $post->ID );
+
+        // Bail out if the publisher logo isn't set.
+        if ( false === $publisher_logo ) {
+            return;
+        }
+
+        // Copy over some useful properties.
+        //
+        // See https://developers.google.com/search/docs/data-types/articles.
+        $params['publisher']['logo']['@type'] = 'ImageObject';
+        $params['publisher']['logo']['url']   = $publisher_logo['url'];
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        $params['publisher']['logo']['width']  = $publisher_logo['width'];
+        $params['publisher']['logo']['height'] = $publisher_logo['height'];
+
+    }
+
+    /**
+     * Get the publisher logo structure.
+     *
+     * The function returns false when the publisher logo cannot be determined, i.e.:
+     *  - the post has no featured image.
+     *  - the featured image has no file.
+     *  - a wp_image_editor instance cannot be instantiated on the original file or on the publisher logo file.
+     *
+     * @param int $post_id The post id.
+     *
+     * @return array|false Returns an array with the `url`, `width` and `height` for the publisher logo or false in case
+     *  of errors.
+     * @since 3.19.2
+     * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
+     *
+     */
+    private function get_publisher_logo( $post_id ) {
+
+        // Get the featured image for the post.
+        $thumbnail_id = get_post_thumbnail_id( $post_id );
+
+        // Bail out if thumbnail not available.
+        if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
+            $this->log->info( "Featured image not set for post $post_id." );
+
+            return false;
+        }
+
+        // Get the uploads base URL.
+        $uploads_dir = wp_upload_dir();
+
+        // Get the attachment metadata.
+        $metadata = wp_get_attachment_metadata( $thumbnail_id );
+
+        // Bail out if the file isn't set.
+        if ( ! isset( $metadata['file'] ) ) {
+            $this->log->warn( "Featured image file not found for post $post_id." );
+
+            return false;
+        }
+
+        // Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
+        $path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+
+        // Bail out if the file isn't found.
+        if ( ! file_exists( $path ) ) {
+            $this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+
+            return false;
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $original_file_editor = wp_get_image_editor( $path );
+        if ( is_wp_error( $original_file_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+
+            return false;
+        }
+
+        // Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
+        // and we don't actually know the end values.
+        $publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+
+        // If the file doesn't exist yet, create it.
+        if ( ! file_exists( $publisher_logo_path ) ) {
+            $original_file_editor->resize( 600, 60 );
+            $original_file_editor->save( $publisher_logo_path );
+        }
+
+        // Try to get the image editor and bail out if the editor cannot be instantiated.
+        $publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
+        if ( is_wp_error( $publisher_logo_editor ) ) {
+            $this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+
+            return false;
+        }
+
+        // Get the actual size.
+        $size = $publisher_logo_editor->get_size();
+
+        // Finally return the array with data.
+        return array(
+            'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+            'width'  => $size['width'],
+            'height' => $size['height'],
+        );
+    }
 
 }

Spacing +70 added lines, -70 removed lines

@@ -45,13 +45,13 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service, $configuration_service ) {
-		parent::__construct( $entity_type_service, $entity_service, $user_service, $attachment_service );
+	public function __construct($entity_type_service, $entity_service, $user_service, $attachment_service, $configuration_service) {
+		parent::__construct($entity_type_service, $entity_service, $user_service, $attachment_service);
 
 		$this->configuration_service = $configuration_service;
 
 		// Set a reference to the logger.
-		$this->log = Wordlift_Log_Service::get_logger( 'Wordlift_Post_To_Jsonld_Converter' );
+		$this->log = Wordlift_Log_Service::get_logger('Wordlift_Post_To_Jsonld_Converter');
 	}
 
 	/**
@@ -65,19 +65,19 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function convert( $post_id, &$references = array() ) {
+	public function convert($post_id, &$references = array()) {
 
 		// Get the post instance.
-		if ( null === $post = get_post( $post_id ) ) {
+		if (null === $post = get_post($post_id)) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the base JSON-LD and the list of entities referenced by this entity.
-		$jsonld = parent::convert( $post_id, $references );
+		$jsonld = parent::convert($post_id, $references);
 
 		// Set WebPage by default.
-		if ( empty( $jsonld['@type'] ) ) {
+		if (empty($jsonld['@type'])) {
 			$jsonld['@type'] = 'WebPage';
 		}
 
@@ -94,13 +94,13 @@ 
 		 */
 		try {
 			$default_timezone = date_default_timezone_get();
-			date_default_timezone_set( get_option( 'timezone_string' ) );
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i:sP', false, $post );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i:sP', false, $post );
-			date_default_timezone_set( $default_timezone );
-		} catch ( Exception $e ) {
-			$jsonld['datePublished'] = get_post_time( 'Y-m-d\TH:i', true, $post, false );
-			$jsonld['dateModified']  = get_post_modified_time( 'Y-m-d\TH:i', true, $post, false );
+			date_default_timezone_set(get_option('timezone_string'));
+			$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i:sP', false, $post);
+			$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i:sP', false, $post);
+			date_default_timezone_set($default_timezone);
+		} catch (Exception $e) {
+			$jsonld['datePublished'] = get_post_time('Y-m-d\TH:i', true, $post, false);
+			$jsonld['dateModified']  = get_post_modified_time('Y-m-d\TH:i', true, $post, false);
 		}
 
 		// Get the word count for the post.
@@ -111,40 +111,40 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		if ( ! empty( $jsonld['@type'] ) && 'WebPage' !== $jsonld['@type'] ) {
-			$post_adapter        = new Wordlift_Post_Adapter( $post_id );
+		if ( ! empty($jsonld['@type']) && 'WebPage' !== $jsonld['@type']) {
+			$post_adapter        = new Wordlift_Post_Adapter($post_id);
 			$jsonld['wordCount'] = $post_adapter->word_count();
 		}
 
 		// Set the publisher.
-		$this->set_publisher( $jsonld );
+		$this->set_publisher($jsonld);
 
 		// Process the references if any.
-		if ( 0 < count( $references ) ) {
+		if (0 < count($references)) {
 
 			// Prepare the `about` and `mentions` array.
 			$about = $mentions = array();
 
 			// If the entity is in the title, then it should be an `about`.
-			foreach ( $references as $reference ) {
+			foreach ($references as $reference) {
 
 				// Get the entity labels.
-				$labels = $this->entity_service->get_labels( $reference );
+				$labels = $this->entity_service->get_labels($reference);
 
 				// Get the entity URI.
 				$item = array(
-					'@id' => $this->entity_service->get_uri( $reference ),
+					'@id' => $this->entity_service->get_uri($reference),
 				);
 
-				$escaped_labels = array_map( function ( $value ) {
-					return preg_quote( $value, '/' );
-				}, $labels );
+				$escaped_labels = array_map(function($value) {
+					return preg_quote($value, '/');
+				}, $labels);
 
 				// Check if the labels match any part of the title.
-				$matches = 1 === preg_match( '/' . implode( '|', $escaped_labels ) . '/', $post->post_title );
+				$matches = 1 === preg_match('/'.implode('|', $escaped_labels).'/', $post->post_title);
 
 				// If the title matches, assign the entity to the about, otherwise to the mentions.
-				if ( $matches ) {
+				if ($matches) {
 					$about[] = $item;
 				} else {
 					$mentions[] = $item;
@@ -152,18 +152,18 @@ 
 			}
 
 			// If we have abouts, assign them to the JSON-LD.
-			if ( 0 < count( $about ) ) {
+			if (0 < count($about)) {
 				$jsonld['about'] = $about;
 			}
 
 			// If we have mentions, assign them to the JSON-LD.
-			if ( 0 < count( $mentions ) ) {
+			if (0 < count($mentions)) {
 				$jsonld['mentions'] = $mentions;
 			}
 		}
 
 		// Finally set the author.
-		$jsonld['author'] = $this->get_author( $post->post_author, $references );
+		$jsonld['author'] = $this->get_author($post->post_author, $references);
 
 		/**
 		 * Call the `wl_post_jsonld_array` filter. This filter allows 3rd parties to also modify the references.
@@ -179,10 +179,10 @@ 
 		 *
 		 * @api
 		 */
-		$ret_val    = apply_filters( 'wl_post_jsonld_array', array(
+		$ret_val = apply_filters('wl_post_jsonld_array', array(
 			'jsonld'     => $jsonld,
 			'references' => $references,
-		), $post_id );
+		), $post_id);
 		$jsonld     = $ret_val['jsonld'];
 		$references = $ret_val['references'];
 
@@ -197,7 +197,7 @@ 
 		 *
 		 * @api
 		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+		return apply_filters('wl_post_jsonld', $jsonld, $post_id, $references);
 	}
 
 	/**
@@ -213,16 +213,16 @@ 
 	 * @since 3.14.0
 	 *
 	 */
-	private function get_author( $author_id, &$references ) {
+	private function get_author($author_id, &$references) {
 
 		// Get the entity bound to this user.
-		$entity_id = $this->user_service->get_entity( $author_id );
+		$entity_id = $this->user_service->get_entity($author_id);
 
 		// If there's no entity bound return a simple author structure.
-		if ( empty( $entity_id ) || 'publish' !== get_post_status( $entity_id ) ) {
+		if (empty($entity_id) || 'publish' !== get_post_status($entity_id)) {
 
-			$author     = get_the_author_meta( 'display_name', $author_id );
-			$author_uri = $this->user_service->get_uri( $author_id );
+			$author     = get_the_author_meta('display_name', $author_id);
+			$author_uri = $this->user_service->get_uri($author_id);
 
 			return array(
 				'@type' => 'Person',
@@ -232,7 +232,7 @@ 
 		}
 
 		// Add the author to the references.
-		$author_uri   = $this->entity_service->get_uri( $entity_id );
+		$author_uri   = $this->entity_service->get_uri($entity_id);
 		$references[] = $entity_id;
 
 		// Return the JSON-LD for the referenced entity.
@@ -249,39 +249,39 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	protected function set_publisher( &$params ) {
+	protected function set_publisher(&$params) {
 
 		// If the publisher id isn't set don't do anything.
-		if ( null === $publisher_id = $this->configuration_service->get_publisher_id() ) {
+		if (null === $publisher_id = $this->configuration_service->get_publisher_id()) {
 			return;
 		}
 
 		// Get the post instance.
-		if ( null === $post = get_post( $publisher_id ) ) {
+		if (null === $post = get_post($publisher_id)) {
 			// Publisher not found.
 			return;
 		}
 
 		// Get the item id.
-		$id = $this->entity_service->get_uri( $publisher_id );
+		$id = $this->entity_service->get_uri($publisher_id);
 
 		// Get the type.
-		$type = $this->entity_type_service->get( $publisher_id );
+		$type = $this->entity_type_service->get($publisher_id);
 
 		// Get the name.
 		$name = $post->post_title;
 
 		// Set the publisher data.
 		$params['publisher'] = array(
-			'@type' => $this->relative_to_context( $type['uri'] ),
+			'@type' => $this->relative_to_context($type['uri']),
 			'@id'   => $id,
 			'name'  => $name,
 		);
 
 		// Add the sameAs values associated with the publisher.
 		$storage_factory = Wordlift_Storage_Factory::get_instance();
-		$sameas          = $storage_factory->post_meta( Wordlift_Schema_Service::FIELD_SAME_AS )->get( $publisher_id );
-		if ( ! empty( $sameas ) ) {
+		$sameas          = $storage_factory->post_meta(Wordlift_Schema_Service::FIELD_SAME_AS)->get($publisher_id);
+		if ( ! empty($sameas)) {
 			$params['publisher']['sameAs'] = $sameas;
 		}
 
@@ -289,15 +289,15 @@ 
 		// support the logo property.
 		//
 		// See http://schema.org/logo.
-		if ( 'http://schema.org/Organization' !== $type['uri'] ) {
+		if ('http://schema.org/Organization' !== $type['uri']) {
 			return;
 		}
 
 		// Get the publisher logo.
-		$publisher_logo = $this->get_publisher_logo( $post->ID );
+		$publisher_logo = $this->get_publisher_logo($post->ID);
 
 		// Bail out if the publisher logo isn't set.
-		if ( false === $publisher_logo ) {
+		if (false === $publisher_logo) {
 			return;
 		}
 
@@ -332,14 +332,14 @@ 
 	 * @see https://github.com/insideout10/wordlift-plugin/issues/823 related issue.
 	 *
 	 */
-	private function get_publisher_logo( $post_id ) {
+	private function get_publisher_logo($post_id) {
 
 		// Get the featured image for the post.
-		$thumbnail_id = get_post_thumbnail_id( $post_id );
+		$thumbnail_id = get_post_thumbnail_id($post_id);
 
 		// Bail out if thumbnail not available.
-		if ( empty( $thumbnail_id ) || 0 === $thumbnail_id ) {
-			$this->log->info( "Featured image not set for post $post_id." );
+		if (empty($thumbnail_id) || 0 === $thumbnail_id) {
+			$this->log->info("Featured image not set for post $post_id.");
 
 			return false;
 		}
@@ -348,47 +348,47 @@ 
 		$uploads_dir = wp_upload_dir();
 
 		// Get the attachment metadata.
-		$metadata = wp_get_attachment_metadata( $thumbnail_id );
+		$metadata = wp_get_attachment_metadata($thumbnail_id);
 
 		// Bail out if the file isn't set.
-		if ( ! isset( $metadata['file'] ) ) {
-			$this->log->warn( "Featured image file not found for post $post_id." );
+		if ( ! isset($metadata['file'])) {
+			$this->log->warn("Featured image file not found for post $post_id.");
 
 			return false;
 		}
 
 		// Retrieve the relative filename, e.g. "2018/05/logo_publisher.png"
-		$path = $uploads_dir['basedir'] . DIRECTORY_SEPARATOR . $metadata['file'];
+		$path = $uploads_dir['basedir'].DIRECTORY_SEPARATOR.$metadata['file'];
 
 		// Bail out if the file isn't found.
-		if ( ! file_exists( $path ) ) {
-			$this->log->warn( "Featured image file $path doesn't exist for post $post_id." );
+		if ( ! file_exists($path)) {
+			$this->log->warn("Featured image file $path doesn't exist for post $post_id.");
 
 			return false;
 		}
 
 		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$original_file_editor = wp_get_image_editor( $path );
-		if ( is_wp_error( $original_file_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $path for post $post_id." );
+		$original_file_editor = wp_get_image_editor($path);
+		if (is_wp_error($original_file_editor)) {
+			$this->log->warn("Cannot instantiate WP Image Editor on file $path for post $post_id.");
 
 			return false;
 		}
 
 		// Generate the publisher logo filename, we cannot use the `width` and `height` because we're scaling
 		// and we don't actually know the end values.
-		$publisher_logo_path = $original_file_editor->generate_filename( '-publisher-logo' );
+		$publisher_logo_path = $original_file_editor->generate_filename('-publisher-logo');
 
 		// If the file doesn't exist yet, create it.
-		if ( ! file_exists( $publisher_logo_path ) ) {
-			$original_file_editor->resize( 600, 60 );
-			$original_file_editor->save( $publisher_logo_path );
+		if ( ! file_exists($publisher_logo_path)) {
+			$original_file_editor->resize(600, 60);
+			$original_file_editor->save($publisher_logo_path);
 		}
 
 		// Try to get the image editor and bail out if the editor cannot be instantiated.
-		$publisher_logo_editor = wp_get_image_editor( $publisher_logo_path );
-		if ( is_wp_error( $publisher_logo_editor ) ) {
-			$this->log->warn( "Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id." );
+		$publisher_logo_editor = wp_get_image_editor($publisher_logo_path);
+		if (is_wp_error($publisher_logo_editor)) {
+			$this->log->warn("Cannot instantiate WP Image Editor on file $publisher_logo_path for post $post_id.");
 
 			return false;
 		}
@@ -398,7 +398,7 @@ 
 
 		// Finally return the array with data.
 		return array(
-			'url'    => $uploads_dir['baseurl'] . substr( $publisher_logo_path, strlen( $uploads_dir['basedir'] ) ),
+			'url'    => $uploads_dir['baseurl'].substr($publisher_logo_path, strlen($uploads_dir['basedir'])),
 			'width'  => $size['width'],
 			'height' => $size['height'],
 		);

src/includes/class-wordlift-abstract-post-to-jsonld-converter.php

Indentation +292 added lines, -292 removed lines

@@ -18,317 +18,317 @@
  */
 abstract class Wordlift_Abstract_Post_To_Jsonld_Converter implements Wordlift_Post_Converter {
 
-	/**
-	 * The JSON-LD context.
-	 *
-	 * @since 3.10.0
-	 */
-	const CONTEXT = 'http://schema.org';
-
-	/**
-	 * A {@link Wordlift_Entity_Type_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access protected
-	 * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 */
-	protected $entity_type_service;
-
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access protected
-	 * @var \Wordlift_Entity_Service $entity_type_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	protected $entity_service;
-
-	/**
-	 * A {@link Wordlift_User_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 */
-	protected $user_service;
-
-	/**
-	 * A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since  3.10.0
-	 * @access private
-	 * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 */
-	protected $attachment_service;
-
-	/**
-	 * Wordlift_Post_To_Jsonld_Converter constructor.
-	 *
-	 * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
-	 * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
-	 * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
-	 *
-	 * @since 3.10.0
-	 *
-	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service ) {
-
-		$this->entity_type_service = $entity_type_service;
-		$this->entity_service      = $entity_service;
-		$this->user_service        = $user_service;
-		$this->attachment_service  = $attachment_service;
-	}
-
-	/**
-	 * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
-	 * found while processing the post is set in the $references array.
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $references An array of entity references.
-	 *
-	 * @return array A JSON-LD array.
-	 * @since 3.10.0
-	 *
-	 */
-	public function convert( $post_id, &$references = array() ) {
-
-		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
-			// Post not found.
-			return null;
-		}
-
-		// Get the post URI @id.
-		$id = $this->entity_service->get_uri( $post->ID );
-
-		/*
+    /**
+     * The JSON-LD context.
+     *
+     * @since 3.10.0
+     */
+    const CONTEXT = 'http://schema.org';
+
+    /**
+     * A {@link Wordlift_Entity_Type_Service} instance.
+     *
+     * @since  3.10.0
+     * @access protected
+     * @var \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     */
+    protected $entity_type_service;
+
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.10.0
+     * @access protected
+     * @var \Wordlift_Entity_Service $entity_type_service A {@link Wordlift_Entity_Service} instance.
+     */
+    protected $entity_service;
+
+    /**
+     * A {@link Wordlift_User_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     */
+    protected $user_service;
+
+    /**
+     * A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since  3.10.0
+     * @access private
+     * @var \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     */
+    protected $attachment_service;
+
+    /**
+     * Wordlift_Post_To_Jsonld_Converter constructor.
+     *
+     * @param \Wordlift_Entity_Type_Service $entity_type_service A {@link Wordlift_Entity_Type_Service} instance.
+     * @param \Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_User_Service $user_service A {@link Wordlift_User_Service} instance.
+     * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
+     *
+     * @since 3.10.0
+     *
+     */
+    public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service ) {
+
+        $this->entity_type_service = $entity_type_service;
+        $this->entity_service      = $entity_service;
+        $this->user_service        = $user_service;
+        $this->attachment_service  = $attachment_service;
+    }
+
+    /**
+     * Convert the provided {@link WP_Post} to a JSON-LD array. Any entity reference
+     * found while processing the post is set in the $references array.
+     *
+     * @param int $post_id The post id.
+     * @param array $references An array of entity references.
+     *
+     * @return array A JSON-LD array.
+     * @since 3.10.0
+     *
+     */
+    public function convert( $post_id, &$references = array() ) {
+
+        // Get the post instance.
+        $post = get_post( $post_id );
+        if ( null === $post ) {
+            // Post not found.
+            return null;
+        }
+
+        // Get the post URI @id.
+        $id = $this->entity_service->get_uri( $post->ID );
+
+        /*
 		 * The `types` variable holds one or more entity types. The `type` variable isn't used anymore.
 		 *
 		 * @since 3.20.0 We support more than one entity type.
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/835
 		 */
-		//		// Get the entity @type. We consider `post` BlogPostings.
-		//		$type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
-
-		// Prepare the response.
-		$jsonld = array(
-			'@context'    => self::CONTEXT,
-			'@id'         => $id,
-			'@type'       => self::make_one( $types ),
-			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
-		);
-
-		// Set the `mainEntityOfPage` property if the post has some contents.
-		/*
+        //		// Get the entity @type. We consider `post` BlogPostings.
+        //		$type = $this->entity_type_service->get( $post_id );
+        $types = $this->entity_type_service->get_names( $post_id );
+
+        // Prepare the response.
+        $jsonld = array(
+            '@context'    => self::CONTEXT,
+            '@id'         => $id,
+            '@type'       => self::make_one( $types ),
+            'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
+        );
+
+        // Set the `mainEntityOfPage` property if the post has some contents.
+        /*
 		 * 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 );
-		if ( ! empty( $post_content ) ) {
-			// We're setting the `mainEntityOfPage` to signal which one is the
-			// main entity for the specified URL. It might be however that the
-			// post/page is actually about another specific entity. How WL deals
-			// with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
-			//
-			// See http://schema.org/mainEntityOfPage
-			//
-			// No need to specify `'@type' => 'WebPage'.
-			//
-			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
-		};
-
-		$this->set_images( $post, $jsonld );
-
-		// Get the entities referenced by this post and set it to the `references`
-		// array so that the caller can do further processing, such as printing out
-		// more of those references.
-		$references_without_locations = $this->entity_service->get_related_entities( $post->ID );
-
-		/*
+        $post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
+        if ( ! empty( $post_content ) ) {
+            // We're setting the `mainEntityOfPage` to signal which one is the
+            // main entity for the specified URL. It might be however that the
+            // post/page is actually about another specific entity. How WL deals
+            // with that hasn't been defined yet (see https://github.com/insideout10/wordlift-plugin/issues/451).
+            //
+            // See http://schema.org/mainEntityOfPage
+            //
+            // No need to specify `'@type' => 'WebPage'.
+            //
+            // See https://github.com/insideout10/wordlift-plugin/issues/451.
+            $jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+        };
+
+        $this->set_images( $post, $jsonld );
+
+        // Get the entities referenced by this post and set it to the `references`
+        // array so that the caller can do further processing, such as printing out
+        // more of those references.
+        $references_without_locations = $this->entity_service->get_related_entities( $post->ID );
+
+        /*
 		 * Add the locations to the references.
 		 *
 		 * @since 3.19.5
 		 *
 		 * @see https://github.com/insideout10/wordlift-plugin/issues/858.
 		 */
-		// A reference to use in closure.
-		$entity_type_service = $this->entity_type_service;
-		$locations           = array_reduce( $references_without_locations, function ( $carry, $post_id ) use ( $entity_type_service ) {
-			// @see https://schema.org/location for the schema.org types using the `location` property.
-			if ( ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Action' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Event' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Organization' ) ) {
-				return $carry;
-			}
-
-			return array_merge( $carry, get_post_meta( $post_id, Wordlift_Schema_Service::FIELD_LOCATION ) );
-		}, array() );
-
-		// Merge the references with the referenced locations if any.
-		$references = array_unique( array_merge( $references_without_locations, $locations ) );
-
-		return $jsonld;
-	}
-
-	/**
-	 * If the provided value starts with the schema.org context, we remove the schema.org
-	 * part since it is set with the '@context'.
-	 *
-	 * @param string $value The property value.
-	 *
-	 * @return string The property value without the context.
-	 * @since 3.10.0
-	 *
-	 */
-	public function relative_to_context( $value ) {
-
-		return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
-	}
-
-	/**
-	 * Set the images, by looking for embedded images, for images loaded via the
-	 * gallery and for the featured image.
-	 *
-	 * Uses the cache service to store the results of this function for a day.
-	 *
-	 * @param WP_Post $post The target {@link WP_Post}.
-	 * @param array $jsonld The JSON-LD array.
-	 *
-	 * @since 3.10.0
-	 *
-	 */
-	protected function set_images( $post, &$jsonld ) {
-
-		// Prepare the attachment ids array.
-		$ids = array();
-
-		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
-			$ids[] = $thumbnail_id;
-		}
-
-		// For the time being the following is being removed since the query
-		// initiated by `get_image_embeds` is consuming lots of CPU.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/689.
-		//
-		// Get the embeds, removing existing ids.
-		// $embeds = array_diff( $this->attachment_service->get_image_embeds( $post->post_content ), $ids );
-		$embeds = array();
-
-		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $this->attachment_service->get_gallery( $post ), $ids, $embeds );
-
-		// Map the attachment ids to images' data structured for schema.org use.
-		$images_with_sizes = array_filter(
-			array_reduce( array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
-					/*
+        // A reference to use in closure.
+        $entity_type_service = $this->entity_type_service;
+        $locations           = array_reduce( $references_without_locations, function ( $carry, $post_id ) use ( $entity_type_service ) {
+            // @see https://schema.org/location for the schema.org types using the `location` property.
+            if ( ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Action' )
+                 && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Event' )
+                 && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Organization' ) ) {
+                return $carry;
+            }
+
+            return array_merge( $carry, get_post_meta( $post_id, Wordlift_Schema_Service::FIELD_LOCATION ) );
+        }, array() );
+
+        // Merge the references with the referenced locations if any.
+        $references = array_unique( array_merge( $references_without_locations, $locations ) );
+
+        return $jsonld;
+    }
+
+    /**
+     * If the provided value starts with the schema.org context, we remove the schema.org
+     * part since it is set with the '@context'.
+     *
+     * @param string $value The property value.
+     *
+     * @return string The property value without the context.
+     * @since 3.10.0
+     *
+     */
+    public function relative_to_context( $value ) {
+
+        return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+    }
+
+    /**
+     * Set the images, by looking for embedded images, for images loaded via the
+     * gallery and for the featured image.
+     *
+     * Uses the cache service to store the results of this function for a day.
+     *
+     * @param WP_Post $post The target {@link WP_Post}.
+     * @param array $jsonld The JSON-LD array.
+     *
+     * @since 3.10.0
+     *
+     */
+    protected function set_images( $post, &$jsonld ) {
+
+        // Prepare the attachment ids array.
+        $ids = array();
+
+        // Set the thumbnail id as first attachment id, if any.
+        $thumbnail_id = get_post_thumbnail_id( $post->ID );
+        if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
+            $ids[] = $thumbnail_id;
+        }
+
+        // For the time being the following is being removed since the query
+        // initiated by `get_image_embeds` is consuming lots of CPU.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/689.
+        //
+        // Get the embeds, removing existing ids.
+        // $embeds = array_diff( $this->attachment_service->get_image_embeds( $post->post_content ), $ids );
+        $embeds = array();
+
+        // Get the gallery, removing existing ids.
+        $gallery = array_diff( $this->attachment_service->get_gallery( $post ), $ids, $embeds );
+
+        // Map the attachment ids to images' data structured for schema.org use.
+        $images_with_sizes = array_filter(
+            array_reduce( array_merge( $ids, $embeds, $gallery ),
+                function ( $carry, $item ) {
+                    /*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
-					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
-					);
-
-					$sources_with_image = array_filter( $sources, function ( $source ) {
-						return ! empty( $source[0] );
-					} );
-
-					// Get the attachment data.
-					// $attachment = wp_get_attachment_image_src( $item, 'full' );
-
-					// var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
-
-					// Bail if image is not found.
-					// In some cases, you can delete the image from the database
-					// or from uploads dir, but the image id still exists as featured image
-					// or in [gallery] shortcode.
-					//					if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
-						return $carry;
-					}
-
-					// Merge the arrays.
-					return array_merge(
-						$carry,
-						$sources_with_image
-					);
-				}
-				// Initial array.
-				, array() )
-		);
-
-		// Refactor data as per schema.org specifications.
-		$images = array_map( function ( $attachment ) {
-			return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
-				array(
-					'@type' => 'ImageObject',
-					'url'   => $attachment[0],
-				), $attachment
-			);
-		}, $images_with_sizes );
-
-		// Add images if present.
-		if ( 0 < count( $images ) ) {
-			$jsonld['image'] = $images;
-		}
-
-	}
-
-	/**
-	 * If the provided array of values contains only one value, then one single
-	 * value is returned, otherwise the original array is returned.
-	 *
-	 * @param array $value An array of values.
-	 *
-	 * @return mixed|array A single value or the original array.
-	 * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
-	 *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
-	 * @since  3.8.0
-	 * @access private
-	 *
-	 */
-	protected static function make_one( $value ) {
-
-		return 1 === count( $value ) ? $value[0] : $value;
-	}
-
-	/**
-	 * Process the provided array by adding the width / height if the values
-	 * are available and are greater than 0.
-	 *
-	 * @param array $image The `ImageObject` array.
-	 * @param array $attachment The attachment array.
-	 *
-	 * @return array The enriched `ImageObject` array.
-	 * @since 3.14.0
-	 *
-	 */
-	public static function set_image_size( $image, $attachment ) {
-
-		// If you specify a "width" or "height" value you should leave out
-		// 'px'. For example: "width":"4608px" should be "width":"4608".
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
-			$image['width'] = $attachment[1];
-		}
-
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
-			$image['height'] = $attachment[2];
-		}
-
-		return $image;
-	}
+                    $sources = array_merge(
+                        Wordlift_Image_Service::get_sources( $item ),
+                        array( wp_get_attachment_image_src( $item, 'full' ) )
+                    );
+
+                    $sources_with_image = array_filter( $sources, function ( $source ) {
+                        return ! empty( $source[0] );
+                    } );
+
+                    // Get the attachment data.
+                    // $attachment = wp_get_attachment_image_src( $item, 'full' );
+
+                    // var_dump( array( "sources-$item" => Wordlift_Image_Service::get_sources( $item ) ) );
+
+                    // Bail if image is not found.
+                    // In some cases, you can delete the image from the database
+                    // or from uploads dir, but the image id still exists as featured image
+                    // or in [gallery] shortcode.
+                    //					if ( empty( $attachment[0] ) ) {
+                    if ( empty( $sources_with_image ) ) {
+                        return $carry;
+                    }
+
+                    // Merge the arrays.
+                    return array_merge(
+                        $carry,
+                        $sources_with_image
+                    );
+                }
+                // Initial array.
+                , array() )
+        );
+
+        // Refactor data as per schema.org specifications.
+        $images = array_map( function ( $attachment ) {
+            return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
+                array(
+                    '@type' => 'ImageObject',
+                    'url'   => $attachment[0],
+                ), $attachment
+            );
+        }, $images_with_sizes );
+
+        // Add images if present.
+        if ( 0 < count( $images ) ) {
+            $jsonld['image'] = $images;
+        }
+
+    }
+
+    /**
+     * If the provided array of values contains only one value, then one single
+     * value is returned, otherwise the original array is returned.
+     *
+     * @param array $value An array of values.
+     *
+     * @return mixed|array A single value or the original array.
+     * @since 3.20.0 The function has been moved from {@link Wordlift_Entity_Post_To_Jsonld_Converter} to
+     *  {@link Wordlift_Abstract_Post_To_Jsonld_Converter}.
+     * @since  3.8.0
+     * @access private
+     *
+     */
+    protected static function make_one( $value ) {
+
+        return 1 === count( $value ) ? $value[0] : $value;
+    }
+
+    /**
+     * Process the provided array by adding the width / height if the values
+     * are available and are greater than 0.
+     *
+     * @param array $image The `ImageObject` array.
+     * @param array $attachment The attachment array.
+     *
+     * @return array The enriched `ImageObject` array.
+     * @since 3.14.0
+     *
+     */
+    public static function set_image_size( $image, $attachment ) {
+
+        // If you specify a "width" or "height" value you should leave out
+        // 'px'. For example: "width":"4608px" should be "width":"4608".
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/451.
+        if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+            $image['width'] = $attachment[1];
+        }
+
+        if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+            $image['height'] = $attachment[2];
+        }
+
+        return $image;
+    }
 }

Spacing +42 added lines, -42 removed lines

@@ -72,7 +72,7 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function __construct( $entity_type_service, $entity_service, $user_service, $attachment_service ) {
+	public function __construct($entity_type_service, $entity_service, $user_service, $attachment_service) {
 
 		$this->entity_type_service = $entity_type_service;
 		$this->entity_service      = $entity_service;
@@ -91,17 +91,17 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function convert( $post_id, &$references = array() ) {
+	public function convert($post_id, &$references = array()) {
 
 		// Get the post instance.
-		$post = get_post( $post_id );
-		if ( null === $post ) {
+		$post = get_post($post_id);
+		if (null === $post) {
 			// Post not found.
 			return null;
 		}
 
 		// Get the post URI @id.
-		$id = $this->entity_service->get_uri( $post->ID );
+		$id = $this->entity_service->get_uri($post->ID);
 
 		/*
 		 * The `types` variable holds one or more entity types. The `type` variable isn't used anymore.
@@ -112,14 +112,14 @@ 
 		 */
 		//		// Get the entity @type. We consider `post` BlogPostings.
 		//		$type = $this->entity_type_service->get( $post_id );
-		$types = $this->entity_type_service->get_names( $post_id );
+		$types = $this->entity_type_service->get_names($post_id);
 
 		// Prepare the response.
 		$jsonld = array(
 			'@context'    => self::CONTEXT,
 			'@id'         => $id,
-			'@type'       => self::make_one( $types ),
-			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt( $post ),
+			'@type'       => self::make_one($types),
+			'description' => Wordlift_Post_Excerpt_Helper::get_text_excerpt($post),
 		);
 
 		// Set the `mainEntityOfPage` property if the post has some contents.
@@ -129,8 +129,8 @@ 
 		 *
 		 * @since 3.20.0
 		 */
-		$post_content = apply_filters( 'wl_post_content', $post->post_content, $post );
-		if ( ! empty( $post_content ) ) {
+		$post_content = apply_filters('wl_post_content', $post->post_content, $post);
+		if ( ! empty($post_content)) {
 			// We're setting the `mainEntityOfPage` to signal which one is the
 			// main entity for the specified URL. It might be however that the
 			// post/page is actually about another specific entity. How WL deals
@@ -141,15 +141,15 @@ 
 			// No need to specify `'@type' => 'WebPage'.
 			//
 			// See https://github.com/insideout10/wordlift-plugin/issues/451.
-			$jsonld['mainEntityOfPage'] = get_the_permalink( $post->ID );
+			$jsonld['mainEntityOfPage'] = get_the_permalink($post->ID);
 		};
 
-		$this->set_images( $post, $jsonld );
+		$this->set_images($post, $jsonld);
 
 		// Get the entities referenced by this post and set it to the `references`
 		// array so that the caller can do further processing, such as printing out
 		// more of those references.
-		$references_without_locations = $this->entity_service->get_related_entities( $post->ID );
+		$references_without_locations = $this->entity_service->get_related_entities($post->ID);
 
 		/*
 		 * Add the locations to the references.
@@ -160,19 +160,19 @@ 
 		 */
 		// A reference to use in closure.
 		$entity_type_service = $this->entity_type_service;
-		$locations           = array_reduce( $references_without_locations, function ( $carry, $post_id ) use ( $entity_type_service ) {
+		$locations           = array_reduce($references_without_locations, function($carry, $post_id) use ($entity_type_service) {
 			// @see https://schema.org/location for the schema.org types using the `location` property.
-			if ( ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Action' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Event' )
-			     && ! $entity_type_service->has_entity_type( $post_id, 'http://schema.org/Organization' ) ) {
+			if ( ! $entity_type_service->has_entity_type($post_id, 'http://schema.org/Action')
+			     && ! $entity_type_service->has_entity_type($post_id, 'http://schema.org/Event')
+			     && ! $entity_type_service->has_entity_type($post_id, 'http://schema.org/Organization')) {
 				return $carry;
 			}
 
-			return array_merge( $carry, get_post_meta( $post_id, Wordlift_Schema_Service::FIELD_LOCATION ) );
-		}, array() );
+			return array_merge($carry, get_post_meta($post_id, Wordlift_Schema_Service::FIELD_LOCATION));
+		}, array());
 
 		// Merge the references with the referenced locations if any.
-		$references = array_unique( array_merge( $references_without_locations, $locations ) );
+		$references = array_unique(array_merge($references_without_locations, $locations));
 
 		return $jsonld;
 	}
@@ -187,9 +187,9 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	public function relative_to_context( $value ) {
+	public function relative_to_context($value) {
 
-		return 0 === strpos( $value, self::CONTEXT . '/' ) ? substr( $value, strlen( self::CONTEXT ) + 1 ) : $value;
+		return 0 === strpos($value, self::CONTEXT.'/') ? substr($value, strlen(self::CONTEXT) + 1) : $value;
 	}
 
 	/**
@@ -204,14 +204,14 @@ 
 	 * @since 3.10.0
 	 *
 	 */
-	protected function set_images( $post, &$jsonld ) {
+	protected function set_images($post, &$jsonld) {
 
 		// Prepare the attachment ids array.
 		$ids = array();
 
 		// Set the thumbnail id as first attachment id, if any.
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id && 0 !== $thumbnail_id) {
 			$ids[] = $thumbnail_id;
 		}
 
@@ -225,24 +225,24 @@ 
 		$embeds = array();
 
 		// Get the gallery, removing existing ids.
-		$gallery = array_diff( $this->attachment_service->get_gallery( $post ), $ids, $embeds );
+		$gallery = array_diff($this->attachment_service->get_gallery($post), $ids, $embeds);
 
 		// Map the attachment ids to images' data structured for schema.org use.
 		$images_with_sizes = array_filter(
-			array_reduce( array_merge( $ids, $embeds, $gallery ),
-				function ( $carry, $item ) {
+			array_reduce(array_merge($ids, $embeds, $gallery),
+				function($carry, $item) {
 					/*
 					* @todo: we're not sure that we're getting attachment data here, we
 					* should filter `false`s.
 					*/
 
 					$sources = array_merge(
-						Wordlift_Image_Service::get_sources( $item ),
-						array( wp_get_attachment_image_src( $item, 'full' ) )
+						Wordlift_Image_Service::get_sources($item),
+						array(wp_get_attachment_image_src($item, 'full'))
 					);
 
-					$sources_with_image = array_filter( $sources, function ( $source ) {
-						return ! empty( $source[0] );
+					$sources_with_image = array_filter($sources, function($source) {
+						return ! empty($source[0]);
 					} );
 
 					// Get the attachment data.
@@ -255,7 +255,7 @@ 
 					// or from uploads dir, but the image id still exists as featured image
 					// or in [gallery] shortcode.
 					//					if ( empty( $attachment[0] ) ) {
-					if ( empty( $sources_with_image ) ) {
+					if (empty($sources_with_image)) {
 						return $carry;
 					}
 
@@ -266,21 +266,21 @@ 
 					);
 				}
 				// Initial array.
-				, array() )
+				, array())
 		);
 
 		// Refactor data as per schema.org specifications.
-		$images = array_map( function ( $attachment ) {
+		$images = array_map(function($attachment) {
 			return Wordlift_Abstract_Post_To_Jsonld_Converter::set_image_size(
 				array(
 					'@type' => 'ImageObject',
 					'url'   => $attachment[0],
 				), $attachment
 			);
-		}, $images_with_sizes );
+		}, $images_with_sizes);
 
 		// Add images if present.
-		if ( 0 < count( $images ) ) {
+		if (0 < count($images)) {
 			$jsonld['image'] = $images;
 		}
 
@@ -299,9 +299,9 @@ 
 	 * @access private
 	 *
 	 */
-	protected static function make_one( $value ) {
+	protected static function make_one($value) {
 
-		return 1 === count( $value ) ? $value[0] : $value;
+		return 1 === count($value) ? $value[0] : $value;
 	}
 
 	/**
@@ -315,17 +315,17 @@ 
 	 * @since 3.14.0
 	 *
 	 */
-	public static function set_image_size( $image, $attachment ) {
+	public static function set_image_size($image, $attachment) {
 
 		// If you specify a "width" or "height" value you should leave out
 		// 'px'. For example: "width":"4608px" should be "width":"4608".
 		//
 		// See https://github.com/insideout10/wordlift-plugin/issues/451.
-		if ( isset( $attachment[1] ) && is_numeric( $attachment[1] ) && 0 < $attachment[1] ) {
+		if (isset($attachment[1]) && is_numeric($attachment[1]) && 0 < $attachment[1]) {
 			$image['width'] = $attachment[1];
 		}
 
-		if ( isset( $attachment[2] ) && is_numeric( $attachment[2] ) && 0 < $attachment[2] ) {
+		if (isset($attachment[2]) && is_numeric($attachment[2]) && 0 < $attachment[2]) {
 			$image['height'] = $attachment[2];
 		}
 

src/shortcodes/wordlift_shortcode_chord.php

Indentation +175 added lines, -175 removed lines

@@ -15,45 +15,45 @@ 
  * @return mixed
  */
 function wl_shortcode_chord_most_referenced_entity_id() {
-	// Get the last 20 articles by post date.
-	// For each article get the entities they reference.
-	$post_ids = get_posts( array(
-		'numberposts' => 20,
-		'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
-		'fields'      => 'ids', // Only get post IDs.
-		'post_status' => 'publish',
-		'tax_query'   => array(
-			'relation' => 'OR',
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'operator' => 'NOT EXISTS',
-			),
-			array(
-				'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
-				'field'    => 'slug',
-				'terms'    => 'article',
-			),
-		),
-		'orderby'     => 'post_date',
-		'order'       => 'DESC',
-	) );
-
-	if ( empty( $post_ids ) ) {
-		return null;
-	}
-
-	$entities = array();
-	foreach ( $post_ids as $id ) {
-		$entities = array_merge( $entities, wl_core_get_related_entity_ids( $id ) );
-	}
-
-	$famous_entities = array_count_values( $entities );
-	arsort( $famous_entities );
-	if ( sizeof( $famous_entities ) >= 1 ) {
-		return key( $famous_entities );
-	} else {
-		return $post_ids[0];
-	}
+    // Get the last 20 articles by post date.
+    // For each article get the entities they reference.
+    $post_ids = get_posts( array(
+        'numberposts' => 20,
+        'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
+        'fields'      => 'ids', // Only get post IDs.
+        'post_status' => 'publish',
+        'tax_query'   => array(
+            'relation' => 'OR',
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'operator' => 'NOT EXISTS',
+            ),
+            array(
+                'taxonomy' => Wordlift_Entity_Type_Taxonomy_Service::TAXONOMY_NAME,
+                'field'    => 'slug',
+                'terms'    => 'article',
+            ),
+        ),
+        'orderby'     => 'post_date',
+        'order'       => 'DESC',
+    ) );
+
+    if ( empty( $post_ids ) ) {
+        return null;
+    }
+
+    $entities = array();
+    foreach ( $post_ids as $id ) {
+        $entities = array_merge( $entities, wl_core_get_related_entity_ids( $id ) );
+    }
+
+    $famous_entities = array_count_values( $entities );
+    arsort( $famous_entities );
+    if ( sizeof( $famous_entities ) >= 1 ) {
+        return key( $famous_entities );
+    } else {
+        return $post_ids[0];
+    }
 
 }
 
@@ -71,60 +71,60 @@ 
  */
 function wl_shortcode_chord_get_relations( $entity_id, $depth = 2, $related = null, $max_size = 9 ) {
 
-	if ( ! is_null( $related ) ) {
-		if ( 0 === $depth ) {
-			return $related;
-		}
-	}
+    if ( ! is_null( $related ) ) {
+        if ( 0 === $depth ) {
+            return $related;
+        }
+    }
 
-	wl_write_log( "wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: " . ( is_null( $related ) ? 'yes' : 'no' ) . " ]" );
+    wl_write_log( "wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: " . ( is_null( $related ) ? 'yes' : 'no' ) . " ]" );
 
-	// Create a related array which will hold entities and relations.
-	if ( is_null( $related ) ) {
-		$related = array(
-			'entities'  => array( $entity_id ),
-			'relations' => array(),
-		);
-	}
+    // Create a related array which will hold entities and relations.
+    if ( is_null( $related ) ) {
+        $related = array(
+            'entities'  => array( $entity_id ),
+            'relations' => array(),
+        );
+    }
 
-	// Get related entities
-	$related_entity_ids = wl_core_get_related_entity_ids( $entity_id, array(
-		'status' => 'publish',
-	) );
+    // Get related entities
+    $related_entity_ids = wl_core_get_related_entity_ids( $entity_id, array(
+        'status' => 'publish',
+    ) );
 
-	// If the current node is an entity, add related posts too
-	$related_post_ids = ( Wordlift_Entity_Service::get_instance()
-	                                             ->is_entity( $entity_id ) ) ?
-		wl_core_get_related_post_ids( $entity_id, array(
-			'status' => 'publish',
-		) ) :
-		array();
+    // If the current node is an entity, add related posts too
+    $related_post_ids = ( Wordlift_Entity_Service::get_instance()
+                                                    ->is_entity( $entity_id ) ) ?
+        wl_core_get_related_post_ids( $entity_id, array(
+            'status' => 'publish',
+        ) ) :
+        array();
 
-	// Merge results and remove duplicated entries
-	$related_ids = array_unique( array_merge( $related_post_ids, $related_entity_ids ) );
+    // Merge results and remove duplicated entries
+    $related_ids = array_unique( array_merge( $related_post_ids, $related_entity_ids ) );
 
-	// TODO: List of entities ($rel) should be ordered by interest factors.
-	shuffle( $related_ids );
+    // TODO: List of entities ($rel) should be ordered by interest factors.
+    shuffle( $related_ids );
 
-	// Now we have all the related IDs.
-	foreach ( $related_ids as $related_id ) {
+    // Now we have all the related IDs.
+    foreach ( $related_ids as $related_id ) {
 
-		if ( count( $related['entities'] ) >= $max_size ) {
-			return $related;
-		}
+        if ( count( $related['entities'] ) >= $max_size ) {
+            return $related;
+        }
 
-		$related['relations'][] = array( $entity_id, $related_id );
+        $related['relations'][] = array( $entity_id, $related_id );
 
-		if ( ! in_array( $related_id, $related['entities'] ) ) {
-			// Found new related entity!
-			$related['entities'][] = $related_id;
+        if ( ! in_array( $related_id, $related['entities'] ) ) {
+            // Found new related entity!
+            $related['entities'][] = $related_id;
 
-			$related = wl_shortcode_chord_get_relations( $related_id, ( $depth - 1 ), $related, $max_size );
-		}
-	}
+            $related = wl_shortcode_chord_get_relations( $related_id, ( $depth - 1 ), $related, $max_size );
+        }
+    }
 
-	// End condition 2: no more entities to search for.
-	return $related;
+    // End condition 2: no more entities to search for.
+    return $related;
 }
 
 /**
@@ -138,57 +138,57 @@ 
  */
 function wl_shortcode_chord_get_graph( $data ) {
 
-	// Refactor the entities array in order to provide entities relevant data (uri, url, label, type, css_class).
-	array_walk( $data['entities'], function ( &$item ) {
-		$post = get_post( $item );
-
-		// Skip non-existing posts.
-		if ( is_null( $post ) ) {
-			wl_write_log( "wl_shortcode_chord_get_graph : post not found [ post id :: $item ]" );
-
-			return $item;
-		}
-
-		// Get the entity taxonomy bound to this post (if there's no taxonomy, no stylesheet will be set).
-		$term = Wordlift_Entity_Type_Service::get_instance()->get( $item );
-
-		// The following log may create a circular loop.
-		// wl_write_log( "wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: " . var_export( $term, true ) . " ]" );
-
-		// TODO: get all images
-		$thumbnail    = null;
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
-			$attachment = wp_get_attachment_image_src( $thumbnail_id );
-			if ( false !== $attachment ) {
-				$thumbnail = esc_attr( $attachment[0] );
-			}
-		}
-
-		$entity = array(
-			'uri'        => wl_get_entity_uri( $item ),
-			'url'        => get_permalink( $item ),
-			'label'      => $post->post_title,
-			'type'       => $post->post_type,
-			'thumbnails' => array( $thumbnail ),
-			'css_class'  => ( isset( $term['css_class'] ) ? $term['css_class'] : '' ),
-		);
-
-		$item = $entity;
-	} );
-
-	// Refactor the relations.
-	array_walk( $data['relations'], function ( &$item ) {
-		$relation = array(
-			's' => wl_get_entity_uri( $item[0] ),
-			'o' => wl_get_entity_uri( $item[1] ),
-		);
-
-		$item = $relation;
-	} );
-
-	// Return the JSON representation.
-	return $data;
+    // Refactor the entities array in order to provide entities relevant data (uri, url, label, type, css_class).
+    array_walk( $data['entities'], function ( &$item ) {
+        $post = get_post( $item );
+
+        // Skip non-existing posts.
+        if ( is_null( $post ) ) {
+            wl_write_log( "wl_shortcode_chord_get_graph : post not found [ post id :: $item ]" );
+
+            return $item;
+        }
+
+        // Get the entity taxonomy bound to this post (if there's no taxonomy, no stylesheet will be set).
+        $term = Wordlift_Entity_Type_Service::get_instance()->get( $item );
+
+        // The following log may create a circular loop.
+        // wl_write_log( "wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: " . var_export( $term, true ) . " ]" );
+
+        // TODO: get all images
+        $thumbnail    = null;
+        $thumbnail_id = get_post_thumbnail_id( $post->ID );
+        if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
+            $attachment = wp_get_attachment_image_src( $thumbnail_id );
+            if ( false !== $attachment ) {
+                $thumbnail = esc_attr( $attachment[0] );
+            }
+        }
+
+        $entity = array(
+            'uri'        => wl_get_entity_uri( $item ),
+            'url'        => get_permalink( $item ),
+            'label'      => $post->post_title,
+            'type'       => $post->post_type,
+            'thumbnails' => array( $thumbnail ),
+            'css_class'  => ( isset( $term['css_class'] ) ? $term['css_class'] : '' ),
+        );
+
+        $item = $entity;
+    } );
+
+    // Refactor the relations.
+    array_walk( $data['relations'], function ( &$item ) {
+        $relation = array(
+            's' => wl_get_entity_uri( $item[0] ),
+            'o' => wl_get_entity_uri( $item[1] ),
+        );
+
+        $item = $relation;
+    } );
+
+    // Return the JSON representation.
+    return $data;
 }
 
 /**
@@ -199,13 +199,13 @@ 
  */
 function wl_shortcode_chord_ajax() {
 
-	$post_id = $_REQUEST['post_id'];
-	$depth   = $_REQUEST['depth'];
+    $post_id = $_REQUEST['post_id'];
+    $depth   = $_REQUEST['depth'];
 
-	$relations = wl_shortcode_chord_get_relations( $post_id, $depth );
-	$graph     = wl_shortcode_chord_get_graph( $relations );
+    $relations = wl_shortcode_chord_get_relations( $post_id, $depth );
+    $graph     = wl_shortcode_chord_get_graph( $relations );
 
-	wl_core_send_json( $graph );
+    wl_core_send_json( $graph );
 }
 
 add_action( 'wp_ajax_wl_chord', 'wl_shortcode_chord_ajax' );
@@ -216,42 +216,42 @@ 
  */
 add_action( 'init', function () {
 
-	// Bail out if the `register_block_type` function isn't available.
-	if ( ! function_exists( 'register_block_type' ) ) {
-		return;
-	}
-
-	register_block_type( 'wordlift/chord', array(
-		'editor_script'   => 'wl-block-editor',
-		'render_callback' => function ( $attributes ) {
-			$attr_code = '';
-			foreach ( $attributes as $key => $value ) {
-				$attr_code .= $key . '="' . $value . '" ';
-			}
-
-			return '[wl_chord ' . $attr_code . ']';
-		},
-		'attributes'      => array(
-			'width'      => array(
-				'type'    => 'string',
-				'default' => '100%',
-			),
-			'height'     => array(
-				'type'    => 'string',
-				'default' => '500px',
-			),
-			'main_color' => array(
-				'type'    => 'string',
-				'default' => '000',
-			),
-			'depth'      => array(
-				'type'    => 'number',
-				'default' => 2,
-			),
-			'global'     => array(
-				'type'    => 'bool',
-				'default' => false,
-			),
-		),
-	) );
+    // Bail out if the `register_block_type` function isn't available.
+    if ( ! function_exists( 'register_block_type' ) ) {
+        return;
+    }
+
+    register_block_type( 'wordlift/chord', array(
+        'editor_script'   => 'wl-block-editor',
+        'render_callback' => function ( $attributes ) {
+            $attr_code = '';
+            foreach ( $attributes as $key => $value ) {
+                $attr_code .= $key . '="' . $value . '" ';
+            }
+
+            return '[wl_chord ' . $attr_code . ']';
+        },
+        'attributes'      => array(
+            'width'      => array(
+                'type'    => 'string',
+                'default' => '100%',
+            ),
+            'height'     => array(
+                'type'    => 'string',
+                'default' => '500px',
+            ),
+            'main_color' => array(
+                'type'    => 'string',
+                'default' => '000',
+            ),
+            'depth'      => array(
+                'type'    => 'number',
+                'default' => 2,
+            ),
+            'global'     => array(
+                'type'    => 'bool',
+                'default' => false,
+            ),
+        ),
+    ) );
 } );

Spacing +59 added lines, -60 removed lines

@@ -17,7 +17,7 @@ 
 function wl_shortcode_chord_most_referenced_entity_id() {
 	// Get the last 20 articles by post date.
 	// For each article get the entities they reference.
-	$post_ids = get_posts( array(
+	$post_ids = get_posts(array(
 		'numberposts' => 20,
 		'post_type'   => Wordlift_Entity_Service::valid_entity_post_types(),
 		'fields'      => 'ids', // Only get post IDs.
@@ -36,21 +36,21 @@ 
 		),
 		'orderby'     => 'post_date',
 		'order'       => 'DESC',
-	) );
+	));
 
-	if ( empty( $post_ids ) ) {
+	if (empty($post_ids)) {
 		return null;
 	}
 
 	$entities = array();
-	foreach ( $post_ids as $id ) {
-		$entities = array_merge( $entities, wl_core_get_related_entity_ids( $id ) );
+	foreach ($post_ids as $id) {
+		$entities = array_merge($entities, wl_core_get_related_entity_ids($id));
 	}
 
-	$famous_entities = array_count_values( $entities );
-	arsort( $famous_entities );
-	if ( sizeof( $famous_entities ) >= 1 ) {
-		return key( $famous_entities );
+	$famous_entities = array_count_values($entities);
+	arsort($famous_entities);
+	if (sizeof($famous_entities) >= 1) {
+		return key($famous_entities);
 	} else {
 		return $post_ids[0];
 	}
@@ -69,57 +69,56 @@ 
  * @uses wl_core_get_related_post_ids() to get the list of post ids that reference an entity.
  *
  */
-function wl_shortcode_chord_get_relations( $entity_id, $depth = 2, $related = null, $max_size = 9 ) {
+function wl_shortcode_chord_get_relations($entity_id, $depth = 2, $related = null, $max_size = 9) {
 
-	if ( ! is_null( $related ) ) {
-		if ( 0 === $depth ) {
+	if ( ! is_null($related)) {
+		if (0 === $depth) {
 			return $related;
 		}
 	}
 
-	wl_write_log( "wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: " . ( is_null( $related ) ? 'yes' : 'no' ) . " ]" );
+	wl_write_log("wl_shortcode_chord_get_relations [ post id :: $entity_id ][ depth :: $depth ][ related? :: ".(is_null($related) ? 'yes' : 'no')." ]");
 
 	// Create a related array which will hold entities and relations.
-	if ( is_null( $related ) ) {
+	if (is_null($related)) {
 		$related = array(
-			'entities'  => array( $entity_id ),
+			'entities'  => array($entity_id),
 			'relations' => array(),
 		);
 	}
 
 	// Get related entities
-	$related_entity_ids = wl_core_get_related_entity_ids( $entity_id, array(
+	$related_entity_ids = wl_core_get_related_entity_ids($entity_id, array(
 		'status' => 'publish',
-	) );
+	));
 
 	// If the current node is an entity, add related posts too
-	$related_post_ids = ( Wordlift_Entity_Service::get_instance()
-	                                             ->is_entity( $entity_id ) ) ?
-		wl_core_get_related_post_ids( $entity_id, array(
+	$related_post_ids = (Wordlift_Entity_Service::get_instance()
+	                                             ->is_entity($entity_id)) ?
+		wl_core_get_related_post_ids($entity_id, array(
 			'status' => 'publish',
-		) ) :
-		array();
+		)) : array();
 
 	// Merge results and remove duplicated entries
-	$related_ids = array_unique( array_merge( $related_post_ids, $related_entity_ids ) );
+	$related_ids = array_unique(array_merge($related_post_ids, $related_entity_ids));
 
 	// TODO: List of entities ($rel) should be ordered by interest factors.
-	shuffle( $related_ids );
+	shuffle($related_ids);
 
 	// Now we have all the related IDs.
-	foreach ( $related_ids as $related_id ) {
+	foreach ($related_ids as $related_id) {
 
-		if ( count( $related['entities'] ) >= $max_size ) {
+		if (count($related['entities']) >= $max_size) {
 			return $related;
 		}
 
-		$related['relations'][] = array( $entity_id, $related_id );
+		$related['relations'][] = array($entity_id, $related_id);
 
-		if ( ! in_array( $related_id, $related['entities'] ) ) {
+		if ( ! in_array($related_id, $related['entities'])) {
 			// Found new related entity!
 			$related['entities'][] = $related_id;
 
-			$related = wl_shortcode_chord_get_relations( $related_id, ( $depth - 1 ), $related, $max_size );
+			$related = wl_shortcode_chord_get_relations($related_id, ($depth - 1), $related, $max_size);
 		}
 	}
 
@@ -136,52 +135,52 @@ 
  *
  * @return mixed|string
  */
-function wl_shortcode_chord_get_graph( $data ) {
+function wl_shortcode_chord_get_graph($data) {
 
 	// Refactor the entities array in order to provide entities relevant data (uri, url, label, type, css_class).
-	array_walk( $data['entities'], function ( &$item ) {
-		$post = get_post( $item );
+	array_walk($data['entities'], function(&$item) {
+		$post = get_post($item);
 
 		// Skip non-existing posts.
-		if ( is_null( $post ) ) {
-			wl_write_log( "wl_shortcode_chord_get_graph : post not found [ post id :: $item ]" );
+		if (is_null($post)) {
+			wl_write_log("wl_shortcode_chord_get_graph : post not found [ post id :: $item ]");
 
 			return $item;
 		}
 
 		// Get the entity taxonomy bound to this post (if there's no taxonomy, no stylesheet will be set).
-		$term = Wordlift_Entity_Type_Service::get_instance()->get( $item );
+		$term = Wordlift_Entity_Type_Service::get_instance()->get($item);
 
 		// The following log may create a circular loop.
 		// wl_write_log( "wl_shortcode_chord_get_graph [ post id :: $post->ID ][ term :: " . var_export( $term, true ) . " ]" );
 
 		// TODO: get all images
 		$thumbnail    = null;
-		$thumbnail_id = get_post_thumbnail_id( $post->ID );
-		if ( '' !== $thumbnail_id && 0 !== $thumbnail_id ) {
-			$attachment = wp_get_attachment_image_src( $thumbnail_id );
-			if ( false !== $attachment ) {
-				$thumbnail = esc_attr( $attachment[0] );
+		$thumbnail_id = get_post_thumbnail_id($post->ID);
+		if ('' !== $thumbnail_id && 0 !== $thumbnail_id) {
+			$attachment = wp_get_attachment_image_src($thumbnail_id);
+			if (false !== $attachment) {
+				$thumbnail = esc_attr($attachment[0]);
 			}
 		}
 
 		$entity = array(
-			'uri'        => wl_get_entity_uri( $item ),
-			'url'        => get_permalink( $item ),
+			'uri'        => wl_get_entity_uri($item),
+			'url'        => get_permalink($item),
 			'label'      => $post->post_title,
 			'type'       => $post->post_type,
-			'thumbnails' => array( $thumbnail ),
-			'css_class'  => ( isset( $term['css_class'] ) ? $term['css_class'] : '' ),
+			'thumbnails' => array($thumbnail),
+			'css_class'  => (isset($term['css_class']) ? $term['css_class'] : ''),
 		);
 
 		$item = $entity;
 	} );
 
 	// Refactor the relations.
-	array_walk( $data['relations'], function ( &$item ) {
+	array_walk($data['relations'], function(&$item) {
 		$relation = array(
-			's' => wl_get_entity_uri( $item[0] ),
-			'o' => wl_get_entity_uri( $item[1] ),
+			's' => wl_get_entity_uri($item[0]),
+			'o' => wl_get_entity_uri($item[1]),
 		);
 
 		$item = $relation;
@@ -202,34 +201,34 @@ 
 	$post_id = $_REQUEST['post_id'];
 	$depth   = $_REQUEST['depth'];
 
-	$relations = wl_shortcode_chord_get_relations( $post_id, $depth );
-	$graph     = wl_shortcode_chord_get_graph( $relations );
+	$relations = wl_shortcode_chord_get_relations($post_id, $depth);
+	$graph     = wl_shortcode_chord_get_graph($relations);
 
-	wl_core_send_json( $graph );
+	wl_core_send_json($graph);
 }
 
-add_action( 'wp_ajax_wl_chord', 'wl_shortcode_chord_ajax' );
-add_action( 'wp_ajax_nopriv_wl_chord', 'wl_shortcode_chord_ajax' );
+add_action('wp_ajax_wl_chord', 'wl_shortcode_chord_ajax');
+add_action('wp_ajax_nopriv_wl_chord', 'wl_shortcode_chord_ajax');
 
 /**
  * register_block_type for Gutenberg blocks
  */
-add_action( 'init', function () {
+add_action('init', function() {
 
 	// Bail out if the `register_block_type` function isn't available.
-	if ( ! function_exists( 'register_block_type' ) ) {
+	if ( ! function_exists('register_block_type')) {
 		return;
 	}
 
-	register_block_type( 'wordlift/chord', array(
+	register_block_type('wordlift/chord', array(
 		'editor_script'   => 'wl-block-editor',
-		'render_callback' => function ( $attributes ) {
+		'render_callback' => function($attributes) {
 			$attr_code = '';
-			foreach ( $attributes as $key => $value ) {
-				$attr_code .= $key . '="' . $value . '" ';
+			foreach ($attributes as $key => $value) {
+				$attr_code .= $key.'="'.$value.'" ';
 			}
 
-			return '[wl_chord ' . $attr_code . ']';
+			return '[wl_chord '.$attr_code.']';
 		},
 		'attributes'      => array(
 			'width'      => array(
@@ -253,5 +252,5 @@ 
 				'default' => false,
 			),
 		),
-	) );
+	));
 } );