PHPackages voku/html-form-validator - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)
1. [Directory](/)
2. /
3. [Validation & Sanitization](/categories/validation)
4. /
5. voku/html-form-validator
ActiveLibrary[Validation & Sanitization](/categories/validation)
voku/html-form-validator
========================
HTML <form> validation without trouble, easy filtering & validation.
3.0.1(4y ago)530[1 issues](https://github.com/voku/HtmlFormValidator/issues)[4 PRs](https://github.com/voku/HtmlFormValidator/pulls)MITPHPPHP ^7.3 || ^8.0CI passing
Since Dec 18Pushed 3w ago2 watchersCompare
[ Source](https://github.com/voku/HtmlFormValidator)[ Packagist](https://packagist.org/packages/voku/html-form-validator)[ RSS](/packages/voku-html-form-validator/feed)WikiDiscussions master Synced today
READMEChangelogDependencies (5)Versions (18)Used By (0)
[](https://github.com/voku/HtmlFormValidator/actions/workflows/ci.yml)[](https://coveralls.io/github/voku/HtmlFormValidator?branch=master)[](https://www.codacy.com/app/voku/HtmlFormValidator?utm_source=github.com&utm_medium=referral&utm_content=voku/HtmlFormValidator&utm_campaign=Badge_Grade)[](https://packagist.org/packages/voku/html-form-validator)[](https://packagist.org/packages/voku/html-form-validator)[](https://packagist.org/packages/voku/html-form-validator)[](https://www.paypal.me/moelleken)[](https://www.patreon.com/voku)
🔦 HTMLFormValidation
====================
[](#flashlight-htmlformvalidation)
### Description
[](#description)
HtmlFormValidator is a very easy to use PHP library that will help you to validate your `` data and you can use this independent from your framework of choice.
### Install via "composer require"
[](#install-via-composer-require)
```
composer require voku/html-form-validator
```
### How does this work?
[](#how-does-this-work)
1. First you need to generate a html form, that's completely your part. You can write it manually or you can generate with a framework or a library, it doesn't matter.
2. Then we use DOM Parsing via [voku/simple\_html\_dom](https://github.com/voku/simple_html_dom), to detect the current validator and filter rules directly from the html.
3. And finally, we use [Respect/Validation](https://github.com/Respect/Validation) to validate the form.
### Simple Example
[](#simple-example)
```
use voku\HtmlFormValidator\Validator;
require_once 'composer/autoload.php';
$html = '
Artist:
Heino
Michael Jackson
Tom Waits
Nina Hagen
Marianne Rosenberg
';
$rules = $formValidator->getAllRules();
static::assertSame(
[
'music' => [
'top5' => 'in(' . \serialize(['Heino','Michael Jackson','Tom Waits','Nina Hagen','Marianne Rosenberg',]) . ')',
],
],
$rules
);
// --- valid
// fake some data
$_POST = [
'top5' => 'Heino',
];
$formValidatorResult = $formValidator->validate($_POST);
static::assertSame([], $formValidatorResult->getErrorMessages());
// --- invalid
// fake some data
$_POST = [
'top5' => 'fooooo',
];
$formValidatorResult = $formValidator->validate($_POST);
static::assertSame(
[
'top5' => [
'"fooooo" must be in { "Heino", "Michael Jackson", "Tom Waits", "Nina Hagen", "Marianne Rosenberg" }',
],
],
$formValidatorResult->getErrorMessages()
);
```
### Extended Example
[](#extended-example)
```
use voku\HtmlFormValidator\Validator;
require_once 'composer/autoload.php';
$html = '
Email:
Name:
Date:
submit
';
$formValidator = new Validator($html);
// fake some data
$_POST = [
'user' => [
'email' => 'foo@isanemail',
'name' => 'bar',
],
];
// validate the form
$formValidatorResult = $formValidator->validate($_POST);
// check the result
static::assertFalse($formValidatorResult->isSuccess());
// get the error messages
static::assertSame(
[
'user[email]' => ['Your email [foo@isanemail] address is not correct.'],
'user[date]' => [
'Date is not correct.',
'Date is empty.',
],
],
$formValidatorResult->getErrorMessages()
);
// get the new html
static::assertSame(
'
Email:
Your email [foo@isanemail] address is not correct.
Name:
Date:
Date is not correct. Date is empty.
submit
',
$formValidatorResult->getHtml()
);
```
### Validator
[](#validator)
You can use all validators from [here](https://github.com/Respect/Validation/blob/1.1/docs/VALIDATORS.md).
e.g.: `data-validator="date"` || `data-validator="' . \Respect\Validation\Rules\Date::class . '"` (you need to lowercase the first letter from the class or you can use the class name itself)
You can combine validators simply via "|" ...
e.g.: `data-validator="notEmpty|maxLength(100)"`
PS: you can add arguments comma separated or you can use serialize -> something like that -> `in(' . serialize($selectableValues) . ')`
If you want to use the HTML5 validation e.g. for min or max values, or for e.g. email then you can use "auto".
e.g.: `data-validator="auto"`
By default we limit the submitted values to the values from the form e.g. for checkboxes, radios or select boxes. If you need to disable this, you can use "non-strict". (not recommended)
e.g.: `data-validator="non-strict"`
By default we use the error messages from the validation exception class, but you can use your own error messages via: "data-error-message--RULE\_NAME\_HERE" in the html.
e.g.: `data-error-message--email="Email [%s] is not correct"`
By default we don't add error messages into html output, but you can add the error messages with a css selector:
e.g.: `data-error-template-selector="span#email-error-message-template"`
By default we also don't add error classes, but you can add a new error class via:
e.g. `data-error-class="error-foo-bar"`
And if you need a more complex validation, then you can add simple-custom validations.
```
$formValidator->addCustomRule(
'foobar',
\Respect\Validation\Validator::allOf(
\Respect\Validation\Validator::intVal(),
\Respect\Validation\Validator::positive()
)
);
```
e.g.: `data-validator="foobar"`
And if you need really complex validation, then you can create your own classes.
```