<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms\Fields\Traits;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Numbers and Number Slider Field trait, designed for use with `WPForms_Field`.

[5] Fix | Delete

*

[6] Fix | Delete

* @since 1.9.4

[7] Fix | Delete

*/

[8] Fix | Delete

trait NumberField {

[9] Fix | Delete

[10] Fix | Delete

/**

[11] Fix | Delete

* Enqueues required scripts for the form builder.

[12] Fix | Delete

*

[13] Fix | Delete

* @since 1.9.4

[14] Fix | Delete

*/

[15] Fix | Delete

private function number_hooks() {

[16] Fix | Delete

[17] Fix | Delete

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

[18] Fix | Delete

}

[19] Fix | Delete

[20] Fix | Delete

/**

[21] Fix | Delete

* Enqueue wpforms-number-field script.

[22] Fix | Delete

*

[23] Fix | Delete

* @since 1.9.4

[24] Fix | Delete

*

[25] Fix | Delete

* @param string $view Current view.

[26] Fix | Delete

*

[27] Fix | Delete

* @noinspection PhpUnusedParameterInspection, PhpUnnecessaryCurlyVarSyntaxInspection

[28] Fix | Delete

*/

[29] Fix | Delete

public function number_builder_enqueues( $view ) { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.Found

[30] Fix | Delete

[31] Fix | Delete

$min = wpforms_get_min_suffix();

[32] Fix | Delete

[33] Fix | Delete

wp_enqueue_script(

[34] Fix | Delete

'wpforms-number-field',

[35] Fix | Delete

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

[36] Fix | Delete

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

[37] Fix | Delete

WPFORMS_VERSION,

[38] Fix | Delete

false

[39] Fix | Delete

);

[40] Fix | Delete

}

[41] Fix | Delete

[42] Fix | Delete

/**

[43] Fix | Delete

* Helper function to create field option elements.

[44] Fix | Delete

*

[45] Fix | Delete

* Field option elements are pieces that help create a field option.

[46] Fix | Delete

* They are used to quickly build field options.

[47] Fix | Delete

*

[48] Fix | Delete

* This method is intended to be used within classes that implement or extend

[49] Fix | Delete

* the `WPForms_Field` functionality.

[50] Fix | Delete

*

[51] Fix | Delete

* @since 1.9.4

[52] Fix | Delete

*

[53] Fix | Delete

* @param string $option Field option to render.

[54] Fix | Delete

* @param array $field Field data and settings.

[55] Fix | Delete

* @param array $args Field preview arguments.

[56] Fix | Delete

* @param bool $echo_output Print or return the value. Print by default.

[57] Fix | Delete

*

[58] Fix | Delete

* @return mixed echo or return string

[59] Fix | Delete

*/

[60] Fix | Delete

abstract public function field_element( $option, $field, $args = [], $echo_output = true );

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Helper function to create a number field option element.

[64] Fix | Delete

*

[65] Fix | Delete

* @since 1.9.4

[66] Fix | Delete

*

[67] Fix | Delete

* @param array $field Field data and settings.

[68] Fix | Delete

* @param array $args Field preview arguments.

[69] Fix | Delete

* @param bool $echo_output Whether to print the generated output. Default true.

[70] Fix | Delete

*

[71] Fix | Delete

* @return string

[72] Fix | Delete

*/

[73] Fix | Delete

private function field_number_element( $field, $args = [], $echo_output = true ) { //phpcs:ignore Generic.Metrics.CyclomaticComplexity.MaxExceeded

[74] Fix | Delete

[75] Fix | Delete

if ( ! isset( $args['slug'], $args['label'] ) ) {

[76] Fix | Delete

return '';

[77] Fix | Delete

}

[78] Fix | Delete

[79] Fix | Delete

$slug = $args['slug'];

[80] Fix | Delete

$label = $args['label'];

[81] Fix | Delete

$value = $field[ $slug ] ?? $args['value'] ?? '';

[82] Fix | Delete

$attrs = [];

[83] Fix | Delete

[84] Fix | Delete

if ( isset( $args['min'] ) && is_numeric( $args['min'] ) ) {

[85] Fix | Delete

$attrs['min'] = (float) $args['min'];

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

if ( isset( $args['max'] ) && is_numeric( $args['max'] ) ) {

[89] Fix | Delete

$attrs['max'] = (float) $args['max'];

[90] Fix | Delete

}

[91] Fix | Delete

[92] Fix | Delete

if (

[93] Fix | Delete

isset( $args['step'] ) &&

[94] Fix | Delete

(

[95] Fix | Delete

$args['step'] === 'any' ||

[96] Fix | Delete

( is_numeric( $args['step'] ) && $args['step'] > 0 )

[97] Fix | Delete

)

[98] Fix | Delete

) {

[99] Fix | Delete

$attrs['step'] = (string) $args['step'];

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

$number_label_markup = $this->field_element(

[103] Fix | Delete

'label',

[104] Fix | Delete

$field,

[105] Fix | Delete

[

[106] Fix | Delete

'slug' => $slug,

[107] Fix | Delete

'value' => $label,

[108] Fix | Delete

'tooltip' => $args['tooltip'] ?? '',

[109] Fix | Delete

],

[110] Fix | Delete

false

[111] Fix | Delete

);

[112] Fix | Delete

[113] Fix | Delete

$number_input_markup = $this->field_element(

[114] Fix | Delete

'text',

[115] Fix | Delete

$field,

[116] Fix | Delete

[

[117] Fix | Delete

'type' => 'number',

[118] Fix | Delete

'slug' => $slug,

[119] Fix | Delete

'value' => is_numeric( $value ) ? (float) $value : '',

[120] Fix | Delete

'attrs' => $attrs,

[121] Fix | Delete

'class' => $args['class'] ?? '',

[122] Fix | Delete

],

[123] Fix | Delete

false

[124] Fix | Delete

);

[125] Fix | Delete

[126] Fix | Delete

$output = $this->field_element(

[127] Fix | Delete

'row',

[128] Fix | Delete

$field,

[129] Fix | Delete

[

[130] Fix | Delete

'slug' => $slug,

[131] Fix | Delete

'content' => $number_label_markup . $number_input_markup,

[132] Fix | Delete

],

[133] Fix | Delete

false

[134] Fix | Delete

);

[135] Fix | Delete

[136] Fix | Delete

if ( ! $output ) {

[137] Fix | Delete

return '';

[138] Fix | Delete

}

[139] Fix | Delete

[140] Fix | Delete

if ( $echo_output ) {

[141] Fix | Delete

// phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[142] Fix | Delete

echo $output;

[143] Fix | Delete

}

[144] Fix | Delete

[145] Fix | Delete

return $output;

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete

/**

[149] Fix | Delete

* Helper function to create `min_max` field option markup.

[150] Fix | Delete

*

[151] Fix | Delete

* @since 1.9.4

[152] Fix | Delete

*

[153] Fix | Delete

* @param array $field Field data and settings.

[154] Fix | Delete

* @param array $args Field preview arguments.

[155] Fix | Delete

* @param bool $echo_output Print or return the value. Print by default.

[156] Fix | Delete

*

[157] Fix | Delete

* @return string

[158] Fix | Delete

*/

[159] Fix | Delete

private function field_number_option_min_max( $field, $args, $echo_output = true ) {

[160] Fix | Delete

[161] Fix | Delete

$class = $args['class'] ?? 'number_min_max';

[162] Fix | Delete

$range_label_markup = $this->field_element(

[163] Fix | Delete

'label',

[164] Fix | Delete

$field,

[165] Fix | Delete

[

[166] Fix | Delete

'slug' => 'min',

[167] Fix | Delete

'value' => $args['label'] ?? esc_html__( 'Range', 'wpforms-lite' ),

[168] Fix | Delete

'tooltip' => $args['tooltip'] ?? esc_html__( 'Define the minimum and the maximum values for the field.', 'wpforms-lite' ),

[169] Fix | Delete

],

[170] Fix | Delete

false

[171] Fix | Delete

);

[172] Fix | Delete

[173] Fix | Delete

$min_value = $field['min'] ?? null;

[174] Fix | Delete

$input_min_args = [

[175] Fix | Delete

'type' => 'number',

[176] Fix | Delete

'slug' => 'min',

[177] Fix | Delete

'value' => is_numeric( $min_value ) ? (float) $min_value : '',

[178] Fix | Delete

'class' => $class . '-min',

[179] Fix | Delete

'attrs' => [

[180] Fix | Delete

'step' => 'any',

[181] Fix | Delete

],

[182] Fix | Delete

];

[183] Fix | Delete

[184] Fix | Delete

$range_input_min_markup = $this->field_element(

[185] Fix | Delete

'text',

[186] Fix | Delete

$field,

[187] Fix | Delete

$input_min_args,

[188] Fix | Delete

false

[189] Fix | Delete

);

[190] Fix | Delete

[191] Fix | Delete

$max_value = $field['max'] ?? null;

[192] Fix | Delete

$input_max_args = [

[193] Fix | Delete

'type' => 'number',

[194] Fix | Delete

'slug' => 'max',

[195] Fix | Delete

'value' => is_numeric( $max_value ) ? (float) $max_value : '',

[196] Fix | Delete

'class' => $class . '-max',

[197] Fix | Delete

'attrs' => [

[198] Fix | Delete

'step' => 'any',

[199] Fix | Delete

],

[200] Fix | Delete

];

[201] Fix | Delete

[202] Fix | Delete

$range_input_max_markup = $this->field_element(

[203] Fix | Delete

'text',

[204] Fix | Delete

$field,

[205] Fix | Delete

$input_max_args,

[206] Fix | Delete

false

[207] Fix | Delete

);

[208] Fix | Delete

[209] Fix | Delete

return $this->field_element(

[210] Fix | Delete

'row',

[211] Fix | Delete

$field,

[212] Fix | Delete

[

[213] Fix | Delete

'slug' => 'min_max',

[214] Fix | Delete

'content' => $range_label_markup . sprintf(

[215] Fix | Delete

'<div class="wpforms-input-row">

[216] Fix | Delete

<div class="minimum">%s<label for="wpforms-field-option-%d-min" class="sub-label">%s</label></div>

[217] Fix | Delete

<div class="maximum">%s<label for="wpforms-field-option-%d-max" class="sub-label">%s</label></div>

[218] Fix | Delete

</div>',

[219] Fix | Delete

$range_input_min_markup,

[220] Fix | Delete

(int) $field['id'],

[221] Fix | Delete

esc_html__( 'Minimum', 'wpforms-lite' ),

[222] Fix | Delete

$range_input_max_markup,

[223] Fix | Delete

(int) $field['id'],

[224] Fix | Delete

esc_html__( 'Maximum', 'wpforms-lite' )

[225] Fix | Delete

),

[226] Fix | Delete

],

[227] Fix | Delete

$echo_output

[228] Fix | Delete

);

[229] Fix | Delete

}

[230] Fix | Delete

[231] Fix | Delete

/**

[232] Fix | Delete

* Helper function to create `default_value` field option markup.

[233] Fix | Delete

*

[234] Fix | Delete

* @since 1.9.4

[235] Fix | Delete

*

[236] Fix | Delete

* @param array $field Field data and settings.

[237] Fix | Delete

* @param array $args Field preview arguments.

[238] Fix | Delete

* @param bool $echo_output Print or return the value. Print by default.

[239] Fix | Delete

*

[240] Fix | Delete

* @return string

[241] Fix | Delete

*/

[242] Fix | Delete

private function field_number_option_default_value( $field, $args, $echo_output = true ) {

[243] Fix | Delete

[244] Fix | Delete

$default_value_args = [

[245] Fix | Delete

'slug' => 'default_value',

[246] Fix | Delete

'label' => esc_html__( 'Default Value', 'wpforms-lite' ),

[247] Fix | Delete

'tooltip' => esc_html__( 'Enter a default value for this field.', 'wpforms-lite' ),

[248] Fix | Delete

'class' => $args['class'] ?? '',

[249] Fix | Delete

'value' => $args['value'] ?? '',

[250] Fix | Delete

'min' => $field['min'] ?? '',

[251] Fix | Delete

'max' => $field['max'] ?? '',

[252] Fix | Delete

'step' => $field['step'] ?? '',

[253] Fix | Delete

];

[254] Fix | Delete

[255] Fix | Delete

return $this->field_number_element(

[256] Fix | Delete

$field,

[257] Fix | Delete

$default_value_args,

[258] Fix | Delete

$echo_output

[259] Fix | Delete

);

[260] Fix | Delete

}

[261] Fix | Delete

[262] Fix | Delete

/**

[263] Fix | Delete

* Helper function to create `step` field option markup.

[264] Fix | Delete

*

[265] Fix | Delete

* @since 1.9.4

[266] Fix | Delete

*

[267] Fix | Delete

* @param array $field Field data and settings.

[268] Fix | Delete

* @param array $args Field preview arguments.

[269] Fix | Delete

* @param bool $echo_output Print or return the value. Print by default.

[270] Fix | Delete

*

[271] Fix | Delete

* @return string

[272] Fix | Delete

*/

[273] Fix | Delete

private function field_number_option_step( $field, $args, $echo_output = true ) {

[274] Fix | Delete

[275] Fix | Delete

$step_args = [

[276] Fix | Delete

'slug' => 'step',

[277] Fix | Delete

'label' => esc_html__( 'Increment', 'wpforms-lite' ),

[278] Fix | Delete

'tooltip' => $args['tooltip'] ?? esc_html__( 'Determines the increment between selectable values on the field.', 'wpforms-lite' ),

[279] Fix | Delete

'class' => $args['class'] ?? '',

[280] Fix | Delete

'min' => 0,

[281] Fix | Delete

'step' => 'any',

[282] Fix | Delete

'value' => 1,

[283] Fix | Delete

];

[284] Fix | Delete

[285] Fix | Delete

$min = is_numeric( $field['min'] ?? null ) ? (float) $field['min'] : null;

[286] Fix | Delete

$max = is_numeric( $field['max'] ?? null ) ? (float) $field['max'] : null;

[287] Fix | Delete

[288] Fix | Delete

if ( ! is_null( $min ) && ! is_null( $max ) ) {

[289] Fix | Delete

$step_args['max'] = $max - $min;

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

return $this->field_number_element(

[293] Fix | Delete

$field,

[294] Fix | Delete

$step_args,

[295] Fix | Delete

$echo_output

[296] Fix | Delete

);

[297] Fix | Delete

}

[298] Fix | Delete

}

[299] Fix | Delete

[300] Fix | Delete