فهرست مستندات پروژه

آشنایی با ابزار

Abzar0.8.1مشاهده منبعفارسی / انگلیسی

شروع کار با ابزار و راهنمای امکانات فارسی و ایرانی در PHP.

ابزار برای اعتبارسنجی داده‌های ایرانی، کار با متن و ارقام فارسی، نمایش عدد و محاسبه مبلغ در PHP ساخته شده است. به فریم‌ورک خاصی وابسته نیست. PHP 8.1 به بالا و mbstring لازم است؛ intl فقط برای مرتب‌سازی فارسی و NFC استفاده می‌شود. جزئیات در راهنمای نصب آمده است.

شروع سریع

بعد از نصب، این کد را در example.php کنار vendor/ ذخیره کنید و با php example.php اجرا کنید:

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

use Eram\Abzar\Validation\PhoneNumber;
use Eram\Abzar\Money\Amount;
use Eram\Abzar\Money\Currency;

$phone = PhoneNumber::from('+98 912 123 4567');
echo $phone->value(), "\n";
echo Currency::format(Amount::fromRials(12_345)), "\n";
09121234567
۱،۲۳۴.۵ تومان

پنج ریال باقی‌مانده در نمایش تومان حفظ شده است. Amount::inToman() فقط بخش صحیح تومان را برمی‌گرداند. اگر شماره نامعتبر باشد، PhoneNumber::from() خطا می‌اندازد؛ برای فرم‌ها از validate() استفاده کنید.

از کجا شروع کنم؟

امکانات

بخشAPIکاربرد
اعتبارسنجیNationalId, LegalIdکد ملی و شناسه ملی اشخاص حقوقی
اعتبارسنجیCardNumber, Ibanشماره کارت و شبا، همراه با lookup بانک
اعتبارسنجیPhoneNumber, PostalCodeتلفن همراه و ثابت، کد پستی
اعتبارسنجیBillId, PlateNumberشناسه قبض و پرداخت، پلاک خودرو
نتیجهValidationResult, ErrorCode, ValidationDetailنتیجه مشترک، کد خطا و DTO جزئیات
enumBank, Operator, Province, PlateTypeمقادیر مشخص برای بانک، اپراتور، استان و نوع پلاک
نمایشNumberFormatter, NumberToWords, WordsToNumberجداکننده هزارگان، عدد به حروف و برعکس
نمایشOrdinalNumber, TimeAgoعدد ترتیبی و زمان نسبی
پولAmount, Currency, Unitمحاسبه مبلغ و نمایش تومان و ریال
متنCharNormalizer, HalfSpaceFixer, Slugیکسان‌سازی حروف، نیم‌فاصله و اسلاگ
متنScript, KeyboardFixer, PersianCollatorبررسی کاراکترها، اصلاح کیبورد و مرتب‌سازی
ارقامDigitConverterتبدیل ارقام فارسی، عربی و انگلیسی

محدودیت‌ها

هیچ استعلامی از ثبت احوال، بانک یا اپراتور انجام نمی‌شود. معتبر بودن ساختار یا checksum، هویت و مالکیت را ثابت نمی‌کند. جدول‌ها snapshot هستند و ممکن است اطلاعات جدید را نداشته باشند. نرمال‌سازی متن موتور جستجو نیست. ابزار تقویم شمسی یا اتصال آماده به فریم‌ورک ندارد و هنوز به نسخه 1.0 نرسیده است.

در نمونه‌های کوتاه فرض شده Composer autoloader را بارگذاری کرده‌اید. کامنت کنار یک expression مقدار برگشتی را نشان می‌دهد؛ خود expression چیزی چاپ نمی‌کند. نمونه‌های کامل با بلوک text خروجی چاپ‌شده را نشان می‌دهند. کدهای فریم‌ورک در برنامه مربوط اجرا می‌شوند.

جستجو در مستندات

در همه پروژه‌ها جستجو کنید. با بستن این پنجره به راهنما برمی‌گردید.

Tab برای جابه‌جایی · Enter برای باز کردنEsc برای بستن