f9webltd/laravel-validation-rules

A collection of useful Laravel validation rules

1.1.1 2020-10-06 15:16 UTC

This package is auto-updated.

Last update: 2024-02-06 23:24:24 UTC


README

Latest Stable Version Scrutinizer coverage (GitHub/BitBucket) Scrutinizer code quality (GitHub/Bitbucket) Build Status StyleCI Status License

Useful Laravel Validation Rules

A collection of useful Laravel validation rules.

Requirements

PHP >= 7.2, Laravel >=5.8 | 6.x | 7.x | 8.x.

Installation

composer require f9webltd/laravel-validation-rules

To publish the package validation message translations:

php artisan vendor:publish --provider="F9Web\ValidationRules\ValidationRulesServiceProvider"

Published translations are available at resources/lang/vendor/f9web-validation-rules/messages.php.

Usage

As discussed in the official Laravel documentation, import the required rule whenever required:

use F9Web\ValidationRules\Rules\TitleCase;

// ...

$request->validate([
    'team' => ['required', new TitleCase()],
]);

Alternatively use the rule directly with a Laravel form request object

Available rules

Base64EncodedString

Ensure the passed attribute is a valid base 64 encoded string.

Coordinate

Ensure the passed attribute is a valid comma separated Latitude and Longitude string. For example: 51.507877,-0.087732.

DomainRestrictedEmail

Ensure the passed email in question is part of the provided whitelist of domains.

For instance, to ensure the given email domain is f9web.co.uk or laravel.com:

use F9Web\ValidationRules\Rules\DomainRestrictedEmail;

// ...

$request->validate([
    'email' => [
        'required', 
        (new DomainRestrictedEmail())->validDomains([
            'f9web.co.uk',
            'laravel.com',
        ]),
    ],
]);

The validation message will include the list of whitelisted domains based upon the provided configuration.

ExcludesHtml

Ensure the passed attribute does not contain HTML.

HexColourCode

Ensure the passed attribute is a valid hex colour code (three of six characters in length), optionally validating the presence of the # prefix.

Minimum usage example to validate a short length code with the prefix i.e. #fff:

use F9Web\ValidationRules\Rules\HexColourCode;

(new HexColourCode());

Extended usage example to validate a long length code , omitting prefix i.e. cc0000:

use F9Web\ValidationRules\Rules\HexColourCode;

(new HexColourCode())->withoutPrefix()->longFormat();

Honorific

Ensure the passed attribute is a valid honorific, omitting appended dots. The list of valid honorifics is available here.

IncludesHtml

Ensure the passed attribute contains HTML.

NoWhitespace

Ensure the passed attribute contains no whitespace.

NumberParity

Validate the number parity.

An odd number:

use F9Web\ValidationRules\Rules\NumberParity;

// ...

$request->validate([
    'amount' => [
        'required', 
        (new NumberParity())->odd(),
    ],
]);

An even number:

use F9Web\ValidationRules\Rules\NumberParity;

// ...

$request->validate([
    'amount' => [
        'required', 
        (new NumberParity())->even(),
    ],
]);

StringContains

Ensure the given attribute contains the provided strings.

Minimum usage example to ensure the attribute in question contains the string php or laravel:

use F9Web\ValidationRules\Rules\StringContains;

// ...

$request->validate([
    'description' => [
        'required', 
        (new StringContains())->phrases([
            'laravel',
            'php',
        ]),
    ],
]);

Optionally force the string to contain all provided phrases:

use F9Web\ValidationRules\Rules\StringContains;

// ...

$request->validate([
    'description' => [
        'required', 
        (new StringContains())->phrases([
            'laravel',
            'php',
        ])->strictly(),
    ],
]);

The validation message will include the list phrases based upon the provided configuration.

StrongPassword

Ensure the given attribute matches the provided conditions.

Minimum usage example to ensure the attribute:

  • is a minimum of eight characters in length
  • contains upper and lowercase characters
  • contains at least one number
use F9Web\ValidationRules\Rules\StrongPassword;

// ...

$request->validate([
    'password' => [
        'required', 
        (new StrongPassword()),
    ],
]);

Additional methods are available.

use F9Web\ValidationRules\Rules\StrongPassword;

// ...

$request->validate([
    'password' => [
        'required', 
        (new StrongPassword())
            ->forceUppercaseCharacters()
            ->forceLowercaseCharacters(false)
            ->forceNumbers()
            ->forceSpecialCharacters()
            // ->withSpecialCharacters('£$*%^'),
    ],
]);

The default special characters are !@#$%^&*()\-_=+{};:,<."£~?|>. Optionally the withSpecialCharacters() method can be used to define a custom list.

TitleCase

Ensure the provided attribute is title case.

UKMobilePhone

Ensure the provided attribute is a valid UK mobile telephone number.

Uppercase

Ensure the provided attribute is entirely uppercase.

Contribution

Any ideas are welcome. Feel free to submit any issues or pull requests.

Testing

composer test

Security

If you discover any security related issues, please email rob@f9web.co.uk instead of using the issue tracker.

Credits

License

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