popphp/pop-validator

Pop Validator Component for Pop PHP Framework

3.0.0 2017-02-22 18:05 UTC

README

Build Status Coverage Status

OVERVIEW

pop-validator is a component for validating values and returning the appropriate result messaging. The component comes with a set of built-in evaluation objects and also the ability to extend the component and build your own.

pop-validator is a component of the Pop PHP Framework.

INSTALL

Install pop-validator using Composer.

composer require popphp/pop-validator

BASIC USAGE

Here's a list of the available built-in validators:

Built-in Validators
AlphaNumeric Ipv4 LessThanEqual
Alpha Ipv6 LessThan
BetweenInclude IsSubnetOf NotContains
Between LengthBetweenInclude NotEmpty
Contains LengthBetween NotEqual
CreditCard LengthGte Numeric
Email LengthGt RegEx
Equal LengthLte Subnet
GreaterThanEqual LengthLt Url
GreaterThan Length

Check an email value

$validator = new Pop\Validator\Email();

// Returns false
if ($validator->evaluate('bad-email-address')) {
    // Prints out the default message 'The value must be a valid email format.'
    echo $validator->getMessage();
}

// Returns true
if ($validator->evaluate('good@email.com')) {
    // Do something with a valid email address.
}

Validate against a specific value

$validator = new Pop\Validator\LessThan(10);

if ($validator->evaluate(8)) { } // Returns true

Set a custom message

$validator = new Pop\Validator\RegEx(
    '/^.*\.(jpg|jpeg|png|gif)$/i',
    'You must only submit JPG, PNG or GIF images.'
);

// Returns false
if ($validator->evaluate('image.bad')) {
    echo $validator->getMessage();
}

Alternatively:

$validator = new Pop\Validator\RegEx('/^.*\.(jpg|jpeg|png|gif)$/i');
$validator->setMessage('You must only submit JPG, PNG or GIF images.');

if ($validator->evaluate('image.jpg')) { } // Returns true