<?php
/**
* Field Validation Class
*
* Handles all field validation for SureForms
*
* @package SureForms
* @since 1.12.2
*/
namespace SRFM\Inc;
if ( ! defined( 'ABSPATH' ) ) {
exit; // Exit if accessed directly.
}
/**
* Field Validation Class
*/
class Field_Validation {
/**
* Add block configuration for form fields.
*
* This function processes blocks in a form and stores their configuration as post meta.
* It applies filters to allow extensions to modify block configs and stores processed
* values for blocks that need special handling (like upload fields).
*
* @param array<mixed> $blocks Array of blocks to process.
* @param int $form_id Form post ID.
* @return void
* @since 1.12.2
*/
public static function add_block_config( $blocks, $form_id ) {
// Initialize array to store processed block configurations.
$block_config = [];
// Loop through each block.
foreach ( $blocks as $block ) {
// Ensure $block is an array and has the required structure.
if ( ! is_array( $block ) ) {
continue;
}
if ( ! isset( $block['blockName'] ) || ! isset( $block['attrs'] ) || ! is_array( $block['attrs'] ) ) {
continue;
}
// Validate block id.
if ( ! array_key_exists( 'block_id', $block['attrs'] ) || empty( $block['attrs']['block_id'] ) || ! is_string( $block['attrs']['block_id'] ) ) {
continue;
}
$block_id = sanitize_text_field( $block['attrs']['block_id'] );
// Allow extensions to process and modify block config.
$config = apply_filters( 'srfm_block_config', [ 'block' => $block ] );
// If block was processed by a filter, add its processed value.
if ( isset( $config['processed_value'] ) && ! empty( $config['processed_value'] ) ) {
$block_config[ $block_id ] = $config['processed_value'];
continue;
}
}
// Only update meta if we have processed configurations.
if ( ! empty( $block_config ) ) {
update_post_meta( $form_id, '_srfm_block_config', $block_config );
}
}
/**
* Retrieve or migrate the block configuration for legacy forms.
*
* This function checks if the _srfm_block_config post meta exists for the given form ID.
* Example: get_post_meta( 123, '_srfm_block_config', true ) might return an array of block configs.
* If not found, it attempts to parse the form's post content and generate the block config.
* Example: If a legacy form with ID 123 has no _srfm_block_config, but its post_content contains blocks,
* the function will parse those blocks and call add_block_config() to generate and store the config.
*
* @param int $form_id The ID of the form post.
* @since 1.12.2
* @return array|null The block configuration array, or null if not found or invalid.
*/
public static function get_or_migrate_block_config_for_legacy_form( $form_id ) {
// Validate that $form_id is a positive integer.
// Example: $form_id = 123 is valid; $form_id = -1 or 'abc' is not.
if ( ! is_int( $form_id ) || $form_id <= 0 ) {
return null;
}
// Retrieve the block config from post meta.
// Example: $block_config = [ 'block-1' => [ ... ], 'block-2' => [ ... ] ].
$block_config = get_post_meta( $form_id, '_srfm_block_config', true );
if ( ! empty( $block_config ) && is_array( $block_config ) ) {
// If it exists and is an array, return it directly (no migration needed).
// Example: Returning the existing $block_config array.
return $block_config;
}
// Get the post by ID and validate.
// Example: $post = get_post( 123 ); $post->post_content should contain block markup.
$post = get_post( $form_id );
if ( ! ( $post instanceof \WP_Post ) || empty( $post->post_content ) ) {
return null;
}
// Parse the blocks from the post content and attempt migration.
// Example: $blocks = parse_blocks( $post->post_content ); $blocks is an array of block arrays.
if ( function_exists( 'parse_blocks' ) ) {
$blocks = parse_blocks( $post->post_content );
if ( is_array( $blocks ) && ! empty( $blocks ) ) {
self::add_block_config( $blocks, $form_id );
}
}
// Retrieve the block config again after migration attempt.
// Example: After migration, $block_config should now be an array if successful.
$block_config = get_post_meta( $form_id, '_srfm_block_config', true );
return ! empty( $block_config ) && is_array( $block_config ) ? $block_config : null;
}
/**
* Prepare validation data for a given form.
*
* Retrieves the form block configuration from post meta and adds a 'name_with_id'
* key to each block, which is a unique identifier for the field (used for validation).
*
* @param int $current_form_id The ID of the form post.
* @since 1.12.2
* @return array|null The processed form configuration array, or null if not found.
*/
public static function prepared_validation_data( $current_form_id ) {
// Retrieve the form block configuration from post meta.
$get_form_config = self::get_or_migrate_block_config_for_legacy_form( $current_form_id );
// If the configuration is an array, add a 'name_with_id' key to each block.
if ( is_array( $get_form_config ) ) {
foreach ( $get_form_config as $index => $block ) {
// Ensure both 'blockName' and 'block_id' exist before creating the identifier.
if ( isset( $block['blockName'] ) ) {
// 'name_with_id' is used as a unique field identifier for validation.
// Example: 'sureforms-input-abc123' for blockName 'sureforms/input' and block_id 'abc123'
$get_form_config[ $index ]['name_with_id'] = str_replace( '/', '-', $block['blockName'] ) . '-' . $index;
}
}
}
// Return the processed configuration array, or an empty array if not found.
return is_array( $get_form_config ) ? $get_form_config : [];
}
/**
* Validate form data for a given form.
*
* This function checks each field in the submitted form data (including uploaded files)
* and applies the 'srfm_validate_form_data' filter to validate each field according to
* its configuration. Only fields with keys containing '-lbl-' (SureForms fields) are processed.
* If a field fails validation, its error message is added to the $not_valid_fields array.
*
* @param array<mixed> $form_data The submitted form data (sanitized).
* @param int|mixed $current_form_id The ID of the form being validated.
* @since 1.12.2
* @return array An array of invalid fields and their error messages. Empty if all fields are valid.
*/
public static function validate_form_data( $form_data, $current_form_id ) {
if ( ! is_array( $form_data ) || ! is_numeric( $current_form_id ) ) {
return [];
}
// Holds fields that are not valid. Example: [ 'srfm-email-c867d9d9-lbl-email' => 'This field is required.' ].
$not_valid_fields = [];
// Retrieve the processed form configuration for validation.
$get_form_config = self::prepared_validation_data( Helper::get_integer_value( $current_form_id ) );
$form_data = apply_filters( 'srfm_field_validation_data', $form_data );
// Iterate over each field in the form data.
foreach ( $form_data as $key => $value ) {
/**
* Only process SureForms fields.
* The '-lbl-' substring is mandatory in SureForms field keys.
* Example: $key = 'srfm-email-c867d9d9-lbl-email'
*/
if ( false === strpos( $key, '-lbl-' ) ) {
continue;
}
$get_name_with_id = explode( '-lbl-', $key );
// Extract the part after the last '-' in the key, if it matches the pattern.
// Example: $get_name_with_id[0] = "srfm-email-c867d9d9".
// $extracted_id = "c867d9d9".
$extracted_id = '';
if ( is_string( $key ) && preg_match( '/-([a-zA-Z0-9]+)$/', $get_name_with_id[0], $matches ) ) {
$extracted_id = $matches[1];
// Now $extracted_id contains "c867d9d9" for "srfm-email-c867d9d9".
}
// $get_slug will be the slug after the first hyphen in the second part.
// Example: $get_name_with_id[1] = "email" or "field-email", $get_slug = "email".
$get_slug = isset( $get_name_with_id[1] ) ? preg_replace( '/^[^-]+-/', '', $get_name_with_id[1] ) : '';
// $get_field_name is the field name without the block id.
// Example: "srfm-email-c867d9d9" => "srfm-email".
$get_field_name = str_replace( '-' . $extracted_id, '', $get_name_with_id[0] );
// Apply the validation filter for the current field.
// Example: Passes all relevant field data to the filter for validation.
$field_validated = apply_filters(
'srfm_validate_form_data',
[
'field_key' => $key,
'field_value' => $value,
'form_id' => $current_form_id,
'form_config' => $get_form_config,
'block_id' => $extracted_id,
'block_slug' => $get_slug,
'name_with_id' => $get_name_with_id[0],
'field_name' => $get_field_name,
]
);
// Check the result of the validation.
// Example: $field_validated = [ 'validated' => false, 'error' => 'This field is required.' ].
if ( isset( $field_validated['validated'] ) ) {
// If the field is valid, skip to the next field.
if ( true === $field_validated['validated'] ) {
continue;
}
// If the field is not valid, add the error message to the result array.
// Example: $not_valid_fields[ 'srfm-email-c867d9d9-lbl-email' ] = 'This field is required.'.
if ( false === $field_validated['validated'] ) {
$not_valid_fields[ $key ] = $field_validated['error'] ?? __( 'Field is not valid.', 'sureforms' );
}
}
}
// Return the array of invalid fields and their error messages.
// Example: [ 'srfm-email-c867d9d9-lbl-email' => 'This field is required.' ].
return $not_valid_fields;
}
}