lightspeeddevelopment / lsx

includes/classes/class-lsx-schema-utils.php

Indentation +208 added lines, -208 removed lines

@@ -10,212 +10,212 @@
  * @since 11.6
  */
 class LSX_Schema_Utils {
-	/**
-	 * Determines whether a given post type should have Review schema.
-	 *
-	 * @param string $post_type       Post type to check.
-	 * @param string $comparison_type Post type to check against.
-	 *
-	 * @return bool True if it has schema, false if not.
-	 */
-	public static function is_type( $post_type = null, $comparison_type = null ) {
-		if ( is_null( $comparison_type ) ) {
-			return false;
-		}
-		if ( is_null( $post_type ) ) {
-			$post_type = get_post_type();
-		}
-		/**
-		 * Filter: 'wpseo_schema_$this->post_type_post_types' - Allow changing for which post types we output Review schema.
-		 *
-		 * @api string[] $post_types The post types for which we output Review.
-		 */
-		$post_types = apply_filters( 'wpseo_schema_' . $comparison_type . '_post_types', array( $comparison_type ) );
-		return in_array( $post_type, $post_types );
-	}
-	/**
-	 * Retrieve a users Schema ID.
-	 *
-	 * @param string               $place_id The Name of the Reviewer you need a for.
-	 * @param string               $type the type of the place.
-	 * @param WPSEO_Schema_Context $context A value object with context variables.
-	 *
-	 * @return string The user's schema ID.
-	 */
-	public static function get_places_schema_id( $place_id, $type, $context ) {
-		$url = $context->site_url . '#/schema/' . strtolower( $type ) . '/' . wp_hash( $place_id . get_the_title( $place_id ) );
-		return trailingslashit( $url );
-	}
-	/**
-	 * Retrieve a users Schema ID.
-	 *
-	 * @param string               $name The Name of the Reviewer you need a for.
-	 * @param WPSEO_Schema_Context $context A value object with context variables.
-	 *
-	 * @return string The user's schema ID.
-	 */
-	public static function get_subtrip_schema_id( $name, $context ) {
-		$url = $context->site_url . '#/subtrip/' . wp_hash( $name . $context->id );
-		return trailingslashit( $url );
-	}
-	/**
-	 * Retrieve an offer Schema ID.
-	 *
-	 * @param string               $id      post ID of the place being added.
-	 * @param WPSEO_Schema_Context $context A value object with context variables.
-	 * @param string               $local   if the Schema is local true / false.
-	 *
-	 * @return string The user's schema ID.
-	 */
-	public static function get_offer_schema_id( $id, $context, $local = false ) {
-		if ( false === $local ) {
-			$url = $context->site_url;
-		} else {
-			$url = get_permalink( $context->id );
-		}
-		$url .= '#/schema/offer/';
-		$url .= wp_hash( $id . get_the_title( $id ) );
-		return trailingslashit( $url );
-	}
-	/**
-	 * Retrieve an review Schema ID.
-	 *
-	 * @param string               $id      post ID of the place being added.
-	 * @param WPSEO_Schema_Context $context A value object with context variables.
-	 * @param string               $local   if the Schema is local true / false.
-	 *
-	 * @return string The user's schema ID.
-	 */
-	public static function get_review_schema_id( $id, $context, $local = false ) {
-		if ( false === $local ) {
-			$url = $context->site_url;
-		} else {
-			$url = get_permalink( $context->id );
-		}
-		$url .= '#/schema/review/';
-		$url .= wp_hash( $id . get_the_title( $id ) );
-		return trailingslashit( $url );
-	}
-	/**
-	 * Retrieve an Article Schema ID.
-	 *
-	 * @param string               $id      post ID of the place being added.
-	 * @param WPSEO_Schema_Context $context A value object with context variables.
-	 * @param string               $local   if the Schema is local true / false.
-	 *
-	 * @return string The user's schema ID.
-	 */
-	public static function get_article_schema_id( $id, $context, $local = false ) {
-		if ( false === $local ) {
-			$url = get_permalink( $id ) . \Schema_IDs::ARTICLE_HASH;
-		} else {
-			$url = get_permalink( $context->id ) . '#/schema/article/' . wp_hash( $id . get_the_title( $id ) );
-		}
-		return trailingslashit( $url );
-	}
-	/**
-	 * Retrieve a users Schema ID.
-	 *
-	 * @param string               $name The Name of the Reviewer you need a for.
-	 * @param WPSEO_Schema_Context $context A value object with context variables.
-	 *
-	 * @return string The user's schema ID.
-	 */
-	public static function get_author_schema_id( $name, $email, $context ) {
-		return $context->site_url . \Schema_IDs::PERSON_HASH . wp_hash( $name . $email );
-	}
-	/**
-	 * Generates the place graph piece for the subtrip / Itinerary arrays.
-	 *
-	 * @param array                $data         subTrip / itinerary data.
-	 * @param string               $type         The type in data to save the terms in.
-	 * @param string               $post_id      The post ID of the current Place to add.
-	 * @param WPSEO_Schema_Context $context      The post ID of the current Place to add.
-	 * @param string               $contained_in The @id of the containedIn place.
-	 *
-	 * @return mixed array $data Place data.
-	 */
-	public static function add_place( $data, $type, $post_id, $context, $contained_in = false ) {
-		$at_id = self::get_places_schema_id( $post_id, $type, $context );
-		$place = array(
-			'@type'       => $type,
-			'@id'         => $at_id,
-			'name'        => get_the_title( $post_id ),
-			'description' => get_the_excerpt( $post_id ),
-			'url'         => get_permalink( $post_id ),
-		);
-		if ( false !== $contained_in ) {
-			$place['containedInPlace'] = array(
-				'@type' => 'Country',
-				'@id'   => $contained_in,
-			);
-		}
-		$data[] = $place;
-		return $data;
-	}
-	/**
-	 * Adds an image node if the post has a featured image.
-	 *
-	 * @param array                $data         The Review data.
-	 * @param WPSEO_Schema_Context $context      The post ID of the current Place to add.
-	 *
-	 * @return array $data The Review data.
-	 */
-	public static function add_image( $data, $context ) {
-		if ( $context->has_image ) {
-			$data['image'] = array(
-				'@id' => $context->canonical . \Schema_IDs::PRIMARY_IMAGE_HASH,
-			);
-		}
-		return $data;
-	}
-	/**
-	 * Generates the itemReviewed schema
-	 *
-	 * @param  array  $items The array of IDS.
-	 * @param  string $type The schema type.
-	 * @return array $schema An array of the schema markup.
-	 */
-	public static function get_item_reviewed( $items = array(), $type = '' ) {
-		$schema = array();
-		if ( false !== $items && ! empty( $items ) && '' !== $type ) {
-			array_unique( $items );
-			foreach ( $items as $item ) {
-				$title = get_the_title( $item );
-				if ( '' !== $title ) {
-					$item_schema = array(
-						'@type' => $type,
-						'name'  => $title,
-					);
-					$schema[]    = $item_schema;
-				}
-			}
-		}
-		return $schema;
-	}
-	/**
-	 * Adds a term or multiple terms, comma separated, to a field.
-	 *
-	 * @param array  $data     Review data.
-	 * @param string $post_id  The ID of the item to fetch terms.
-	 * @param string $key      The key in data to save the terms in.
-	 * @param string $taxonomy The taxonomy to retrieve the terms from.
-	 *
-	 * @return mixed array $data Review data.
-	 */
-	public static function add_terms( $data, $post_id, $key, $taxonomy ) {
-		$terms = get_the_terms( $post_id, $taxonomy );
-		if ( is_array( $terms ) ) {
-			$keywords = array();
-			foreach ( $terms as $term ) {
-				// We are checking against the WordPress internal translation.
-				// @codingStandardsIgnoreLine
-				if ( __( 'Uncategorized', 'lsx' ) !== $term->name ) {
-					$keywords[] = $term->name;
-				}
-			}
-			$data[ $key ] = implode( ',', $keywords );
-		}
-		return $data;
-	}
+     /**
+      * Determines whether a given post type should have Review schema.
+      *
+      * @param string $post_type       Post type to check.
+      * @param string $comparison_type Post type to check against.
+      *
+      * @return bool True if it has schema, false if not.
+      */
+     public static function is_type( $post_type = null, $comparison_type = null ) {
+          if ( is_null( $comparison_type ) ) {
+               return false;
+          }
+          if ( is_null( $post_type ) ) {
+               $post_type = get_post_type();
+          }
+          /**
+           * Filter: 'wpseo_schema_$this->post_type_post_types' - Allow changing for which post types we output Review schema.
+           *
+           * @api string[] $post_types The post types for which we output Review.
+           */
+          $post_types = apply_filters( 'wpseo_schema_' . $comparison_type . '_post_types', array( $comparison_type ) );
+          return in_array( $post_type, $post_types );
+     }
+     /**
+      * Retrieve a users Schema ID.
+      *
+      * @param string               $place_id The Name of the Reviewer you need a for.
+      * @param string               $type the type of the place.
+      * @param WPSEO_Schema_Context $context A value object with context variables.
+      *
+      * @return string The user's schema ID.
+      */
+     public static function get_places_schema_id( $place_id, $type, $context ) {
+          $url = $context->site_url . '#/schema/' . strtolower( $type ) . '/' . wp_hash( $place_id . get_the_title( $place_id ) );
+          return trailingslashit( $url );
+     }
+     /**
+      * Retrieve a users Schema ID.
+      *
+      * @param string               $name The Name of the Reviewer you need a for.
+      * @param WPSEO_Schema_Context $context A value object with context variables.
+      *
+      * @return string The user's schema ID.
+      */
+     public static function get_subtrip_schema_id( $name, $context ) {
+          $url = $context->site_url . '#/subtrip/' . wp_hash( $name . $context->id );
+          return trailingslashit( $url );
+     }
+     /**
+      * Retrieve an offer Schema ID.
+      *
+      * @param string               $id      post ID of the place being added.
+      * @param WPSEO_Schema_Context $context A value object with context variables.
+      * @param string               $local   if the Schema is local true / false.
+      *
+      * @return string The user's schema ID.
+      */
+     public static function get_offer_schema_id( $id, $context, $local = false ) {
+          if ( false === $local ) {
+               $url = $context->site_url;
+          } else {
+               $url = get_permalink( $context->id );
+          }
+          $url .= '#/schema/offer/';
+          $url .= wp_hash( $id . get_the_title( $id ) );
+          return trailingslashit( $url );
+     }
+     /**
+      * Retrieve an review Schema ID.
+      *
+      * @param string               $id      post ID of the place being added.
+      * @param WPSEO_Schema_Context $context A value object with context variables.
+      * @param string               $local   if the Schema is local true / false.
+      *
+      * @return string The user's schema ID.
+      */
+     public static function get_review_schema_id( $id, $context, $local = false ) {
+          if ( false === $local ) {
+               $url = $context->site_url;
+          } else {
+               $url = get_permalink( $context->id );
+          }
+          $url .= '#/schema/review/';
+          $url .= wp_hash( $id . get_the_title( $id ) );
+          return trailingslashit( $url );
+     }
+     /**
+      * Retrieve an Article Schema ID.
+      *
+      * @param string               $id      post ID of the place being added.
+      * @param WPSEO_Schema_Context $context A value object with context variables.
+      * @param string               $local   if the Schema is local true / false.
+      *
+      * @return string The user's schema ID.
+      */
+     public static function get_article_schema_id( $id, $context, $local = false ) {
+          if ( false === $local ) {
+               $url = get_permalink( $id ) . \Schema_IDs::ARTICLE_HASH;
+          } else {
+               $url = get_permalink( $context->id ) . '#/schema/article/' . wp_hash( $id . get_the_title( $id ) );
+          }
+          return trailingslashit( $url );
+     }
+     /**
+      * Retrieve a users Schema ID.
+      *
+      * @param string               $name The Name of the Reviewer you need a for.
+      * @param WPSEO_Schema_Context $context A value object with context variables.
+      *
+      * @return string The user's schema ID.
+      */
+     public static function get_author_schema_id( $name, $email, $context ) {
+          return $context->site_url . \Schema_IDs::PERSON_HASH . wp_hash( $name . $email );
+     }
+     /**
+      * Generates the place graph piece for the subtrip / Itinerary arrays.
+      *
+      * @param array                $data         subTrip / itinerary data.
+      * @param string               $type         The type in data to save the terms in.
+      * @param string               $post_id      The post ID of the current Place to add.
+      * @param WPSEO_Schema_Context $context      The post ID of the current Place to add.
+      * @param string               $contained_in The @id of the containedIn place.
+      *
+      * @return mixed array $data Place data.
+      */
+     public static function add_place( $data, $type, $post_id, $context, $contained_in = false ) {
+          $at_id = self::get_places_schema_id( $post_id, $type, $context );
+          $place = array(
+               '@type'       => $type,
+               '@id'         => $at_id,
+               'name'        => get_the_title( $post_id ),
+               'description' => get_the_excerpt( $post_id ),
+               'url'         => get_permalink( $post_id ),
+          );
+          if ( false !== $contained_in ) {
+               $place['containedInPlace'] = array(
+                    '@type' => 'Country',
+                    '@id'   => $contained_in,
+               );
+          }
+          $data[] = $place;
+          return $data;
+     }
+     /**
+      * Adds an image node if the post has a featured image.
+      *
+      * @param array                $data         The Review data.
+      * @param WPSEO_Schema_Context $context      The post ID of the current Place to add.
+      *
+      * @return array $data The Review data.
+      */
+     public static function add_image( $data, $context ) {
+          if ( $context->has_image ) {
+               $data['image'] = array(
+                    '@id' => $context->canonical . \Schema_IDs::PRIMARY_IMAGE_HASH,
+               );
+          }
+          return $data;
+     }
+     /**
+      * Generates the itemReviewed schema
+      *
+      * @param  array  $items The array of IDS.
+      * @param  string $type The schema type.
+      * @return array $schema An array of the schema markup.
+      */
+     public static function get_item_reviewed( $items = array(), $type = '' ) {
+          $schema = array();
+          if ( false !== $items && ! empty( $items ) && '' !== $type ) {
+               array_unique( $items );
+               foreach ( $items as $item ) {
+                    $title = get_the_title( $item );
+                    if ( '' !== $title ) {
+                         $item_schema = array(
+                              '@type' => $type,
+                              'name'  => $title,
+                         );
+                         $schema[]    = $item_schema;
+                    }
+               }
+          }
+          return $schema;
+     }
+     /**
+      * Adds a term or multiple terms, comma separated, to a field.
+      *
+      * @param array  $data     Review data.
+      * @param string $post_id  The ID of the item to fetch terms.
+      * @param string $key      The key in data to save the terms in.
+      * @param string $taxonomy The taxonomy to retrieve the terms from.
+      *
+      * @return mixed array $data Review data.
+      */
+     public static function add_terms( $data, $post_id, $key, $taxonomy ) {
+          $terms = get_the_terms( $post_id, $taxonomy );
+          if ( is_array( $terms ) ) {
+               $keywords = array();
+               foreach ( $terms as $term ) {
+                    // We are checking against the WordPress internal translation.
+                    // @codingStandardsIgnoreLine
+                    if ( __( 'Uncategorized', 'lsx' ) !== $term->name ) {
+                         $keywords[] = $term->name;
+                    }
+               }
+               $data[ $key ] = implode( ',', $keywords );
+          }
+          return $data;
+     }
 }

