Installation

Requirements

• PHP 8.1 or later. The repository CI matrix covers PHP 8.1–8.5.
• ext-mbstring is required by composer.json; do not assume your PHP distribution enables it.
• ext-intl is optional. It is required for PersianCollator and new CharNormalizer(normalizeToNfc: true). Calling those without it throws EnvironmentException with ENV.MISSING_EXT_INTL.
• No third-party Composer runtime packages. Development tools have their own requirements.

Install via Composer

composer require 'eram/abzar:^0.8.1'
composer check-platform-reqs
php -m

^0.8.1 allows releases from 0.8.1 up to, but not including, 0.9; it does not pin one exact release. Release 0.8.1 has no prerelease suffix and does not require a beta stability flag. The API remains pre-1.0. Commit your application’s composer.lock for reproducible installs. Never bypass platform checks to hide a missing extension. The web server and CLI can use different PHP configurations.

Verify the install

Save example.php beside vendor/, then run php example.php:

<?php
require 'vendor/autoload.php';

use Eram\Abzar\Validation\NationalId;

var_dump(NationalId::validate('0013542419')->isValid());

bool(true)

This checks the ID’s structure and checksum, not a person’s identity.

Optional companions

eram/daynum is listed in Composer’s suggestions for Jalali calendar utilities; it is not installed with Abzar. See related projects and the WordPress recipe for adjacent work.

Next: quick start, validation, API stability.