insideout10 / wordlift-plugin

src/public/class-wordlift-term-jsonld-adapter.php

Indentation +213 added lines, -213 removed lines

@@ -16,218 +16,218 @@
  */
 class Wordlift_Term_JsonLd_Adapter {
 
-	/**
-	 * The {@link Wordlift_Entity_Uri_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 */
-	private $entity_uri_service;
-
-	/**
-	 * The {@link Wordlift_Jsonld_Service} instance.
-	 *
-	 * @since 3.20.0
-	 * @access private
-	 * @var \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
-	 */
-	private $jsonld_service;
-
-	private static $instance;
-
-	/**
-	 * Wordlift_Term_JsonLd_Adapter constructor.
-	 *
-	 * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
-	 * @param \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
-	 *
-	 * @since 3.20.0
-	 *
-	 */
-	public function __construct( $entity_uri_service, $jsonld_service ) {
-
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
-
-		$this->entity_uri_service = $entity_uri_service;
-		$this->jsonld_service     = $jsonld_service;
-
-		self::$instance = $this;
-	}
-
-	public static function get_instance() {
-
-		return self::$instance;
-	}
-
-	/**
-	 * Adds carousel json ld data to term page if the conditions match
-	 *
-	 * @return array|boolean
-	 */
-	public function get_carousel_jsonld( $id = null ) {
-		$posts       = $this->get_posts( $id );
-		$post_jsonld = array();
-		if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
-			// Bail out if no posts are present.
-			return false;
-		}
-
-		if ( ! is_null( $id ) ) {
-			$term                       = get_term( $id );
-			$post_jsonld['description'] = strip_tags( strip_shortcodes( $term->description ) );
-			$thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
-			if ( ! empty( $thumbnail_id ) ) {
-				$post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
-			}
-		}
-
-		// More than 2 items are present, so construct the post_jsonld data
-		$post_jsonld['@context']        = 'https://schema.org';
-		$post_jsonld['@type']           = 'ItemList';
-		$post_jsonld['url']             = $this->get_term_url( $id );
-		$post_jsonld['itemListElement'] = array();
-		$position                       = 1;
-
-		foreach ( $posts as $post_id ) {
-			$result = array(
-				'@type'    => 'ListItem',
-				'position' => $position,
-				/**
-				 * We can't use `item` here unless we change the URL for the item to point to the current page.
-				 *
-				 * See https://developers.google.com/search/docs/data-types/carousel
-				 */
-				'url'      => get_permalink( $post_id )
-			);
-			array_push( $post_jsonld['itemListElement'], $result );
-			$position += 1;
-		}
-
-		return $post_jsonld;
-	}
-
-	private function get_posts( $id ) {
-		global $wp_query;
-
-		if ( ! is_null( $wp_query->posts ) ) {
-			return array_map( function ( $post ) {
-				return $post->ID;
-			}, $wp_query->posts );
-		}
-
-		if ( is_null( $id ) ) {
-			return null;
-		}
-
-		$term = get_term( $id );
-
-		return get_objects_in_term( $id, $term->taxonomy );
-	}
-
-	/**
-	 * Hook to `wp_head` to print the JSON-LD.
-	 *
-	 * @since 3.20.0
-	 */
-	public function wp_head() {
-		$query_object = get_queried_object();
-
-		// Check if it is a term page.
-		if ( ! $query_object instanceof WP_Term ) {
-			return;
-		}
-
-		$term_id = $query_object->term_id;
-
-		$jsonld  = $this->get( $term_id );
-
-		// Bail out if the JSON-LD is empty.
-		if ( empty( $jsonld ) || empty( $jsonld['jsonld'] ) ) {
-			return;
-		}
-
-		$jsonld_string = wp_json_encode( $jsonld['jsonld'] );
-
-		echo "<script type=\"application/ld+json\" id=\"wl-jsonld-term\">$jsonld_string</script>";
-
-	}
-
-	public function get( $id ) {
-
-		/**
-		 * Support for carousel rich snippet, get jsonld data present
-		 * for all the posts shown in the term page, and add the jsonld data
-		 * to list
-		 *
-		 * see here: https://developers.google.com/search/docs/data-types/carousel
-		 *
-		 * @since 3.26.0
-		 */
-		$carousel_data = $this->get_carousel_jsonld( $id );
-		$jsonld_array  = array();
-		if ( $carousel_data ) {
-			$jsonld_array[] = $carousel_data;
-		}
-		$entities_jsonld_array = $this->get_entity_jsonld( $id );
-
-		$result = array(
-			'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
-			'references' => array()
-		);
-
-		/**
-		 * @since 3.26.3
-		 * Filter: wl_term_jsonld_array
-		 * @var $id int Term id
-		 * @var $jsonld_array array An array containing jsonld for term and entities.
-		 */
-		$arr = apply_filters( 'wl_term_jsonld_array', $result, $id );
-
-		return $arr['jsonld'];
-	}
-
-	private function get_term_url( $id ) {
-
-		if ( is_null( $id ) ) {
-			return $_SERVER['REQUEST_URI'];
-		}
-
-		$maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
-		if ( ! empty( $maybe_url ) ) {
-			return $maybe_url;
-		}
-
-		return get_term_link( $id );
-	}
-
-	/**
-	 * Return jsonld for entities bound to terms.
-	 *
-	 * @param $id
-	 *
-	 * @return array
-	 */
-	private function get_entity_jsonld( $id ) {
-		// The `_wl_entity_id` are URIs.
-		$entity_ids         = get_term_meta( $id, '_wl_entity_id' );
-		$entity_uri_service = $this->entity_uri_service;
-
-		$local_entity_ids = array_filter( $entity_ids, function ( $uri ) use ( $entity_uri_service ) {
-			return $entity_uri_service->is_internal( $uri );
-		} );
-
-		// Bail out if there are no entities.
-		if ( empty( $local_entity_ids ) ) {
-			return array();
-		}
-
-		$post   = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
-		$jsonld = $this->jsonld_service->get_jsonld( false, $post->ID );
-		// Reset the `url` to the term page.
-		$jsonld[0]['url'] = get_term_link( $id );
-
-		return $jsonld;
-	}
+    /**
+     * The {@link Wordlift_Entity_Uri_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     */
+    private $entity_uri_service;
+
+    /**
+     * The {@link Wordlift_Jsonld_Service} instance.
+     *
+     * @since 3.20.0
+     * @access private
+     * @var \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
+     */
+    private $jsonld_service;
+
+    private static $instance;
+
+    /**
+     * Wordlift_Term_JsonLd_Adapter constructor.
+     *
+     * @param \Wordlift_Entity_Uri_Service $entity_uri_service The {@link Wordlift_Entity_Uri_Service} instance.
+     * @param \Wordlift_Jsonld_Service $jsonld_service The {@link Wordlift_Jsonld_Service} instance.
+     *
+     * @since 3.20.0
+     *
+     */
+    public function __construct( $entity_uri_service, $jsonld_service ) {
+
+        add_action( 'wp_head', array( $this, 'wp_head' ) );
+
+        $this->entity_uri_service = $entity_uri_service;
+        $this->jsonld_service     = $jsonld_service;
+
+        self::$instance = $this;
+    }
+
+    public static function get_instance() {
+
+        return self::$instance;
+    }
+
+    /**
+     * Adds carousel json ld data to term page if the conditions match
+     *
+     * @return array|boolean
+     */
+    public function get_carousel_jsonld( $id = null ) {
+        $posts       = $this->get_posts( $id );
+        $post_jsonld = array();
+        if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
+            // Bail out if no posts are present.
+            return false;
+        }
+
+        if ( ! is_null( $id ) ) {
+            $term                       = get_term( $id );
+            $post_jsonld['description'] = strip_tags( strip_shortcodes( $term->description ) );
+            $thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
+            if ( ! empty( $thumbnail_id ) ) {
+                $post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
+            }
+        }
+
+        // More than 2 items are present, so construct the post_jsonld data
+        $post_jsonld['@context']        = 'https://schema.org';
+        $post_jsonld['@type']           = 'ItemList';
+        $post_jsonld['url']             = $this->get_term_url( $id );
+        $post_jsonld['itemListElement'] = array();
+        $position                       = 1;
+
+        foreach ( $posts as $post_id ) {
+            $result = array(
+                '@type'    => 'ListItem',
+                'position' => $position,
+                /**
+                 * We can't use `item` here unless we change the URL for the item to point to the current page.
+                 *
+                 * See https://developers.google.com/search/docs/data-types/carousel
+                 */
+                'url'      => get_permalink( $post_id )
+            );
+            array_push( $post_jsonld['itemListElement'], $result );
+            $position += 1;
+        }
+
+        return $post_jsonld;
+    }
+
+    private function get_posts( $id ) {
+        global $wp_query;
+
+        if ( ! is_null( $wp_query->posts ) ) {
+            return array_map( function ( $post ) {
+                return $post->ID;
+            }, $wp_query->posts );
+        }
+
+        if ( is_null( $id ) ) {
+            return null;
+        }
+
+        $term = get_term( $id );
+
+        return get_objects_in_term( $id, $term->taxonomy );
+    }
+
+    /**
+     * Hook to `wp_head` to print the JSON-LD.
+     *
+     * @since 3.20.0
+     */
+    public function wp_head() {
+        $query_object = get_queried_object();
+
+        // Check if it is a term page.
+        if ( ! $query_object instanceof WP_Term ) {
+            return;
+        }
+
+        $term_id = $query_object->term_id;
+
+        $jsonld  = $this->get( $term_id );
+
+        // Bail out if the JSON-LD is empty.
+        if ( empty( $jsonld ) || empty( $jsonld['jsonld'] ) ) {
+            return;
+        }
+
+        $jsonld_string = wp_json_encode( $jsonld['jsonld'] );
+
+        echo "<script type=\"application/ld+json\" id=\"wl-jsonld-term\">$jsonld_string</script>";
+
+    }
+
+    public function get( $id ) {
+
+        /**
+         * Support for carousel rich snippet, get jsonld data present
+         * for all the posts shown in the term page, and add the jsonld data
+         * to list
+         *
+         * see here: https://developers.google.com/search/docs/data-types/carousel
+         *
+         * @since 3.26.0
+         */
+        $carousel_data = $this->get_carousel_jsonld( $id );
+        $jsonld_array  = array();
+        if ( $carousel_data ) {
+            $jsonld_array[] = $carousel_data;
+        }
+        $entities_jsonld_array = $this->get_entity_jsonld( $id );
+
+        $result = array(
+            'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
+            'references' => array()
+        );
+
+        /**
+         * @since 3.26.3
+         * Filter: wl_term_jsonld_array
+         * @var $id int Term id
+         * @var $jsonld_array array An array containing jsonld for term and entities.
+         */
+        $arr = apply_filters( 'wl_term_jsonld_array', $result, $id );
+
+        return $arr['jsonld'];
+    }
+
+    private function get_term_url( $id ) {
+
+        if ( is_null( $id ) ) {
+            return $_SERVER['REQUEST_URI'];
+        }
+
+        $maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
+        if ( ! empty( $maybe_url ) ) {
+            return $maybe_url;
+        }
+
+        return get_term_link( $id );
+    }
+
+    /**
+     * Return jsonld for entities bound to terms.
+     *
+     * @param $id
+     *
+     * @return array
+     */
+    private function get_entity_jsonld( $id ) {
+        // The `_wl_entity_id` are URIs.
+        $entity_ids         = get_term_meta( $id, '_wl_entity_id' );
+        $entity_uri_service = $this->entity_uri_service;
+
+        $local_entity_ids = array_filter( $entity_ids, function ( $uri ) use ( $entity_uri_service ) {
+            return $entity_uri_service->is_internal( $uri );
+        } );
+
+        // Bail out if there are no entities.
+        if ( empty( $local_entity_ids ) ) {
+            return array();
+        }
+
+        $post   = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
+        $jsonld = $this->jsonld_service->get_jsonld( false, $post->ID );
+        // Reset the `url` to the term page.
+        $jsonld[0]['url'] = get_term_link( $id );
+
+        return $jsonld;
+    }
 
 }

