Schema::getSchemaOption() - Code Metrics - Inspection of "manage review counts" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 6f6d9e...e32a3c )

by Paul

created 2018-07-18 00:11 UTC

Schema::getSchemaOption() A

↳ Parent: Schema

Complexity

Conditions	4
Paths	4

Size

Total Lines	13
Code Lines	9

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
eloc	9
nc	4
nop	2
dl	0
loc	13
ccs	0
cts	13
cp	0
crap	20
rs	9.9666
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\Database\ReviewManager;
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 $reviewCounts;

	/**
	 * @return array
	 */
	public function build( array $args = [] )
	{
		$this->args = $args;
		$schema = $this->buildSummary( $args );
		$reviews = [];
		foreach( glsr( ReviewManager::class )->get( $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 = array_sum( $this->getReviewCounts() );
		$schema = method_exists( $this, $buildSummary )
			? $this->$buildSummary()
			: $this->buildSummaryForCustom();
		if( !empty( $count )) {
			$schema->aggregateRating(
				$this->getSchemaType( 'AggregateRating' )
					->ratingValue( $this->getRatingValue() )
					->reviewCount( $count )
					->bestRating( Rating::MAX_RATING )
					->worstRating( Rating::MIN_RATING )
			);
		}
		$schema = $schema->toArray();
		return apply_filters( 'site-reviews/schema/'.$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 )))
			->author( $this->getSchemaType( 'Person' )->name( $review->author ))
			->itemReviewed( $this->getSchemaType()->name( $this->getSchemaOptionValue( 'name' )));
		if( !empty( $review->rating )) {
			$schema->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 )
			->setProperty( '@id', $this->getSchemaOptionValue( 'url' ));
	}

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

	/**
	 * @return array
	 */
	protected function getReviewCounts()
	{
		if( !isset( $this->reviewCounts )) {
			$this->reviewCounts = glsr( Database::class )->getReviewCounts([
				'min' => $this->args['rating'],
			]);
		}
		return $this->reviewCounts;
	}

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


