tamedevelopers/validator

PHP Form Validator is a small no-depencies library for PHP codes.

4.2.18 2024-10-13 03:50 UTC

Requires

• php: >=8.0
• tamedevelopers/support: *

MIT

• Fredrick Peterson
• Tame Developers

• php
• form
• Forms
• form validator
• php forms
• easy validation
• php form validator

README

Documentation

• Requirements
• Installation
• Instantiate
• Laravel Support
• Methods That Should Always Come First
• Global Configuration
• Csrf
  • Csrf Form Input
  • Csrf Token
• Usage
  • Error Type
  • Token
  • POST
  • GET
  • ALL
  • ANY
  • Rules
  • Validate
  • Save
  • Data Types
  • Operators
  • noInterface
  • Before
  • After
  • Has Error
  • Is Validated
• Reset Error
• Only
• Except
• Has
• Old
• Merge
• Only Data
• Except Data
• GetForm
• Get Message and Class
• Collection
• Collection Methods
• toObject
• toArray
• toJson
• Helpers
• Useful links

Requirements

• >= php 8.0+

Installation

Prior to installing validator package get the Composer dependency manager for PHP because it'll simplify installation.

composer require tamedevelopers/validator

Instantiate — Instantiate class using

require_once __DIR__ . '/vendor/autoload.php';

use \Tamedevelopers\Validator\Validator;

$form = new Validator();

• or -- Helpers Function

$form = form();

Laravel Support

• Now supports Laravel and with same Functionalities no different
  • use Tamedevelopers\Validator\Validator;

public function save(Request $request){

    $form = new Validator();
    or
    $form = form();
}

Methods That Should Always Come First

• All are Optional method
  • These methods are only mandatory on usage and should always come first before others.

$form->post()->rules([
    // 
]);

Global Configuration

• Helpers available to assist on easy configuration
  • config_form()

config_form(
    request       : 'POST',
    error_type    : true,
    csrf_token    : true,
    class         : [
        'error'     => 'alert alert-danger',
        'success'   => 'alert alert-success'
    ]
); 

Csrf

• Implementing Csrf (Cross-Site Request Forgery)
  • By default the form requires all request to have a token attached.
    • You can disable the usage with the config_form() Helper

Csrf Form Input

• This will create html input element with valid csrf token
  • It's a function and you don't need to echo
    • Use anywhere inside your HTML form

csrf();

Csrf Token

• This will return the csrf token string

csrf_token();

USAGE

• All Methods of usage

Error Type

• Takes a param as bool Default is false
  • You can call separately or Call Before any other method, if intend to use.

$form->errorType(false);

Token

• Takes a param as bool Default is false
  • Allow disability of csrf_token on each form request

$form->token(false);

POST

• Set the Form Request to POST
  • This will always override the config_form() settings

$form->post();

GET

• Set the Form Request to GET

$form->get();

All

• Will automatically detect if request type is GET\|POST and get it's data.

$form->all()->rules([
    // 
])

Any

• same as all

$form->any()->rules([
    // 
])

Rules

• By default only DATA TYPE and [INPUT_NAME] is required
  • Always seperate each indicator with a 'colon' : or 'pipe' |

$form->rules([
    "string|country|==|0"   => 'Please Select a Country',
    "email:email"           => 'Please enter a valid email address',
])

• HTML FORM Structure

<form>
    <select name="country">
        <option value="0">Select Country</option>
        <option value="NGA">Nigeria</option>
        <option value="USA">United States of America</option>
    </select>

    <input type="hidden" name="_token" value="749c345a1d407f29e777349f5e46a8d6d2cd51454b6719228b5ee28f94c30432">
    <input type="email" name="email" placeholder="Email Address">
</form>

Validate

• Takes an [optional] closure function as the param

$form->rules([
    "s:name" => 'Please enter a name',
])->validate(function($response){

    $response->param; //Collection of form data
    $response->getMessage(); //message property
});

Save

• Expects a closure function as the param
  • Message property will be empty string on success $response->message

$form->rules([
    "s:name" => 'Please enter a name',
])->save(function(){
    //on success
});

Data Types

• Supports 9 Data Flags type

Operators

• Supports 10 operational statement

noInterface

