<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms\Fields\Pagebreak;

[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

* Pagebreak 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 indicator color.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.9.4

[19] Fix | Delete

*/

[20] Fix | Delete

private const DEFAULT_INDICATOR_COLOR = [

[21] Fix | Delete

'classic' => '#72b239',

[22] Fix | Delete

'modern' => '#066aab',

[23] Fix | Delete

];

[24] Fix | Delete

[25] Fix | Delete

/**

[26] Fix | Delete

* Pages information.

[27] Fix | Delete

*

[28] Fix | Delete

* @since 1.9.4

[29] Fix | Delete

*

[30] Fix | Delete

* @var array|bool

[31] Fix | Delete

*/

[32] Fix | Delete

protected $pagebreak;

[33] Fix | Delete

[34] Fix | Delete

/**

[35] Fix | Delete

* Primary class constructor.

[36] Fix | Delete

*

[37] Fix | Delete

* @since 1.9.4

[38] Fix | Delete

*/

[39] Fix | Delete

public function init() {

[40] Fix | Delete

[41] Fix | Delete

// Define field type information.

[42] Fix | Delete

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

[43] Fix | Delete

$this->keywords = esc_html__( 'progress bar, multi step, multi part', 'wpforms-lite' );

[44] Fix | Delete

$this->type = 'pagebreak';

[45] Fix | Delete

$this->icon = 'fa-files-o';

[46] Fix | Delete

$this->order = 160;

[47] Fix | Delete

$this->group = 'fancy';

[48] Fix | Delete

$this->allow_read_only = false;

[49] Fix | Delete

[50] Fix | Delete

$this->init_pro_field();

[51] Fix | Delete

$this->hooks();

[52] Fix | Delete

}

[53] Fix | Delete

[54] Fix | Delete

/**

[55] Fix | Delete

* Hooks.

[56] Fix | Delete

*

[57] Fix | Delete

* @since 1.9.4

[58] Fix | Delete

*/

[59] Fix | Delete

protected function hooks() {

[60] Fix | Delete

[61] Fix | Delete

add_filter( 'wpforms_field_preview_class', [ $this, 'preview_field_class' ], 10, 2 );

[62] Fix | Delete

add_filter( 'wpforms_field_preview_display_duplicate_button', [ $this, 'field_display_duplicate_button' ], 10, 2 );

[63] Fix | Delete

add_filter( 'wpforms_field_new_display_duplicate_button', [ $this, 'field_display_duplicate_button' ], 10, 2 );

[64] Fix | Delete

}

[65] Fix | Delete

[66] Fix | Delete

/**

[67] Fix | Delete

* Field options panel inside the builder.

[68] Fix | Delete

*

[69] Fix | Delete

* @since 1.9.4

[70] Fix | Delete

*

[71] Fix | Delete

* @param array $field Field data.

[72] Fix | Delete

*/

[73] Fix | Delete

public function field_options( $field ) {

[74] Fix | Delete

[75] Fix | Delete

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

[76] Fix | Delete

$position_class = ! empty( $field['position'] ) ? 'wpforms-pagebreak-' . $position : '';

[77] Fix | Delete

[78] Fix | Delete

$this->field_options_basic( $field, $position, $position_class );

[79] Fix | Delete

$this->field_options_advanced( $field, $position, $position_class );

[80] Fix | Delete

}

[81] Fix | Delete

[82] Fix | Delete

/**

[83] Fix | Delete

* Advanced field options panel inside the builder.

[84] Fix | Delete

*

[85] Fix | Delete

* @since 1.9.4

[86] Fix | Delete

*

[87] Fix | Delete

* @param array $field Field data.

[88] Fix | Delete

* @param string $position Position.

[89] Fix | Delete

* @param string $position_class Position CSS class.

[90] Fix | Delete

*/

[91] Fix | Delete

private function field_options_basic( array $field, string $position, string $position_class ): void {

[92] Fix | Delete

[93] Fix | Delete

// Hidden field indicating the position.

[94] Fix | Delete

$this->field_element(

[95] Fix | Delete

'text',

[96] Fix | Delete

$field,

[97] Fix | Delete

[

[98] Fix | Delete

'type' => 'hidden',

[99] Fix | Delete

'slug' => 'position',

[100] Fix | Delete

'value' => $position,

[101] Fix | Delete

'class' => 'position',

[102] Fix | Delete

]

[103] Fix | Delete

);

[104] Fix | Delete

[105] Fix | Delete

/*

[106] Fix | Delete

* Basic field options.

[107] Fix | Delete

*/

[108] Fix | Delete

[109] Fix | Delete

// Options open markup.

[110] Fix | Delete

$this->field_option(

[111] Fix | Delete

'basic-options',

[112] Fix | Delete

$field,

[113] Fix | Delete

[

[114] Fix | Delete

'markup' => 'open',

[115] Fix | Delete

'class' => $position_class,

[116] Fix | Delete

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

[117] Fix | Delete

]

[118] Fix | Delete

);

[119] Fix | Delete

[120] Fix | Delete

$this->field_options_basic_top( $field, $position );

[121] Fix | Delete

[122] Fix | Delete

// Page Title, don't display for bottom page breaks.

[123] Fix | Delete

if ( $position !== 'bottom' ) {

[124] Fix | Delete

$lbl = $this->field_element(

[125] Fix | Delete

'label',

[126] Fix | Delete

$field,

[127] Fix | Delete

[

[128] Fix | Delete

'slug' => 'title',

[129] Fix | Delete

'value' => esc_html__( 'Page Title', 'wpforms-lite' ),

[130] Fix | Delete

'tooltip' => esc_html__( 'Enter text for the page title.', 'wpforms-lite' ),

[131] Fix | Delete

],

[132] Fix | Delete

false

[133] Fix | Delete

);

[134] Fix | Delete

[135] Fix | Delete

$fld = $this->field_element(

[136] Fix | Delete

'text',

[137] Fix | Delete

$field,

[138] Fix | Delete

[

[139] Fix | Delete

'slug' => 'title',

[140] Fix | Delete

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

[141] Fix | Delete

],

[142] Fix | Delete

false

[143] Fix | Delete

);

[144] Fix | Delete

[145] Fix | Delete

$indicator = ! empty( $field['indicator'] ) ? esc_attr( $field['indicator'] ) : 'progress';

[146] Fix | Delete

[147] Fix | Delete

$this->field_element(

[148] Fix | Delete

'row',

[149] Fix | Delete

$field,

[150] Fix | Delete

[

[151] Fix | Delete

'slug' => 'title',

[152] Fix | Delete

'content' => $lbl . $fld,

[153] Fix | Delete

'class' => $indicator === 'none' ? 'wpforms-hidden' : '',

[154] Fix | Delete

]

[155] Fix | Delete

);

[156] Fix | Delete

}

[157] Fix | Delete

[158] Fix | Delete

// Next label.

[159] Fix | Delete

if ( empty( $position ) ) {

[160] Fix | Delete

$lbl = $this->field_element(

[161] Fix | Delete

'label',

[162] Fix | Delete

$field,

[163] Fix | Delete

[

[164] Fix | Delete

'slug' => 'next',

[165] Fix | Delete

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

[166] Fix | Delete

'tooltip' => esc_html__( 'Enter text for Next page navigation button.', 'wpforms-lite' ),

[167] Fix | Delete

],

[168] Fix | Delete

false

[169] Fix | Delete

);

[170] Fix | Delete

$fld = $this->field_element(

[171] Fix | Delete

'text',

[172] Fix | Delete

$field,

[173] Fix | Delete

[

[174] Fix | Delete

'slug' => 'next',

[175] Fix | Delete

'value' => ! empty( $field['next'] ) ? esc_attr( $field['next'] ) : esc_html__( 'Next', 'wpforms-lite' ),

[176] Fix | Delete

],

[177] Fix | Delete

false

[178] Fix | Delete

);

[179] Fix | Delete

[180] Fix | Delete

$this->field_element(

[181] Fix | Delete

'row',

[182] Fix | Delete

$field,

[183] Fix | Delete

[

[184] Fix | Delete

'slug' => 'next',

[185] Fix | Delete

'content' => $lbl . $fld,

[186] Fix | Delete

]

[187] Fix | Delete

);

[188] Fix | Delete

}

[189] Fix | Delete

[190] Fix | Delete

// Options are not available to top page breaks.

[191] Fix | Delete

if ( $position !== 'top' ) {

[192] Fix | Delete

[193] Fix | Delete

// Previous button toggle.

[194] Fix | Delete

$fld = $this->field_element(

[195] Fix | Delete

'toggle',

[196] Fix | Delete

$field,

[197] Fix | Delete

[

[198] Fix | Delete

'slug' => 'prev_toggle',

[199] Fix | Delete

// Backward compatibility for forms that were created before the toggle was added.

[200] Fix | Delete

'value' => ! empty( $field['prev_toggle'] ) || ! empty( $field['prev'] ),

[201] Fix | Delete

'desc' => esc_html__( 'Display Previous', 'wpforms-lite' ),

[202] Fix | Delete

'tooltip' => esc_html__( 'Toggle displaying the Previous page navigation button.', 'wpforms-lite' ),

[203] Fix | Delete

],

[204] Fix | Delete

false

[205] Fix | Delete

);

[206] Fix | Delete

[207] Fix | Delete

$this->field_element(

[208] Fix | Delete

'row',

[209] Fix | Delete

$field,

[210] Fix | Delete

[

[211] Fix | Delete

'slug' => 'prev_toggle',

[212] Fix | Delete

'content' => $fld,

[213] Fix | Delete

]

[214] Fix | Delete

);

[215] Fix | Delete

[216] Fix | Delete

// Previous button label.

[217] Fix | Delete

$lbl = $this->field_element(

[218] Fix | Delete

'label',

[219] Fix | Delete

$field,

[220] Fix | Delete

[

[221] Fix | Delete

'slug' => 'prev',

[222] Fix | Delete

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

[223] Fix | Delete

'tooltip' => esc_html__( 'Enter text for Previous page navigation button.', 'wpforms-lite' ),

[224] Fix | Delete

],

[225] Fix | Delete

false

[226] Fix | Delete

);

[227] Fix | Delete

$fld = $this->field_element(

[228] Fix | Delete

'text',

[229] Fix | Delete

$field,

[230] Fix | Delete

[

[231] Fix | Delete

'slug' => 'prev',

[232] Fix | Delete

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

[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' => 'prev',

[242] Fix | Delete

'content' => $lbl . $fld,

[243] Fix | Delete

'class' => empty( $field['prev_toggle'] ) ? 'wpforms-hidden' : '',

[244] Fix | Delete

]

[245] Fix | Delete

);

[246] Fix | Delete

}

[247] Fix | Delete

[248] Fix | Delete

// Options close markup.

[249] Fix | Delete

$this->field_option(

[250] Fix | Delete

'basic-options',

[251] Fix | Delete

$field,

[252] Fix | Delete

[

[253] Fix | Delete

'markup' => 'close',

[254] Fix | Delete

]

[255] Fix | Delete

);

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

/**

[259] Fix | Delete

* Generate the field UI for progress text configuration within a form.

[260] Fix | Delete

*

[261] Fix | Delete

* @since 1.9.7

[262] Fix | Delete

*

[263] Fix | Delete

* @param array $field The field data used to generate the progress text UI elements.

[264] Fix | Delete

*/

[265] Fix | Delete

private function field_progress_text( array $field ): void {

[266] Fix | Delete

[267] Fix | Delete

$lbl = $this->field_element(

[268] Fix | Delete

'label',

[269] Fix | Delete

$field,

[270] Fix | Delete

[

[271] Fix | Delete

'slug' => 'progress_text',

[272] Fix | Delete

'value' => esc_html__( 'Progress Text', 'wpforms-lite' ),

[273] Fix | Delete

'tooltip' => esc_html__( 'Enter text for the progress indicator.', 'wpforms-lite' ),

[274] Fix | Delete

],

[275] Fix | Delete

false

[276] Fix | Delete

);

[277] Fix | Delete

[278] Fix | Delete

$fld = $this->field_element(

[279] Fix | Delete

'text',

[280] Fix | Delete

$field,

[281] Fix | Delete

[

[282] Fix | Delete

'slug' => 'progress_text',

[283] Fix | Delete

'value' => ! empty( $field['progress_text'] ) ? esc_html( $field['progress_text'] ) : 'Step {current_page} of {last_page}',

[284] Fix | Delete

'after' => esc_html__( 'Enter text to show the user\'s progress. You can use {current_page} and {last_page} to indicate the current and last steps.', 'wpforms-lite' ),

[285] Fix | Delete

],

[286] Fix | Delete

false

[287] Fix | Delete

);

[288] Fix | Delete

[289] Fix | Delete

$indicator = ! empty( $field['indicator'] ) ? esc_attr( $field['indicator'] ) : 'progress';

[290] Fix | Delete

[291] Fix | Delete

$this->field_element(

[292] Fix | Delete

'row',

[293] Fix | Delete

$field,

[294] Fix | Delete

[

[295] Fix | Delete

'slug' => 'progress_text',

[296] Fix | Delete

'content' => $lbl . $fld,

[297] Fix | Delete

'class' => $indicator !== 'progress' ? 'wpforms-hidden' : '', // Hide if the indicator is not set to progress.

[298] Fix | Delete

]

[299] Fix | Delete

);

[300] Fix | Delete

}

[301] Fix | Delete

[302] Fix | Delete

/**

[303] Fix | Delete

* Field options panel inside the builder.

[304] Fix | Delete

*

[305] Fix | Delete

* @since 1.9.4

[306] Fix | Delete

*

[307] Fix | Delete

* @param array $field Field data.

[308] Fix | Delete

* @param string $position Position.

[309] Fix | Delete

*/

[310] Fix | Delete

private function field_options_basic_top( array $field, string $position ): void {

[311] Fix | Delete

[312] Fix | Delete

// Options specific to the top pagebreak.

[313] Fix | Delete

if ( $position !== 'top' ) {

[314] Fix | Delete

return;

[315] Fix | Delete

}

[316] Fix | Delete

[317] Fix | Delete

// Indicator themes.

[318] Fix | Delete

$themes = [

[319] Fix | Delete

'progress' => esc_html__( 'Progress Bar', 'wpforms-lite' ),

[320] Fix | Delete

'circles' => esc_html__( 'Circles', 'wpforms-lite' ),

[321] Fix | Delete

'connector' => esc_html__( 'Connector', 'wpforms-lite' ),

[322] Fix | Delete

'none' => esc_html__( 'None', 'wpforms-lite' ),

[323] Fix | Delete

];

[324] Fix | Delete

[325] Fix | Delete

/**

[326] Fix | Delete

* Filter the available Pagebreak Indicator themes.

[327] Fix | Delete

*

[328] Fix | Delete

* @since 1.6.6

[329] Fix | Delete

*

[330] Fix | Delete

* @param array $themes Available themes.

[331] Fix | Delete

*/

[332] Fix | Delete

$themes = apply_filters( 'wpforms_pagebreak_indicator_themes', $themes ); // phpcs:ignore WPForms.PHP.ValidateHooks.InvalidHookName

[333] Fix | Delete

$lbl = $this->field_element(

[334] Fix | Delete

'label',

[335] Fix | Delete

$field,

[336] Fix | Delete

[

[337] Fix | Delete

'slug' => 'indicator',

[338] Fix | Delete

'value' => esc_html__( 'Progress Indicator', 'wpforms-lite' ),

[339] Fix | Delete

'tooltip' => esc_html__( 'Select theme for Page Indicator which is displayed at the top of the form.', 'wpforms-lite' ),

[340] Fix | Delete

],

[341] Fix | Delete

false

[342] Fix | Delete

);

[343] Fix | Delete

[344] Fix | Delete

$indicator = ! empty( $field['indicator'] ) ? esc_attr( $field['indicator'] ) : 'progress';

[345] Fix | Delete

[346] Fix | Delete

$fld = $this->field_element(

[347] Fix | Delete

'select',

[348] Fix | Delete

$field,

[349] Fix | Delete

[

[350] Fix | Delete

'slug' => 'indicator',

[351] Fix | Delete

'value' => $indicator,

[352] Fix | Delete

'options' => $themes,

[353] Fix | Delete

'class' => 'wpforms-pagebreak-progress-indicator',

[354] Fix | Delete

],

[355] Fix | Delete

false

[356] Fix | Delete

);

[357] Fix | Delete

[358] Fix | Delete

$this->field_element(

[359] Fix | Delete

'row',

[360] Fix | Delete

$field,

[361] Fix | Delete

[

[362] Fix | Delete

'slug' => 'indicator',

[363] Fix | Delete

'content' => $lbl . $fld,

[364] Fix | Delete

]

[365] Fix | Delete

);

[366] Fix | Delete

[367] Fix | Delete

// Indicator color picker.

[368] Fix | Delete

$lbl = $this->field_element(

[369] Fix | Delete

'label',

[370] Fix | Delete

$field,

[371] Fix | Delete

[

[372] Fix | Delete

'slug' => 'indicator_color',

[373] Fix | Delete

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

[374] Fix | Delete

'tooltip' => esc_html__( 'Select the primary color for the Page Indicator theme.', 'wpforms-lite' ),

[375] Fix | Delete

],

[376] Fix | Delete

false

[377] Fix | Delete

);

[378] Fix | Delete

[379] Fix | Delete

$indicator_color = isset( $field['indicator_color'] ) ? wpforms_sanitize_hex_color( $field['indicator_color'] ) : self::get_default_indicator_color();

[380] Fix | Delete

[381] Fix | Delete

$fld = $this->field_element(

[382] Fix | Delete

'color',

[383] Fix | Delete

$field,

[384] Fix | Delete

[

[385] Fix | Delete

'slug' => 'indicator_color',

[386] Fix | Delete

'value' => $indicator_color,

[387] Fix | Delete

'data' => [

[388] Fix | Delete

'fallback-color' => $indicator_color,

[389] Fix | Delete

],

[390] Fix | Delete

],

[391] Fix | Delete

false

[392] Fix | Delete

);

[393] Fix | Delete

[394] Fix | Delete

$indicator_color_classes = [ 'color-picker-row' ];

[395] Fix | Delete

[396] Fix | Delete

if ( $indicator === 'none' ) {

[397] Fix | Delete

$indicator_color_classes[] = 'wpforms-hidden';

[398] Fix | Delete

}

[399] Fix | Delete

[400] Fix | Delete

$this->field_element(

[401] Fix | Delete

'row',

[402] Fix | Delete

$field,

[403] Fix | Delete

[

[404] Fix | Delete

'slug' => 'indicator_color',

[405] Fix | Delete

'content' => $lbl . $fld,

[406] Fix | Delete

'class' => $indicator_color_classes,

[407] Fix | Delete

]

[408] Fix | Delete

);

[409] Fix | Delete

[410] Fix | Delete

$this->field_progress_text( $field );

[411] Fix | Delete

}

[412] Fix | Delete

[413] Fix | Delete

/**

[414] Fix | Delete

* Advanced field options panel inside the builder.

[415] Fix | Delete

*

[416] Fix | Delete

* @since 1.9.4

[417] Fix | Delete

*

[418] Fix | Delete

* @param array $field Field data.

[419] Fix | Delete

* @param string $position Position.

[420] Fix | Delete

* @param string $position_class Position CSS class.

[421] Fix | Delete

*/

[422] Fix | Delete

private function field_options_advanced( array $field, string $position, string $position_class ): void {

[423] Fix | Delete

[424] Fix | Delete

if ( $position === 'bottom' ) {

[425] Fix | Delete

return;

[426] Fix | Delete

}

[427] Fix | Delete

[428] Fix | Delete

/**

[429] Fix | Delete

* Advanced field options.

[430] Fix | Delete

*/

[431] Fix | Delete

[432] Fix | Delete

// Options open markup.

[433] Fix | Delete

$this->field_option(

[434] Fix | Delete

'advanced-options',

[435] Fix | Delete

$field,

[436] Fix | Delete

[

[437] Fix | Delete

'markup' => 'open',

[438] Fix | Delete

'class' => $position_class,

[439] Fix | Delete

]

[440] Fix | Delete

);

[441] Fix | Delete

[442] Fix | Delete

// Navigation alignment, only available to the top.

[443] Fix | Delete

if ( $position === 'top' ) {

[444] Fix | Delete

$lbl = $this->field_element(

[445] Fix | Delete

'label',

[446] Fix | Delete

$field,

[447] Fix | Delete

[

[448] Fix | Delete

'slug' => 'nav_align',

[449] Fix | Delete

'value' => esc_html__( 'Page Navigation Alignment', 'wpforms-lite' ),

[450] Fix | Delete

'tooltip' => esc_html__( 'Select the alignment for the Next/Previous page navigation buttons', 'wpforms-lite' ),

[451] Fix | Delete

],

[452] Fix | Delete

false

[453] Fix | Delete

);

[454] Fix | Delete

$fld = $this->field_element(

[455] Fix | Delete

'select',

[456] Fix | Delete

$field,

[457] Fix | Delete

[

[458] Fix | Delete

'slug' => 'nav_align',

[459] Fix | Delete

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

[460] Fix | Delete

'options' => [

[461] Fix | Delete

'left' => esc_html__( 'Left', 'wpforms-lite' ),

[462] Fix | Delete

'right' => esc_html__( 'Right', 'wpforms-lite' ),

[463] Fix | Delete

'' => esc_html__( 'Center', 'wpforms-lite' ),

[464] Fix | Delete

'split' => esc_html__( 'Split', 'wpforms-lite' ),

[465] Fix | Delete

],

[466] Fix | Delete

],

[467] Fix | Delete

false

[468] Fix | Delete

);

[469] Fix | Delete

[470] Fix | Delete

$this->field_element(

[471] Fix | Delete

'row',

[472] Fix | Delete

$field,

[473] Fix | Delete

[

[474] Fix | Delete

'slug' => 'nav_align',

[475] Fix | Delete

'content' => $lbl . $fld,

[476] Fix | Delete

]

[477] Fix | Delete

);

[478] Fix | Delete

[479] Fix | Delete

// Scroll animation toggle.

[480] Fix | Delete

$fld = $this->field_element(

[481] Fix | Delete

'toggle',

[482] Fix | Delete

$field,

[483] Fix | Delete

[

[484] Fix | Delete

'slug' => 'scroll_disabled',

[485] Fix | Delete

'value' => ! empty( $field['scroll_disabled'] ),

[486] Fix | Delete

'desc' => esc_html__( 'Disable Scroll Animation', 'wpforms-lite' ),

[487] Fix | Delete

'tooltip' => esc_html__( 'By default, a user\'s view is pulled to the top of each form page. Set to ON to disable this animation.', 'wpforms-lite' ),

[488] Fix | Delete

],

[489] Fix | Delete

false

[490] Fix | Delete

);

[491] Fix | Delete

[492] Fix | Delete

$this->field_element(

[493] Fix | Delete

'row',

[494] Fix | Delete

$field,

[495] Fix | Delete

[

[496] Fix | Delete

'slug' => 'scroll_disabled',

[497] Fix | Delete

'content' => $fld,

[498] Fix | Delete

]

[499] Fix | Delete