🇮🇷 Persian Tools for Laravel

A powerful and comprehensive Laravel validation package for Persian text, Iranian identifiers, banking, dates, license plates, and more.

Developed by Alireza Fallah — fallahalireza/persian-tools-laravel

✨ What makes this package different?

📦 Installation

composer require fallahalireza/persian-tools-laravel

Publish config (optional)

php artisan vendor:publish --tag="persian-tools-config"

Publish language files (optional)

php artisan vendor:publish --tag="persian-tools-lang"

⚙️ Configuration

config/persian-tools.php:

return [
    // Register rules as Laravel validator strings (default: true)
    'register_rules' => true,

    // Accept Persian digits globally (default: false)
    'accept_persian_numbers' => false,
];

🚀 Usage

String-based (when register_rules = true)

$rules = [
    'name'        => 'required|persian_alpha',
    'mobile'      => 'required|ir_mobile',
    'national_id' => 'required|ir_national_id',
    'birth_date'  => 'required|persian_date',
    'card'        => 'required|ir_bank_card',
    'plate'       => 'required|ir_license_plate',
    'eco_code'    => 'required|ir_economic_code',
];

Class-based (always works)

use FallahAlireza\PersianTools\Rules\PersianAlpha;
use FallahAlireza\PersianTools\Rules\IranianNationalId;
use FallahAlireza\PersianTools\Rules\IranianMobile;
use FallahAlireza\PersianTools\Rules\IranianBankCardNumber;
use FallahAlireza\PersianTools\Enums\MobileFormat;

$rules = [
    'name'   => ['required', new PersianAlpha],
    'mobile' => ['required', new IranianMobile(format: MobileFormat::Zero)],
    'card'   => ['required', new IranianBankCardNumber(separator: '-')],
];

Type-safe Enum

use FallahAlireza\PersianTools\Enums\PersianRule;

$rules = [
    'name'   => ['required', PersianRule::PersianAlpha->value],
    'mobile' => ['required', PersianRule::IranianMobile->value],
];

📋 All Validation Rules

🔤 Persian Text & Numbers

📅 Persian Dates

// Validates 1403/01/01 (not inclusive)
new PersianDateBetween('1400/01/01', '1403/12/29')

// Custom separator
new PersianDate(separator: '-') // e.g. 1403-06-31

📱 Phone Numbers

use FallahAlireza\PersianTools\Enums\MobileFormat;

new IranianMobile(format: MobileFormat::Zero)      // 09123456789 only
new IranianMobile(format: MobileFormat::PlusCode)  // +989123456789 only
new IranianPhone(withAreaCode: true, areaCodeSeparator: '-') // 021-12345678

MobileFormat options: All, ZeroCode (0098...), PlusCode (+98...), Code (98...), Zero (0...), Normal (9...)

🪪 Identifiers

🏦 Banking

// Detect bank name from card
$rule = new IranianBankCardNumber();
$bank = $rule->detectBank('6037991234567890'); // "بانک ملی ایران"

// Card with dash separator
new IranianBankCardNumber(separator: '-') // 6037-9912-3456-7890

// IBAN without IR prefix
new IranianIban(withPrefix: false)

📍 Other

new IranianLicensePlate()                          // 12الف34567
new IranianLicensePlate(allowMotorcycle: true)     // also 123456789

🌐 Localization

The package supports fa and en error messages.

Set your app locale in config/app.php:

'locale' => 'fa',

Or per-request:

app()->setLocale('fa');

🧪 Testing

composer test

📄 License

MIT License — Alireza Fallah