SiteReviews::generateAvatar() - Code Metrics - Inspection of "update readme v3 changelog" - pryley/site-reviews - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( c5e678...d8e403 )

by Paul

created 2018-06-05 09:31 UTC

SiteReviews::generateAvatar() A

↳ Parent: SiteReviews

Complexity

Conditions	4
Paths	3

Size

Total Lines	12
Code Lines	8

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	20

Importance

Changes

Metric	Value
cc	4
eloc	8
nc	3
nop	1
dl	0
loc	12
ccs	0
cts	12
cp	0
crap	20
rs	9.2
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 int
	 */
	protected $current;

	/**
	 * @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 $index => $review ) {
			$this->current = $index;
			$review = apply_filters( 'site-reviews/review/build/before', $review );
			$review = $this->buildReview( $review );
			$review = apply_filters( 'site-reviews/review/build/after', $review );
			$reviews[] = $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', 40 );
		return $this->wrap( $key, glsr( Builder::class )->img([
			'src' => $this->generateAvatar( $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>' );
	}

	/**
	 * @param string $avatarUrl
	 * @return string
	 */
	protected function generateAvatar( $avatarUrl )
	{
		$review = $this->reviews->results[$this->current];
		if( !$this->isOptionEnabled( 'settings.reviews.avatars.regenerate' )
			|| $review->review_type != 'local' ) {
			return $avatarUrl;
		}
		$authorIdOrEmail = get_the_author_meta( 'ID', $review->user_id );
		if( empty( $authorIdOrEmail )) {
			$authorIdOrEmail = $review->email;
		}
		return get_avatar_url( $authorIdOrEmail );

	}

	/**
	 * @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 int
26			*/
27			protected $current;
28
29			/**
30			* @var array
31			*/
32			protected $options;
33
34			/**
35			* @var object
36			*/
37			protected $reviews;
38
39			/**
40			* @return void\|string
41			*/
42			public function build( array $args = [] )
43			{
44			$this->args = $args;
45			$this->options = glsr( Helper::class )->flattenArray( glsr( OptionManager::class )->all() );
46			$this->reviews = glsr( Database::class )->getReviews( $args );
47			$this->generateSchema();
48			$navigation = wp_validate_boolean( $this->args['pagination'] )
49			? glsr( Partial::class )->build( 'pagination', ['total' => $this->reviews->max_num_pages] )
50			: '';
51			return glsr( Template::class )->build( 'templates/reviews', [
52			'context' => [
53			'class' => $this->getClass(),
54			'id' => $this->args['id'],
55			'navigation' => $navigation,
56			],
57			'reviews' => $this->buildReviews(),
58			]);
59			}
60
61			/**
62			* @return array
63			*/
64			public function buildReviews()
65			{
66			$reviews = [];
67			foreach( $this->reviews->results as $index => $review ) {
68			$this->current = $index;
69			$review = apply_filters( 'site-reviews/review/build/before', $review );
70			$review = $this->buildReview( $review );
71			$review = apply_filters( 'site-reviews/review/build/after', $review );
72			$reviews[] = $review;
73			}
74			return $reviews;
75			}
76
77			/**
78			* @param object $review
79			* @return object
80			*/
81			protected function buildReview( $review )
82			{
83			$generatedReview = [];
84			foreach( $review as $key => $value ) {
85			$method = glsr( Helper::class )->buildMethodName( $key, 'buildOption' );
86			if( !method_exists( $this, $method ))continue;
87			$generatedReview[$key] = $this->$method( $key, $value );
88			}
89			return (object)$generatedReview;
90			}
91
92			/**
93			* @param string $key
94			* @param string $value
95			* @return void\|string
96			*/
97			protected function buildOptionAssignedTo( $key, $value )
98			{
99			if( $this->isHiddenOrEmpty( $key, 'settings.reviews.assigned_links.enabled' ))return;
100			$post = get_post( intval( $value ));
101			if( !( $post instanceof WP_Post ))return;
102			$permalink = glsr( Builder::class )->a( get_the_title( $post->ID ), [
103			'href' => get_the_permalink( $post->ID ),
104			]);
105			$assignedTo = sprintf( __( 'Review of %s', 'site-reviews' ), $permalink );
106			return $this->wrap( $key, '<span>'.$assignedTo.'</span>' );
107			}
108
109			/**
110			* @param string $key
111			* @param string $value
112			* @return void\|string
113			*/
114			protected function buildOptionAuthor( $key, $value )
115			{
116			if( $this->isHidden( $key ))return;
117			$prefix = !$this->isOptionEnabled( 'settings.reviews.avatars.enabled' )
118			? apply_filters( 'site-reviews/review/author/prefix', '—' )
119			: '';
120			return $this->wrap( $key, $prefix.'<span>'.$value.'</span>' );
121			}
122
123			/**
124			* @param string $key
125			* @param string $value
126			* @return void\|string
127			*/
128			protected function buildOptionAvatar( $key, $value )
129			{
130			if( $this->isHidden( $key, 'settings.reviews.avatars.enabled' ))return;
131			$size = $this->getOption( 'settings.reviews.avatars.size', 40 );
132			return $this->wrap( $key, glsr( Builder::class )->img([
133			'src' => $this->generateAvatar( $value ),
134			'height' => $size,
135			'width' => $size,
136			]));
137			}
138
139			/**
140			* @param string $key
141			* @param string $value
142			* @return void\|string
143			*/
144			protected function buildOptionContent( $key, $value )
145			{
146			$text = $this->normalizeText( $value );
147			if( $this->isHiddenOrEmpty( $key, $text ))return;
148			return $this->wrap( $key, '<p>'.$text.'</p>' );
149			}
150
151			/**
152			* @param string $key
153			* @param string $value
154			* @return void\|string
155			*/
156			protected function buildOptionDate( $key, $value )
157			{
158			if( $this->isHidden( $key ))return;
159			$dateFormat = $this->getOption( 'settings.reviews.date.format', 'default' );
160			if( $dateFormat == 'relative' ) {
161			$date = glsr( Date::class )->relative( $value );
162			}
163			else {
164			$format = $dateFormat == 'custom'
165			? $this->getOption( 'settings.reviews.date.custom', 'M j, Y' )
166			: (string)get_option( 'date_format' );
167			$date = date_i18n( $format, strtotime( $value ));
168			}
169			return $this->wrap( $key, '<span>'.$date.'</span>' );
170			}
171
172			/**
173			* @param string $key
174			* @param string $value
175			* @return void\|string
176			*/
177			protected function buildOptionRating( $key, $value )
178			{
179			if( $this->isHiddenOrEmpty( $key, $value ))return;
180			$rating = glsr( Html::class )->buildPartial( 'star-rating', [
181			'rating' => $value,
182			]);
183			return $this->wrap( $key, $rating );
184			}
185
186			/**
187			* @param string $key
188			* @param string $value
189			* @return void\|string
190			*/
191			protected function buildOptionResponse( $key, $value )
192			{
193			if( $this->isHiddenOrEmpty( $key, $value ))return;
194			$title = sprintf( __( 'Response from %s', 'site-reviews' ), get_bloginfo( 'name' ));
195			$text = $this->normalizeText( $value );
196			$text = '<p><strong>'.$title.'</strong></p><p>'.$text.'</p>';
197			return $this->wrap( $key,
198			glsr( Builder::class )->div( $text, ['class' => 'glsr-review-response-inner'] ).
199			glsr( Builder::class )->div( ['class' => 'glsr-review-response-background'] )
200			);
201			}
202
203			/**
204			* @param string $key
205			* @param string $value
206			* @return void\|string
207			*/
208			protected function buildOptionTitle( $key, $value )
209			{
210			if( $this->isHidden( $key ))return;
211			if( empty( $value )) {
212			$value = __( 'No Title', 'site-reviews' );
213			}
214			return $this->wrap( $key, '<h3>'.$value.'</h3>' );
215			}
216
217			/**
218			* @param string $avatarUrl
219			* @return string
220			*/
221			protected function generateAvatar( $avatarUrl )
222			{
223			$review = $this->reviews->results[$this->current];
224			if( !$this->isOptionEnabled( 'settings.reviews.avatars.regenerate' )
225			\|\| $review->review_type != 'local' ) {
226			return $avatarUrl;
227			}
228			$authorIdOrEmail = get_the_author_meta( 'ID', $review->user_id );
229			if( empty( $authorIdOrEmail )) {
230			$authorIdOrEmail = $review->email;
231			}
232			return get_avatar_url( $authorIdOrEmail );
			0 ignored issues – show Bug Best Practice introduced 2018-06-05 09:37 UTC by Report Bug Copy Issue Report The expression `return get_avatar_url($authorIdOrEmail)` could also return `false` which is incompatible with the documented return type `string`. Did you maybe forget to handle an error condition? If the returned type also contains false, it is an indicator that maybe an error condition leading to the specific return statement remains unhandled. Loading history...
233			}
234
235			/**
236			* @return void
237			*/
238			protected function generateSchema()
239			{
240			if( !wp_validate_boolean( $this->args['schema'] ))return;
241			glsr( Schema::class )->store(
242			glsr( Schema::class )->build( $this->args )
243			);
244			}
245
246			/**
247			* @return string
248			*/
249			protected function getClass()
250			{
251			$style = apply_filters( 'site-reviews/style', 'glsr-style' );
252			$pagination = $this->args['pagination'] == 'ajax'
253			? 'glsr-ajax-pagination'
254			: '';
255			return trim( 'glsr-reviews '.$style.' '.$pagination.' '.$this->args['class'] );
256			}
257
258			/**
259			* @param string $text
260			* @return string
261			*/
262			protected function getExcerpt( $text )
263			{
264			$limit = $this->getOption( 'settings.reviews.excerpt.length', 55 );
265			if( str_word_count( $text, 0 ) > $limit ) {
266			$words = array_keys( str_word_count( $text, 2 ));
267			$excerpt = ltrim( substr( $text, 0, $words[$limit] ));
268			$hiddenText = substr( $text, strlen( $excerpt ));
269			$showMore = glsr( Builder::class )->span( $hiddenText, [
270			'class' => 'glsr-hidden glsr-hidden-text',
271			'data-show-less' => __( 'Show less', 'site-reviews' ),
272			'data-show-more' => __( 'Show more', 'site-reviews' ),
273			]);
274			$text = $excerpt.$showMore;
275			}
276			return nl2br( $text );
277			}
278
279			/**
280			* @param string $path
281			* @param mixed $fallback
282			* @return mixed
283			*/
284			protected function getOption( $path, $fallback = '' )
285			{
286			if( array_key_exists( $path, $this->options )) {
287			return $this->options[$path];
288			}
289			return $fallback;
290			}
291
292			/**
293			* @param string $key
294			* @param string $path
295			* @return bool
296			*/
297			protected function isHidden( $key, $path = '' )
298			{
299			$isOptionEnabled = !empty( $path )
300			? $this->isOptionEnabled( $path )
301			: true;
302			return in_array( $key, $this->args['hide'] ) \|\| !$isOptionEnabled;
303			}
304
305			/**
306			* @param string $key
307			* @param string $value
308			* @return bool
309			*/
310			protected function isHiddenOrEmpty( $key, $value )
311			{
312			return $this->isHidden( $key ) \|\| empty( $value );
313			}
314
315			/**
316			* @param string $path
317			* @return bool
318			*/
319			protected function isOptionEnabled( $path )
320			{
321			return $this->getOption( $path ) == 'yes';
322			}
323
324			/**
325			* @param string $text
326			* @return string
327			*/
328			protected function normalizeText( $text )
329			{
330			$text = wp_kses( $text, wp_kses_allowed_html() );
331			$text = convert_smilies( wptexturize( strip_shortcodes( $text )));
332			$text = str_replace( ']]>', ']]>', $text );
333			$text = preg_replace( '/(\R){2,}/', '$1', $text );
334			return $this->isOptionEnabled( 'settings.reviews.excerpt.enabled' )
335			? $this->getExcerpt( $text )
336			: $text;
337			}
338
339			/**
340			* @param string $key
341			* @param string $value
342			* @return string
343			*/
344			protected function wrap( $key, $value )
345			{
346			return glsr( Builder::class )->div( $value, [
347			'class' => 'glsr-review-'.$key,
348			]);
349			}
350			}
351

pryley / site-reviews

Push — master ( c5e678...d8e403 )

SiteReviews::generateAvatar() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like