• Expects a closure function as the param
  • have access to form data without any validation

$form->noInterface(function($response){

    if($response->has('amount')){
        // exec code
    }
});

Before

• Expects a closure function as the param
  • Will only execute code within when Request is [GET]
    • CSRF Token does'nt apply to this method

$form->rules([
    "s:name" => 'Please enter a name',
])->before(function($response){

    // execute code
});

After

• Expects a closure function as the param
  • Will always execute no matter the request method type
    • CSRF Token does'nt apply to this method

$form->after(function(){
    // execute code
});

Has Error

• Returns bool true\|false

$form->hasError();

Is Validated

• Returns bool true\|false, When Form has already been validated

$form->isValidated();

Reset Error

• Even if you're inside the success() method
• With this helper, you can be able to reset the class, to error class

->save(function($response){

    $availableUserAmount = 900;

    <!-- Lets say for instance, users have wallet balance and the form request has no error -->
    <!-- But you need to perform another error validator before you allow request to pass through -->
    <!-- Don't forget the add the "return;" key to stop any other code from executing -->


    if($response->amount > $availableUserAmount){
        $response->reset();
        $response->message = "Your wallet balance is too low, Please recharge before you can Subscribe to Plan!";        
        return;
    }

    // perform other request before
});

Only

• Takes a param as an array
  • keys of data only needed, from the form param

->save(function($response){
    //
    $data = $response->only(['password', 'username']);
});

Except

• Exact opposite of only() method

->save(function($response){
    
    $data = $response->except(['_token']);
});

Has

• Takes a param as string input name
  • Returns boolean as true|\false

->save(function($response){
    
    if($response->has('remeber_me')){
        // execute code
    }
});

Old

• Takes a param as string and return old inserted data
  • Second parameter is [optional] mixed data.

$form->rules([
    "s:password" => 'Please enter a name',
    "s:retype_pass:!==:{$form->old('password')}" => 'Password mismatch, Please enter same password',
]);

• or -- Helpers Function

<input type="email" name="email" value="<?= old('email', 'default_value')>">

GetForm

• Return all submitted form data as an array

->save(function($response){

    $data = $response->getForm();
});

Merge

• Same as PHP function array_merge
  • Merge two array data together
  • Second data will always repalace any matched key data in the first array

->save(function($response){
    
    $data = [
        'name' => 'Lorem Name',
        'user_id' => rand(10000, 99999),
    ];

    $param = $response->merge($data, [
        'password' => md5($param['password'])
    ]);
});

Only Data

• Return only data passed from set of given array elements.

->save(function($response){

    $data = $response->onlyData(['email', 'password'], [
        'email'     => '[e-mail]', 
        '_token'    => md5('token'), 
        'age'       => 17,
        'password'  => 'test',
    ]);

    ---
    Only ['email', 'password'] will be returned.
});

Except Data

• Exact opposite of onlyData() method

->save(function($response){
    
    $data = $response->exceptData(['_token'], [
        'email'     => '[e-mail]', 
        '_token'    => md5('token'), 
        'password'  => 'test'
    ]);

    ---
    Return all array element, except ['_token']
});

Get Message and Class

$form->getMessage();
$form->getClass();

Collection

• Forms param returns a Collection Class
  • This enable us access property as an object or array index

$form->rules([
    "string:country:==:0"   => 'Please Select a Country',
    "email:email"           => 'Please enter a valid email address',
])->save(function($response){

    $param = $response->param;


    $param->country;
    $param['country']

    ---
    As you can see, we're able to access data in both ways without errors
})

Collection Methods

toObject

• Takes a param as mixed data
  • Converts to an Object data

$form->toObject([
    'food' => 'Basmati Rice'
]);

toArray

• Takes a param as mixed data
  • Converts to an Array data

$form->toArray([
    'food' => 'Basmati Rice'
]);

toJson

• Takes a param as mixed data
  • Converts to an Json data

$form->toJson([
    'food' => 'Basmati Rice'
]);

Helpers

Useful links

• @author Fredrick Peterson (Tame Developers)
• Lightweight - PHP Form Validator
• If you love this PHP Library, you can Buy Tame Developers a coffee
• Link to Youtube Video Tutorial on usage will be available soon