insideout10 / wordlift-plugin

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

Indentation +153 added lines, -153 removed lines

@@ -13,158 +13,158 @@
  */
 class Wordlift_Jsonld_Service {
 
-	/**
-	 * A {@link Wordlift_Entity_Service} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
-	 */
-	private $entity_service;
-
-	/**
-	 * A {@link Wordlift_Post_Converter} instance.
-	 *
-	 * @since  3.8.0
-	 * @access private
-	 * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
-	 */
-	private $converter;
-
-
-	/**
-	 * A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 *
-	 * @since  3.14.0
-	 * @access private
-	 * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	private $website_converter;
-
-	/**
-	 * The singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
-	 */
-	private static $instance;
-
-	/**
-	 * Create a JSON-LD service.
-	 *
-	 * @since 3.8.0
-	 *
-	 * @param \Wordlift_Entity_Service           $entity_service    A {@link Wordlift_Entity_Service} instance.
-	 * @param \Wordlift_Post_Converter           $converter         A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
-	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
-	 */
-	public function __construct( $entity_service, $converter, $website_converter ) {
-
-		$this->entity_service    = $entity_service;
-		$this->converter         = $converter;
-		$this->website_converter = $website_converter;
-
-		self::$instance = $this;
-
-	}
-
-	/**
-	 * Get the singleton instance for the JSON-LD service.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
-	 */
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Process calls to the AJAX 'wl_jsonld' endpoint.
-	 *
-	 * @since 3.8.0
-	 */
-	public function get() {
-		// Clear the buffer to be sure someone doesn't mess with our response.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/406.
-		// See https://codex.wordpress.org/AJAX_in_Plugins.
-		@ob_clean();
-
-		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] );
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null;
-
-		// Send the generated JSON-LD.
-		wp_send_json( $this->get_jsonld( $is_homepage, $post_id ) );
-
-	}
-
-	/**
-	 * Get the JSON-LD.
-	 *
-	 * @since 3.15.1
-	 *
-	 * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
-	 * @param int|null $post_id     The JSON-LD for the specified {@link WP_Post} id.
-	 *
-	 * @return array A JSON-LD structure.
-	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null ) {
-
-		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
-		// e-mails with a low apdex score.
-		//
-		// See https://github.com/insideout10/wordlift-plugin/issues/521
-		Wordlift_NewRelic_Adapter::ignore_apdex();
-
-		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
-			/**
-			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
-			 *
-			 * @since  3.14.0
-			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
-			 */
-			if ( ! apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
-				// Set a reference to the website_converter.
-				$website_converter = $this->website_converter;
-
-				// Send JSON-LD.
-				return $website_converter->create_schema();
-			}
-		}
-
-		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
-			return array();
-		}
-
-		// An array of references which is captured when converting an URI to a
-		// json which we gather to further expand our json-ld.
-		$references = array();
-
-		// Set a reference to the entity_to_jsonld_converter to use in the closures.
-		$entity_to_jsonld_converter = $this->converter;
-
-		// Convert each URI to a JSON-LD array, while gathering referenced entities.
-		// in the references array.
-		$jsonld = array_merge(
-			array( $entity_to_jsonld_converter->convert( $post_id, $references ) ),
-			// Convert each URI in the references array to JSON-LD. We don't output
-			// entities already output above (hence the array_diff).
-			array_filter( array_map( function ( $item ) use ( $entity_to_jsonld_converter, $references ) {
-
-				// "2nd level properties" may not output here, e.g. a post
-				// mentioning an event, located in a place: the place is referenced
-				// via the `@id` but no other properties are loaded.
-				return $entity_to_jsonld_converter->convert( $item, $references );
-			}, $references ) ) );
-
-		// Finally send the JSON-LD.
-		return $jsonld;
-	}
+    /**
+     * A {@link Wordlift_Entity_Service} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var Wordlift_Entity_Service $entity_service A {@link Wordlift_Entity_Service} instance.
+     */
+    private $entity_service;
+
+    /**
+     * A {@link Wordlift_Post_Converter} instance.
+     *
+     * @since  3.8.0
+     * @access private
+     * @var \Wordlift_Post_Converter A {@link Wordlift_Post_Converter} instance.
+     */
+    private $converter;
+
+
+    /**
+     * A {@link Wordlift_Website_Jsonld_Converter} instance.
+     *
+     * @since  3.14.0
+     * @access private
+     * @var \Wordlift_Website_Jsonld_Converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    private $website_converter;
+
+    /**
+     * The singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @var \Wordlift_Jsonld_Service $instance The singleton instance for the JSON-LD service.
+     */
+    private static $instance;
+
+    /**
+     * Create a JSON-LD service.
+     *
+     * @since 3.8.0
+     *
+     * @param \Wordlift_Entity_Service           $entity_service    A {@link Wordlift_Entity_Service} instance.
+     * @param \Wordlift_Post_Converter           $converter         A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
+     * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
+     */
+    public function __construct( $entity_service, $converter, $website_converter ) {
+
+        $this->entity_service    = $entity_service;
+        $this->converter         = $converter;
+        $this->website_converter = $website_converter;
+
+        self::$instance = $this;
+
+    }
+
+    /**
+     * Get the singleton instance for the JSON-LD service.
+     *
+     * @since 3.15.1
+     *
+     * @return \Wordlift_Jsonld_Service The singleton instance for the JSON-LD service.
+     */
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Process calls to the AJAX 'wl_jsonld' endpoint.
+     *
+     * @since 3.8.0
+     */
+    public function get() {
+        // Clear the buffer to be sure someone doesn't mess with our response.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/406.
+        // See https://codex.wordpress.org/AJAX_in_Plugins.
+        @ob_clean();
+
+        // Get the parameter from the request.
+        $is_homepage = isset( $_REQUEST['homepage'] );
+        $post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null;
+
+        // Send the generated JSON-LD.
+        wp_send_json( $this->get_jsonld( $is_homepage, $post_id ) );
+
+    }
+
+    /**
+     * Get the JSON-LD.
+     *
+     * @since 3.15.1
+     *
+     * @param bool     $is_homepage Whether the JSON-LD for the homepage is being requested.
+     * @param int|null $post_id     The JSON-LD for the specified {@link WP_Post} id.
+     *
+     * @return array A JSON-LD structure.
+     */
+    public function get_jsonld( $is_homepage = false, $post_id = null ) {
+
+        // Tell NewRelic to ignore us, otherwise NewRelic customers might receive
+        // e-mails with a low apdex score.
+        //
+        // See https://github.com/insideout10/wordlift-plugin/issues/521
+        Wordlift_NewRelic_Adapter::ignore_apdex();
+
+        // Switch to Website converter if is home page.
+        if ( $is_homepage ) {
+            /**
+             * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
+             *
+             * @since  3.14.0
+             * @api    bool $display_search Whether or not to display json+ld search on the frontend.
+             */
+            if ( ! apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+                // Set a reference to the website_converter.
+                $website_converter = $this->website_converter;
+
+                // Send JSON-LD.
+                return $website_converter->create_schema();
+            }
+        }
+
+        // If no id has been provided return an empty array.
+        if ( ! isset( $post_id ) ) {
+            return array();
+        }
+
+        // An array of references which is captured when converting an URI to a
+        // json which we gather to further expand our json-ld.
+        $references = array();
+
+        // Set a reference to the entity_to_jsonld_converter to use in the closures.
+        $entity_to_jsonld_converter = $this->converter;
+
+        // Convert each URI to a JSON-LD array, while gathering referenced entities.
+        // in the references array.
+        $jsonld = array_merge(
+            array( $entity_to_jsonld_converter->convert( $post_id, $references ) ),
+            // Convert each URI in the references array to JSON-LD. We don't output
+            // entities already output above (hence the array_diff).
+            array_filter( array_map( function ( $item ) use ( $entity_to_jsonld_converter, $references ) {
+
+                // "2nd level properties" may not output here, e.g. a post
+                // mentioning an event, located in a place: the place is referenced
+                // via the `@id` but no other properties are loaded.
+                return $entity_to_jsonld_converter->convert( $item, $references );
+            }, $references ) ) );
+
+        // Finally send the JSON-LD.
+        return $jsonld;
+    }
 
 }

