Nebumix/NeburtValidationBundle
A real time backend validation for Symfony2, (*1)
Installation
Add bundle to your composer.json file
``` js
// composer.json, (*2)
{
"require": {
// ...
"nebumix/rt-validation-bundle": "dev-master"
}
}, (*3)
### Add bundle to your application kernel
``` php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Bmatzner\JQueryBundle\BmatznerJQueryBundle(),
new FOS\JsRoutingBundle\FOSJsRoutingBundle(),
new Nebumix\rtValidationBundle\NebumixrtValidationBundle(),
// ...
);
}
Download the bundle using Composer
``` bash
$ php composer.phar update nebumix/rt-validation-bundle, (*4)
### Register the routing definition in `app/config/routing.yml`:
``` yml
# app/config/routing.yml
fos_js_routing:
resource: "@FOSJsRoutingBundle/Resources/config/routing/routing.xml"
Nebumix_rtV_routing:
resource: "@NebumixrtValidationBundle/Resources/config/routing.yml"
Install assets
Given your server's public directory is named "web", install the public vendor resources, (*5)
``` bash
$ php app/console assets:install web, (*6)
Optionally, use the --symlink attribute to create links rather than copies of the resources
``` bash
$ php app/console assets:install --symlink web
Create new file app/config/securityRT.yml:
``` yml, (*7)
app/config/securityRT.yml
parameters:
nebumix_rtvalidation.check.class: Nebumix\rtValidationBundle\Controller\CheckController, (*8)
### Import the new file in `app/config/config.yml`:
``` yml
# app/config/config.yml
imports:
// ...
- { resource: securityRT.yml }
We need to configure friendsofsymfony/jsrouting-bundle, you can look the official documentation in the official page.
I suggest to add these lines in app/config/config.yml:, (*9)
``` yml, (*10)
app/config/config.yml
fos_js_routing:
routes_to_expose: [ nebumixrt_validation_check ], (*11)
The route name you need is `nebumixrt_validation_check`
Usage
-----
#### Add jQuery
Add this line in your layout:
, (*12)
#### Add FOSJsRoutingBundle
Add these two lines in your layout:
, (*13)
#### Add rtValidation
Add this line in your layout:
, (*14)
#### Write javascript functions
This example supposed to have in the page a form with fields called `nameField`, `nameField1` ... It will be explain better in the example.
To validate in real time a form field, you need to call a function to check your field.
I use the .focusout function.
To validate a text field you need to add in your layout:
``` js
$(function() {
$('#nameForm_nameField').focusout(function() {
check_field('nameValidation', 'nameForm_nameField');
});
$('#nameForm_nameField1').focusout(function() {
check_field('nameValidation', 'nameForm_nameField1');
});
//...
$('#nameForm_nameFieldN').focusout(function() {
check_field('nameValidation', 'nameForm_nameFieldN');
});
//if you have a radio or checkbox
$('#nameForm_nameFieldN').onchange(function() {
check_field_check('nameValidation', 'nameFieldToCheck');
});
});
You need to replace nameField with the field name you want to validate and nameForm with the form name (generally the id field is made using nameForm_nameField).
You need to replace nameValidation with a name, it must to be different for each form.
Is not necessary nameValidation is the real form name, it needs just to distinguish the form fields in the validation file., (*15)
Write validation rules in securityRT.yml:
``` yml
parameters:
nebumix_rtvalidation.check.class: Nebumix\rtValidationBundle\Controller\CheckController
nameValidation:
nameForm_nameField:
NotBlank:
message: Field is required.
Regex:
pattern: "/^\d+$/"
message: insert an integer
nameForm_nameField1:
NotBlank:
Length:
min: 3
nameFieldToCheck:
NotBlank:, (*16)
You have to use the name you used as `nameValidation` in the javascript function followed by the name used as `nameForm_nameField` and by the validation rules, as you can see in the example.
### Print errors
To print errors you can add in your layout:
``` html
<div id="nameForm_nameField_error"></div>
<div id="nameForm_nameField1_error"></div>
/ ...
<div id="nameForm_nameFieldN_error"></div>
The div id must to have the nameForm_nameField followed by _error. You have to write one for each field., (*17)
Now you can validate your form in real time, but if you like stopping the form if the validation returns errors, add the javascript function in your layout:, (*18)
``` js
$( document ).ready(function() {
$( "#sendForm" ).click(function() {, (*19)
//list functions, each per field
var c_nameField = check_field('nameValidation', 'nameForm_nameField');
var c_nameField1 = check_field('nameValidation', 'nameForm_nameField1');
//..
var c_nameFieldN = check_field('nameValidation', 'nameForm_nameFieldN');
//if you have a radio or checkbox
var c_nameFieldToCheck = check_field_check('nameValidation', 'nameFieldToCheck');
if( c_nameField == 1 && c_nameField1 == 1 )
{
var form_data = $('#myForm').serialize();
$.ajax({
url: Routing.generate('_your_route_to_save_form'),
type: "POST",
data: form_data,
dataType: "html",
async : false,
success: function(msg) {
//if the function have no error return 1
if(msg == 1){
alert('Saved');
}else{
check_field('nameValidation', 'nameForm_nameField');
check_field('nameValidation', 'nameForm_nameField1');
//...
check_field('nameValidation', 'nameForm_nameFieldN');
}
},
error: function(){
alert("ERROR!");
}
});
}
});
});
```, (*20)
This is just an example, you can write your own function., (*21)
Supported Constraints:
Basic Constraints
String Constraints
Number Constraints
Comparison Constraints
Date Constraints
Financial and other Number Constraints
Example
..., (*22)
Wallogit.com
