<?php
/**
 * Email rule.
 *
 * @package FormPilot
 * @since   1.0.0
 */

declare( strict_types = 1 );

namespace FormPilot\Validation\Rules;

use FormPilot\Contracts\ValidationRule;
use FormPilot\Fields\FieldTypes;
use FormPilot\Models\Field;
use FormPilot\Validation\ValidationError;

if ( ! defined( 'ABSPATH' ) ) {
	exit;
}

/**
 * Checks that an email field holds a deliverable looking address.
 *
 * @since 1.0.0
 */
final class EmailRule implements ValidationRule {

	/**
	 * Determines whether this rule applies to a field.
	 *
	 * @param Field $field Field being validated.
	 */
	public function supports( Field $field ): bool {
		return FieldTypes::EMAIL === $field->type();
	}

	/**
	 * Checks the address.
	 *
	 * @param Field $field Field being validated.
	 * @param mixed $value Sanitised value.
	 *
	 * @return ValidationError|null The failure, or null when the value passes.
	 */
	public function validate( Field $field, mixed $value ): ?ValidationError {
		if ( is_email( (string) $value ) ) {
			return null;
		}

		return new ValidationError(
			'',
			'invalid_email',
			__( 'Please enter a valid email address.', 'devplugins-custom-form-builder' )
		);
	}
}