<?php

[0] Fix | Delete

[1] Fix | Delete

namespace WPForms\Forms\Fields\Traits;

[2] Fix | Delete

[3] Fix | Delete

/**

[4] Fix | Delete

* Trait ReadOnlyField.

[5] Fix | Delete

*

[6] Fix | Delete

* Methods for read-only fields.

[7] Fix | Delete

*

[8] Fix | Delete

* @since 1.9.8

[9] Fix | Delete

*/

[10] Fix | Delete

trait ReadOnlyField {

[11] Fix | Delete

[12] Fix | Delete

/**

[13] Fix | Delete

* Whether the Read-Only option is allowed.

[14] Fix | Delete

*

[15] Fix | Delete

* @since 1.9.8

[16] Fix | Delete

*

[17] Fix | Delete

* @var bool

[18] Fix | Delete

*/

[19] Fix | Delete

protected $allow_read_only = true;

[20] Fix | Delete

[21] Fix | Delete

/**

[22] Fix | Delete

* Init Read-Only field functionality.

[23] Fix | Delete

*

[24] Fix | Delete

* @since 1.9.8

[25] Fix | Delete

*/

[26] Fix | Delete

public function read_only_init(): void {

[27] Fix | Delete

[28] Fix | Delete

// Read-only field hooks.

[29] Fix | Delete

add_action( 'wpforms_field_options_bottom_advanced-options', [ $this, 'field_option_read_only_toggle' ], -10 );

[30] Fix | Delete

add_filter( 'wpforms_field_properties', [ $this, 'read_only_field_properties' ], 100, 3 );

[31] Fix | Delete

add_filter( "wpforms_admin_builder_ajax_save_form_field_{$this->type}", [ $this, 'read_only_save_form_field' ], 100, 3 );

[32] Fix | Delete

add_filter( 'wpforms_frontend_strings', [ $this, 'read_only_frontend_strings' ] );

[33] Fix | Delete

}

[34] Fix | Delete

[35] Fix | Delete

/**

[36] Fix | Delete

* Display the Read-Only toggle on the Advanced Options tab.

[37] Fix | Delete

*

[38] Fix | Delete

* @since 1.9.8

[39] Fix | Delete

*

[40] Fix | Delete

* @param array $field Field data.

[41] Fix | Delete

*

[42] Fix | Delete

* @return void

[43] Fix | Delete

*/

[44] Fix | Delete

public function field_option_read_only_toggle( array $field ): void {

[45] Fix | Delete

[46] Fix | Delete

if ( $field['type'] !== $this->type || ! $this->allow_read_only ) {

[47] Fix | Delete

return;

[48] Fix | Delete

}

[49] Fix | Delete

[50] Fix | Delete

$value = $field['read_only'] ?? '0';

[51] Fix | Delete

$tooltip = esc_html__( 'Check this option to show the field’s value without allowing changes. It will still be submitted.', 'wpforms-lite' );

[52] Fix | Delete

[53] Fix | Delete

$output = $this->field_element(

[54] Fix | Delete

'toggle',

[55] Fix | Delete

$field,

[56] Fix | Delete

[

[57] Fix | Delete

'slug' => 'read_only',

[58] Fix | Delete

'value' => $value,

[59] Fix | Delete

'desc' => esc_html__( 'Read-Only', 'wpforms-lite' ),

[60] Fix | Delete

'tooltip' => $tooltip,

[61] Fix | Delete

],

[62] Fix | Delete

false

[63] Fix | Delete

);

[64] Fix | Delete

[65] Fix | Delete

$this->field_element(

[66] Fix | Delete

'row',

[67] Fix | Delete

$field,

[68] Fix | Delete

[

[69] Fix | Delete

'slug' => 'read_only',

[70] Fix | Delete

'content' => $output,

[71] Fix | Delete

]

[72] Fix | Delete

);

[73] Fix | Delete

}

[74] Fix | Delete

[75] Fix | Delete

/**

[76] Fix | Delete

* Add a Read-Only field CSS class.

[77] Fix | Delete

*

[78] Fix | Delete

* @since 1.9.8

[79] Fix | Delete

*

[80] Fix | Delete

* @param array|mixed $properties Field properties.

[81] Fix | Delete

* @param array $field Field data and settings.

[82] Fix | Delete

* @param array $form_data Form data and settings.

[83] Fix | Delete

*

[84] Fix | Delete

* @return array

[85] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[86] Fix | Delete

*/

[87] Fix | Delete

public function read_only_field_properties( $properties, array $field, array $form_data ): array { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[88] Fix | Delete

[89] Fix | Delete

$properties = (array) $properties;

[90] Fix | Delete

[91] Fix | Delete

if ( $field['type'] !== $this->type || ! $this->allow_read_only || empty( $field['read_only'] ) ) {

[92] Fix | Delete

return $properties;

[93] Fix | Delete

}

[94] Fix | Delete

[95] Fix | Delete

$properties['container']['class'][] = 'wpforms-field-readonly';

[96] Fix | Delete

[97] Fix | Delete

return $properties;

[98] Fix | Delete

}

[99] Fix | Delete

[100] Fix | Delete

/**

[101] Fix | Delete

* Filter field data before saving the form.

[102] Fix | Delete

*

[103] Fix | Delete

* @since 1.9.8

[104] Fix | Delete

*

[105] Fix | Delete

* @param array $field_data Field data.

[106] Fix | Delete

* @param array $form_data Forms data.

[107] Fix | Delete

* @param array $saved_form_data Saved form data.

[108] Fix | Delete

*

[109] Fix | Delete

* @noinspection PhpMissingParamTypeInspection

[110] Fix | Delete

* @noinspection PhpUnusedParameterInspection

[111] Fix | Delete

*/

[112] Fix | Delete

public function read_only_save_form_field( $field_data, array $form_data, array $saved_form_data ): array { // phpcs:ignore Generic.CodeAnalysis.UnusedFunctionParameter.FoundAfterLastUsed

[113] Fix | Delete

[114] Fix | Delete

$field_data = (array) $field_data;

[115] Fix | Delete

[116] Fix | Delete

// Unset the `required` field option if the field is Read-Only.

[117] Fix | Delete

if ( ! empty( $field_data['read_only'] ) ) {

[118] Fix | Delete

unset( $field_data['required'] );

[119] Fix | Delete

}

[120] Fix | Delete

[121] Fix | Delete

return $field_data;

[122] Fix | Delete

}

[123] Fix | Delete

[124] Fix | Delete

/**

[125] Fix | Delete

* Add read-only related strings to the frontend.

[126] Fix | Delete

*

[127] Fix | Delete

* @since 1.9.8

[128] Fix | Delete

*

[129] Fix | Delete

* @param array|mixed $strings Frontend strings.

[130] Fix | Delete

*

[131] Fix | Delete

* @return array Frontend strings.

[132] Fix | Delete

*/

[133] Fix | Delete

public function read_only_frontend_strings( $strings ): array {

[134] Fix | Delete

[135] Fix | Delete

$strings = (array) $strings;

[136] Fix | Delete

$strings['readOnlyDisallowedFields'] = $strings['readOnlyDisallowedFields'] ?? [];

[137] Fix | Delete

[138] Fix | Delete

if ( $this->allow_read_only ) {

[139] Fix | Delete

return $strings;

[140] Fix | Delete

}

[141] Fix | Delete

[142] Fix | Delete

$strings['readOnlyDisallowedFields'][] = $this->type;

[143] Fix | Delete

[144] Fix | Delete

return $strings;

[145] Fix | Delete

}

[146] Fix | Delete

}

[147] Fix | Delete

[148] Fix | Delete