includes/classes/class-lsx-schema-graph-piece.php

Indentation +217 added lines, -217 removed lines

@@ -12,221 +12,221 @@
 use \Yoast\WP\SEO\Generators\Schema\Abstract_Schema_Piece;
 
 if ( class_exists( 'Abstract_Schema_Piece' ) ) {
-	class LSX_Schema_Graph_Piece extends Abstract_Schema_Piece {
-		/**
-		 * A value object with context variables.
-		 *
-		 * @var \WPSEO_Schema_Context
-		 */
-		public $context;
-		/**
-		 * This is the post type that you want the piece to output for.
-		 *
-		 * @var string;
-		 */
-		public $post_type;
-		/**
-		 * If this is a top level parent
-		 *
-		 * @var boolean
-		 */
-		public $is_top_level;
-		/**
-		 * This holds the meta_key => scehma_type of the fields you want to add to your subtrip.
-		 *
-		 * @var array()
-		 */
-		public $place_ids;
-		/**
-		 * This holds an object or the current trip post.
-		 *
-		 * @var WP_Post();
-		 */
-		public $post;
-		/**
-		 * This holds URL for the trip
-		 *
-		 * @var string
-		 */
-		public $post_url;
-		/**
-		 * Constructor.
-		 *
-		 * @param \WPSEO_Schema_Context $context A value object with context variables.
-		 */
-		public function __construct( WPSEO_Schema_Context $context ) {
-			$this->context      = $context;
-			$this->place_ids    = array();
-			$this->post         = get_post( $this->context->id );
-			$this->post_url     = get_permalink( $this->context->id );
-			$this->is_top_level = false;
-			if ( is_object( $this->post ) && isset( $this->post->post_parent ) && ( false === $this->post->post_parent || 0 === $this->post->post_parent || '' === $this->post->post_parent ) ) {
-				$this->is_top_level = true;
-			}
-		}
-		/**
-		 * Determines whether or not a piece should be added to the graph.
-		 *
-		 * @return bool
-		 */
-		public function is_needed() {
-			if ( ! is_singular() ) {
-				return false;
-			}
-			if ( false === $this->context->site_represents ) {
-				return false;
-			}
-			return LSX_Schema_Utils::is_type( get_post_type(), $this->post_type );
-		}
-		/**
-		 * Returns Review data.
-		 *
-		 * @return array $data Review data.
-		 */
-		public function generate() {
-			$data = array();
-			return $data;
-		}
-		/**
-		 * Gets the connected reviews post type and set it as the "Review" schema
-		 *
-		 * @param  array    $data An array of offers already added.
-		 * @param  string   $data_key
-		 * @param  boolean  $include_aggregate
-		 * @return array    $data
-		 */
-		public function add_reviews( $data, $data_key = 'reviews', $include_aggregate = true ) {
-			$reviews       = get_post_meta( $this->context->id, 'review_to_' . $this->post_type, false );
-			$reviews_array = array();
-			if ( ! empty( $reviews ) ) {
-				$aggregate_value = 1;
-				$review_count    = 0;
-				foreach ( $reviews as $review_id ) {
-					$rating      = get_post_meta( $review_id, 'rating', true );
-					$author      = get_post_meta( $review_id, 'reviewer_name', true );
-					$description = wp_strip_all_tags( get_the_excerpt( $review_id ) );
-					$review_args = array(
-						'author'     => $author,
-						'reviewBody' => $description,
-					);
-					// Add in the review rating.
-					if ( false !== $rating && '' !== $rating && '0' !== $rating && 0 !== $rating ) {
-						$review_args['reviewRating'] = array(
-							'@type'       => 'Rating',
-							'ratingValue' => $rating,
-						);
-					}
-					$reviews_array = LSX_Schema_Utils::add_review( $reviews_array, $review_id, $this->context, $review_args );
-					$review_count++;
-				}
-				if ( ! empty( $reviews_array ) ) {
-					if ( true === $include_aggregate ) {
-						$data['aggregateRating'] = array(
-							'@type'       => 'AggregateRating',
-							'ratingValue' => (string) $aggregate_value,
-							'reviewCount' => (string) $review_count,
-							'bestRating'  => '5',
-							'worstRating' => '1',
-						);
-					}
-					$data[ $data_key ] = $reviews_array;
-				}
-			}
-			return $data;
-		}
-		/**
-		 * Gets the connected posts and set it as the "Article" schema
-		 *
-		 * @param  array  $data An array of offers already added.
-		 * @param  string $data_key
-		 * @return array  $data
-		 */
-		public function add_articles( $data, $data_key = 'subjectOf' ) {
-			$posts       = get_post_meta( $this->context->id, 'post_to_' . $this->post_type, false );
-			$posts_array = array();
-			if ( ! empty( $posts ) ) {
-				foreach ( $posts as $post_id ) {
-					$post_args = array(
-						'articleBody' => wp_strip_all_tags( get_the_excerpt( $post_id ) ),
-						'headline'    => get_the_title( $post_id ),
-					);
-					$section   = get_the_term_list( $post_id, 'category' );
-					if ( ! is_wp_error( $section ) && '' !== $section && false !== $section ) {
-						$post_args['articleSection'] = wp_strip_all_tags( $section );
-					}
-					if ( $this->context->site_represents_reference ) {
-						$post_args['publisher'] = $this->context->site_represents_reference;
-					}
-					$image_url = get_the_post_thumbnail_url( $post_id, 'lsx-thumbnail-wide' );
-					if ( false !== $image_url ) {
-						$post_args['image'] = $image_url;
-					}
-					$posts_array = LSX_Schema_Utils::add_article( $posts_array, $post_id, $this->context, $post_args );
-				}
-				if ( ! empty( $posts_array ) ) {
-					$data[ $data_key ] = $posts_array;
-				}
-			}
-			return $data;
-		}
-		/**
-		 * Adds the Project and Testimonials attached to the Team Member
-		 *
-		 * @param array $data
-		 *
-		 * @return array $data
-		 */
-		public function add_connections( $data ) {
-			$connections_array = array();
-			if ( $this->is_top_level ) {
-				$connections_array = $this->add_regions( $connections_array );
-				$connections_array = $this->add_accommodation( $connections_array );
-				if ( ! empty( $connections_array ) ) {
-					$data['containsPlace'] = $connections_array;
-				}
-			} else {
-				$connections_array             = $this->add_countries( $connections_array );
-				$data['containedInPlace'] = $connections_array;
-				$connections_array          = array();
-				$connections_array          = $this->add_accommodation( $connections_array );
-				$data['containsPlace'] = $connections_array;
-			}
-			return $data;
-		}
-		/**
-		 * Adds the terms for the taxonomy
-		 *
-		 * @param array $data     Review data.
-		 * @param array $data_key the parameter name you wish to assign it to.
-		 * @param array $taxonomy the taxonomy to grab terms for.
-		 *
-		 * @return array $data Review data.
-		 */
-		public function add_taxonomy_terms( $data, $data_key, $taxonomy ) {
-			/**
-			 * Filter: 'lsx_schema_' . $this->post_type . '_' . $data_key . '_taxonomy' - Allow changing the taxonomy used to assign keywords to a post type Review data.
-			 *
-			 * @api string $taxonomy The chosen taxonomy.
-			 */
-			$taxonomy = apply_filters( 'lsx_schema_' . $this->post_type . '_' . $data_key . '_taxonomy', $taxonomy );
-			return LSX_Schema_Utils::add_terms( $data, $this->context->id, $data_key, $taxonomy );
-		}
-		/**
-		 * Adds the custom field value for the supplied key
-		 *
-		 * @param array   $data     Schema data.
-		 * @param string  $data_key the parameter name you wish to assign it to.
-		 * @param string  $meta_key the taxonomy to grab terms for.
-		 * @param boolean $single   A single custom field or an array
-		 *
-		 * @return array $data Review data.
-		 */
-		public function add_custom_field( $data, $data_key, $meta_key, $single = true ) {
-			$value = get_post_meta( $this->context->id, $meta_key, $single );
-			if ( '' !== $value && false !== $value ) {
-				$data[ $data_key ] = $value;
-			}
-			return $data;
-		}
-	}
+     class LSX_Schema_Graph_Piece extends Abstract_Schema_Piece {
+          /**
+           * A value object with context variables.
+           *
+           * @var \WPSEO_Schema_Context
+           */
+          public $context;
+          /**
+           * This is the post type that you want the piece to output for.
+           *
+           * @var string;
+           */
+          public $post_type;
+          /**
+           * If this is a top level parent
+           *
+           * @var boolean
+           */
+          public $is_top_level;
+          /**
+           * This holds the meta_key => scehma_type of the fields you want to add to your subtrip.
+           *
+           * @var array()
+           */
+          public $place_ids;
+          /**
+           * This holds an object or the current trip post.
+           *
+           * @var WP_Post();
+           */
+          public $post;
+          /**
+           * This holds URL for the trip
+           *
+           * @var string
+           */
+          public $post_url;
+          /**
+           * Constructor.
+           *
+           * @param \WPSEO_Schema_Context $context A value object with context variables.
+           */
+          public function __construct( WPSEO_Schema_Context $context ) {
+               $this->context      = $context;
+               $this->place_ids    = array();
+               $this->post         = get_post( $this->context->id );
+               $this->post_url     = get_permalink( $this->context->id );
+               $this->is_top_level = false;
+               if ( is_object( $this->post ) && isset( $this->post->post_parent ) && ( false === $this->post->post_parent || 0 === $this->post->post_parent || '' === $this->post->post_parent ) ) {
+                    $this->is_top_level = true;
+               }
+          }
+          /**
+           * Determines whether or not a piece should be added to the graph.
+           *
+           * @return bool
+           */
+          public function is_needed() {
+               if ( ! is_singular() ) {
+                    return false;
+               }
+               if ( false === $this->context->site_represents ) {
+                    return false;
+               }
+               return LSX_Schema_Utils::is_type( get_post_type(), $this->post_type );
+          }
+          /**
+           * Returns Review data.
+           *
+           * @return array $data Review data.
+           */
+          public function generate() {
+               $data = array();
+               return $data;
+          }
+          /**
+           * Gets the connected reviews post type and set it as the "Review" schema
+           *
+           * @param  array    $data An array of offers already added.
+           * @param  string   $data_key
+           * @param  boolean  $include_aggregate
+           * @return array    $data
+           */
+          public function add_reviews( $data, $data_key = 'reviews', $include_aggregate = true ) {
+               $reviews       = get_post_meta( $this->context->id, 'review_to_' . $this->post_type, false );
+               $reviews_array = array();
+               if ( ! empty( $reviews ) ) {
+                    $aggregate_value = 1;
+                    $review_count    = 0;
+                    foreach ( $reviews as $review_id ) {
+                         $rating      = get_post_meta( $review_id, 'rating', true );
+                         $author      = get_post_meta( $review_id, 'reviewer_name', true );
+                         $description = wp_strip_all_tags( get_the_excerpt( $review_id ) );
+                         $review_args = array(
+                              'author'     => $author,
+                              'reviewBody' => $description,
+                         );
+                         // Add in the review rating.
+                         if ( false !== $rating && '' !== $rating && '0' !== $rating && 0 !== $rating ) {
+                              $review_args['reviewRating'] = array(
+                                   '@type'       => 'Rating',
+                                   'ratingValue' => $rating,
+                              );
+                         }
+                         $reviews_array = LSX_Schema_Utils::add_review( $reviews_array, $review_id, $this->context, $review_args );
+                         $review_count++;
+                    }
+                    if ( ! empty( $reviews_array ) ) {
+                         if ( true === $include_aggregate ) {
+                              $data['aggregateRating'] = array(
+                                   '@type'       => 'AggregateRating',
+                                   'ratingValue' => (string) $aggregate_value,
+                                   'reviewCount' => (string) $review_count,
+                                   'bestRating'  => '5',
+                                   'worstRating' => '1',
+                              );
+                         }
+                         $data[ $data_key ] = $reviews_array;
+                    }
+               }
+               return $data;
+          }
+          /**
+           * Gets the connected posts and set it as the "Article" schema
+           *
+           * @param  array  $data An array of offers already added.
+           * @param  string $data_key
+           * @return array  $data
+           */
+          public function add_articles( $data, $data_key = 'subjectOf' ) {
+               $posts       = get_post_meta( $this->context->id, 'post_to_' . $this->post_type, false );
+               $posts_array = array();
+               if ( ! empty( $posts ) ) {
+                    foreach ( $posts as $post_id ) {
+                         $post_args = array(
+                              'articleBody' => wp_strip_all_tags( get_the_excerpt( $post_id ) ),
+                              'headline'    => get_the_title( $post_id ),
+                         );
+                         $section   = get_the_term_list( $post_id, 'category' );
+                         if ( ! is_wp_error( $section ) && '' !== $section && false !== $section ) {
+                              $post_args['articleSection'] = wp_strip_all_tags( $section );
+                         }
+                         if ( $this->context->site_represents_reference ) {
+                              $post_args['publisher'] = $this->context->site_represents_reference;
+                         }
+                         $image_url = get_the_post_thumbnail_url( $post_id, 'lsx-thumbnail-wide' );
+                         if ( false !== $image_url ) {
+                              $post_args['image'] = $image_url;
+                         }
+                         $posts_array = LSX_Schema_Utils::add_article( $posts_array, $post_id, $this->context, $post_args );
+                    }
+                    if ( ! empty( $posts_array ) ) {
+                         $data[ $data_key ] = $posts_array;
+                    }
+               }
+               return $data;
+          }
+          /**
+           * Adds the Project and Testimonials attached to the Team Member
+           *
+           * @param array $data
+           *
+           * @return array $data
+           */
+          public function add_connections( $data ) {
+               $connections_array = array();
+               if ( $this->is_top_level ) {
+                    $connections_array = $this->add_regions( $connections_array );
+                    $connections_array = $this->add_accommodation( $connections_array );
+                    if ( ! empty( $connections_array ) ) {
+                         $data['containsPlace'] = $connections_array;
+                    }
+               } else {
+                    $connections_array             = $this->add_countries( $connections_array );
+                    $data['containedInPlace'] = $connections_array;
+                    $connections_array          = array();
+                    $connections_array          = $this->add_accommodation( $connections_array );
+                    $data['containsPlace'] = $connections_array;
+               }
+               return $data;
+          }
+          /**
+           * Adds the terms for the taxonomy
+           *
+           * @param array $data     Review data.
+           * @param array $data_key the parameter name you wish to assign it to.
+           * @param array $taxonomy the taxonomy to grab terms for.
+           *
+           * @return array $data Review data.
+           */
+          public function add_taxonomy_terms( $data, $data_key, $taxonomy ) {
+               /**
+                * Filter: 'lsx_schema_' . $this->post_type . '_' . $data_key . '_taxonomy' - Allow changing the taxonomy used to assign keywords to a post type Review data.
+                *
+                * @api string $taxonomy The chosen taxonomy.
+                */
+               $taxonomy = apply_filters( 'lsx_schema_' . $this->post_type . '_' . $data_key . '_taxonomy', $taxonomy );
+               return LSX_Schema_Utils::add_terms( $data, $this->context->id, $data_key, $taxonomy );
+          }
+          /**
+           * Adds the custom field value for the supplied key
+           *
+           * @param array   $data     Schema data.
+           * @param string  $data_key the parameter name you wish to assign it to.
+           * @param string  $meta_key the taxonomy to grab terms for.
+           * @param boolean $single   A single custom field or an array
+           *
+           * @return array $data Review data.
+           */
+          public function add_custom_field( $data, $data_key, $meta_key, $single = true ) {
+               $value = get_post_meta( $this->context->id, $meta_key, $single );
+               if ( '' !== $value && false !== $value ) {
+                    $data[ $data_key ] = $value;
+               }
+               return $data;
+          }
+     }
 }