insideout10 / wordlift-plugin

src/classes/jsonld/class-jsonld-article-wrapper.php

Indentation +178 added lines, -178 removed lines

@@ -7,193 +7,193 @@
 
 class Jsonld_Article_Wrapper {
 
-	public static $article_types = array(
-		'Article',
-		'AdvertiserContentArticle',
-		'NewsArticle',
-		'AnalysisNewsArticle',
-		'AskPublicNewsArticle',
-		'BackgroundNewsArticle',
-		'OpinionNewsArticle',
-		'ReportageNewsArticle',
-		'ReviewNewsArticle',
-		'Report',
-		'SatiricalArticle',
-		'ScholarlyArticle',
-		'MedicalScholarlyArticle',
-		'SocialMediaPosting',
-		'BlogPosting',
-		'LiveBlogPosting',
-		'DiscussionForumPosting',
-		'TechArticle',
-		'APIReference',
-	);
-
-	/**
-	 * @var Wordlift_Post_To_Jsonld_Converter
-	 */
-	private $post_to_jsonld_converter;
-	/**
-	 * @var \Wordlift_Cached_Post_Converter
-	 */
-	private $cached_postid_to_jsonld_converter;
-	/**
-	 * @var \Wordlift_Entity_Uri_Service
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * Jsonld_Article_Wrapper constructor.
-	 *
-	 * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
-	 * @param $cached_postid_to_jsonld_converter
-	 */
-	public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
-
-		$this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
-
-		add_filter(
-			'wl_after_get_jsonld',
-			array(
-				$this,
-				'after_get_jsonld',
-			),
-			PHP_INT_MAX - 100,
-			3
-		);
-
-		$this->cached_postid_to_jsonld_converter = $cached_postid_to_jsonld_converter;
-
-		$this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
-	}
-
-	public function after_get_jsonld( $jsonld, $post_id, $context ) {
-
-		// Invalid data structure
-		if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
-			return $jsonld;
-		}
-
-		if ( Jsonld_Context_Enum::PAGE !== $context
-			 // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
-			 && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
-			return $jsonld;
-		}
-
-		// Copy the 1st array element
-		$post_jsonld = $jsonld[0];
-
-		// Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
-		// in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
-		if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
-			return $jsonld;
-		}
-
-		$references      = array();
-		$reference_infos = array();
-
-		// Convert the post as Article.
-		$article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
-
-		$article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
-		// Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
-		$article_jsonld['@type'] = 'Article';
-		$article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
-
-		// Copy over the URLs.
-		if ( isset( $post_jsonld['url'] ) ) {
-			$article_jsonld['url'] = $post_jsonld['url'];
-		}
-
-		array_unshift( $jsonld, $article_jsonld );
-
-		$author_jsonld = $this->get_author_linked_entity( $article_jsonld );
-
-		if ( $author_jsonld ) {
-			// Get primary author in case co-authors exist.
-			$primary_author = $this->get_primary_author( $article_jsonld['author'] );
-
-			/**
-			 * The author entities can be present in graph for some entity types
-			 * for Person and Organization, so check before we add it to graph.
-			 * reference : https://schema.org/author
-			 */
-			if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $primary_author['@id'] ) ) {
-				$jsonld[] = $author_jsonld;
-			}
-		}
-
-		return $jsonld;
-	}
-
-	private function is_article( $schema_types ) {
-
-		$array_intersect = array_intersect( self::$article_types, (array) $schema_types );
-
-		return ! empty( $array_intersect );
-	}
-
-	/**
-	 * Get primary author from author array.
-	 *
-	 * A helper function that checks the structure of the author array and returns the primary author.
-	 *
-	 * @param array|string $author The author array.
-	 *
-	 * @return array|string The primary author.
-	 *
-	 * @since 3.51.4
-	 */
-	private function get_primary_author( $author ) {
-
-		// Nested array of co-authors. Return the primary author.
-		if ( is_array( $author ) && ! empty( $author ) && ! isset( $author['@id'] ) ) {
-			return $author[0];
-		}
-
-		return $author;
-	}
-
-	private function get_author_linked_entity( $article_jsonld ) {
-		if ( ! array_key_exists( 'author', $article_jsonld ) ) {
-			return false;
-		}
+    public static $article_types = array(
+        'Article',
+        'AdvertiserContentArticle',
+        'NewsArticle',
+        'AnalysisNewsArticle',
+        'AskPublicNewsArticle',
+        'BackgroundNewsArticle',
+        'OpinionNewsArticle',
+        'ReportageNewsArticle',
+        'ReviewNewsArticle',
+        'Report',
+        'SatiricalArticle',
+        'ScholarlyArticle',
+        'MedicalScholarlyArticle',
+        'SocialMediaPosting',
+        'BlogPosting',
+        'LiveBlogPosting',
+        'DiscussionForumPosting',
+        'TechArticle',
+        'APIReference',
+    );
+
+    /**
+     * @var Wordlift_Post_To_Jsonld_Converter
+     */
+    private $post_to_jsonld_converter;
+    /**
+     * @var \Wordlift_Cached_Post_Converter
+     */
+    private $cached_postid_to_jsonld_converter;
+    /**
+     * @var \Wordlift_Entity_Uri_Service
+     */
+    private $entity_uri_service;
+
+    /**
+     * Jsonld_Article_Wrapper constructor.
+     *
+     * @param Wordlift_Post_To_Jsonld_Converter $post_to_jsonld_converter
+     * @param $cached_postid_to_jsonld_converter
+     */
+    public function __construct( $post_to_jsonld_converter, $cached_postid_to_jsonld_converter ) {
+
+        $this->post_to_jsonld_converter = $post_to_jsonld_converter->new_instance_with_filters_disabled();
+
+        add_filter(
+            'wl_after_get_jsonld',
+            array(
+                $this,
+                'after_get_jsonld',
+            ),
+            PHP_INT_MAX - 100,
+            3
+        );
+
+        $this->cached_postid_to_jsonld_converter = $cached_postid_to_jsonld_converter;
+
+        $this->entity_uri_service = \Wordlift_Entity_Uri_Service::get_instance();
+    }
+
+    public function after_get_jsonld( $jsonld, $post_id, $context ) {
+
+        // Invalid data structure
+        if ( ! is_array( $jsonld ) || ! isset( $jsonld[0] ) || ! is_array( $jsonld[0] ) ) {
+            return $jsonld;
+        }
+
+        if ( Jsonld_Context_Enum::PAGE !== $context
+                // Returns true for "1", "true", "on" and "yes". Returns false otherwise.
+             && ! filter_input( INPUT_GET, 'article_wrapper', FILTER_VALIDATE_BOOLEAN ) ) {
+            return $jsonld;
+        }
+
+        // Copy the 1st array element
+        $post_jsonld = $jsonld[0];
+
+        // Don't wrap in article if the json-ld is already about an Article (or its descendants). `@type` must be
+        // in the schema.org context, i.e. `Article`, not `http://schema.org/Article`.
+        if ( ! isset( $post_jsonld['@id'] ) || ! isset( $post_jsonld['@type'] ) || $this->is_article( $post_jsonld['@type'] ) ) {
+            return $jsonld;
+        }
+
+        $references      = array();
+        $reference_infos = array();
+
+        // Convert the post as Article.
+        $article_jsonld = $this->post_to_jsonld_converter->convert( $post_id, $references, $reference_infos, new Relations() );
+
+        $article_jsonld['@id'] = $post_jsonld['@id'] . '#article';
+        // Reset the type, since by default the type assigned via the Entity Type taxonomy is used.
+        $article_jsonld['@type'] = 'Article';
+        $article_jsonld['about'] = array( '@id' => $post_jsonld['@id'] );
+
+        // Copy over the URLs.
+        if ( isset( $post_jsonld['url'] ) ) {
+            $article_jsonld['url'] = $post_jsonld['url'];
+        }
+
+        array_unshift( $jsonld, $article_jsonld );
+
+        $author_jsonld = $this->get_author_linked_entity( $article_jsonld );
+
+        if ( $author_jsonld ) {
+            // Get primary author in case co-authors exist.
+            $primary_author = $this->get_primary_author( $article_jsonld['author'] );
+
+            /**
+             * The author entities can be present in graph for some entity types
+             * for Person and Organization, so check before we add it to graph.
+             * reference : https://schema.org/author
+             */
+            if ( $author_jsonld && ! $this->is_author_entity_present_in_graph( $jsonld, $primary_author['@id'] ) ) {
+                $jsonld[] = $author_jsonld;
+            }
+        }
+
+        return $jsonld;
+    }
+
+    private function is_article( $schema_types ) {
+
+        $array_intersect = array_intersect( self::$article_types, (array) $schema_types );
+
+        return ! empty( $array_intersect );
+    }
+
+    /**
+     * Get primary author from author array.
+     *
+     * A helper function that checks the structure of the author array and returns the primary author.
+     *
+     * @param array|string $author The author array.
+     *
+     * @return array|string The primary author.
+     *
+     * @since 3.51.4
+     */
+    private function get_primary_author( $author ) {
+
+        // Nested array of co-authors. Return the primary author.
+        if ( is_array( $author ) && ! empty( $author ) && ! isset( $author['@id'] ) ) {
+            return $author[0];
+        }
+
+        return $author;
+    }
+
+    private function get_author_linked_entity( $article_jsonld ) {
+        if ( ! array_key_exists( 'author', $article_jsonld ) ) {
+            return false;
+        }
 
-		$author = $this->get_primary_author( $article_jsonld['author'] );
+        $author = $this->get_primary_author( $article_jsonld['author'] );
 
-		if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
-			return false;
-		}
+        if ( count( array_keys( $author ) ) !== 1 || ! array_key_exists( '@id', $author ) ) {
+            return false;
+        }
 
-		$author_linked_entity_id = $author['@id'];
+        $author_linked_entity_id = $author['@id'];
 
-		$author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
+        $author_entity_post = $this->entity_uri_service->get_entity( $author_linked_entity_id );
 
-		if ( ! $author_entity_post instanceof \WP_Post ) {
-			return false;
-		}
+        if ( ! $author_entity_post instanceof \WP_Post ) {
+            return false;
+        }
 
-		$references      = array();
-		$reference_infos = array();
-
-		return $this->cached_postid_to_jsonld_converter->convert(
-			$author_entity_post->ID,
-			$references,
-			$reference_infos,
-			new Relations()
-		);
+        $references      = array();
+        $reference_infos = array();
+
+        return $this->cached_postid_to_jsonld_converter->convert(
+            $author_entity_post->ID,
+            $references,
+            $reference_infos,
+            new Relations()
+        );
 
-	}
+    }
 
-	private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
+    private function is_author_entity_present_in_graph( $jsonld, $author_entity_id ) {
 
-		foreach ( $jsonld as $item ) {
-			if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
-				return true;
-			}
-		}
+        foreach ( $jsonld as $item ) {
+            if ( $item && array_key_exists( '@id', $item ) && $item['@id'] === $author_entity_id ) {
+                return true;
+            }
+        }
 
-		return false;
-	}
+        return false;
+    }
 
 }