avonnadozie/php-form-validation

A PHP 5.3 Class for Easy Form Validation

A PHP 5.3 Class for Easy Form Validation

, _(*1)

Quick and painless form validation., _(*2)

Installation

composer require avonnadozie/php-form-validation

A Quick Example

The example below shows how to throw validation exceptions with the custom exception. You can then retrieve the error messages from the calling method. It is not good practice to validate your data in your controller, this should be handled in your Model. This is just a quick example., _(*3)

<?php
use FormValidator\Exception\ValidatorException;
use FormValidator\Validator;

class ExampleController {

    /**
     * Your controller action that handles validation errors, as you would
     * want these errors passed on to the view.
     *
     * @access  public
     * @return  void
     */
    public function indexAction()
    {
        try {
            // validate the data
            $validData = $this->validate($_POST);

            // validation passed because no exception was thrown
            // ... to something with the $validData ...
        } catch (ValidatorException $e) {
            // retrieve the overall error message to display
            $message = $e->getMessage();

            // retrieve all of the errors
            $errors = $e->getErrors();
        }
    }

    /**
     * Your user-defined validation handling. The exception section is
     * very important and should always be used.
     *
     * @access  private
     * @param   array   $post
     * @return  mixed
     */
    private function validate(array $post = array())
    {
        $validator = new Validator($post);
        $validator
                ->required('You must supply a name.')
                ->validate('name', 'Name');
        $validator
                ->required('You must supply an email address.')
                ->email('You must supply a valid email address')
                ->validate('email', 'Email');

        // check for errors
        if ($validator->hasErrors()) {
            throw new ValidatorException(
            'There were errors in your form.', $validator->getAllErrors()
            );
        }

        return $validator->getValidData();
    }

}

Available Validation Methods

• required($message = null) - The field value is required.
• email($message = null) - The field value must be a valid email address string.
• float($message = null) - The field value must be a float.
• integer($message = null) - The field value must be an integer.
• digits($message = null) - The field value must be a digit (integer with no upper bounds).
• min($limit, $include = TRUE, $message = null) - The field value must be greater than $limit (numeric). $include defines if the value can be equal to the limit.
• max($limit, $include = TRUE, $message = null) - The field value must be less than $limit (numeric). $include defines if the value can be equal to the limit.
• between($min, $max, $include = TRUE, $message = null) - The field value must be between $min and $max (numeric). $include defines if the value can be equal to $min and $max.
• minLength($length, $message = null) - The field value must be greater than or equal to $length characters.
• maxLength($length, $message = null) - The field value must be less than or equal to $length characters.
• length($length, $message = null) - The field must be $length characters long.
• matches($field, $label, $message = null) - One field matches another one (i.e. password matching)
• notMatches($field, $label, $message = null) - The field value must not match the value of $field.
• startsWith($sub, $message = null) - The field must start with $sub as a string.
• notStartsWith($sub, $message = null) - The field must not start with $sub as a string.
• endsWith($sub, $message = null) - THe field must end with $sub as a string.
• notEndsWith($sub, $message = null) - The field must not end with $sub as a string.
• ip($message = null) - The field value is a valid IP, determined using filter_var.
• url($message = null) - The field value is a valid URL, determined using filter_var.
• date($message = null) - The field value is a valid date, can be of any format accepted by DateTime()
• minDate($date, $format, $message = null) - The date must be greater than $date. $format must be of a format on the page http://php.net/manual/en/datetime.createfromformat.php
• maxDate($date, $format, $message = null) - The date must be less than $date. $format must be of a format on the page http://php.net/manual/en/datetime.createfromformat.php
• ccnum($message = null) - The field value must be a valid credit card number.
• oneOf($allowed, $message = null) - The field value must be one of the $allowed values. $allowed can be either an array or a comma-separated list of values. If comma separated, do not include spaces unless intended for matching.
• callback($callback, $message = '', $params = array()) - Define your own custom callback validation function. $callback must pass an is_callable() check. $params can be any value, or an array if multiple parameters must be passed.

Callback Examples

Callback functions can be passed as strings or closures., _(*4)

// numeric example
$validadator
  ->callback('is_numeric', 'Field is not numeric.')
  ->validate('number_field');

// closure example
$validator
  ->callback(function($val) {
    return $val < -1 || $val > 1;
  }, 'Number must be less than -1 or greater than 1.')
  ->validate('number_field_2');

Validating Arrays and Array Indices

This validation class has been extended to allow for validation of arrays as well as nested indices of a multi-dimensional array., _(*5)

Validating Specific Indices

To validate specific indices of an array, use dot notation, i.e., _(*6)

<?php
// load the validator
$validator = new Validator($_POST);

// ensure $_POST['field']['nested'] exists
$validator
  ->required('The nested field is required.')
  ->validate('field.nested');

// ensure we have the first two numeric indices of $_POST['links'][]
$validator
  ->required('This field is required')
  ->validate('links.0');
$validator
  ->required('This field is required')
  ->validate('links.1');

Available Pre-Validation Filtering

You can apply pre-validation filters to your data (i.e. trim, strip_tags, htmlentities). These filters can also be custom defined so long as they pass an is_callable() check., _(*7)

• filter($callback)

Filter Examples

    // standard php filter for valid user ids.
    $validator
      ->filter('intval')
      ->min(1)
      ->validate('user_id');

    // custom filter
    $validator
      ->filter(function($val) {
        // bogus formatting of the field
        $val = rtrim($val, '/');
        $val .= '_custom_formatted';
        return $val;
      })
      ->validate('field_to_be_formatted');

Credits

• Modifications by Victor Anuebunwa, Corey Ballou, Chris Gutierrez, and Robert Fruchtman.
• Forked from http://github.com/blackbe.lt which was forked from Tasos Bekos http://github.com/bekos which was based on the initial work of "Bretticus".
• See http://brettic.us/2010/06/18/form-validation-class-using-php-5-3/ for the original.