Schema::buildReview() - Code Metrics - Inspection of "fix scrutinizer issues" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed
Push — master ( 227e6c...6addba )

by Paul
created 2018-06-25 03:32 UTC
Schema::buildReview() A

↳ Parent: Schema
Complexity

Conditions	2
Paths	2
Size

Total Lines
Duplication

Lines	0
Ratio	0 %
Code Coverage

Tests	0
CRAP Score	6
Importance

Changes
Metric	Value
cc	2
nc	2
nop	1
dl	0
loc	20
ccs	0
cts	20
cp	0
crap	6
rs	9.6
c	0
b	0
f	0
<?php

namespace GeminiLabs\SiteReviews\Modules;

use DateTime;
use GeminiLabs\SiteReviews\Database;
use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Helper;
use GeminiLabs\SiteReviews\Modules\Rating;
use GeminiLabs\SiteReviews\Modules\Schema\UnknownType;
use WP_Post;

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 )->results as $review ) {
			// Only include critic reviews that have been directly produced by your site, not reviews from third- party sites or syndicated reviews.
			// @see https://developers.google.com/search/docs/data-types/review
			if( $review->review_type != 'local' )continue;
			$reviews[] = $this->buildReview( $review );
		}
		if( !empty( $reviews )) {
			array_walk( $reviews, function( &$review ) {
				unset( $review['@context'] );
				unset( $review['itemReviewed'] );
			});
			$schema['review'] = $reviews;
		}
		return $schema;
	}

	/**
	 * @param null|array $args
	 * @return array
	 */
	public function buildSummary( $args = null )
	{
		if( is_array( $args )) {
			$this->args = $args;
		}
		$buildSummary = glsr( Helper::class )->buildMethodName( $this->getSchemaOptionValue( 'type' ), 'buildSummaryFor' );
		$count = $this->getReviewCount();
		$schema = method_exists( $this, $buildSummary )
			? $this->$buildSummary()
			: $this->buildSummaryForCustom();
		if( !empty( $count )) {
			$schema->aggregateRating( $this->getSchemaType( 'AggregateRating' )
            aggregateRating( $this->getSchemaType( 'AggregateRating' )
				->ratingValue( $this->getRatingValue() )
				->/** @scrutinizer ignore-call */ ratingValue( $this->getRatingValue() )
				->reviewCount( $count )
				->/** @scrutinizer ignore-call */ reviewCount( $count )
				->bestRating( Rating::MAX_RATING )
				->/** @scrutinizer ignore-call */ bestRating( Rating::MAX_RATING )
				->worstRating( Rating::MIN_RATING )
				->/** @scrutinizer ignore-call */ 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 = glsr()->schemas;
		$schemas[] = $schema;
		glsr()->schemas = array_map( 'unserialize', array_unique( array_map( 'serialize', $schemas )));
	}

	/**
	 * @param object $review
	 * @return array
	 */
	protected function buildReview( $review )
	{
		$schema = $this->getSchemaType( 'Review' )
			->doIf( !in_array( 'title', $this->args['hide'] ), function( $schema ) use( $review ) {
				$schema->name( $review->title );
			})
			->doIf( !in_array( 'excerpt', $this->args['hide'] ), function( $schema ) use( $review ) {
				$schema->reviewBody( $review->content );
			})
			->datePublished(( new DateTime( $review->date )))
			->/** @scrutinizer ignore-call */ datePublished(( new DateTime( $review->date )))
			->author( $this->getSchemaType( 'Person' )->name( $review->author ))
			->author( $this->getSchemaType( 'Person' )->/** @scrutinizer ignore-call */ name( $review->author ))
			->itemReviewed( $this->getSchemaType()->name( $this->getSchemaOptionValue( 'name' )));
			->/** @scrutinizer ignore-call */ itemReviewed( $this->getSchemaType()->name( $this->getSchemaOptionValue( 'name' )));
		if( !empty( $review->rating )) {
			$schema->reviewRating( $this->getSchemaType( 'Rating' )
            reviewRating( $this->getSchemaType( '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 mixed $schema
	 * @return mixed
	 */
	protected function buildSchemaValues( $schema, array $values = [] )
	{
		foreach( $values as $value ) {
			$option = $this->getSchemaOptionValue( $value );
			if( empty( $option ))continue;
			$schema->$value( $option );
		}
		return $schema;
	}

	/**
	 * @return mixed
	 */
	protected function buildSummaryForCustom()
	{
		return $this->buildSchemaValues( $this->getSchemaType(), [
			'description', 'image', 'name', 'url',
		]);
	}

	/**
	 * @return mixed
	 */
	protected function buildSummaryForLocalBusiness()
	{
		return $this->buildSchemaValues( $this->buildSummaryForCustom(), [
			'address', 'priceRange', 'telephone',
		]);
	}

	/**
	 * @return mixed
	 */
	protected function buildSummaryForProduct()
	{
		$offers = $this->buildSchemaValues( $this->getSchemaType( 'AggregateOffer' ), [
			'highPrice', 'lowPrice', 'priceCurrency',
		]);
		return $this->buildSummaryForCustom()
			->offers( $offers )
			->/** @scrutinizer ignore-call */ offers( $offers )
			->setProperty( '@id', $this->getSchemaOptionValue( 'url' ));
	}

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

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

	/**
	 * @return array
	 */
	protected function getReviews( $force = false )
	{
		if( !isset( $this->reviews ) || $force ) {
			$args = wp_parse_args( ['count' => -1], $this->args );
			$this->reviews = glsr( Database::class )->getReviews( $args )->results;
		}
		return $this->reviews;
	}

	/**
	 * @param string $option
	 * @param string $fallback
	 * @return string
	 */
	protected function getSchemaOption( $option, $fallback )
	{
		$option = strtolower( $option );
		if( $schemaOption = trim( (string)get_post_meta( intval( get_the_ID() ), 'schema_'.$option, true ))) {
			return $schemaOption;
		}
		$setting = glsr( OptionManager::class )->get( 'settings.schema.'.$option );
		if( is_array( $setting )) {
			return $this->getSchemaOptionDefault( $setting, $fallback );
		}
		return !empty( $setting )
			? $setting
			: $fallback;
	}

	/**
	 * @param string $fallback
	 * @return string
	 */
	protected function getSchemaOptionDefault( array $setting, $fallback )
	{
		$setting = wp_parse_args( $setting, [
			'custom' => '',
			'default' => $fallback,
		]);
		return $setting['default'] != 'custom'
			? $setting['default']
			: $setting['custom'];
	}

	/**
	 * @param string $option
	 * @param string $fallback
	 * @return void|string
	 */
	protected function getSchemaOptionValue( $option, $fallback = 'post' )
	{
		$value = $this->getSchemaOption( $option, $fallback );
		if( $value != $fallback ) {
			return $value;
		}
		if( !is_single() && !is_page() )return;
		$method = glsr( Helper::class )->buildMethodName( $option, 'getThing' );
		if( method_exists( $this, $method )) {
			return $this->$method();
		}
	}

	/**
	 * @param null|string $type
	 * @return mixed
	 */
	protected function getSchemaType( $type = null )
	{
		if( !is_string( $type )) {
			$type = $this->getSchemaOption( 'type', 'LocalBusiness' );
		}
		$className = glsr( Helper::class )->buildClassName( $type, 'Modules\Schema' );
		return class_exists( $className )
			? new $className()
			: new UnknownType( $type );
	}

	/**
	 * @return string
	 */
	protected function getThingDescription()
	{
		$post = get_post();
		if( !( $post instanceof WP_Post )) {
			return '';
		}
		$text = strip_shortcodes( wp_strip_all_tags( $post->post_excerpt ));
		return wp_trim_words( $text, apply_filters( 'excerpt_length', 55 ));
	}

	/**
	 * @return string
	 */
	protected function getThingImage()
	{
		return (string)get_the_post_thumbnail_url( null, 'large' );
	}

	/**
	 * @return string
	 */
	protected function getThingName()
	{
		return get_the_title();
	}

	/**
	 * @return string
	 */
	protected function getThingUrl()
	{
		return (string)get_the_permalink();
	}
}

pryley / site-reviews

Push — master ( 227e6c...6addba )

Schema::buildReview() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like
