All guides
RTLY-Kit
No guide matches your search.
Guides
RTLY-Kit
Getting started
- Quick startInstall RTLY-Kit with Composer. In about five minutes you will convert a Jalali date, check an Iranian national code and catch your first library exception.
- InstallationRequirements, installation with Composer or Docker, optional Carbon and Laravel support, supported versions, how to check the install and how to remove the package.
Calendars
- Jalali calendarThe immutable Jalali (Persian, Solar Hijri) date class. Create and parse dates, format them with PHP date tokens, shift and snap them, compare them and measure the gap, with the exact year range and error behaviour.
- Hijri calendarThe immutable Hijri (Islamic) date class with the Umm al-Qura month table and an arithmetic Tabular variant. Create, parse and format dates in Arabic, Persian or English, shift them, compare them and measure the gap.
- Hebrew calendarThe immutable Hebrew (Jewish) date class with ordinal month numbers, Adar I and Adar II in leap years, and month names in English, Hebrew and Persian. Create, parse, format, shift and measure dates.
- Convert and compare datesThe shared CalendarDate contract of Jalali, Hijri and Hebrew. How to convert a date between calendars, and how comparing and measuring works across calendars and time zones.
- Carbon macrosOptional Carbon support. Turn any Carbon instance into a Jalali, Hijri or Hebrew date, and create Carbon dates from calendar parts. The page lists every macro with its return type and errors.
Validation
- Validators overviewHow the six Iranian validators work. The shared Validator contract, the Result object, stable error keys, input cleaning and size limits.
- National codeValidate Iranian national codes (کد ملی) with the mod-11 check digit, accept Persian and Arabic digits, and read the place-of-issue hint safely.
- Sheba and bank cardValidate Sheba (IBAN) numbers with ISO 7064 mod-97-10 and bank card numbers with the Luhn checksum, and look up the issuing bank. The page says where the bank data comes from.
- Mobile, postal code and plateValidate Iranian mobile numbers in every common input form, postal codes and vehicle plates, with operator hints, an allocation flag and parsing.
Numbers and text
- Digits and number formattingConvert between English, Persian and Arabic-Indic digits, format numbers with Persian separators and build Persian ordinals. Every cap and edge case is listed.
- Number to wordsSpell integers out in Persian (up to 10^21) and Arabic (up to 10^27), and read Persian number words back into numbers with fromWords().
- Arabic number wordsSpell numbers in Modern Standard Arabic with the right gender, case and vowel marks, up to 10^27, and write the ordinals from 1 to 99. Every option is shown with real output.
- Text toolsNormalize Persian and Arabic text, repair half-spaces, detect language and direction, and build URL-safe slugs. Each tool is described with its exact behavior and edge cases.
Holidays and prayer times
- Iranian holidaysLook up official Iranian public holidays for any Jalali date, list a whole year, and find business days. Official dates are used for 1394 to 1405, and other years are estimated.
- Holiday calendarUse official Iranian holiday dates, see where each date comes from, and fix moon-sighting differences with your own offsets, month starts and extra or removed days.
- Prayer timesCompute Fajr, sunrise, Dhuhr, Asr, Maghrib and Isha for any place with six calculation methods, high-latitude rules and manual tuning. The page lists what each method was checked against.
Laravel
- Laravel setupHow RTLY-Kit plugs into Laravel. Package auto-discovery, what the service provider registers, the Jalali facade, the optional config file and the fa, en and ar validation messages.
- Validation rules and Eloquent castUse the Iranian validation rules in Laravel forms, store Jalali dates in Eloquent models with JalaliCast, and show them in Blade.
Reference
- Helpers and globalsThe 27 namespaced helper functions, how to import them, and the opt-in Globals::register() that adds short global names without ever replacing yours.
- Error handlingWhich calls throw and which never do, the exception hierarchy, the stable ErrorCode values, and how to catch and log failures safely.
- API stabilityWhat you can rely on, what is internal, how versions are numbered before and after 1.0, and which PHP, Laravel and Carbon versions are supported.
- Accuracy and dataWhere every embedded data table comes from, what we compared it with and when, and what each result means. Read it before you rely on the results in production.
- BenchmarksA small micro-benchmark of RTLY-Kit against morilog/jalali, with the full method, the caveats and a one-line command to reproduce it on your machine.
- LimitsEvery hard limit in one place. Supported year ranges, input size caps, number-word ranges, the Umm al-Qura range, tuning ranges and the other numeric boundaries of the library.
- Troubleshooting and FAQAnswers to the questions people ask most. Missing helpers, weekday numbers, string years, time zones, Carbon macros, the Eloquent cast, prayer times and holidays.
- Upgrade guideChanges that can affect your code before 1.0, with before and after examples and the steps to migrate, plus the highlights of the changelog for the 0.x series.
- Verifying releasesHow to check that a release archive is the file the release workflow built, with a checksum and a build provenance attestation, and how this relates to a Composer install.