Spacing +12 added lines, -12 removed lines

@@ -59,7 +59,7 @@ 
 	 * @param \Wordlift_Post_Converter           $converter         A {@link Wordlift_Uri_To_Jsonld_Converter} instance.
 	 * @param \Wordlift_Website_Jsonld_Converter $website_converter A {@link Wordlift_Website_Jsonld_Converter} instance.
 	 */
-	public function __construct( $entity_service, $converter, $website_converter ) {
+	public function __construct($entity_service, $converter, $website_converter) {
 
 		$this->entity_service    = $entity_service;
 		$this->converter         = $converter;
@@ -94,11 +94,11 @@ 
 		@ob_clean();
 
 		// Get the parameter from the request.
-		$is_homepage = isset( $_REQUEST['homepage'] );
-		$post_id     = isset( $_REQUEST['id'] ) && is_numeric( $_REQUEST['id'] ) ? intval( $_REQUEST['id'] ) : null;
+		$is_homepage = isset($_REQUEST['homepage']);
+		$post_id     = isset($_REQUEST['id']) && is_numeric($_REQUEST['id']) ? intval($_REQUEST['id']) : null;
 
 		// Send the generated JSON-LD.
-		wp_send_json( $this->get_jsonld( $is_homepage, $post_id ) );
+		wp_send_json($this->get_jsonld($is_homepage, $post_id));
 
 	}
 
@@ -112,7 +112,7 @@ 
 	 *
 	 * @return array A JSON-LD structure.
 	 */
-	public function get_jsonld( $is_homepage = false, $post_id = null ) {
+	public function get_jsonld($is_homepage = false, $post_id = null) {
 
 		// Tell NewRelic to ignore us, otherwise NewRelic customers might receive
 		// e-mails with a low apdex score.
@@ -121,14 +121,14 @@ 
 		Wordlift_NewRelic_Adapter::ignore_apdex();
 
 		// Switch to Website converter if is home page.
-		if ( $is_homepage ) {
+		if ($is_homepage) {
 			/**
 			 * Filter: 'wordlift_disable_website_json_ld' - Allow disabling of the json+ld output.
 			 *
 			 * @since  3.14.0
 			 * @api    bool $display_search Whether or not to display json+ld search on the frontend.
 			 */
-			if ( ! apply_filters( 'wordlift_disable_website_json_ld', false ) ) {
+			if ( ! apply_filters('wordlift_disable_website_json_ld', false)) {
 				// Set a reference to the website_converter.
 				$website_converter = $this->website_converter;
 
@@ -138,7 +138,7 @@ 
 		}
 
 		// If no id has been provided return an empty array.
-		if ( ! isset( $post_id ) ) {
+		if ( ! isset($post_id)) {
 			return array();
 		}
 
@@ -152,16 +152,16 @@ 
 		// Convert each URI to a JSON-LD array, while gathering referenced entities.
 		// in the references array.
 		$jsonld = array_merge(
-			array( $entity_to_jsonld_converter->convert( $post_id, $references ) ),
+			array($entity_to_jsonld_converter->convert($post_id, $references)),
 			// Convert each URI in the references array to JSON-LD. We don't output
 			// entities already output above (hence the array_diff).
-			array_filter( array_map( function ( $item ) use ( $entity_to_jsonld_converter, $references ) {
+			array_filter(array_map(function($item) use ($entity_to_jsonld_converter, $references) {
 
 				// "2nd level properties" may not output here, e.g. a post
 				// mentioning an event, located in a place: the place is referenced
 				// via the `@id` but no other properties are loaded.
-				return $entity_to_jsonld_converter->convert( $item, $references );
-			}, $references ) ) );
+				return $entity_to_jsonld_converter->convert($item, $references);
+			}, $references)) );
 
 		// Finally send the JSON-LD.
 		return $jsonld;

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

Indentation +251 added lines, -251 removed lines

@@ -15,256 +15,256 @@
  */
 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.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @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.
-	 */
-	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.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @param int $post_id The post id.
-	 * @param array $references An array of entity references.
-	 *
-	 * @return array A JSON-LD array.
-	 */
-	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 );
-
-		// Get the entity name.
-		$jsonld['headline'] = $post->post_title;
-
-		// Set the published and modified dates.
-		$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.
-		$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_lables = 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_lables ) . '/', $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` filter.
-		 *
-		 * @api
-		 *
-		 * @since 3.14.0
-		 *
-		 * @param array $jsonld The JSON-LD structure.
-		 * @param int $post_id The {@link WP_Post} `id`.
-		 * @param array $references The array of referenced entities.
-		 */
-		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}.
-	 *
-	 * @since 3.14.0
-	 *
-	 * @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.
-	 */
-	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.
-	 *
-	 * @since 3.10.0
-	 *
-	 * @param array $params The parameters array.
-	 */
-	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 logo, WP < 4.4 way: only post ID accepted here.
-		if ( '' === $thumbnail_id = get_post_thumbnail_id( $post->ID ) ) {
-			return;
-		}
-
-		// Get the image URL.
-		if ( false === $attachment = wp_get_attachment_image_src( $thumbnail_id, array( 600, 60 ) ) ) {
-			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']   = $attachment[0];
-		// 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']  = $attachment[1];
-		$params['publisher']['logo']['height'] = $attachment[2];
-
-	}
+    /**
+     * 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.
+     *
+     * @since 3.10.0
+     *
+     * @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.
+     */
+    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.
+     *
+     * @since 3.10.0
+     *
+     * @param int $post_id The post id.
+     * @param array $references An array of entity references.
+     *
+     * @return array A JSON-LD array.
+     */
+    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 );
+
+        // Get the entity name.
+        $jsonld['headline'] = $post->post_title;
+
+        // Set the published and modified dates.
+        $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.
+        $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_lables = 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_lables ) . '/', $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` filter.
+         *
+         * @api
+         *
+         * @since 3.14.0
+         *
+         * @param array $jsonld The JSON-LD structure.
+         * @param int $post_id The {@link WP_Post} `id`.
+         * @param array $references The array of referenced entities.
+         */
+        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}.
+     *
+     * @since 3.14.0
+     *
+     * @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.
+     */
+    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.
+     *
+     * @since 3.10.0
+     *
+     * @param array $params The parameters array.
+     */
+    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 logo, WP < 4.4 way: only post ID accepted here.
+        if ( '' === $thumbnail_id = get_post_thumbnail_id( $post->ID ) ) {
+            return;
+        }
+
+        // Get the image URL.
+        if ( false === $attachment = wp_get_attachment_image_src( $thumbnail_id, array( 600, 60 ) ) ) {
+            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']   = $attachment[0];
+        // 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']  = $attachment[1];
+        $params['publisher']['logo']['height'] = $attachment[2];
+
+    }
 
 }

Spacing +39 added lines, -39 removed lines

@@ -44,13 +44,13 @@ 
 	 * @param \Wordlift_Attachment_Service $attachment_service A {@link Wordlift_Attachment_Service} instance.
 	 * @param \Wordlift_Configuration_Service $configuration_service A {@link Wordlift_Configuration_Service} instance.
 	 */
-	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');
 	}
 
 	/**
@@ -64,59 +64,59 @@ 
 	 *
 	 * @return array A JSON-LD array.
 	 */
-	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);
 
 		// Get the entity name.
 		$jsonld['headline'] = $post->post_title;
 
 		// Set the published and modified dates.