Spacing +45 added lines, -45 removed lines

@@ -45,9 +45,9 @@ 
 	 * @since 3.20.0
 	 *
 	 */
-	public function __construct( $entity_uri_service, $jsonld_service ) {
+	public function __construct($entity_uri_service, $jsonld_service) {
 
-		add_action( 'wp_head', array( $this, 'wp_head' ) );
+		add_action('wp_head', array($this, 'wp_head'));
 
 		$this->entity_uri_service = $entity_uri_service;
 		$this->jsonld_service     = $jsonld_service;
@@ -65,31 +65,31 @@ 
 	 *
 	 * @return array|boolean
 	 */
-	public function get_carousel_jsonld( $id = null ) {
-		$posts       = $this->get_posts( $id );
+	public function get_carousel_jsonld($id = null) {
+		$posts       = $this->get_posts($id);
 		$post_jsonld = array();
-		if ( ! is_array( $posts ) || count( $posts ) < 2 ) {
+		if ( ! is_array($posts) || count($posts) < 2) {
 			// Bail out if no posts are present.
 			return false;
 		}
 
-		if ( ! is_null( $id ) ) {
-			$term                       = get_term( $id );
-			$post_jsonld['description'] = strip_tags( strip_shortcodes( $term->description ) );
-			$thumbnail_id               = get_term_meta( $id, 'thumbnail_id', true );
-			if ( ! empty( $thumbnail_id ) ) {
-				$post_jsonld['image'] = wp_get_attachment_url( $thumbnail_id );
+		if ( ! is_null($id)) {
+			$term                       = get_term($id);
+			$post_jsonld['description'] = strip_tags(strip_shortcodes($term->description));
+			$thumbnail_id               = get_term_meta($id, 'thumbnail_id', true);
+			if ( ! empty($thumbnail_id)) {
+				$post_jsonld['image'] = wp_get_attachment_url($thumbnail_id);
 			}
 		}
 
 		// More than 2 items are present, so construct the post_jsonld data
 		$post_jsonld['@context']        = 'https://schema.org';
 		$post_jsonld['@type']           = 'ItemList';
-		$post_jsonld['url']             = $this->get_term_url( $id );
+		$post_jsonld['url']             = $this->get_term_url($id);
 		$post_jsonld['itemListElement'] = array();
 		$position                       = 1;
 
-		foreach ( $posts as $post_id ) {
+		foreach ($posts as $post_id) {
 			$result = array(
 				'@type'    => 'ListItem',
 				'position' => $position,
@@ -98,31 +98,31 @@ 
 				 *
 				 * See https://developers.google.com/search/docs/data-types/carousel
 				 */
-				'url'      => get_permalink( $post_id )
+				'url'      => get_permalink($post_id)
 			);
-			array_push( $post_jsonld['itemListElement'], $result );
+			array_push($post_jsonld['itemListElement'], $result);
 			$position += 1;
 		}
 
 		return $post_jsonld;
 	}
 
-	private function get_posts( $id ) {
+	private function get_posts($id) {
 		global $wp_query;
 
-		if ( ! is_null( $wp_query->posts ) ) {
-			return array_map( function ( $post ) {
+		if ( ! is_null($wp_query->posts)) {
+			return array_map(function($post) {
 				return $post->ID;
-			}, $wp_query->posts );
+			}, $wp_query->posts);
 		}
 
-		if ( is_null( $id ) ) {
+		if (is_null($id)) {
 			return null;
 		}
 
-		$term = get_term( $id );
+		$term = get_term($id);
 
-		return get_objects_in_term( $id, $term->taxonomy );
+		return get_objects_in_term($id, $term->taxonomy);
 	}
 
 	/**
@@ -134,26 +134,26 @@ 
 		$query_object = get_queried_object();
 
 		// Check if it is a term page.
-		if ( ! $query_object instanceof WP_Term ) {
+		if ( ! $query_object instanceof WP_Term) {
 			return;
 		}
 
 		$term_id = $query_object->term_id;
 
-		$jsonld  = $this->get( $term_id );
+		$jsonld  = $this->get($term_id);
 
 		// Bail out if the JSON-LD is empty.
-		if ( empty( $jsonld ) || empty( $jsonld['jsonld'] ) ) {
+		if (empty($jsonld) || empty($jsonld['jsonld'])) {
 			return;
 		}
 
-		$jsonld_string = wp_json_encode( $jsonld['jsonld'] );
+		$jsonld_string = wp_json_encode($jsonld['jsonld']);
 
 		echo "<script type=\"application/ld+json\" id=\"wl-jsonld-term\">$jsonld_string</script>";
 
 	}
 
-	public function get( $id ) {
+	public function get($id) {
 
 		/**
 		 * Support for carousel rich snippet, get jsonld data present
@@ -164,15 +164,15 @@ 
 		 *
 		 * @since 3.26.0
 		 */
-		$carousel_data = $this->get_carousel_jsonld( $id );
+		$carousel_data = $this->get_carousel_jsonld($id);
 		$jsonld_array  = array();
-		if ( $carousel_data ) {
+		if ($carousel_data) {
 			$jsonld_array[] = $carousel_data;
 		}
-		$entities_jsonld_array = $this->get_entity_jsonld( $id );
+		$entities_jsonld_array = $this->get_entity_jsonld($id);
 
 		$result = array(
-			'jsonld'     => array_merge( $jsonld_array, $entities_jsonld_array ),
+			'jsonld'     => array_merge($jsonld_array, $entities_jsonld_array),
 			'references' => array()
 		);
 
@@ -182,23 +182,23 @@ 
 		 * @var $id int Term id
 		 * @var $jsonld_array array An array containing jsonld for term and entities.
 		 */
-		$arr = apply_filters( 'wl_term_jsonld_array', $result, $id );
+		$arr = apply_filters('wl_term_jsonld_array', $result, $id);
 
 		return $arr['jsonld'];
 	}
 
-	private function get_term_url( $id ) {
+	private function get_term_url($id) {
 
-		if ( is_null( $id ) ) {
+		if (is_null($id)) {
 			return $_SERVER['REQUEST_URI'];
 		}
 
-		$maybe_url = get_term_meta( $id, Wordlift_Url_Property_Service::META_KEY, true );
-		if ( ! empty( $maybe_url ) ) {
+		$maybe_url = get_term_meta($id, Wordlift_Url_Property_Service::META_KEY, true);
+		if ( ! empty($maybe_url)) {
 			return $maybe_url;
 		}
 
-		return get_term_link( $id );
+		return get_term_link($id);
 	}
 
 	/**
@@ -208,24 +208,24 @@ 
 	 *
 	 * @return array
 	 */
-	private function get_entity_jsonld( $id ) {
+	private function get_entity_jsonld($id) {
 		// The `_wl_entity_id` are URIs.
-		$entity_ids         = get_term_meta( $id, '_wl_entity_id' );
+		$entity_ids         = get_term_meta($id, '_wl_entity_id');
 		$entity_uri_service = $this->entity_uri_service;
 
-		$local_entity_ids = array_filter( $entity_ids, function ( $uri ) use ( $entity_uri_service ) {
-			return $entity_uri_service->is_internal( $uri );
+		$local_entity_ids = array_filter($entity_ids, function($uri) use ($entity_uri_service) {
+			return $entity_uri_service->is_internal($uri);
 		} );
 
 		// Bail out if there are no entities.
-		if ( empty( $local_entity_ids ) ) {
+		if (empty($local_entity_ids)) {
 			return array();
 		}
 
-		$post   = $this->entity_uri_service->get_entity( array_shift( $local_entity_ids ) );
-		$jsonld = $this->jsonld_service->get_jsonld( false, $post->ID );
+		$post   = $this->entity_uri_service->get_entity(array_shift($local_entity_ids));
+		$jsonld = $this->jsonld_service->get_jsonld(false, $post->ID);
 		// Reset the `url` to the term page.
-		$jsonld[0]['url'] = get_term_link( $id );
+		$jsonld[0]['url'] = get_term_link($id);
 
 		return $jsonld;
 	}