forestry/form-validator

This package is abandoned and no longer maintained. No replacement package was suggested.

Validation of form data using defined rulesets.

0.1.1 2015-10-06 08:36 UTC

Requires

• php: >=5.4.0

Requires (Dev)

• phpunit/phpunit: 4.*

MIT

• Daniel Melzer

• form validation
• forestry

README

Library to validate form data based on rules.

Install

Via Composer

$ composer require forestry/form-validator

Usage

Create a validator

$validator = new Forestry\FormValidator\Validator();

Define a ruleset for a form

$rules = [
    'name' => 'alpha|required',
    'age' => 'num|required',
];

Validate the form data

$validator->validate($_POST, $rules);

if ($validator->hasErrors()) {
    $errors = $validator->getErrors();
}

Show error message

<label for="name">Name</label>
<input type="text" name="name" id="name">
<?= (!empty(Forestry\FormValidator\Validator::error('name')) ? Forestry\FormValidator\Validator::error('name') : '') ?>

You can also wrap error messages with custom markup:

Forestry\FormValidator\Validator::error('confirm_password', '<span class="text-danger">{message}</span>');

Rules

This package comes with the following built-in rules:

Rule	Parameter	Description
alpha	none	Allows only text, space, . and -
alphanum	none	Allows text and numerical values
boolean	none	Checks if the value can be interpreted as a boolean true (true, 1, yes or on).
date	format	Checks if the value is a valid date, time or date-time string. You can provide a date format to check against.
email	none	Checks if the value is a valid email address.
float	none	Checks if the value is a valid float value.
integer	none	Checks if the value is a valid integer value.
ip	none	Checks if the value is a valid IP address.
max	number	Checks if the value exceeds number characters.
min	number	Checks if the value has at least number characters.
natural	none	Checks if the value is a natural number.
number	none	Checks if the value is a number.
phone	none	Checks if the value is a valid phone number format.
required	none	Checks if the value is set.
same	fieldname	Compares if the value matches with the one in fieldname.
url	none	Checks if the value is a valid URL.

same rule example

With this rule, you can define that two fields must have the same value, e.g. password fields:

$rules['password'] = 'required|min:8';
$rules['confirm_password'] = 'same:password';

Custom messages

Instead of using the default error messages, you can also pass a custom one with each rule:

$rules['tos'] = "required--Please accept the terms of service";

Custom rules

You can define your own rules:

First, create a class which implements the Forestry\FormValidator\SimpleRuleInterface or Forestry\FormValidator\ParameterRuleInterface. The later on is used for rules whose have a parameter.

use Forestry\FormValidator\SimpleRuleInterface;

MyRule implements SimpleRuleInterface
{
    public function validate($value)
    {
        // Your code.
    }
    
    public function getMessage($value)
    {
        // Your code.
    }
}

Next, register your rule with a name and the full qualified class name.

$validator->registerRule('myrule', '\MyRule');

If you want to change an already registered rule, use the updateRule() method.

$validator->updateRule('url', '\MyRule');

Testing

$ phpunit

Contributing

Please see CONTRIBUTING for details.

Credits

• daniel-melzer
• All Contributors

License

The MIT License (MIT). Please see License File for more information.