SiteReviews::buildReview() - Code Metrics - Inspection of "[site_reviews_summary]" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 425d57...ac8e88 )

by Paul

created 2018-06-03 23:27 UTC

SiteReviews::buildReview() A

↳ Parent: SiteReviews

Complexity

Conditions	3
Paths	3

Size

Total Lines	9
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes

Metric	Value
cc	3
eloc	6
nc	3
nop	1
dl	0
loc	9
ccs	0
cts	9
cp	0
crap	12
rs	9.6666
c	0
b	0
f	0

<?php

namespace GeminiLabs\SiteReviews\Modules\Html\Partials;

use GeminiLabs\SiteReviews\Database;
use GeminiLabs\SiteReviews\Database\OptionManager;
use GeminiLabs\SiteReviews\Helper;
use GeminiLabs\SiteReviews\Modules\Date;
use GeminiLabs\SiteReviews\Modules\Html;
use GeminiLabs\SiteReviews\Modules\Html\Builder;
use GeminiLabs\SiteReviews\Modules\Html\Partial;
use GeminiLabs\SiteReviews\Modules\Html\Template;
use GeminiLabs\SiteReviews\Modules\Rating;
use GeminiLabs\SiteReviews\Modules\Schema;
use WP_Post;

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

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

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

	/**
	 * @return void|string
	 */
	public function build( array $args = [] )
	{
		$this->args = $args;
		$this->options = glsr( Helper::class )->flattenArray( glsr( OptionManager::class )->all() );
		$this->reviews = glsr( Database::class )->getReviews( $args );
		$this->generateSchema();
		$navigation = wp_validate_boolean( $this->args['pagination'] )
			? glsr( Partial::class )->build( 'pagination', ['total' => $this->reviews->max_num_pages] )
			: '';
		return glsr( Template::class )->build( 'templates/reviews', [
			'context' => [
				'class' => $this->getClass(),
				'id' => $this->args['id'],
				'navigation' => $navigation,
			],
			'reviews' => $this->buildReviews(),
		]);
	}

	/**
	 * @return array
	 */
	public function buildReviews()
	{
		$reviews = [];
		foreach( $this->reviews->results as $review ) {
			$reviews[] = $this->buildReview( $review );
		}
		return $reviews;
	}

	/**
	 * @param object $review
	 * @return object
	 */
	protected function buildReview( $review )
	{
		$generatedReview = [];
		foreach( $review as $key => $value ) {
			$method = glsr( Helper::class )->buildMethodName( $key, 'buildOption' );
			if( !method_exists( $this, $method ))continue;
			$generatedReview[$key] = $this->$method( $key, $value );
		}
		return (object)$generatedReview;
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionAssignedTo( $key, $value )
	{
		if( $this->isHiddenOrEmpty( $key, 'settings.reviews.assigned_links.enabled' ))return;
		$post = get_post( intval( $value ));
		if( !( $post instanceof WP_Post ))return;
		$permalink = glsr( Builder::class )->a( get_the_title( $post->ID ), [
			'href' => get_the_permalink( $post->ID ),
		]);
		$assignedTo = sprintf( __( 'Review of %s', 'site-reviews' ), $permalink );
		return $this->wrap( $key, '<span>'.$assignedTo.'</span>' );
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionAuthor( $key, $value )
	{
		if( $this->isHidden( $key ))return;
		$prefix = !$this->isOptionEnabled( 'settings.reviews.avatars.enabled' )
			? apply_filters( 'site-reviews/review/author/prefix', '&mdash;' )
			: '';
		return $this->wrap( $key, $prefix.'<span>'.$value.'</span>' );
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionAvatar( $key, $value )
	{
		if( $this->isHidden( $key, 'settings.reviews.avatars.enabled' ))return;
		$size = $this->getOption( 'settings.reviews.avatars.size', 36 );
		return $this->wrap( $key, glsr( Builder::class )->img([
			'src' => $value,
			'height' => $size,
			'width' => $size,
		]));
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionContent( $key, $value )
	{
		$text = $this->normalizeText( $value );
		if( $this->isHiddenOrEmpty( $key, $text ))return;
		return $this->wrap( $key, '<p>'.$text.'</p>' );
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionDate( $key, $value )
	{
		if( $this->isHidden( $key ))return;
		$dateFormat = $this->getOption( 'settings.reviews.date.format', 'default' );
		if( $dateFormat == 'relative' ) {
			$date = glsr( Date::class )->relative( $value );
		}
		else {
			$format = $dateFormat == 'custom'
				? $this->getOption( 'settings.reviews.date.custom', 'M j, Y' )
				: (string)get_option( 'date_format' );
			$date = date_i18n( $format, strtotime( $value ));
		}
		return $this->wrap( $key, '<span>'.$date.'</span>' );
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionRating( $key, $value )
	{
		if( $this->isHiddenOrEmpty( $key, $value ))return;
		$rating = glsr( Html::class )->buildPartial( 'star-rating', [
			'rating' => $value,
		]);
		return $this->wrap( $key, $rating );
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionResponse( $key, $value )
	{
		if( $this->isHiddenOrEmpty( $key, $value ))return;
		$title = sprintf( __( 'Response from %s', 'site-reviews' ), get_bloginfo( 'name' ));
		$text = $this->normalizeText( $value );
		$text = '<p><strong>'.$title.'</strong></p><p>'.$text.'</p>';
		return $this->wrap( $key,
			glsr( Builder::class )->div( $text, ['class' => 'glsr-review-response-inner'] ).
			glsr( Builder::class )->div( ['class' => 'glsr-review-response-background'] )
		);
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return void|string
	 */
	protected function buildOptionTitle( $key, $value )
	{
		if( $this->isHidden( $key ))return;
		if( empty( $value )) {
			$value = __( 'No Title', 'site-reviews' );
		}
		return $this->wrap( $key, '<h3>'.$value.'</h3>' );
	}

	/**
	 * @return void
	 */
	protected function generateSchema()
	{
		if( !wp_validate_boolean( $this->args['schema'] ))return;
		glsr( Schema::class )->store( glsr( Schema::class )->build( $this->args ));
	}

	/**
	 * @return string
	 */
	protected function getClass()
	{
		$style = apply_filters( 'site-reviews/style', 'glsr-style' );
		$pagination = $this->args['pagination'] == 'ajax'
			? 'glsr-ajax-pagination'
			: '';
		return trim( 'glsr-reviews '.$style.' '.$pagination.' '.$this->args['class'] );
	}

	/**
	 * @param string $text
	 * @return string
	 */
	protected function getExcerpt( $text )
	{
		$limit = $this->getOption( 'settings.reviews.excerpt.length', 55 );
		if( str_word_count( $text, 0 ) > $limit ) {
			$words = array_keys( str_word_count( $text, 2 ));
			$excerpt = ltrim( substr( $text, 0, $words[$limit] ));
			$hiddenText = substr( $text, strlen( $excerpt ));
			$showMore = glsr( Builder::class )->span( $hiddenText, [
				'class' => 'glsr-hidden glsr-hidden-text',
				'data-show-less' => __( 'Show less', 'site-reviews' ),
				'data-show-more' => __( 'Show more', 'site-reviews' ),
			]);
			$text = $excerpt.$showMore;
		}
		return nl2br( $text );
	}

	/**
	 * @param string $path
	 * @param mixed $fallback
	 * @return mixed
	 */
	protected function getOption( $path, $fallback = '' )
	{
		if( array_key_exists( $path, $this->options )) {
			return $this->options[$path];
		}
		return $fallback;
	}

	/**
	 * @param string $key
	 * @param string $path
	 * @return bool
	 */
	protected function isHidden( $key, $path = '' )
	{
		$isOptionEnabled = !empty( $path )
			? $this->isOptionEnabled( $path )
			: true;
		return in_array( $key, $this->args['hide'] ) || !$isOptionEnabled;
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return bool
	 */
	protected function isHiddenOrEmpty( $key, $value )
	{
		return $this->isHidden( $key ) || empty( $value );
	}

	/**
	 * @param string $path
	 * @return bool
	 */
	protected function isOptionEnabled( $path )
	{
		return $this->getOption( $path ) == 'yes';
	}

	/**
	 * @param string $text
	 * @return string
	 */
	protected function normalizeText( $text )
	{
		$text = wp_kses( $text, wp_kses_allowed_html() );
		$text = convert_smilies( wptexturize( strip_shortcodes( $text )));
		$text = str_replace( ']]>', ']]&gt;', $text );
		$text = preg_replace( '/(\R){2,}/', '$1', $text );
		return $this->isOptionEnabled( 'settings.reviews.excerpt.enabled' )
			? $this->getExcerpt( $text )
			: $text;
	}

	/**
	 * @param string $key
	 * @param string $value
	 * @return string
	 */
	protected function wrap( $key, $value )
	{
		return glsr( Builder::class )->div( $value, [
			'class' => 'glsr-review-'.$key,
		]);
	}
}


1			<?php
2
3			namespace GeminiLabs\SiteReviews\Modules\Html\Partials;
4
5			use GeminiLabs\SiteReviews\Database;
6			use GeminiLabs\SiteReviews\Database\OptionManager;
7			use GeminiLabs\SiteReviews\Helper;
8			use GeminiLabs\SiteReviews\Modules\Date;
9			use GeminiLabs\SiteReviews\Modules\Html;
10			use GeminiLabs\SiteReviews\Modules\Html\Builder;
11			use GeminiLabs\SiteReviews\Modules\Html\Partial;
12			use GeminiLabs\SiteReviews\Modules\Html\Template;
13			use GeminiLabs\SiteReviews\Modules\Rating;
14			use GeminiLabs\SiteReviews\Modules\Schema;
15			use WP_Post;
16
17			class SiteReviews
18			{
19			/**
20			* @var array
21			*/
22			protected $args;
23
24			/**
25			* @var array
26			*/
27			protected $options;
28
29			/**
30			* @var object
31			*/
32			protected $reviews;
33
34			/**
35			* @return void\|string
36			*/
37			public function build( array $args = [] )
38			{
39			$this->args = $args;
40			$this->options = glsr( Helper::class )->flattenArray( glsr( OptionManager::class )->all() );
41			$this->reviews = glsr( Database::class )->getReviews( $args );
42			$this->generateSchema();
43			$navigation = wp_validate_boolean( $this->args['pagination'] )
44			? glsr( Partial::class )->build( 'pagination', ['total' => $this->reviews->max_num_pages] )
45			: '';
46			return glsr( Template::class )->build( 'templates/reviews', [
47			'context' => [
48			'class' => $this->getClass(),
49			'id' => $this->args['id'],
50			'navigation' => $navigation,
51			],
52			'reviews' => $this->buildReviews(),
53			]);
54			}
55
56			/**
57			* @return array
58			*/
59			public function buildReviews()
60			{
61			$reviews = [];
62			foreach( $this->reviews->results as $review ) {
63			$reviews[] = $this->buildReview( $review );
64			}
65			return $reviews;
66			}
67
68			/**
69			* @param object $review
70			* @return object
71			*/
72			protected function buildReview( $review )
73			{
74			$generatedReview = [];
75			foreach( $review as $key => $value ) {
76			$method = glsr( Helper::class )->buildMethodName( $key, 'buildOption' );
77			if( !method_exists( $this, $method ))continue;
78			$generatedReview[$key] = $this->$method( $key, $value );
79			}
80			return (object)$generatedReview;
81			}
82
83			/**
84			* @param string $key
85			* @param string $value
86			* @return void\|string
87			*/
88			protected function buildOptionAssignedTo( $key, $value )
89			{
90			if( $this->isHiddenOrEmpty( $key, 'settings.reviews.assigned_links.enabled' ))return;
91			$post = get_post( intval( $value ));
92			if( !( $post instanceof WP_Post ))return;
93			$permalink = glsr( Builder::class )->a( get_the_title( $post->ID ), [
94			'href' => get_the_permalink( $post->ID ),
95			]);
96			$assignedTo = sprintf( __( 'Review of %s', 'site-reviews' ), $permalink );
97			return $this->wrap( $key, '<span>'.$assignedTo.'</span>' );
98			}
99
100			/**
101			* @param string $key
102			* @param string $value
103			* @return void\|string
104			*/
105			protected function buildOptionAuthor( $key, $value )
106			{
107			if( $this->isHidden( $key ))return;
108			$prefix = !$this->isOptionEnabled( 'settings.reviews.avatars.enabled' )
109			? apply_filters( 'site-reviews/review/author/prefix', '—' )
110			: '';
111			return $this->wrap( $key, $prefix.'<span>'.$value.'</span>' );
112			}
113
114			/**
115			* @param string $key
116			* @param string $value
117			* @return void\|string
118			*/
119			protected function buildOptionAvatar( $key, $value )
120			{
121			if( $this->isHidden( $key, 'settings.reviews.avatars.enabled' ))return;
122			$size = $this->getOption( 'settings.reviews.avatars.size', 36 );
123			return $this->wrap( $key, glsr( Builder::class )->img([
124			'src' => $value,
125			'height' => $size,
126			'width' => $size,
127			]));
128			}
129
130			/**
131			* @param string $key
132			* @param string $value
133			* @return void\|string
134			*/
135			protected function buildOptionContent( $key, $value )
136			{
137			$text = $this->normalizeText( $value );
138			if( $this->isHiddenOrEmpty( $key, $text ))return;
139			return $this->wrap( $key, '<p>'.$text.'</p>' );
140			}
141
142			/**
143			* @param string $key
144			* @param string $value
145			* @return void\|string
146			*/
147			protected function buildOptionDate( $key, $value )
148			{
149			if( $this->isHidden( $key ))return;
150			$dateFormat = $this->getOption( 'settings.reviews.date.format', 'default' );
151			if( $dateFormat == 'relative' ) {
152			$date = glsr( Date::class )->relative( $value );
153			}
154			else {
155			$format = $dateFormat == 'custom'
156			? $this->getOption( 'settings.reviews.date.custom', 'M j, Y' )
157			: (string)get_option( 'date_format' );
158			$date = date_i18n( $format, strtotime( $value ));
159			}
160			return $this->wrap( $key, '<span>'.$date.'</span>' );
161			}
162
163			/**
164			* @param string $key
165			* @param string $value
166			* @return void\|string
167			*/
168			protected function buildOptionRating( $key, $value )
169			{
170			if( $this->isHiddenOrEmpty( $key, $value ))return;
171			$rating = glsr( Html::class )->buildPartial( 'star-rating', [
172			'rating' => $value,
173			]);
174			return $this->wrap( $key, $rating );
175			}
176
177			/**
178			* @param string $key
179			* @param string $value
180			* @return void\|string
181			*/
182			protected function buildOptionResponse( $key, $value )
183			{
184			if( $this->isHiddenOrEmpty( $key, $value ))return;
185			$title = sprintf( __( 'Response from %s', 'site-reviews' ), get_bloginfo( 'name' ));
186			$text = $this->normalizeText( $value );
187			$text = '<p><strong>'.$title.'</strong></p><p>'.$text.'</p>';
188			return $this->wrap( $key,
189			glsr( Builder::class )->div( $text, ['class' => 'glsr-review-response-inner'] ).
190			glsr( Builder::class )->div( ['class' => 'glsr-review-response-background'] )
191			);
192			}
193
194			/**
195			* @param string $key
196			* @param string $value
197			* @return void\|string
198			*/
199			protected function buildOptionTitle( $key, $value )
200			{
201			if( $this->isHidden( $key ))return;
202			if( empty( $value )) {
203			$value = __( 'No Title', 'site-reviews' );
204			}
205			return $this->wrap( $key, '<h3>'.$value.'</h3>' );
206			}
207
208			/**
209			* @return void
210			*/
211			protected function generateSchema()
212			{
213			if( !wp_validate_boolean( $this->args['schema'] ))return;
214			glsr( Schema::class )->store( glsr( Schema::class )->build( $this->args ));
215			}
216
217			/**
218			* @return string
219			*/
220			protected function getClass()
221			{
222			$style = apply_filters( 'site-reviews/style', 'glsr-style' );
223			$pagination = $this->args['pagination'] == 'ajax'
224			? 'glsr-ajax-pagination'
225			: '';
226			return trim( 'glsr-reviews '.$style.' '.$pagination.' '.$this->args['class'] );
227			}
228
229			/**
230			* @param string $text
231			* @return string
232			*/
233			protected function getExcerpt( $text )
234			{
235			$limit = $this->getOption( 'settings.reviews.excerpt.length', 55 );
236			if( str_word_count( $text, 0 ) > $limit ) {
237			$words = array_keys( str_word_count( $text, 2 ));
238			$excerpt = ltrim( substr( $text, 0, $words[$limit] ));
239			$hiddenText = substr( $text, strlen( $excerpt ));
240			$showMore = glsr( Builder::class )->span( $hiddenText, [
241			'class' => 'glsr-hidden glsr-hidden-text',
242			'data-show-less' => __( 'Show less', 'site-reviews' ),
243			'data-show-more' => __( 'Show more', 'site-reviews' ),
244			]);
245			$text = $excerpt.$showMore;
246			}
247			return nl2br( $text );
248			}
249
250			/**
251			* @param string $path
252			* @param mixed $fallback
253			* @return mixed
254			*/
255			protected function getOption( $path, $fallback = '' )
256			{
257			if( array_key_exists( $path, $this->options )) {
258			return $this->options[$path];
259			}
260			return $fallback;
261			}
262
263			/**
264			* @param string $key
265			* @param string $path
266			* @return bool
267			*/
268			protected function isHidden( $key, $path = '' )
269			{
270			$isOptionEnabled = !empty( $path )
271			? $this->isOptionEnabled( $path )
272			: true;
273			return in_array( $key, $this->args['hide'] ) \|\| !$isOptionEnabled;
274			}
275
276			/**
277			* @param string $key
278			* @param string $value
279			* @return bool
280			*/
281			protected function isHiddenOrEmpty( $key, $value )
282			{
283			return $this->isHidden( $key ) \|\| empty( $value );
284			}
285
286			/**
287			* @param string $path
288			* @return bool
289			*/
290			protected function isOptionEnabled( $path )
291			{
292			return $this->getOption( $path ) == 'yes';
293			}
294
295			/**
296			* @param string $text
297			* @return string
298			*/
299			protected function normalizeText( $text )
300			{
301			$text = wp_kses( $text, wp_kses_allowed_html() );
302			$text = convert_smilies( wptexturize( strip_shortcodes( $text )));
303			$text = str_replace( ']]>', ']]>', $text );
304			$text = preg_replace( '/(\R){2,}/', '$1', $text );
305			return $this->isOptionEnabled( 'settings.reviews.excerpt.enabled' )
306			? $this->getExcerpt( $text )
307			: $text;
308			}
309
310			/**
311			* @param string $key
312			* @param string $value
313			* @return string
314			*/
315			protected function wrap( $key, $value )
316			{
317			return glsr( Builder::class )->div( $value, [
318			'class' => 'glsr-review-'.$key,
319			]);
320			}
321			}
322

pryley / site-reviews

Push — master ( 425d57...ac8e88 )

SiteReviews::buildReview() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like