README

Laravel Persian Validation

Laravel Persian Validation provides validation rules for Persian alphabet, numbers and Iranian-specific data formats. It offers comprehensive validation for Persian (Shamsi) dates, phone numbers, national IDs, bank cards, Sheba numbers, postal codes, and company identifiers. Supporting Laravel 11+ and PHP 8.2+, it seamlessly integrates with Laravel's validation system.

Requirement

• Laravel 11, 12
• PHP >= 8.2

⚠️ If you need to use the package with older versions of Laravel (6, 7, 8, 9, 10) and PHP (>= 7.4), please use version 1.x

Installation

Important

Read the upgrade guide before upgrading to the version 2.0

Install the package with Composer:

composer require sadegh19b/laravel-persian-validation

Publish

If you want to change the configs, you can publish the config file. Run the below command on your terminal (the config file will be published to config/persian-validation.php):

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

If you want to use validations custom messages, you can publish language file. Run the below command on your terminal (the language file will be published to lang/vendor/persianValidation/{locale}/persian-validation.php. supported locales: en, fa):

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

Configurations

The package provides below configuration options in config/persian-validation.php:

• register_rules (default: true): Enables using the validation rules directly in Laravel's validation syntax. When enabled, you can use rules like: php 'field' => 'required|persian_alpha'

• accept_persian_numbers (default: false): Determines whether Persian numbers are accepted alongside English numbers in validation rules that involve numbers. When disabled, only English numbers will be accepted.

Usage

When the register_rules is true in configuration:

// Basic usage
$rules = [
    'name' => 'required|persian_alpha',
    'mobile' => 'required|ir_mobile',
    'code_melli' => 'required|ir_national_id',
];

// With parameters
$rules = [
    'birth_date' => ['required', 'persian_date', 'persian_date_between:1370/01/01,1402/12/29'],
    // First param for with area code, and second for area code separator.
    // for example this valid value is 021-12345678
    'phone' => ['required', 'ir_phone:true,-'],
];

When the rules not registered in laravel validation container:

use Sadegh19b\LaravelPersianValidation\Rules\PersianAlpha;
use Sadegh19b\LaravelPersianValidation\Rules\IranianMobile;
use Sadegh19b\LaravelPersianValidation\Rules\IranianNationalId;
use Sadegh19b\LaravelPersianValidation\Rules\PersianDate;

// Basic usage
$rules = [
    'name' => ['required', new PersianAlpha],
    'mobile' => ['required', new IranianMobile],
    'code_melli' => ['required', new IranianNationalId],
];

// With parameters
$rules = [
    'birth_date' => ['required', new PersianDate(separator: '-')],
    'phone' => ['required', new IranianPhone(withAreaCode: true, areaCodeSeparator: '-')],
];

Rules

Note: All parameters in below tables are in order to be used, must be passed to the rule constructor.

Persian Text and Numbers

Parameters Details

• convertPersianNumbers is a boolean parameter that converts Persian numbers to English numbers. the default is false.

Persian Dates

Note: The dates validate between 1000 and 1600 years.

Note: The validation values for persian_day and persian_month rules can be customized by modifying the corresponding values in the language file (lang/{locale}/persian-validation.php).

Parameters Details

• convertPersianNumbers is a boolean parameter that converts Persian numbers to English numbers. the default is false.

• separator is a string parameter that separates the numbers in the validation rules. the default is /. (Allows: /, |, -, _, *, ., ,, space)

• startDate and endDate are required parameters and are Shamsi dates that are used to validate the date is between them and using the separator.

• startYear and endYear are required parameters and are Shamsi years that are used to validate the year is between them and the 4-digit acceptable.

Phone Numbers

Parameters Details

• convertPersianNumbers is a boolean parameter that converts Persian numbers to English numbers. the default is false.

• format is a string parameter to validate mobile number format type. the default is all.(Allows: all, zero_code, plus_code, code, zero, normal)

  • zero_code => 0098: ex. 00989123456789
  • plus_code => +98: ex. +989123456789
  • code => 98: ex. 989123456789
  • zero => 0: ex. 09123456789
  • normal => ex. 9123456789
  • all => 0098, +98, 98, 0: ex. 00989123456789, +989123456789, 989123456789, 09123456789, 9123456789

• withAreaCode is a boolean parameter that validate the phone with should include area phone code. the default is false.

• areaCodeSeparator is a string parameter that separates the area code from phone number. the default is null. (Allows: /, |, -, _, *, ., ,, space)

• withCountryCodeFormat is a string parameter that validate the phone with should include country code and area code. the default is null. (Allows: zero, plus, normal, all)

  • zero => 0098: ex. 009802112345678
  • plus => +98: ex. +9802112345678
  • normal => 98: ex. 9802112345678
  • all => 0098, +98, 98: ex. 009802112345678, +9802112345678, 9802112345678
    Note: When use the withCountryCodeFormat parameter, the withAreaCodeis required and set it to true and the areaCodeSeparator parameter will be ignored.

National and Company Identifiers

Parameters Details

• convertPersianNumbers is a boolean parameter that converts Persian numbers to English numbers. the default is false.

Banking

Parameters Details

• convertPersianNumbers is a boolean parameter that converts Persian numbers to English numbers. the default is false.

• separator is a string parameter that separates the numbers in the validation rules. the default is null, and means does not use separator. (Allows: /, |, -, _, *, ., ,, space)

• withPrefix is a boolean parameter that validate should with the prefix (IR) to the Iranian iban (Sheba). The default is true.

Postal Codes

Parameters Details

• convertPersianNumbers is a boolean parameter that converts Persian numbers to English numbers. the default is false.

• separator is a string parameter that separates the numbers in the validation rules. the default is null, and means does not use separator. (Allows: /, |, -, _, *, ., ,, space)

License

The Laravel Persian Validation package is open-sourced software licensed under the MIT License.