shopsys/jsformvalidator-bundle

Javascript validation for Symfony forms.

2.0 2024-11-15 08:29 UTC

Requires

• php: ^8.3
• symfony/form: ^6.4 | ^7.1
• symfony/validator: ^6.4 | ^7.1

Requires (Dev)

• ext-pdo_sqlite: *
• erusev/parsedown: ^1.6
• roave/security-advisories: dev-latest
• symfony/asset: *
• symfony/console: *
• symfony/dotenv: *
• symfony/expression-language: *
• symfony/flex: ^2.4
• symfony/framework-bundle: *
• symfony/html-sanitizer: *
• symfony/intl: *
• symfony/security-csrf: *
• symfony/translation: *
• symfony/twig-bundle: *
• symfony/webpack-encore-bundle: *
• symfony/yaml: *
• twig/twig: ^3.14.1

Suggests

• symfony/symfony: For using as a Symfony Bundle and for using a default ajax validation

MIT

• Ton Sharp
• Yury Maltsev

• symfony
• javascript
• form
• validation

README

This module enables validation of the Symfony 4 or later forms on the JavaScript side. It converts form type constraints into JavaScript validation rules.

If you have Symfony 4.4 or 5.x - you need to use Version 1.7.x

If you have Symfony 4.* - you need to use Version 1.6.x-dev

If you have Symfony 3.1.* - you need to use Version 1.5.*

If you have Symfony 3.0.* - you need to use Version 1.4.*

If you have Symfony 2.8.* or 2.7.* - you need to use Version 1.3.*

If you have Symfony 2.6.* or less - you need to use Version 1.2.*

1 Installation

1.1 Download FpJsFormValidatorBundle using composer

Run in terminal:

$ composer require "shopsys/jsformvalidator-bundle":"dev-master"

Or if you do not want to unexpected problems better to use exact version.

$ composer require "shopsys/jsformvalidator-bundle":"v1.6.*"

1.2 Enable javascript libraries

There are two ways to initialize javascript's files for this library. You can create a new entry in the webpack or import the main file into your javascript.

1.2.1 Add FpJsFormValidatorBundle to webpack.config.js

Encore
    ...
    .addEntry('app', './assets/js/app.js')
+   .addEntry('FpJsFormElement', './vendor/fp/jsformvalidator-bundle/Fp/JsFormValidatorBundle/Resources/public/js/FpJsFormValidatorWithJqueryInit.js')
    ...
    .configureBabel(null, {
        useBuiltIns: 'usage',
        corejs: 3,
    })
;

And include new entry in your template

+   {{ encore_entry_script_tags('FpJsFormElement') }}
    {{ encore_entry_script_tags('app') }}

1.2.2 Import FpJsFormValidatorBundle in your main javascript

  import $ from 'jquery';
+  import 'path-to-bundles/fpjsformvalidator/js/FpJsFormValidator';
+  import 'path-to-bundles/fpjsformvalidator/js/jquery.fpjsformvalidator';

1.2.3 Use inits in your template

{% block javascripts %}
+   {{ js_validator_config() }}
+   {{ init_js_validation() }}
{% endblock %}

1.4 Add routes

If you use the UniqueEntity constraint, then you have to include the next part to your routing config: app/config/routing.yml

# ...
fp_js_form_validator:
    resource: "@FpJsFormValidatorBundle/Resources/config/routing.xml"
    prefix: /fp_js_form_validator

Make sure that your security settings do not prevent these routes.

2 Usage

After the previous steps the javascript validation will be enabled automatically for all your forms.

1. Disabling validation
2. If your forms are placed in sub-requests
3. If you need to initialize JS validation for your forms separately, or by some event, in this case you need to follow these steps instead of the chapter 1.3

3 Customization

Preface

This bundle finds related DOM elements for each element of a symfony form and attach to it a special object-validator. This object contains list of properties and methods which fully define the validation process for the related form element. And some of those properties and methods can be changed to customize the validation process.

If you render forms with a some level of customization - read this note.

1. Disable validation for a specified field
2. Error display
3. Get validation groups from a closure
4. Getters validation
5. The Callback constraint
6. The Choice constraint. How to get the choices list from a callback
7. Custom constraints
8. Custom data transformers
9. Checking the uniqueness of entities
10. Form submit by Javasrcipt
11. onValidate callback
12. Run validation on custom event
13. Collections validation

4 Local development

Requirements

• docker with docker-compose
• make

Run application

docker-compose up -d --build
make install
# test form will be available at http://127.0.0.1:8080

Run tests

make tests