-		$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 );
+		$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.
-		$post_adapter        = new Wordlift_Post_Adapter( $post_id );
+		$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_lables = array_map(
-					function ( $value ) {
-						return preg_quote( $value, '/' );
+					function($value) {
+						return preg_quote($value, '/');
 					}, $labels
 				);
 
 				// Check if the labels match any part of the title.
-				$matches = 1 === preg_match( '/' . implode( '|', $escaped_lables ) . '/', $post->post_title );
+				$matches = 1 === preg_match('/'.implode('|', $escaped_lables).'/', $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;
@@ -124,18 +124,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` filter.
@@ -148,7 +148,7 @@ 
 		 * @param int $post_id The {@link WP_Post} `id`.
 		 * @param array $references The array of referenced entities.
 		 */
-		return apply_filters( 'wl_post_jsonld', $jsonld, $post_id, $references );
+		return apply_filters('wl_post_jsonld', $jsonld, $post_id, $references);
 	}
 
 	/**
@@ -164,16 +164,16 @@ 
 	 *
 	 * @return string|array A JSON-LD structure.
 	 */
-	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',
@@ -183,7 +183,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.
@@ -199,39 +199,39 @@ 
 	 *
 	 * @param array $params The parameters array.
 	 */
-	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;
 		}
 
@@ -239,17 +239,17 @@ 
 		// 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 logo, WP < 4.4 way: only post ID accepted here.
-		if ( '' === $thumbnail_id = get_post_thumbnail_id( $post->ID ) ) {
+		if ('' === $thumbnail_id = get_post_thumbnail_id($post->ID)) {
 			return;
 		}
 
 		// Get the image URL.
-		if ( false === $attachment = wp_get_attachment_image_src( $thumbnail_id, array( 600, 60 ) ) ) {
+		if (false === $attachment = wp_get_attachment_image_src($thumbnail_id, array(600, 60))) {
 			return;
 		}