GeminiLabs\SiteReviews\Modules\Schema

Complexity

Total Complexity

32

Size/Duplication

Total Lines	224
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes

0

15 Methods

Rating	Name	Duplication	Size	Complexity
B	getSchemaOptionValue()	0	16	8
A	build()	0	16	3
A	getReviews()	0	7	3
B	buildReview()	0	24	2
A	render()	0	6	2
A	getRatingValue()	0	3	1
A	getThingUrl()	0	3	1
A	getThingName()	0	3	1
A	getReviewCount()	0	3	1
A	getSchemaType()	0	4	1
A	getThingDescription()	0	3	1
A	store()	0	5	1
A	getSchemaOption()	0	9	3
B	buildSummary()	0	25	3
A	getThingImage()	0	3	1

<?php

namespace GeminiLabs\SiteReviews\Modules;

use DateTime;
use GeminiLabs\SchemaOrg\Review as ReviewSchema;
use GeminiLabs\SchemaOrg\Schema as SchemaOrg;
use GeminiLabs\SiteReviews\Database;
use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Modules\Rating;

class Schema
{
	/**
	 * @var array
	 */
	protected $args;

	/**
	 * @var array
	 */
	protected $reviews;

	/**
	 * @return array
	 */
	public function build( array $args = [] )
	{
		$this->args = $args;
		$schema = $this->buildSummary( $args );
		$reviews = [];
		foreach( glsr( Database::class )->getReviews( $this->args )->reviews as $review ) {
			$reviews[] = $this->buildReview( $review );
		}
		if( !empty( $reviews )) {
			array_walk( $reviews, function( &$review ) {
				unset( $review['@context'] );
				unset( $review['itemReviewed'] );
			});
			$schema['review'] = $reviews;
		}
		return $schema;
	}

	/**
	 * @param object $review
	 * @return array
	 */
	public function buildReview( $review )
	{
		$schema = SchemaOrg::Review()
			->doIf( !in_array( 'title', $this->args['hide'] ), function( ReviewSchema $schema ) use( $review ) {
				$schema->name( $review->title );
			})
			->doIf( !in_array( 'excerpt', $this->args['hide'] ), function( ReviewSchema $schema ) use( $review ) {
				$schema->reviewBody( $review->content );
			})
			->datePublished(( new DateTime( $review->date ))->format( DateTime::ISO8601 ))

new DateTime($review->date)->format(DateTime::ISO8601) of type string is incompatible with the type DateTimeInterface expected by parameter $datePublished of GeminiLabs\SchemaOrg\CreativeWork::datePublished().

			->author( SchemaOrg::Person()
				->name( $review->author )
			)
			->itemReviewed( $this->getSchemaType()

Are you sure the usage of $this->getSchemaType()->name($this->getThingName()) targeting GeminiLabs\SchemaOrg\Type::__call() seems to always return null.

				->name( $this->getThingName() )
			);
		if( !empty( $review->rating )) {
			$schema->reviewRating( SchemaOrg::Rating()
				->ratingValue( $review->rating )
				->bestRating( Rating::MAX_RATING )
				->worstRating( Rating::MIN_RATING )
			);
		}
		return apply_filters( 'site-reviews/schema/Review', $schema->toArray(), $review, $this->args );
	}

	/**
	 * @param null|array $args
	 * @return array
	 */
	public function buildSummary( $args = null )
	{
		if( is_array( $args )) {
			$this->args = $args;
		}
		$schema = $this->getSchemaType()

Are you sure the usage of $this->getSchemaType()->doIf($this->getSchemaOption('type') == 'Product', function(...) { /* ... */ }) targeting GeminiLabs\SchemaOrg\Type::__call() seems to always return null.

			->doIf( $this->getSchemaOption( 'type' ) == 'Product', function( $schema ) {

The call to GeminiLabs\SiteReviews\Modules\Schema::getSchemaOption() has too few arguments starting with fallback.

				$schema->setProperty( '@id', $this->getThingUrl() );
			})
			->name( $this->getThingName() )
			->description( $this->getThingDescription() )
			->image( $this->getThingImage() )
			->url( $this->getThingUrl() );
		$count = $this->getReviewCount();
		if( !empty( $count )) {
			$schema->aggregateRating( SchemaOrg::AggregateRating()
				->ratingValue( $this->getRatingValue() )
				->reviewCount( $count )
				->bestRating( Rating::MAX_RATING )
				->worstRating( Rating::MIN_RATING )
			);
		}
		$schema = $schema->toArray();
		$args = wp_parse_args( ['count' => -1], $this->args );
		return apply_filters( sprintf( 'site-reviews/schema/%s', $schema['@type'] ), $schema, $args );
	}

