lightspeeddevelopment / lsx

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

<?php
/**
 * Helper functions for the Schema class.
 *
 * @package lsx
 */

There must be exactly one blank line after the file comment

/**
 * Schema utility functions.
 *
 * @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 );

Not using strict comparison for in_array; supply true for third argument.

	}
	/**
	 * 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 ) );

$place_id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_title().

		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 );

$context->id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_permalink().

		}
		$url .= '#/schema/offer/';
		$url .= wp_hash( $id . get_the_title( $id ) );

$id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_title().

		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 );

$context->id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_permalink().

		}
		$url .= '#/schema/review/';
		$url .= wp_hash( $id . get_the_title( $id ) );

$id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_title().

		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;

Are you sure get_permalink($id) of type false|string can be used in concatenation?

$id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_permalink().

The type Schema_IDs was not found. Maybe you did not declare it correctly or list all dependencies?

		} else {
			$url = get_permalink( $context->id ) . '#/schema/article/' . wp_hash( $id . get_the_title( $id ) );

Are you sure get_permalink($context->id) of type false|string can be used in concatenation?

$id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_title().

		}
		return trailingslashit( $url );
	}
	/**

Doc comment for parameter "$email" missing

	 * 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.

Doc comment for parameter $context does not match actual variable name $email

	 *
	 * @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 ),

$post_id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_title().

			'description' => get_the_excerpt( $post_id ),

$post_id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_excerpt().

			'url'         => get_permalink( $post_id ),

$post_id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_permalink().

		);
		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 );

$post_id of type string is incompatible with the type WP_Post|integer expected by parameter $post of get_the_terms().

		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;
	}
}