lightspeeddevelopment / to-reviews

classes/class-to-review-schema.php

<?php

Class file names should be based on the class name with "class-" prepended. Expected class-lsx-to-schema-review.php, but found class-to-review-schema.php.

/**
 * The Review Schema
 *
 * @package to-reviews
 */

/**
 * Returns schema Review data.
 *
 * @since 10.2
 */
class LSX_TO_Schema_Review extends LSX_TO_Schema_Graph_Piece {

	/**
	 * Constructor.
	 *
	 * @param \WPSEO_Schema_Context $context A value object with context variables.
	 */
	public function __construct( WPSEO_Schema_Context $context ) {

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

Expected 2 blank lines before function; 1 found

		$this->post_type = 'review';
		parent::__construct( $context );
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**
	 * Returns Review data.
	 *
	 * @return array $data Review data.
	 */
	public function generate() {
		$post                = get_post( $this->context->id );
		$review_author       = get_post_meta( $post->ID, 'reviewer_name', true );
		$review_email        = get_post_meta( $post->ID, 'reviewer_email', true );
		$rating_value        = get_post_meta( $post->ID, 'rating', true );
		$description         = wp_strip_all_tags( get_the_content() );
		$tour_list           = get_post_meta( get_the_ID(), 'tour_to_review', false );

It seems like get_the_ID() can also be of type false; however, parameter $post_id of get_post_meta() does only seem to accept integer, maybe add an additional type check?

		$accom_list          = get_post_meta( get_the_ID(), 'accommodation_to_review', false );
		$comment_count       = get_comment_count( $this->context->id );
		$review_author       = get_post_meta( $post->ID, 'reviewer_name', true );
		$date_of_visit_start = get_post_meta( $post->ID, 'date_of_visit_start', true );
		$date_of_visit_end   = get_post_meta( $post->ID, 'date_of_visit_end', true );

		$data          = array(

Equals sign not aligned correctly; expected 1 space but found 10 spaces

			'@type'            => 'Review',
			'@id'              => $this->context->canonical . '#review',
			'author'           => array(
				'@type' => 'Person',
				'@id'   => \lsx\legacy\Schema_Utils::get_author_schema_id( $review_author, $review_email, $this->context ),

It seems like $review_author can also be of type false; however, parameter $name of lsx\legacy\Schema_Utils::get_author_schema_id() does only seem to accept string, maybe add an additional type check?

				'name'  => $review_author,
				'email' => $review_email,
			),
			'headline'         => get_the_title(),
			'datePublished'    => mysql2date( DATE_W3C, $post->post_date_gmt, false ),
			'dateModified'     => mysql2date( DATE_W3C, $post->post_modified_gmt, false ),
			'commentCount'     => $comment_count['approved'],
			'mainEntityOfPage' => array(
				'@id' => $this->context->canonical . WPSEO_Schema_IDs::WEBPAGE_HASH,

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

			),
			'reviewRating' => array(

Array double arrow not aligned correctly; expected 5 space(s) between "'reviewRating'" and double arrow, but found 1.

				'@type'       => 'Rating',
				'ratingValue' => $rating_value,
				'bestRating'  => $rating_value,
			),
			'reviewBody'       => $description,
			'itemReviewed'     => \lsx\legacy\Schema_Utils::get_item_reviewed( $tour_list, 'Product' ),

It seems like $tour_list can also be of type false; however, parameter $items of lsx\legacy\Schema_Utils::get_item_reviewed() does only seem to accept array, maybe add an additional type check?

			'itemReviewed'     => \lsx\legacy\Schema_Utils::get_item_reviewed( $accom_list, 'Product' ),
		);

		if ( $this->context->site_represents_reference ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$data['publisher'] = $this->context->site_represents_reference;
		}

		if ( '' !== $date_of_visit_start && '' !== $date_of_visit_end ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$data['temporalCoverage'] = $date_of_visit_start . ' - ' . $date_of_visit_end;
		}

		$data = \lsx\legacy\Schema_Utils::add_image( $data, $this->context );
		$data = $this->add_taxonomy_terms( $data, 'keywords', 'post_tag' );

'keywords' of type string is incompatible with the type array expected by parameter $data_key of LSX_TO_Schema_Graph_Piece::add_taxonomy_terms().

'post_tag' of type string is incompatible with the type array expected by parameter $taxonomy of LSX_TO_Schema_Graph_Piece::add_taxonomy_terms().

		$data = $this->add_taxonomy_terms( $data, 'reviewSection', 'category' );
		$data = $this->add_offers( $data );
		$data = $this->add_destinations( $data );
		return $data;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 1 found

	/**

Doc comment for parameter "$data_key" missing

	 * Adds the Destinations attached to the review
	 *
	 * @param array $data Country / State data.
	 *
	 * @return array $data Country / State data.
	 */
	public function add_destinations( $data, $data_key = '' ) {
		$places_array = array();
		$destinations = get_post_meta( $this->context->id, 'destination_to_' . $this->post_type, false );
		if ( ! empty( $destinations ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			foreach ( $destinations as $destination_id ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

				if ( '' !== $destination_id ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

					if ( 0 === wp_get_post_parent_id( $destination_id ) || false === wp_get_post_parent_id( $destination_id ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

						$places_array = \lsx\legacy\Schema_Utils::add_place( $places_array, 'Country', $destination_id, $this->context );
					} else {
						$places_array = \lsx\legacy\Schema_Utils::add_place( $places_array, 'State', $destination_id, $this->context );
					}
				}
			}
		}

No blank line found after control structure

		if ( ! empty( $places_array ) ) {

Expected 0 spaces after opening bracket; 1 found

Expected 0 spaces before closing bracket; 1 found

			$data['spatialCoverage'] = $places_array;
		}

No blank line found after control structure

		return $data;
	}

Expected 1 blank line before closing function brace; 0 found

Expected 2 blank lines after function; 0 found

}