	/**
	 * @return void
	 */
	public function render()
	{
		if( is_null( glsr()->schemas ))return;
		printf( '<script type="application/ld+json">%s</script>', json_encode(
			apply_filters( 'site-reviews/schema/all', glsr()->schemas ),
			JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES
		));
	}

	/**
	 * @return void
	 */
	public function store( array $schema )
	{
		$schemas = (array) glsr()->schemas;
		$schemas[] = $schema;
		glsr()->schemas = array_map( 'unserialize', array_unique( array_map( 'serialize', $schemas )));
	}

	/**
	 * @return int|float
	 */
	protected function getRatingValue()
	{
		return glsr( Rating::class )->getAverage( $this->getReviews() );
	}

	/**
	 * @return int
	 */
	protected function getReviewCount()
	{
		return count( $this->getReviews() );
	}

	/**
	 * Get all reviews possible for given args
	 * @return array
	 */
	protected function getReviews( $force = false )
	{
		if( !is_array( $this->reviews ) || $force ) {

The condition is_array($this->reviews) is always true.

			$args = wp_parse_args( ['count' => -1], $this->args );
			$this->reviews = glsr( Database::class )->getReviews( $args )->reviews;
		}
		return $this->reviews;
	}

	/**
	 * @param string $option
	 * @param string $fallback
	 * @return string
	 */
	protected function getSchemaOption( $option, $fallback )
	{
		if( $schemaOption = trim( get_post_meta( get_the_ID(), 'schema_'.$option, true ))) {

It seems like get_post_meta(get_the_ID(), 'schema_' . $option, true) can also be of type false; however, parameter $str of trim() does only seem to accept string, maybe add an additional type check?

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?

			return $schemaOption;
		}
		$default = glsr( OptionManager::class )->get( 'settings.reviews.schema.'.$option.'.default', $fallback );
		return $default == 'custom'
			? glsr( OptionManager::class )->get( 'settings.reviews.schema.'.$option.'.custom', $fallback )
			: $default;
	}

	/**
	 * @param string $option
	 * @param string $fallback
	 * @return null|string
	 */
	protected function getSchemaOptionValue( $option, $fallback = 'post' )
	{
		$value = $this->getSchemaOption( $option, $fallback );
		if( $value != $fallback ) {
			return $value;
		}
		if( !is_single() && !is_page() )return;
		switch( $option ) {
			case 'description':
				return get_the_excerpt();
			case 'image':
				return (string)get_the_post_thumbnail_url( null, 'large' );
			case 'name':
				return get_the_title();
			case 'url':
				return (string)get_the_permalink();
		}
	}

	/**
	 * @return \GeminiLabs\SchemaOrg\Type
	 */
	protected function getSchemaType()
	{
		$type = $this->getSchemaOption( 'type', 'LocalBusiness' );
		return SchemaOrg::$type( $type );
	}

	/**
	 * @return null|string
	 */
	protected function getThingDescription()
	{
		return $this->getSchemaOptionValue( 'description' );
	}

	/**
	 * @return null|string
	 */
	protected function getThingImage()
	{
		return $this->getSchemaOptionValue( 'image' );
	}

	/**
	 * @return null|string
	 */
	protected function getThingName()
	{
		return $this->getSchemaOptionValue( 'name' );
	}

	/**
	 * @return null|string
	 */
	protected function getThingUrl()
	{
		return $this->getSchemaOptionValue( 'url' );
	}
}