martynbiz/php-validator

Basic validation for PHP forms

1.2.1 2017-05-04 20:38 UTC

Requires

• php: >=5.3.0

Requires (Dev)

• phpunit/phpunit: 4.8.*

MIT

• Martyn Bissett

• form
• validation

README

##Installation

Install with composer:

composer require martynbiz/php-validator

Basic Usage

$validator = new MartynBiz\Validator();
$validator->setData($_POST);

The check() method instructs the object that this is a new value to validate. Additional methods are chained from this. Below shows an example of the object checking a value is not empty, then checking it is a valid email address.

$validator->check('email')
  ->isNotEmpty('Email address is blank')
  ->isEmail('Invalid email address');

To fetch the errors from a validation check, use getErrors():

$errors = $validator->getErrors();

After validation, check if data is valid:

$continue = $validator->isValid();

Check if a data has been given. Useful for checking checkboxes have been ticked:

$validator->check('name');

Note: will not work for empty strings, which isNonEmpty should also be used.

This will return an array of containing the error that occured (Email address is blank). Please note that although the isEmail method was called too, because it has already gathered an error it does not record another. Remember this when ordering your methods in the chain.

It is also possible to do this in one go, and return errors:

$errors = $validator->check('email')
  ->isNotEmpty('Email address is blank')
  ->isEmail('Invalid email address')
  ->getErrors();

Optional fields are when validation only occurs on that param if the param is given.

$validator->check('age', array('optional' => true))
  ->is...

Other methods for validating

The above example shows how to validate an email address but the following methods can be used to numeric, date and time stings too. Below is the full list of validation methods available.

// strings

$validator->check('name')
  ->isNotEmpty('Value must not be blank');

$validator->check('email')
  ->isEmail('Email address must be valid');

$validator->check('name')
  ->isLetters('Value must be letters');

$validator->check('name')
  ->isMinimumLength('Password must be at least 8 characters', 8);

$validator->check('name')
  ->isMaximumLength('Password must be no more than 16 characters', 16);

// numeric strings

$validator->check('amount')
  ->isNumber('Value must be a number');

$validator->check('profit')
  ->isPositiveNumber('Value must be a positive number');

$validator->check('loss')
  ->isNotPositiveNumber('Value must not be a positive number, negatives and zeros OK');

$validator->check('loss')
  ->isNegativeNumber('Value must be a negative number');

$validator->check('profit')
  ->isNotNegativeNumber('Value must not be a negative number, positives and zeros OK');

// date/time

$validator->check('publish_date')
  ->isDateTime('Value must be date/time format yyyy-mm-dd hh:mm:ss');

$validator->check('publish_date')
  ->isDate('Value must be date format yyyy-mm-dd');

$validator->check('meeting_time')
  ->isTime('Value must be time hh:mm:ss');

// passwords

$message = 'Password must contain upper and lower case characters, and have more than 8 characters';
$validator->check('password')
  ->isNotEmpty($message)
  ->hasLowerCase($message)
  ->hasUpperCase($message)
  ->hasNumber($message)
  ->isMinimumLength($message, 8);

// etc

$validator->check('username')
  ->isNotEmpty('Username missing')
  ->isMaximumLength('Username must not exceed 16 characters', 16);

Other error logging

You can use the logError() method too to log a custom error:

$validator->logError('Could not load api');

Extend Validator

Sometimes it's useful to add your own validator methods. This can be done by extending the class, and ensuring that your new method returns the instance logs the error:

class MyValidator extends Validator
{
    protected $userModel;

    // example constructor with dependency injection
    public function __construct($userModel, $data)
    {
        $this->userModel = $userModel;

        $this->setData($data);
    }

    // create new validation rule
    public function isUniqueEmail($message)
    {
        //check whether this email exists in the db
        //this is an example model, use your own models here
        $user = $this->userModel->findByEmail( $this->value );

        // log error - required
        if ($user) {
          $this->logError($message);
        }

        // return instance - required
        return $this;
    }

    // or create new rule from existing rules
    public function isValidPassword($message)
    {
        return $this
          ->isNotEmpty($message)
          ->hasLowerCase($message)
          ->hasUpperCase($message)
          ->hasNumber($message)
          ->isMinimumLength($message, 8);
    }

    // override isValid so we only have to call this method
    // and keep controllers, etc tidy
    public function isValid()
    {
        // first_name
        $this->check('first_name')
            ->isNotEmpty('First name missing');

        // last_name
        $this->check('last_name')
            ->isNotEmpty('Last name missing');

        $this->check('password')
            ->isValidPassword('Invalid password');

        return parent::isValid();
    }
}

Then you can chain the method as with the built in ones:

$validator = new MyValidator($userModel, $_POST):

if ($validator->isValid()) {
    //..
}