README

Pachyderm Validation is a PHP library for Pachyderm, designed to provide a robust and flexible validation framework for your applications. It offers a wide range of built-in validators and allows for easy extension to meet custom validation needs.

Features

Comprehensive Validators: Includes a variety of validators such as Required, Email, Min, Max, Between, Regex, and more.
Customizable: Easily extend the library with custom validators.
Nested Validation: Supports validation of nested fields using dot notation.
Exception Handling: Throws detailed exceptions for validation errors.

Installation

To install the library, use Composer:

composer require pachyderm/validation

Run the tests

composer test

Usage

To use the library, you can create a new instance of the Validator class and pass the data you want to validate to the validate method.

use Pachyderm\Validation\Validator;
$validator = Validator::getInstance();
$errors = $validator->validate('required|email', $value);
if (!empty($errors)) {
    // Handle validation errors
}

Request Validation

For validating request data, extend the RequestValidator class and define your rules:

use Pachyderm\Validation\RequestValidator;

class MyRequestValidator extends RequestValidator
{
    protected function rules(): array
    {
        return [
            'name' => 'required|string',
            'age' => 'required|integer|min:18',
            'email' => 'required|email'
        ];
    }
}

Object Validation

You can validate objects using dot notation to access nested properties:

$validator = Validator::getInstance();
$rules = [
    'user.name' => 'required|string',
    'user.email' => 'required|email',
    'user.profile.age' => 'required|integer|min:18'
];

$data = [
    'user' => [
        'name' => 'John Doe',
        'email' => 'john@example.com',
        'profile' => [
            'age' => 25
        ]
    ]
];
$errors = Validator::validate($rules, $data);

Array Validation

For validating arrays or collections, you can use the array validator along with other rules:

$rules = [
    'items' => 'required|array',
    'items.*.id' => 'required|integer',
    'items.*.name' => 'required|string|min:3',
    'items.*.price' => 'required|numeric|min:0'
];

$data = [
    'items' => [
        [
            'id' => 1,
            'name' => 'Product 1',
            'price' => 29.99
        ],
        [
            'id' => 2,
            'name' => 'Product 2',
            'price' => 49.99
        ]
    ]
];

$errors = Validator::validate($rules, $data);

Custom Validators

To create a custom validator, implement the ValidatorInterface:

use Pachyderm\Validation\ValidatorInterface;

class MyCustomValidator implements ValidatorInterface
{
    public function validate($value, $rule): bool
    {
        // Implement your custom validation logic here
        return $value === 'custom';
    }
}

License

This project is licensed under the MIT License. See the LICENSE file for details.

aliengen / pachyderm-validation

Maintainers

Details