/ 
HTML-FormBuilder-0.01
River stage zero No dependents
/ HTML::FormBuilder::Validation

NAME

HTML::FormBuilder::Validation - An extention of the Form object, to allow for javascript-side validation of inputs and also server-side validation after the form is POSTed

SYNOPSIS

First, create the Form object. The keys in the HASH reference is the attributes of the form.

 	# Form attributes require to create new form object
	my $form_attributes =
	{
		'name'     => 'name_test_form',
		'id'       => 'id_test_form',
		'method'   => 'post',
		'action'   => "http://www.domain.com/contact.cgi",
		'class'    => 'formObject',
	};
	my $form_obj = new HTML::FormBuilder::Validation($form_attributes);

	my $fieldset_index = $form_obj->add_fieldset({});

Create the input fields with validation

This is quite similar to creating input field in Form object. Likewise you can add validation to HASH reference as the attribute of input field.

Below you can see the sample included four types of validation:

1. regexp: Just write the reqular expression that should be apply to the value

2. min_amount: Needs both type=min_amount and also minimum amount that declared in amount

3. max_amount: Just like min_amount

4. custom: Just the javascript function call with parameters should be given to. It only specifies client side validation.

  	my $input_field_amount =
	{
		'label' =>
		{
			'text'     => 'Amount',
			'for'      => 'amount',
			'optional' => '0',
		},
		'input' =>
		{
			'type'      => 'text',
			'id'        => 'amount',
			'name'      => 'amount',
			'maxlength' => 40,
			'value'     => '',
		},
		'error' =>
		{
			'text' => '',
			'id'    => 'error_amount',
			'class' => 'errorfield',
		},
		'validation' =>
		[
			{
				'type'    => 'regexp',
				'regexp'  => '\w+',
				'err_msg' => 'Not empty',
			},
			{
				'type'    => 'regexp',
				'regexp'  => '\d+',
				'err_msg' => 'Must be digit',
			},
			{
				'type'    => 'min_amount',
				'amount'  => 50,
				'err_msg' => 'Too little',
			},
			{
				'type'    => 'max_amount',
				'amount'  => 500,
				'err_msg' => 'Too much',
			},
 			{
 				'type' => 'custom',
 				'function' => 'custom_amount_validation()',
 				'err_msg' => 'It is not good',
 			},
		],
	};

Below is another example with two different fields. In this matter we need to indicate the id of each field in validation attributes.

my $select_curr =
{
	'id'      => 'select_text_curr',
	'name'    => 'select_text_curr',
	'type'    => 'select',
	'options' => '<option value=""></option><option value="USD">USD</option><option value="EUR">EUR</option>',
};
my $input_amount =
{
	'id'    => 'select_text_amount',
	'name'  => 'select_text_amount',
	'type'  => 'text',
	'value' => ''
};
my $input_field_select_text =
{
	'label' =>
	{
		'text'     => 'select_text',
		'for'      => 'select_text',
	},
	'input' => [ $select_curr, $input_amount ],
	'error' =>
	{
		'text'  => '',
		'id'    => 'error_select_text',
		'class' => 'errorfield',
	},
	'validation' =>
	[
		{
			'type' => 'regexp',
			'id'   => 'select_text_curr',
			'regexp'  => '\w+',
			'err_msg' => 'Must be select',
		},
		{
			'type' => 'regexp',
			'id'   => 'select_text_amount',
			'regexp'  => '\d+',
			'err_msg' => 'Must be digits',
		},
		{
			'type' => 'min_amount',
			'id'   => 'select_text_amount',
			'amount'  => 50,
			'err_msg' => 'Too little',
		},
	],
};

my $general_error_field =
{
	'error' =>
	{
		'text' => '',
		'id' => 'error_general',
		'class' => 'errorfield'
	},
};

Adding input fields to form object

Here is just add fields to the form object like before.

$form_obj->add_field($fieldset_index, $general_error_field);
$form_obj->add_field($fieldset_index, $input_field_amount);
$form_obj->add_field($fieldset_index, $input_field_select_text);

Custom javascript validation

Custom javascript validation should be defined and assigned to the form object. Note that, the name and parameters should be the same as the way you indicate function call in validation attributes.

You can see a sample below:

my $custom_javascript = qq~
	function custom_amount_validation()
	{
		var input_amount = document.getElementById('amount');
		if (input_amount.value == 100)
		{
			return false;
		}
		return true;
	}~;

Custom server side validation

The custom server side validation is quite similar to javascript. A reference to a subrotine should be pass to form object.

my $custom_server_side_sub_ref = sub {
	if ($form_obj->get_field_value('name') eq 'felix')
	{
		$form_obj->set_field_error_message('name', 'felix is not allow to use this page');
		$form_obj->set_field_error_message('error_general', 'There is an error !!!');
	}
};

$form_obj->set_server_side_checks($custom_server_side_sub_ref);

Use form object in cgi files

Somewhere in cgi files you can just print the result of build().

print $form_obj->build();

In submit you need to fill form values, use set_input_fields(\%input) and pass %input HASH and then show what ever you want in result of validation. Just like Below:

if (not $form_obj->validate())
{
	print '<h1>Test Form</h1>';
	print $form_obj->build();
}
else
{
	print '<h1>Success !!!</h1>';
}

code_exit();

AUTHOR

Felix Tan, <felix@regentmarkets.com<gt>

Omid Houshyar, <omid@regentmarkets.com<gt>

COPYRIGHT AND LICENSE