<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms\Fields\EntryPreview;

[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

* Entry preview 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

* Init.

[17] Fix | Delete

*

[18] Fix | Delete

* @since 1.9.4

[19] Fix | Delete

*/

[20] Fix | Delete

public function init() {

[21] Fix | Delete

[22] Fix | Delete

// Define field type information.

[23] Fix | Delete

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

[24] Fix | Delete

$this->keywords = esc_html__( 'confirm', 'wpforms-lite' );

[25] Fix | Delete

$this->type = 'entry-preview';

[26] Fix | Delete

$this->icon = 'fa-file-text-o';

[27] Fix | Delete

$this->order = 190;

[28] Fix | Delete

$this->group = 'fancy';

[29] Fix | Delete

$this->allow_read_only = false;

[30] Fix | Delete

[31] Fix | Delete

$this->init_pro_field();

[32] Fix | Delete

$this->hooks();

[33] Fix | Delete

}

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Hooks.

[37] Fix | Delete

*

[38] Fix | Delete

* @since 1.9.4

[39] Fix | Delete

*/

[40] Fix | Delete

protected function hooks() {

[41] Fix | Delete

[42] Fix | Delete

add_filter( 'wpforms_builder_strings', [ $this, 'add_builder_strings' ], 10, 2 );

[43] Fix | Delete

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

[44] Fix | Delete

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

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Field options panel inside the builder.

[49] Fix | Delete

*

[50] Fix | Delete

* @since 1.9.4

[51] Fix | Delete

*

[52] Fix | Delete

* @param array $field Field data.

[53] Fix | Delete

*/

[54] Fix | Delete

public function field_options( $field ) {

[55] Fix | Delete

[56] Fix | Delete

// Options open markup.

[57] Fix | Delete

$this->field_option(

[58] Fix | Delete

'basic-options',

[59] Fix | Delete

$field,

[60] Fix | Delete

[

[61] Fix | Delete

'markup' => 'open',

[62] Fix | Delete

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

[63] Fix | Delete

]

[64] Fix | Delete

);

[65] Fix | Delete

[66] Fix | Delete

if ( empty( $this->is_disabled_field ) ) {

[67] Fix | Delete

$this->field_element(

[68] Fix | Delete

'row',

[69] Fix | Delete

$field,

[70] Fix | Delete

[

[71] Fix | Delete

'slug' => 'description',

[72] Fix | Delete

'content' => sprintf(

[73] Fix | Delete

'<p class="note">%s</p>',

[74] Fix | Delete

esc_html__( 'Entry Preview must be displayed on its own page, without other fields. HTML fields are allowed.', 'wpforms-lite' )

[75] Fix | Delete

),

[76] Fix | Delete

]

[77] Fix | Delete

);

[78] Fix | Delete

}

[79] Fix | Delete

[80] Fix | Delete

$this->field_element(

[81] Fix | Delete

'row',

[82] Fix | Delete

$field,

[83] Fix | Delete

[

[84] Fix | Delete

'slug' => 'preview-notice-enable',

[85] Fix | Delete

'content' => $this->field_element(

[86] Fix | Delete

'toggle',

[87] Fix | Delete

$field,

[88] Fix | Delete

[

[89] Fix | Delete

'slug' => 'preview-notice-enable',

[90] Fix | Delete

// When we add the field to a form, it enabled by default.

[91] Fix | Delete

'value' => ! empty( $field['preview-notice-enable'] ) || wp_doing_ajax(),

[92] Fix | Delete

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

[93] Fix | Delete

'tooltip' => esc_html__( 'Check this option to show a message above the entry preview.', 'wpforms-lite' ),

[94] Fix | Delete

],

[95] Fix | Delete

false

[96] Fix | Delete

),

[97] Fix | Delete

]

[98] Fix | Delete

);

[99] Fix | Delete

[100] Fix | Delete

$this->field_element(

[101] Fix | Delete

'row',

[102] Fix | Delete

$field,

[103] Fix | Delete

[

[104] Fix | Delete

'slug' => 'preview-notice',

[105] Fix | Delete

'content' =>

[106] Fix | Delete

$this->field_element(

[107] Fix | Delete

'label',

[108] Fix | Delete

$field,

[109] Fix | Delete

[

[110] Fix | Delete

'slug' => 'preview-notice',

[111] Fix | Delete

'value' => esc_html__( 'Preview Notice', 'wpforms-lite' ),

[112] Fix | Delete

'tooltip' => esc_html__( 'Fill in the message to show above the entry preview.', 'wpforms-lite' ),

[113] Fix | Delete

],

[114] Fix | Delete

false

[115] Fix | Delete

) .

[116] Fix | Delete

$this->field_element(

[117] Fix | Delete

'textarea',

[118] Fix | Delete

$field,

[119] Fix | Delete

[

[120] Fix | Delete

'slug' => 'preview-notice',

[121] Fix | Delete

'value' => $field['preview-notice'] ?? self::get_default_notice(),

[122] Fix | Delete

],

[123] Fix | Delete

false

[124] Fix | Delete

),

[125] Fix | Delete

]

[126] Fix | Delete

);

[127] Fix | Delete

[128] Fix | Delete

$this->field_option( 'basic-options', $field, [ 'markup' => 'close' ] );

[129] Fix | Delete

[130] Fix | Delete

$this->field_option( 'advanced-options', $field, [ 'markup' => 'open' ] );

[131] Fix | Delete

[132] Fix | Delete

$this->field_element(

[133] Fix | Delete

'row',

[134] Fix | Delete

$field,

[135] Fix | Delete

[

[136] Fix | Delete

'slug' => 'style',

[137] Fix | Delete

'content' =>

[138] Fix | Delete

$this->field_element(

[139] Fix | Delete

'label',

[140] Fix | Delete

$field,

[141] Fix | Delete

[

[142] Fix | Delete

'slug' => 'style',

[143] Fix | Delete

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

[144] Fix | Delete

'tooltip' => esc_html__( 'Choose the entry preview display style.', 'wpforms-lite' ),

[145] Fix | Delete

],

[146] Fix | Delete

false

[147] Fix | Delete

) .

[148] Fix | Delete

$this->field_element(

[149] Fix | Delete

'select',

[150] Fix | Delete

$field,

[151] Fix | Delete

[

[152] Fix | Delete

'slug' => 'style',

[153] Fix | Delete

'value' => ! empty( $field['style'] ) ? $field['style'] : 'basic',

[154] Fix | Delete

'options' => self::get_styles(),

[155] Fix | Delete

],

[156] Fix | Delete

false

[157] Fix | Delete

),

[158] Fix | Delete

]

[159] Fix | Delete

);

[160] Fix | Delete

[161] Fix | Delete

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

[162] Fix | Delete

[163] Fix | Delete

$this->field_option( 'advanced-options', $field, [ 'markup' => 'close' ] );

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

/**

[167] Fix | Delete

* Create the field preview.

[168] Fix | Delete

*

[169] Fix | Delete

* @since 1.9.4

[170] Fix | Delete

*

[171] Fix | Delete

* @param array $field Field data and settings.

[172] Fix | Delete

*

[173] Fix | Delete

* @noinspection HtmlUnknownAttribute*/

[174] Fix | Delete

public function field_preview( $field ) {

[175] Fix | Delete

[176] Fix | Delete

printf(

[177] Fix | Delete

'<label class="label-title">

[178] Fix | Delete

<span class="text">%1$s</span>%2$s</label>',

[179] Fix | Delete

esc_html__( 'Entry Preview', 'wpforms-lite' ),

[180] Fix | Delete

$this->get_field_preview_badge() // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped

[181] Fix | Delete

);

[182] Fix | Delete

[183] Fix | Delete

$is_new_field = wp_doing_ajax();

[184] Fix | Delete

$notice = ! empty( $field['preview-notice-enable'] ) && isset( $field['preview-notice'] ) && ! wpforms_is_empty_string( $field['preview-notice'] )

[185] Fix | Delete

? force_balance_tags( $field['preview-notice'] ) : '';

[186] Fix | Delete

$notice = $is_new_field || wpforms_is_empty_string( $notice ) ? self::get_default_notice() : $notice;

[187] Fix | Delete

$is_disabled = $is_new_field || ! empty( $field['preview-notice-enable'] );

[188] Fix | Delete

[189] Fix | Delete

printf(

[190] Fix | Delete

'<div class="wpforms-entry-preview-notice nl2br"%2$s>%1$s</div>',

[191] Fix | Delete

wp_kses_post( nl2br( $notice ) ),

[192] Fix | Delete

! $is_disabled ? ' style="display: none"' : ''

[193] Fix | Delete

);

[194] Fix | Delete

[195] Fix | Delete

printf(

[196] Fix | Delete

'<div class="wpforms-alert wpforms-alert-info"%2$s>

[197] Fix | Delete

<p>%1$s</p>

[198] Fix | Delete

</div>',

[199] Fix | Delete

esc_html__( 'Entry preview will be displayed here and will contain all fields found on the previous page.', 'wpforms-lite' ),

[200] Fix | Delete

$is_disabled ? ' style="display: none"' : ''

[201] Fix | Delete

);

[202] Fix | Delete

}

[203] Fix | Delete

[204] Fix | Delete

/**

[205] Fix | Delete

* Display the field input elements on the frontend.

[206] Fix | Delete

*

[207] Fix | Delete

* @since 1.9.4

[208] Fix | Delete

*

[209] Fix | Delete

* @param array $field Field data and settings.

[210] Fix | Delete

* @param array $deprecated Field attributes.

[211] Fix | Delete

* @param array $form_data Form data and settings.

[212] Fix | Delete

*/

[213] Fix | Delete

public function field_display( $field, $deprecated, $form_data ) {

[214] Fix | Delete

}

[215] Fix | Delete

[216] Fix | Delete

/**

[217] Fix | Delete

* Add custom JS i18n strings for the builder.

[218] Fix | Delete

*

[219] Fix | Delete

* @since 1.9.4

[220] Fix | Delete

*

[221] Fix | Delete

* @param array|mixed $strings List of strings.

[222] Fix | Delete

* @param array $form Current form.

[223] Fix | Delete

*

[224] Fix | Delete

* @return array

[225] Fix | Delete

* @noinspection PhpMissingParamTypeInspection

[226] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[227] Fix | Delete

*/

[228] Fix | Delete

public function add_builder_strings( $strings, $form ): array {

[229] Fix | Delete

[230] Fix | Delete

$strings = (array) $strings;

[231] Fix | Delete

[232] Fix | Delete

$strings['entry_preview_require_page_break'] = esc_html__( 'Page breaks are required for entry previews to work. If you\'d like to remove page breaks, you\'ll have to first remove the entry preview field.', 'wpforms-lite' );

[233] Fix | Delete

$strings['entry_preview_default_notice'] = self::get_default_notice();

[234] Fix | Delete

$strings['entry_preview_require_previous_button'] = esc_html__( 'You can\'t hide the previous button because it is required for the entry preview field on this page.', 'wpforms-lite' );

[235] Fix | Delete

[236] Fix | Delete

return $strings;

[237] Fix | Delete

}

[238] Fix | Delete

[239] Fix | Delete

/**

[240] Fix | Delete

* Get default notice.

[241] Fix | Delete

*

[242] Fix | Delete

* @since 1.9.4

[243] Fix | Delete

*

[244] Fix | Delete

* @return string

[245] Fix | Delete

*/

[246] Fix | Delete

protected static function get_default_notice(): string {

[247] Fix | Delete

[248] Fix | Delete

return sprintf(

[249] Fix | Delete

"<strong>%s</strong>\n%s",

[250] Fix | Delete

esc_html__( 'This is a preview of your submission. It has not been submitted yet!', 'wpforms-lite' ),

[251] Fix | Delete

esc_html__( 'Please take a moment to verify your information. You can also go back to make changes.', 'wpforms-lite' )

[252] Fix | Delete

);

[253] Fix | Delete

}

[254] Fix | Delete

[255] Fix | Delete

/**

[256] Fix | Delete

* Get a list of available styles.

[257] Fix | Delete

*

[258] Fix | Delete

* @since 1.9.4

[259] Fix | Delete

*

[260] Fix | Delete

* @return array

[261] Fix | Delete

*/

[262] Fix | Delete

protected static function get_styles(): array {

[263] Fix | Delete

[264] Fix | Delete

return [

[265] Fix | Delete

'basic' => esc_html__( 'Basic', 'wpforms-lite' ),

[266] Fix | Delete

'compact' => esc_html__( 'Compact', 'wpforms-lite' ),

[267] Fix | Delete

'table' => esc_html__( 'Table', 'wpforms-lite' ),

[268] Fix | Delete

'table_compact' => esc_html__( 'Table, Compact', 'wpforms-lite' ),

[269] Fix | Delete

];

[270] Fix | Delete

}

[271] Fix | Delete

[272] Fix | Delete

/**

[273] Fix | Delete

* Disallow the field preview "Duplicate" button.

[274] Fix | Delete

*

[275] Fix | Delete

* @since 1.9.9

[276] Fix | Delete

*

[277] Fix | Delete

* @param bool|mixed $display Display switch.

[278] Fix | Delete

* @param array $field Field settings.

[279] Fix | Delete

*

[280] Fix | Delete

* @return bool

[281] Fix | Delete

*/

[282] Fix | Delete

public function field_display_duplicate_button( $display, array $field ): bool {

[283] Fix | Delete

[284] Fix | Delete

$type = $field['type'] ?? '';

[285] Fix | Delete

[286] Fix | Delete

if ( $type === $this->type ) {

[287] Fix | Delete

// Pagebreak fields cannot be duplicated.

[288] Fix | Delete

return false;

[289] Fix | Delete

}

[290] Fix | Delete

[291] Fix | Delete

return (bool) $display;

[292] Fix | Delete

}

[293] Fix | Delete

}

[294] Fix | Delete

[295] Fix | Delete