elementor / includes / widgets / star-rating.php

star-rating.php in Elementor Website Builder – more than just a page builder 3.17.0-dev3, at includes/widgets/star-rating.php

508 lines 12.4 KB

Raw Download Zip

1	<?php
2	namespace Elementor;
3
4	if ( ! defined( 'ABSPATH' ) ) {
5	exit; // Exit if accessed directly.
6	}
7
8	use Elementor\Core\Kits\Documents\Tabs\Global_Colors;
9	use Elementor\Core\Kits\Documents\Tabs\Global_Typography;
10
11	/**
12	* Elementor star rating widget.
13	*
14	* Elementor widget that displays star rating.
15	*
16	* @since 2.3.0
17	*/
18	class Widget_Star_Rating extends Widget_Base {
19
20	/**
21	* Get widget name.
22	*
23	* Retrieve star rating widget name.
24	*
25	* @since 2.3.0
26	* @access public
27	*
28	* @return string Widget name.
29	*/
30	public function get_name() {
31	return 'star-rating';
32	}
33
34	/**
35	* Get widget title.
36	*
37	* Retrieve star rating widget title.
38	*
39	* @since 2.3.0
40	* @access public
41	*
42	* @return string Widget title.
43	*/
44	public function get_title() {
45	return esc_html__( 'Star Rating', 'elementor' );
46	}
47
48	/**
49	* Get widget icon.
50	*
51	* Retrieve star rating widget icon.
52	*
53	* @since 2.3.0
54	* @access public
55	*
56	* @return string Widget icon.
57	*/
58	public function get_icon() {
59	return 'eicon-rating';
60	}
61
62	/**
63	* Get widget keywords.
64	*
65	* Retrieve the list of keywords the widget belongs to.
66	*
67	* @since 2.3.0
68	* @access public
69	*
70	* @return array Widget keywords.
71	*/
72	public function get_keywords() {
73	return [ 'star', 'rating', 'rate', 'review' ];
74	}
75
76	/**
77	* Hide widget from panel.
78	*
79	* Hide the star rating widget from the panel.
80	*
81	* @since 3.17.0
82	* @return bool
83	*/
84	public function show_in_panel(): bool {
85	return false;
86	}
87
88	/**
89	* Register star rating widget controls.
90	*
91	* Adds different input fields to allow the user to change and customize the widget settings.
92	*
93	* @since 3.1.0
94	* @access protected
95	*/
96	protected function register_controls() {
97	$this->start_controls_section(
98	'section_rating',
99	[
100	'label' => esc_html__( 'Rating', 'elementor' ),
101	]
102	);
103
104	if ( Plugin::$instance->widgets_manager->get_widget_types( 'rating' ) ) {
105	$this->add_deprecation_message(
106	'3.17.0',
107	esc_html__(
108	'You are currently editing a Star Rating widget in its old version. Drag a new Rating widget onto your page to use a newer version, providing better capabilities.',
109	'elementor'
110	),
111	'rating'
112	);
113	}
114
115	$this->add_control(
116	'rating_scale',
117	[
118	'label' => esc_html__( 'Rating Scale', 'elementor' ),
119	'type' => Controls_Manager::SELECT,
120	'options' => [
121	'5' => '0-5',
122	'10' => '0-10',
123	],
124	'default' => '5',
125	]
126	);
127
128	$this->add_control(
129	'rating',
130	[
131	'label' => esc_html__( 'Rating', 'elementor' ),
132	'type' => Controls_Manager::NUMBER,
133	'min' => 0,
134	'max' => 10,
135	'step' => 0.1,
136	'default' => 5,
137	'dynamic' => [
138	'active' => true,
139	],
140	]
141	);
142
143	$this->add_control(
144	'star_style',
145	[
146	'label' => esc_html__( 'Icon', 'elementor' ),
147	'type' => Controls_Manager::SELECT,
148	'options' => [
149	'star_fontawesome' => 'Font Awesome',
150	'star_unicode' => 'Unicode',
151	],
152	'default' => 'star_fontawesome',
153	'render_type' => 'template',
154	'prefix_class' => 'elementor--star-style-',
155	'separator' => 'before',
156	]
157	);
158
159	$this->add_control(
160	'unmarked_star_style',
161	[
162	'label' => esc_html__( 'Unmarked Style', 'elementor' ),
163	'type' => Controls_Manager::CHOOSE,
164	'options' => [
165	'solid' => [
166	'title' => esc_html__( 'Solid', 'elementor' ),
167	'icon' => 'eicon-star',
168	],
169	'outline' => [
170	'title' => esc_html__( 'Outline', 'elementor' ),
171	'icon' => 'eicon-star-o',
172	],
173	],
174	'default' => 'solid',
175	]
176	);
177
178	$this->add_control(
179	'title',
180	[
181	'label' => esc_html__( 'Title', 'elementor' ),
182	'type' => Controls_Manager::TEXT,
183	'separator' => 'before',
184	'dynamic' => [
185	'active' => true,
186	],
187	]
188	);
189
190	$this->add_responsive_control(
191	'align',
192	[
193	'label' => esc_html__( 'Alignment', 'elementor' ),
194	'type' => Controls_Manager::CHOOSE,
195	'options' => [
196	'left' => [
197	'title' => esc_html__( 'Left', 'elementor' ),
198	'icon' => 'eicon-text-align-left',
199	],
200	'center' => [
201	'title' => esc_html__( 'Center', 'elementor' ),
202	'icon' => 'eicon-text-align-center',
203	],
204	'right' => [
205	'title' => esc_html__( 'Right', 'elementor' ),
206	'icon' => 'eicon-text-align-right',
207	],
208	'justify' => [
209	'title' => esc_html__( 'Justified', 'elementor' ),
210	'icon' => 'eicon-text-align-justify',
211	],
212	],
213	'prefix_class' => 'elementor-star-rating%s--align-',
214	'selectors' => [
215	'{{WRAPPER}}' => 'text-align: {{VALUE}}',
216	],
217	]
218	);
219
220	$this->end_controls_section();
221
222	$this->start_controls_section(
223	'section_title_style',
224	[
225	'label' => esc_html__( 'Title', 'elementor' ),
226	'tab' => Controls_Manager::TAB_STYLE,
227	'condition' => [
228	'title!' => '',
229	],
230	]
231	);
232
233	$this->add_control(
234	'title_color',
235	[
236	'label' => esc_html__( 'Text Color', 'elementor' ),
237	'type' => Controls_Manager::COLOR,
238	'global' => [
239	'default' => Global_Colors::COLOR_TEXT,
240	],
241	'selectors' => [
242	'{{WRAPPER}} .elementor-star-rating__title' => 'color: {{VALUE}}',
243	],
244	]
245	);
246
247	$this->add_group_control(
248	Group_Control_Typography::get_type(),
249	[
250	'name' => 'title_typography',
251	'selector' => '{{WRAPPER}} .elementor-star-rating__title',
252	'global' => [
253	'default' => Global_Typography::TYPOGRAPHY_TEXT,
254	],
255	]
256	);
257
258	$this->add_group_control(
259	Group_Control_Text_Shadow::get_type(),
260	[
261	'name' => 'title_shadow',
262	'selector' => '{{WRAPPER}} .elementor-star-rating__title',
263	]
264	);
265
266	$this->add_responsive_control(
267	'title_gap',
268	[
269	'label' => esc_html__( 'Gap', 'elementor' ),
270	'type' => Controls_Manager::SLIDER,
271	'range' => [
272	'px' => [
273	'min' => 0,
274	'max' => 50,
275	],
276	],
277	'selectors' => [
278	'body:not(.rtl) {{WRAPPER}}:not(.elementor-star-rating--align-justify) .elementor-star-rating__title' => 'margin-right: {{SIZE}}{{UNIT}}',
279	'body.rtl {{WRAPPER}}:not(.elementor-star-rating--align-justify) .elementor-star-rating__title' => 'margin-left: {{SIZE}}{{UNIT}}',
280	],
281	]
282	);
283
284	$this->end_controls_section();
285
286	$this->start_controls_section(
287	'section_stars_style',
288	[
289	'label' => esc_html__( 'Stars', 'elementor' ),
290	'tab' => Controls_Manager::TAB_STYLE,
291	]
292	);
293
294	$this->add_responsive_control(
295	'icon_size',
296	[
297	'label' => esc_html__( 'Size', 'elementor' ),
298	'type' => Controls_Manager::SLIDER,
299	'range' => [
300	'px' => [
301	'min' => 0,
302	'max' => 100,
303	],
304	],
305	'selectors' => [
306	'{{WRAPPER}} .elementor-star-rating' => 'font-size: {{SIZE}}{{UNIT}}',
307	],
308	]
309	);
310
311	$this->add_responsive_control(
312	'icon_space',
313	[
314	'label' => esc_html__( 'Spacing', 'elementor' ),
315	'type' => Controls_Manager::SLIDER,
316	'range' => [
317	'px' => [
318	'min' => 0,
319	'max' => 50,
320	],
321	],
322	'selectors' => [
323	'body:not(.rtl) {{WRAPPER}} .elementor-star-rating i:not(:last-of-type)' => 'margin-right: {{SIZE}}{{UNIT}}',
324	'body.rtl {{WRAPPER}} .elementor-star-rating i:not(:last-of-type)' => 'margin-left: {{SIZE}}{{UNIT}}',
325	],
326	]
327	);
328
329	$this->add_control(
330	'stars_color',
331	[
332	'label' => esc_html__( 'Color', 'elementor' ),
333	'type' => Controls_Manager::COLOR,
334	'selectors' => [
335	'{{WRAPPER}} .elementor-star-rating i:before' => 'color: {{VALUE}}',
336	],
337	'separator' => 'before',
338	]
339	);
340
341	$this->add_control(
342	'stars_unmarked_color',
343	[
344	'label' => esc_html__( 'Unmarked Color', 'elementor' ),
345	'type' => Controls_Manager::COLOR,
346	'selectors' => [
347	'{{WRAPPER}} .elementor-star-rating i' => 'color: {{VALUE}}',
348	],
349	]
350	);
351
352	$this->end_controls_section();
353	}
354
355	/**
356	* @since 2.3.0
357	* @access protected
358	*/
359	protected function get_rating() {
360	$settings = $this->get_settings_for_display();
361	$rating_scale = (int) $settings['rating_scale'];
362	$rating = (float) $settings['rating'] > $rating_scale ? $rating_scale : $settings['rating'];
363
364	return [ $rating, $rating_scale ];
365	}
366
367	/**
368	* Print the actual stars and calculate their filling.
369	*
370	* Rating type is float to allow stars-count to be a fraction.
371	* Floored-rating type is int, to represent the rounded-down stars count.
372	* In the `for` loop, the index type is float to allow comparing with the rating value.
373	*
374	* @since 2.3.0
375	* @access protected
376	*/
377	protected function render_stars( $icon ) {
378	$rating_data = $this->get_rating();
379	$rating = (float) $rating_data[0];
380	$floored_rating = floor( $rating );
381	$stars_html = '';
382
383	for ( $stars = 1.0; $stars <= $rating_data[1]; $stars++ ) {
384	if ( $stars <= $floored_rating ) {
385	$stars_html .= '<i class="elementor-star-full">' . $icon . '</i>';
386	} elseif ( $floored_rating + 1 === $stars && $rating !== $floored_rating ) {
387	$stars_html .= '<i class="elementor-star-' . ( $rating - $floored_rating ) * 10 . '">' . $icon . '</i>';
388	} else {
389	$stars_html .= '<i class="elementor-star-empty">' . $icon . '</i>';
390	}
391	}
392
393	return $stars_html;
394	}
395
396	/**
397	* @since 2.3.0
398	* @access protected
399	*/
400	protected function render() {
401	$settings = $this->get_settings_for_display();
402	$rating_data = $this->get_rating();
403	$textual_rating = $rating_data[0] . '/' . $rating_data[1];
404	$icon = '';
405
406	if ( 'star_fontawesome' === $settings['star_style'] ) {
407	if ( 'outline' === $settings['unmarked_star_style'] ) {
408	$icon = '';
409	}
410	} elseif ( 'star_unicode' === $settings['star_style'] ) {
411	$icon = '★';
412
413	if ( 'outline' === $settings['unmarked_star_style'] ) {
414	$icon = '☆';
415	}
416	}
417
418	$this->add_render_attribute( 'icon_wrapper', [
419	'class' => 'elementor-star-rating',
420	'title' => $textual_rating,
421	'itemtype' => 'http://schema.org/Rating',
422	'itemscope' => '',
423	'itemprop' => 'reviewRating',
424	] );
425
426	$schema_rating = '<span itemprop="ratingValue" class="elementor-screen-only">' . $textual_rating . '</span>';
427	$stars_element = '<div ' . $this->get_render_attribute_string( 'icon_wrapper' ) . '>' . $this->render_stars( $icon ) . ' ' . $schema_rating . '</div>';
428	?>
429
430	<div class="elementor-star-rating__wrapper">
431	<?php if ( ! Utils::is_empty( $settings['title'] ) ) : ?>
432	<div class="elementor-star-rating__title"><?php echo esc_html( $settings['title'] ); ?></div>
433	<?php endif;
434	// PHPCS - $stars_element contains an HTML string that cannot be escaped. ?>
435	<?php echo $stars_element; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped ?>
436	</div>
437	<?php
438	}
439
440	/**
441	* @since 2.9.0
442	* @access protected
443	*/
444	protected function content_template() {
445	?>
446	<#
447	var getRating = function() {
448	var ratingScale = parseInt( settings.rating_scale, 10 ),
449	rating = settings.rating > ratingScale ? ratingScale : settings.rating;
450
451	return [ rating, ratingScale ];
452	},
453	ratingData = getRating(),
454	rating = ratingData[0],
455	textualRating = ratingData[0] + '/' + ratingData[1],
456	renderStars = function( icon ) {
457	var starsHtml = '',
458	flooredRating = Math.floor( rating );
459
460	for ( var stars = 1; stars <= ratingData[1]; stars++ ) {
461	if ( stars <= flooredRating ) {
462	starsHtml += '<i class="elementor-star-full">' + icon + '</i>';
463	} else if ( flooredRating + 1 === stars && rating !== flooredRating ) {
464	starsHtml += '<i class="elementor-star-' + ( rating - flooredRating ).toFixed( 1 ) * 10 + '">' + icon + '</i>';
465	} else {
466	starsHtml += '<i class="elementor-star-empty">' + icon + '</i>';
467	}
468	}
469
470	return starsHtml;
471	},
472	icon = '';
473
474	if ( 'star_fontawesome' === settings.star_style ) {
475	if ( 'outline' === settings.unmarked_star_style ) {
476	icon = '';
477	}
478	} else if ( 'star_unicode' === settings.star_style ) {
479	icon = '★';
480
481	if ( 'outline' === settings.unmarked_star_style ) {
482	icon = '☆';
483	}
484	}
485
486	view.addRenderAttribute( 'iconWrapper', 'class', 'elementor-star-rating' );
487	view.addRenderAttribute( 'iconWrapper', 'itemtype', 'http://schema.org/Rating' );
488	view.addRenderAttribute( 'iconWrapper', 'title', textualRating );
489	view.addRenderAttribute( 'iconWrapper', 'itemscope', '' );
490	view.addRenderAttribute( 'iconWrapper', 'itemprop', 'reviewRating' );
491
492	var stars = renderStars( icon );
493	#>
494
495	<div class="elementor-star-rating__wrapper">
496	<# if ( ! _.isEmpty( settings.title ) ) { #>
497	<div class="elementor-star-rating__title">{{ settings.title }}</div>
498	<# } #>
499	<div {{{ view.getRenderAttributeString( 'iconWrapper' ) }}} >
500	{{{ stars }}}
501	<span itemprop="ratingValue" class="elementor-screen-only">{{ textualRating }}</span>
502	</div>
503	</div>
504
505	<?php
506	}
507	}
508