1			<?php
2
3			namespace GeminiLabs\SiteReviews\Modules;
4
5			use DateTime;
6			use GeminiLabs\SiteReviews\Database;
7			use GeminiLabs\SiteReviews\Database\OptionManager;
8			use GeminiLabs\SiteReviews\Database\ReviewManager;
9			use GeminiLabs\SiteReviews\Helper;
10			use GeminiLabs\SiteReviews\Modules\Rating;
11			use GeminiLabs\SiteReviews\Modules\Schema\UnknownType;
12			use WP_Post;
13
14			class Schema
15			{
16			/**
17			* @var array
18			*/
19			protected $args;
20
21			/**
22			* @var array
23			*/
24			protected $reviewCounts;
25
26			/**
27			* @return array
28			*/
29			public function build( array $args = [] )
30			{
31			$this->args = $args;
32			$schema = $this->buildSummary( $args );
33			$reviews = [];
34			foreach( glsr( ReviewManager::class )->get( $this->args )->results as $review ) {
35			// Only include critic reviews that have been directly produced by your site, not reviews from third- party sites or syndicated reviews.
36			// @see https://developers.google.com/search/docs/data-types/review
37			if( $review->review_type != 'local' )continue;
38			$reviews[] = $this->buildReview( $review );
39			}
40			if( !empty( $reviews )) {
41			array_walk( $reviews, function( &$review ) {
42			unset( $review['@context'] );
43			unset( $review['itemReviewed'] );
44			});
45			$schema['review'] = $reviews;
46			}
47			return $schema;
48			}
49
50			/**
51			* @param null\|array $args
52			* @return array
53			*/
54			public function buildSummary( $args = null )
55			{
56			if( is_array( $args )) {
57			$this->args = $args;
58			}
59			$buildSummary = glsr( Helper::class )->buildMethodName( $this->getSchemaOptionValue( 'type' ), 'buildSummaryFor' );
60			$count = array_sum( $this->getReviewCounts() );
61			$schema = method_exists( $this, $buildSummary )
62			? $this->$buildSummary()
63			: $this->buildSummaryForCustom();
64			if( !empty( $count )) {
65			$schema->aggregateRating(
66			$this->getSchemaType( 'AggregateRating' )
67			->ratingValue( $this->getRatingValue() )
68			->reviewCount( $count )
69			->bestRating( Rating::MAX_RATING )
70			->worstRating( Rating::MIN_RATING )
71			);
72			}
73			$schema = $schema->toArray();
74			return apply_filters( 'site-reviews/schema/'.$schema['@type'], $schema, $args );
75			}
76
77			/**
78			* @return void
79			*/
80			public function render()
81			{
82			if( is_null( glsr()->schemas ))return;
83			printf( '<script type="application/ld+json">%s</script>', json_encode(
84			apply_filters( 'site-reviews/schema/all', glsr()->schemas ),
85			JSON_UNESCAPED_UNICODE \| JSON_UNESCAPED_SLASHES
86			));
87			}
88
89			/**
90			* @return void
91			*/
92			public function store( array $schema )
93			{
94			$schemas = glsr()->schemas;
95			$schemas[] = $schema;
96			glsr()->schemas = array_map( 'unserialize', array_unique( array_map( 'serialize', $schemas )));
97			}
98
99			/**
100			* @param object $review
101			* @return array
102			*/
103			protected function buildReview( $review )
104			{
105			$schema = $this->getSchemaType( 'Review' )
106			->doIf( !in_array( 'title', $this->args['hide'] ), function( $schema ) use( $review ) {
107			$schema->name( $review->title );
108			})
109			->doIf( !in_array( 'excerpt', $this->args['hide'] ), function( $schema ) use( $review ) {
110			$schema->reviewBody( $review->content );
111			})
112			->datePublished(( new DateTime( $review->date )))
113			->author( $this->getSchemaType( 'Person' )->name( $review->author ))
114			->itemReviewed( $this->getSchemaType()->name( $this->getSchemaOptionValue( 'name' )));
115			if( !empty( $review->rating )) {
116			$schema->reviewRating(
117			$this->getSchemaType( 'Rating' )
118			->ratingValue( $review->rating )
119			->bestRating( Rating::MAX_RATING )
120			->worstRating( Rating::MIN_RATING )
121			);
122			}
123			return apply_filters( 'site-reviews/schema/review', $schema->toArray(), $review, $this->args );
124			}
125
126			/**
127			* @param mixed $schema
128			* @return mixed
129			*/
130			protected function buildSchemaValues( $schema, array $values = [] )
131			{
132			foreach( $values as $value ) {
133			$option = $this->getSchemaOptionValue( $value );
134			if( empty( $option ))continue;
135			$schema->$value( $option );
136			}
137			return $schema;
138			}
139
140			/**
141			* @return mixed
142			*/
143			protected function buildSummaryForCustom()
144			{
145			return $this->buildSchemaValues( $this->getSchemaType(), [
146			'description', 'image', 'name', 'url',
147			]);
148			}
149
150			/**
151			* @return mixed
152			*/
153			protected function buildSummaryForLocalBusiness()
154			{
155			return $this->buildSchemaValues( $this->buildSummaryForCustom(), [
156			'address', 'priceRange', 'telephone',
157			]);
158			}
159
160			/**
161			* @return mixed
162			*/
163			protected function buildSummaryForProduct()
164			{
165			$offers = $this->buildSchemaValues( $this->getSchemaType( 'AggregateOffer' ), [
166			'highPrice', 'lowPrice', 'priceCurrency',
167			]);
168			return $this->buildSummaryForCustom()
169			->offers( $offers )
170			->setProperty( '@id', $this->getSchemaOptionValue( 'url' ));
171			}
172
173			/**
174			* @return int\|float
175			*/
176			protected function getRatingValue()
177			{
178			return glsr( Rating::class )->getAverage( $this->getReviewCounts() );
179			}
180
181			/**
182			* @return array
183			*/
184			protected function getReviewCounts()
185			{
186			if( !isset( $this->reviewCounts )) {
187			$this->reviewCounts = glsr( Database::class )->getReviewCounts([
188			'min' => $this->args['rating'],
189			]);
190			}
191			return $this->reviewCounts;
192			}
193
194			/**
195			* @param string $option
196			* @param string $fallback
197			* @return string
198			*/
199			protected function getSchemaOption( $option, $fallback )
200			{
201			$option = strtolower( $option );
202			if( $schemaOption = trim( (string)get_post_meta( intval( get_the_ID() ), 'schema_'.$option, true ))) {
203			return $schemaOption;
204			}
205			$setting = glsr( OptionManager::class )->get( 'settings.schema.'.$option );
206			if( is_array( $setting )) {
207			return $this->getSchemaOptionDefault( $setting, $fallback );
208			}
209			return !empty( $setting )
210			? $setting
211			: $fallback;
212			}
213
214			/**
215			* @param string $fallback
216			* @return string
217			*/
218			protected function getSchemaOptionDefault( array $setting, $fallback )
219			{
220			$setting = wp_parse_args( $setting, [
221			'custom' => '',
222			'default' => $fallback,
223			]);
224			return $setting['default'] != 'custom'
225			? $setting['default']
226			: $setting['custom'];
227			}
228
229			/**
230			* @param string $option
231			* @param string $fallback
232			* @return void\|string
233			*/
234			protected function getSchemaOptionValue( $option, $fallback = 'post' )
235			{
236			$value = $this->getSchemaOption( $option, $fallback );
237			if( $value != $fallback ) {
238			return $value;
239			}
240			if( !is_single() && !is_page() )return;
241			$method = glsr( Helper::class )->buildMethodName( $option, 'getThing' );
242			if( method_exists( $this, $method )) {
243			return $this->$method();
244			}
245			}
246
247			/**
248			* @param null\|string $type
249			* @return mixed
250			*/
251			protected function getSchemaType( $type = null )
252			{
253			if( !is_string( $type )) {
254			$type = $this->getSchemaOption( 'type', 'LocalBusiness' );
255			}
256			$className = glsr( Helper::class )->buildClassName( $type, 'Modules\Schema' );
257			return class_exists( $className )
258			? new $className()
259			: new UnknownType( $type );
260			}
261
262			/**
263			* @return string
264			*/
265			protected function getThingDescription()
266			{
267			$post = get_post();
268			if( !( $post instanceof WP_Post )) {
269			return '';
270			}
271			$text = strip_shortcodes( wp_strip_all_tags( $post->post_excerpt ));
272			return wp_trim_words( $text, apply_filters( 'excerpt_length', 55 ));
273			}
274
275			/**
276			* @return string
277			*/
278			protected function getThingImage()
279			{
280			return (string)get_the_post_thumbnail_url( null, 'large' );
281			}
282
283			/**
284			* @return string
285			*/
286			protected function getThingName()
287			{
288			return get_the_title();
289			}
290
291			/**
292			* @return string
293			*/
294			protected function getThingUrl()
295			{
296			return (string)get_the_permalink();
297			}
298			}
299

pryley / site-reviews

Push — master ( 6f6d9e...e32a3c )

Schema::getSchemaOption() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like