<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms\Fields\Rating;

[2] Fix | Delete

[3] Fix | Delete

use WPForms\Forms\Fields\Traits\ProField as ProFieldTrait;

[4] Fix | Delete

use WPForms_Field;

[5] Fix | Delete

[6] Fix | Delete

/**

[7] Fix | Delete

* Rating field.

[8] Fix | Delete

*

[9] Fix | Delete

* @since 1.9.4

[10] Fix | Delete

*/

[11] Fix | Delete

class Field extends WPForms_Field {

[12] Fix | Delete

[13] Fix | Delete

use ProFieldTrait;

[14] Fix | Delete

[15] Fix | Delete

/**

[16] Fix | Delete

* Default icon color.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.9.4

[19] Fix | Delete

*/

[20] Fix | Delete

protected const DEFAULT_ICON_COLOR = [

[21] Fix | Delete

'classic' => '#e27730',

[22] Fix | Delete

'modern' => '#066aab',

[23] Fix | Delete

];

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Primary class constructor.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 1.9.4

[29] Fix | Delete

*/

[30] Fix | Delete

public function init() {

[31] Fix | Delete

[32] Fix | Delete

// Define field type information.

[33] Fix | Delete

$this->name = esc_html__( 'Rating', 'wpforms-lite' );

[34] Fix | Delete

$this->keywords = esc_html__( 'review, emoji, star', 'wpforms-lite' );

[35] Fix | Delete

$this->type = 'rating';

[36] Fix | Delete

$this->icon = 'fa-star';

[37] Fix | Delete

$this->order = 310;

[38] Fix | Delete

$this->group = 'fancy';

[39] Fix | Delete

[40] Fix | Delete

$this->default_settings = [

[41] Fix | Delete

'icon_color' => $this->get_default_icon_color(),

[42] Fix | Delete

];

[43] Fix | Delete

[44] Fix | Delete

$this->init_pro_field();

[45] Fix | Delete

$this->hooks();

[46] Fix | Delete

}

[47] Fix | Delete

[48] Fix | Delete

/**

[49] Fix | Delete

* Hooks.

[50] Fix | Delete

*

[51] Fix | Delete

* @since 1.9.4

[52] Fix | Delete

*/

[53] Fix | Delete

protected function hooks(): void {

[54] Fix | Delete

[55] Fix | Delete

add_action( 'wpforms_builder_enqueues', [ $this, 'builder_enqueues' ] );

[56] Fix | Delete

}

[57] Fix | Delete

[58] Fix | Delete

/**

[59] Fix | Delete

* Builder enqueues.

[60] Fix | Delete

*

[61] Fix | Delete

* @since 1.9.8

[62] Fix | Delete

*/

[63] Fix | Delete

public function builder_enqueues(): void {

[64] Fix | Delete

[65] Fix | Delete

$min = wpforms_get_min_suffix();

[66] Fix | Delete

[67] Fix | Delete

wp_enqueue_script(

[68] Fix | Delete

'wpforms-rating-field',

[69] Fix | Delete

WPFORMS_PLUGIN_URL . "assets/js/admin/builder/fields/rating{$min}.js",

[70] Fix | Delete

[ 'wpforms-builder', 'wpforms-utils' ],

[71] Fix | Delete

WPFORMS_VERSION,

[72] Fix | Delete

false

[73] Fix | Delete

);

[74] Fix | Delete

}

[75] Fix | Delete

[76] Fix | Delete

/**

[77] Fix | Delete

* Field options panel inside the builder.

[78] Fix | Delete

*

[79] Fix | Delete

* @since 1.9.4

[80] Fix | Delete

*

[81] Fix | Delete

* @param array $field Field settings.

[82] Fix | Delete

*

[83] Fix | Delete

* @noinspection PackedHashtableOptimizationInspection

[84] Fix | Delete

*/

[85] Fix | Delete

public function field_options( $field ) {

[86] Fix | Delete

[87] Fix | Delete

/**

[88] Fix | Delete

* Basic field options.

[89] Fix | Delete

*/

[90] Fix | Delete

[91] Fix | Delete

// Options open markup.

[92] Fix | Delete

$this->field_option(

[93] Fix | Delete

'basic-options',

[94] Fix | Delete

$field,

[95] Fix | Delete

[

[96] Fix | Delete

'markup' => 'open',

[97] Fix | Delete

'after_title' => $this->get_field_options_notice(),

[98] Fix | Delete

]

[99] Fix | Delete

);

[100] Fix | Delete

[101] Fix | Delete

// Label.

[102] Fix | Delete

$this->field_option( 'label', $field );

[103] Fix | Delete

[104] Fix | Delete

// Description.

[105] Fix | Delete

$this->field_option( 'description', $field );

[106] Fix | Delete

[107] Fix | Delete

// Scale.

[108] Fix | Delete

$lbl = $this->field_element(

[109] Fix | Delete

'label',

[110] Fix | Delete

$field,

[111] Fix | Delete

[

[112] Fix | Delete

'slug' => 'scale',

[113] Fix | Delete

'value' => esc_html__( 'Scale', 'wpforms-lite' ),

[114] Fix | Delete

'tooltip' => esc_html__( 'Select rating scale', 'wpforms-lite' ),

[115] Fix | Delete

],

[116] Fix | Delete

false

[117] Fix | Delete

);

[118] Fix | Delete

[119] Fix | Delete

$fld = $this->field_element(

[120] Fix | Delete

'select',

[121] Fix | Delete

$field,

[122] Fix | Delete

[

[123] Fix | Delete

'slug' => 'scale',

[124] Fix | Delete

'value' => ! empty( $field['scale'] ) ? esc_attr( $field['scale'] ) : '5',

[125] Fix | Delete

'options' => [

[126] Fix | Delete

'2' => '2',

[127] Fix | Delete

'3' => '3',

[128] Fix | Delete

'4' => '4',

[129] Fix | Delete

'5' => '5',

[130] Fix | Delete

'6' => '6',

[131] Fix | Delete

'7' => '7',

[132] Fix | Delete

'8' => '8',

[133] Fix | Delete

'9' => '9',

[134] Fix | Delete

'10' => '10',

[135] Fix | Delete

],

[136] Fix | Delete

],

[137] Fix | Delete

false

[138] Fix | Delete

);

[139] Fix | Delete

[140] Fix | Delete

$this->field_element(

[141] Fix | Delete

'row',

[142] Fix | Delete

$field,

[143] Fix | Delete

[

[144] Fix | Delete

'slug' => 'scale',

[145] Fix | Delete

'content' => $lbl . $fld,

[146] Fix | Delete

]

[147] Fix | Delete

);

[148] Fix | Delete

[149] Fix | Delete

// Required toggle.

[150] Fix | Delete

$this->field_option( 'required', $field );

[151] Fix | Delete

[152] Fix | Delete

// Options close markup.

[153] Fix | Delete

$this->field_option(

[154] Fix | Delete

'basic-options',

[155] Fix | Delete

$field,

[156] Fix | Delete

[

[157] Fix | Delete

'markup' => 'close',

[158] Fix | Delete

]

[159] Fix | Delete

);

[160] Fix | Delete

[161] Fix | Delete

/*

[162] Fix | Delete

* Advanced field options.

[163] Fix | Delete

*/

[164] Fix | Delete

[165] Fix | Delete

// Options open markup.

[166] Fix | Delete

$this->field_option(

[167] Fix | Delete

'advanced-options',

[168] Fix | Delete

$field,

[169] Fix | Delete

[

[170] Fix | Delete

'markup' => 'open',

[171] Fix | Delete

]

[172] Fix | Delete

);

[173] Fix | Delete

[174] Fix | Delete

// Icon.

[175] Fix | Delete

$lbl = $this->field_element(

[176] Fix | Delete

'label',

[177] Fix | Delete

$field,

[178] Fix | Delete

[

[179] Fix | Delete

'slug' => 'icon',

[180] Fix | Delete

'value' => esc_html__( 'Icon', 'wpforms-lite' ),

[181] Fix | Delete

'tooltip' => esc_html__( 'Select icon to display', 'wpforms-lite' ),

[182] Fix | Delete

],

[183] Fix | Delete

false

[184] Fix | Delete

);

[185] Fix | Delete

[186] Fix | Delete

$fld = $this->field_element(

[187] Fix | Delete

'select',

[188] Fix | Delete

$field,

[189] Fix | Delete

[

[190] Fix | Delete

'slug' => 'icon',

[191] Fix | Delete

'value' => ! empty( $field['icon'] ) ? esc_attr( $field['icon'] ) : 'star',

[192] Fix | Delete

'options' => [

[193] Fix | Delete

'star' => esc_html__( 'Star', 'wpforms-lite' ),

[194] Fix | Delete

'heart' => esc_html__( 'Heart', 'wpforms-lite' ),

[195] Fix | Delete

'thumb' => esc_html__( 'Thumb', 'wpforms-lite' ),

[196] Fix | Delete

'smiley' => esc_html__( 'Smiley Face', 'wpforms-lite' ),

[197] Fix | Delete

],

[198] Fix | Delete

],

[199] Fix | Delete

false

[200] Fix | Delete

);

[201] Fix | Delete

[202] Fix | Delete

$this->field_element(

[203] Fix | Delete

'row',

[204] Fix | Delete

$field,

[205] Fix | Delete

[

[206] Fix | Delete

'slug' => 'icon',

[207] Fix | Delete

'content' => $lbl . $fld,

[208] Fix | Delete

]

[209] Fix | Delete

);

[210] Fix | Delete

[211] Fix | Delete

// Icon size.

[212] Fix | Delete

$lbl = $this->field_element(

[213] Fix | Delete

'label',

[214] Fix | Delete

$field,

[215] Fix | Delete

[

[216] Fix | Delete

'slug' => 'icon_size',

[217] Fix | Delete

'value' => esc_html__( 'Icon Size', 'wpforms-lite' ),

[218] Fix | Delete

'tooltip' => esc_html__( 'Select the size of the rating icon', 'wpforms-lite' ),

[219] Fix | Delete

],

[220] Fix | Delete

false

[221] Fix | Delete

);

[222] Fix | Delete

$fld = $this->field_element(

[223] Fix | Delete

'select',

[224] Fix | Delete

$field,

[225] Fix | Delete

[

[226] Fix | Delete

'slug' => 'icon_size',

[227] Fix | Delete

'value' => ! empty( $field['icon_size'] ) ? esc_attr( $field['icon_size'] ) : 'medium',

[228] Fix | Delete

'options' => [

[229] Fix | Delete

'small' => esc_html__( 'Small', 'wpforms-lite' ),

[230] Fix | Delete

'medium' => esc_html__( 'Medium', 'wpforms-lite' ),

[231] Fix | Delete

'large' => esc_html__( 'Large', 'wpforms-lite' ),

[232] Fix | Delete

],

[233] Fix | Delete

],

[234] Fix | Delete

false

[235] Fix | Delete

);

[236] Fix | Delete

[237] Fix | Delete

$this->field_element(

[238] Fix | Delete

'row',

[239] Fix | Delete

$field,

[240] Fix | Delete

[

[241] Fix | Delete

'slug' => 'icon_size',

[242] Fix | Delete

'content' => $lbl . $fld,

[243] Fix | Delete

]

[244] Fix | Delete

);

[245] Fix | Delete

[246] Fix | Delete

$this->score_labels( $field );

[247] Fix | Delete

[248] Fix | Delete

// Icon color picker.

[249] Fix | Delete

$lbl = $this->field_element(

[250] Fix | Delete

'label',

[251] Fix | Delete

$field,

[252] Fix | Delete

[

[253] Fix | Delete

'slug' => 'icon_color',

[254] Fix | Delete

'value' => esc_html__( 'Icon Color', 'wpforms-lite' ),

[255] Fix | Delete

'tooltip' => esc_html__( 'Select the color for the rating icon', 'wpforms-lite' ),

[256] Fix | Delete

],

[257] Fix | Delete

false

[258] Fix | Delete

);

[259] Fix | Delete

[260] Fix | Delete

$icon_color = isset( $field['icon_color'] ) ? wpforms_sanitize_hex_color( $field['icon_color'] ) : '';

[261] Fix | Delete

$icon_color = empty( $icon_color ) ? $this->get_default_icon_color() : $icon_color;

[262] Fix | Delete

[263] Fix | Delete

$fld = $this->field_element(

[264] Fix | Delete

'color',

[265] Fix | Delete

$field,

[266] Fix | Delete

[

[267] Fix | Delete

'slug' => 'icon_color',

[268] Fix | Delete

'value' => $icon_color,

[269] Fix | Delete

'data' => [

[270] Fix | Delete

'fallback-color' => $icon_color,

[271] Fix | Delete

],

[272] Fix | Delete

],

[273] Fix | Delete

false

[274] Fix | Delete

);

[275] Fix | Delete

[276] Fix | Delete

$this->field_element(

[277] Fix | Delete

'row',

[278] Fix | Delete

$field,

[279] Fix | Delete

[

[280] Fix | Delete

'slug' => 'icon_color',

[281] Fix | Delete

'content' => $lbl . $fld,

[282] Fix | Delete

'class' => 'color-picker-row',

[283] Fix | Delete

]

[284] Fix | Delete

);

[285] Fix | Delete

[286] Fix | Delete

// Custom CSS classes.

[287] Fix | Delete

$this->field_option( 'css', $field );

[288] Fix | Delete

[289] Fix | Delete

// Hide label.

[290] Fix | Delete

$this->field_option( 'label_hide', $field );

[291] Fix | Delete

[292] Fix | Delete

// Options close markup.

[293] Fix | Delete

$this->field_option(

[294] Fix | Delete

'advanced-options',

[295] Fix | Delete

$field,

[296] Fix | Delete

[

[297] Fix | Delete

'markup' => 'close',

[298] Fix | Delete

]

[299] Fix | Delete

);

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Score labels.

[304] Fix | Delete

*

[305] Fix | Delete

* @since 1.9.8

[306] Fix | Delete

*

[307] Fix | Delete

* @param array $field Field settings.

[308] Fix | Delete

*/

[309] Fix | Delete

private function score_labels( array $field ): void {

[310] Fix | Delete

[311] Fix | Delete

// Lowest score label.

[312] Fix | Delete

$lowest_label = $this->field_element(

[313] Fix | Delete

'label',

[314] Fix | Delete

$field,

[315] Fix | Delete

[

[316] Fix | Delete

'slug' => 'lowest_label',

[317] Fix | Delete

'value' => esc_html__( 'Lowest Score Label', 'wpforms-lite' ),

[318] Fix | Delete

'tooltip' => esc_html__( 'This label indicates the lowest score on the scale.', 'wpforms-lite' ),

[319] Fix | Delete

],

[320] Fix | Delete

false

[321] Fix | Delete

);

[322] Fix | Delete

[323] Fix | Delete

$lowest_field = $this->field_element(

[324] Fix | Delete

'text',

[325] Fix | Delete

$field,

[326] Fix | Delete

[

[327] Fix | Delete

'slug' => 'lowest_label',

[328] Fix | Delete

'value' => $field['lowest_label'] ?? '',

[329] Fix | Delete

],

[330] Fix | Delete

false

[331] Fix | Delete

);

[332] Fix | Delete

[333] Fix | Delete

$this->field_element(

[334] Fix | Delete

'row',

[335] Fix | Delete

$field,

[336] Fix | Delete

[

[337] Fix | Delete

'slug' => 'lowest_label',

[338] Fix | Delete

'content' => $lowest_label . $lowest_field,

[339] Fix | Delete

]

[340] Fix | Delete

);

[341] Fix | Delete

[342] Fix | Delete

// Highest score label.

[343] Fix | Delete

$highest_label = $this->field_element(

[344] Fix | Delete

'label',

[345] Fix | Delete

$field,

[346] Fix | Delete

[

[347] Fix | Delete

'slug' => 'highest_label',

[348] Fix | Delete

'value' => esc_html__( 'Highest Score Label', 'wpforms-lite' ),

[349] Fix | Delete

'tooltip' => esc_html__( 'This label indicates the highest score on the scale.', 'wpforms-lite' ),

[350] Fix | Delete

],

[351] Fix | Delete

false

[352] Fix | Delete

);

[353] Fix | Delete

[354] Fix | Delete

$highest_field = $this->field_element(

[355] Fix | Delete

'text',

[356] Fix | Delete

$field,

[357] Fix | Delete

[

[358] Fix | Delete

'slug' => 'highest_label',

[359] Fix | Delete

'value' => $field['highest_label'] ?? '',

[360] Fix | Delete

],

[361] Fix | Delete

false

[362] Fix | Delete

);

[363] Fix | Delete

[364] Fix | Delete

$this->field_element(

[365] Fix | Delete

'row',

[366] Fix | Delete

$field,

[367] Fix | Delete

[

[368] Fix | Delete

'slug' => 'highest_label',

[369] Fix | Delete

'content' => $highest_label . $highest_field,

[370] Fix | Delete

]

[371] Fix | Delete

);

[372] Fix | Delete

[373] Fix | Delete

// Label position.

[374] Fix | Delete

$label_position = $this->field_element(

[375] Fix | Delete

'label',

[376] Fix | Delete

$field,

[377] Fix | Delete

[

[378] Fix | Delete

'slug' => 'label_position',

[379] Fix | Delete

'value' => esc_html__( 'Label Position', 'wpforms-lite' ),

[380] Fix | Delete

'tooltip' => esc_html__( 'Select the position of the label', 'wpforms-lite' ),

[381] Fix | Delete

],

[382] Fix | Delete

false

[383] Fix | Delete

);

[384] Fix | Delete

[385] Fix | Delete

$select_position = $this->field_element(

[386] Fix | Delete

'select',

[387] Fix | Delete

$field,

[388] Fix | Delete

[

[389] Fix | Delete

'slug' => 'label_position',

[390] Fix | Delete

'value' => ! empty( $field['label_position'] ) ? esc_attr( $field['label_position'] ) : 'below',

[391] Fix | Delete

'options' => [

[392] Fix | Delete

'above' => esc_html__( 'Above', 'wpforms-lite' ),

[393] Fix | Delete

'below' => esc_html__( 'Below', 'wpforms-lite' ),

[394] Fix | Delete

],

[395] Fix | Delete

],

[396] Fix | Delete

false

[397] Fix | Delete

);

[398] Fix | Delete

[399] Fix | Delete

$this->field_element(

[400] Fix | Delete

'row',

[401] Fix | Delete

$field,

[402] Fix | Delete

[

[403] Fix | Delete

'slug' => 'label_position',

[404] Fix | Delete

'content' => $label_position . $select_position,

[405] Fix | Delete

]

[406] Fix | Delete

);

[407] Fix | Delete

}

[408] Fix | Delete

[409] Fix | Delete

/**

[410] Fix | Delete

* Field preview inside the builder.

[411] Fix | Delete

*

[412] Fix | Delete

* @since 1.9.4

[413] Fix | Delete

*

[414] Fix | Delete

* @param array $field Field settings.

[415] Fix | Delete

*/

[416] Fix | Delete

public function field_preview( $field ): void {

[417] Fix | Delete

[418] Fix | Delete

// Label.

[419] Fix | Delete

$this->field_preview_option(

[420] Fix | Delete

'label',

[421] Fix | Delete

$field,

[422] Fix | Delete

[

[423] Fix | Delete

'label_badge' => $this->get_field_preview_badge(),

[424] Fix | Delete

]

[425] Fix | Delete

);

[426] Fix | Delete

[427] Fix | Delete

echo '<div class="wpforms-rating-field">';

[428] Fix | Delete

[429] Fix | Delete

$this->get_field_preview_icons( $field );

[430] Fix | Delete

[431] Fix | Delete

$this->get_field_preview_labels( $field );

[432] Fix | Delete

[433] Fix | Delete

echo '</div>';

[434] Fix | Delete

[435] Fix | Delete

// Description.

[436] Fix | Delete

$this->field_preview_option( 'description', $field );

[437] Fix | Delete

}

[438] Fix | Delete

[439] Fix | Delete

/**

[440] Fix | Delete

* Get field preview icons.

[441] Fix | Delete

*

[442] Fix | Delete

* @since 1.9.8

[443] Fix | Delete

*

[444] Fix | Delete

* @param array $field Field settings.

[445] Fix | Delete

*/

[446] Fix | Delete

private function get_field_preview_icons( array $field ): void {

[447] Fix | Delete

[448] Fix | Delete

// Define data.

[449] Fix | Delete

$scale = ! empty( $field['scale'] ) ? esc_attr( $field['scale'] ) : 5;

[450] Fix | Delete

$icon = ! empty( $field['icon'] ) ? esc_attr( $field['icon'] ) : 'star';

[451] Fix | Delete

$icon_size = ! empty( $field['icon_size'] ) ? esc_attr( $field['icon_size'] ) : 'medium';

[452] Fix | Delete

$icon_color = ! empty( $field['icon_color'] ) ? esc_attr( $field['icon_color'] ) : $this->get_default_icon_color();

[453] Fix | Delete

$icon_class = $this->get_preview_icon_class( $icon );

[454] Fix | Delete

[455] Fix | Delete

// Set icon size.

[456] Fix | Delete

$icon_size_css = $this->get_icon_size_css( $icon_size );

[457] Fix | Delete

[458] Fix | Delete

echo '<div class="wpforms-rating-field-icons">';

[459] Fix | Delete

[460] Fix | Delete

// Primary input.

[461] Fix | Delete

for ( $i = 1; $i <= 10; $i++ ) {

[462] Fix | Delete

printf(

[463] Fix | Delete

'<i class="fa %s %s rating-icon" aria-hidden="true" style="color:%s; display:%s; font-size:%dpx;"></i>',

[464] Fix | Delete

esc_attr( $icon_class ),

[465] Fix | Delete

esc_attr( $icon_size ),

[466] Fix | Delete

esc_attr( $icon_color ),

[467] Fix | Delete

$i <= $scale ? 'inline-block' : 'none',

[468] Fix | Delete

esc_attr( $icon_size_css )

[469] Fix | Delete

);

[470] Fix | Delete

}

[471] Fix | Delete

[472] Fix | Delete

echo '</div>';

[473] Fix | Delete

}

[474] Fix | Delete

[475] Fix | Delete

/**

[476] Fix | Delete

* Get preview icon class based on the selected icon.

[477] Fix | Delete

*

[478] Fix | Delete

* @since 1.9.8

[479] Fix | Delete

*

[480] Fix | Delete

* @param string $icon Selected icon.

[481] Fix | Delete

*

[482] Fix | Delete

* @return string Icon class.

[483] Fix | Delete

*/

[484] Fix | Delete

private function get_preview_icon_class( string $icon ): string {

[485] Fix | Delete

[486] Fix | Delete

$icon_class = '';

[487] Fix | Delete

[488] Fix | Delete

// Set icon class.

[489] Fix | Delete

switch ( $icon ) {

[490] Fix | Delete

case 'star':

[491] Fix | Delete

$icon_class = 'fa-star';

[492] Fix | Delete

break;

[493] Fix | Delete

[494] Fix | Delete

case 'heart':

[495] Fix | Delete

$icon_class = 'fa-heart';

[496] Fix | Delete

break;

[497] Fix | Delete

[498] Fix | Delete

case 'thumb':

[499] Fix | Delete