PHPackages opilo/farsi - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. opilo/farsi ActiveLibrary[Utility & Helpers](/categories/utility) opilo/farsi =========== Farsi Tools for Dates and Numbers and Strings (with Laravel Validation Support) 0.3.0(6y ago)333.2k9[2 PRs](https://github.com/opilo/farsi/pulls)1MITPHPPHP >=7.1.0CI failing Since Aug 16Pushed 5y ago2 watchersCompare [ Source](https://github.com/opilo/farsi)[ Packagist](https://packagist.org/packages/opilo/farsi)[ RSS](/packages/opilo-farsi/feed)WikiDiscussions master Synced today READMEChangelog (1)Dependencies (5)Versions (16)Used By (1) Opilo Farsi Tools ================= [](#opilo-farsi-tools) [![Build Status](https://camo.githubusercontent.com/146008e2d69899c7b18a0e4413944df2c005f96fea6e970063cb9cde46b2bbc6/68747470733a2f2f7472617669732d63692e6f72672f6f70696c6f2f66617273692e737667)](https://travis-ci.org/opilo/farsi)[![Latest Stable Version](https://camo.githubusercontent.com/404928fdabb25b0c1aa5afbbfa1a3f84e0b0262780911f26f834a2e82b9c004b/68747470733a2f2f706f7365722e707567782e6f72672f6f70696c6f2f66617273692f762f737461626c65)](https://packagist.org/packages/opilo/farsi)[![Total Downloads](https://camo.githubusercontent.com/0e9139344a07b3247e1d26ceb977f5370656e89b49a2e77d748fe9950dfd28e7/68747470733a2f2f706f7365722e707567782e6f72672f6f70696c6f2f66617273692f646f776e6c6f616473)](https://packagist.org/packages/opilo/farsi)[![Latest Unstable Version](https://camo.githubusercontent.com/44dd800c612177d19b768eb9050b0344d17a1f20038a908d89e08b5368652972/68747470733a2f2f706f7365722e707567782e6f72672f6f70696c6f2f66617273692f762f756e737461626c65)](https://packagist.org/packages/opilo/farsi)[![License](https://camo.githubusercontent.com/ce1fc35cf6bb78c6b1cff100d83f9f7079aefebf855cd352f748e3130700482a/68747470733a2f2f706f7365722e707567782e6f72672f6f70696c6f2f66617273692f6c6963656e7365)](https://packagist.org/packages/opilo/farsi) This package provides Farsi tools for PHP developers. It also introduce validation facilities specially designed for Laravel developers. Jalali (Higri Shamsi) Date -------------------------- [](#jalali-higri-shamsi-date) The `JalaliDate` class represents Iranian calendar. It calculates leap years based on data referenced in [this wiki page](https://fa.wikipedia.org/wiki/%DA%AF%D8%A7%D9%87%E2%80%8C%D8%B4%D9%85%D8%A7%D8%B1%DB%8C_%D8%B1%D8%B3%D9%85%DB%8C_%D8%A7%DB%8C%D8%B1%D8%A7%D9%86). According to the tests done in `tests/SallarJdatetimeTest.php`, for years between 1343 and 1473, the leap years in this calendar perfectly match those of `calculated` leap years based on the proposed calculation rules. But it should be considered that Iranian calendar is based on astronomical observations and, unlike the Georgian, it is not a rule-based calendar. The following code shows how you can convert a `DateTime` object into a `JalaliDate` one and then print it according to a desired format. All you need is using `JalaliDate::fromDateTime()` method and take a look at `JalaliFormatter::$conversionFunctions` array to know what to pass to `JalaliDate::format()` function as format string. ``` use Opilo\Farsi\JalaliDate; $dateTime = \DateTime::createFromFormat('Y-m-d', '2015-09-03'); $jalaliDate = JalaliDate::fromDateTime($dateTime); print ($jalaliDate->format('D S M ماه سال X')); ``` And the output will be: **پنج‌شنبه دوازدهم شهریور ماه سال یک هزار و سیصد و نود و چهار** The following sample code shows how to convert numeric inputs representing a Jalali date into a `JalaliDate` and then convert it into `DateTime`. This may be helpful if you want to validate user's input Jalali date, and then save the appropriate standard timestamp into database. ``` use Opilo\Farsi\JalaliDate; $jalaliDate = new JalaliDate(1394, 6, 12); $dateTime = $jalaliDate->toDateTime(); print($dateTime->format('Y-m-d')); ``` And the output will be: **2015-09-03** Conveniently, you can also directly convert an string with a known format into a `JalaliDate`: ``` use Opilo\Farsi\JalaliDate; $jalaliDate = JalaliDate::fromFormat('Y/m/d', '1394/6/20'); print($jalaliDate->format('D، d M y')); ``` The output of the code above, is: **جمعه، ۲۰ شهریور ۹۴** Note that if you try to construct an invalid `JalaliDate`, an `InvalidArgumentException` will be thrown. ### JDateTime class [](#jdatetime-class) The `JDateTime` class is an extension of `JalaliDate` class with time (hour, minute, second) support. Number to String Converter -------------------------- [](#number-to-string-converter) If your application is supposed to print financial documents, you probably love this: ``` use Opilo\Farsi\NumberToStringConverter; print NumberToStringConverter::toString(21034510); ``` because, this is the output: **بیست و یک میلیون و سی و چهار هزار و پانصد و ده** And, here is the second note **(نکته‌ی دوم)**: ``` print ('نکته‌ی ' . NumberToStringConverter::toOrdinalString(2)); ``` String Cleanser --------------- [](#string-cleanser) With `StringCleanser` class you can deal with Farsi digits while interacting with the users. `StringCleanser::arabicToFarsi()` function cleans input Farsi strings out of Arabic characters that commonly presents in standard keywords. ``` use Opilo\Farsi\StringCleaner; print(StringCleaner::digitsToFarsi('1394')); print("\n"); print(StringCleaner::digitsToEnglish('۱۳۹۴')); print("\n"); print(StringCleaner::arabicToFarsi('كيك پي اچ پي چيست؟')); print("\n"); ``` This will (approximately) output: ``` ۱۳۹۴ 1394 کیک پی اچ پی چیز خاصی نیست ``` Jalali Validator For Laravel 4.2 and Laravel 5 ---------------------------------------------- [](#jalali-validator-for-laravel-42-and-laravel-5) ### Installation [](#installation) #### Step 1: Add the Service Provider [](#step-1-add-the-service-provider) Add the provider class to the array of providers in config/app.php file ``` 'providers' => [ ... Opilo\Farsi\Laravel\FarsiServiceProvider::class, ] ``` #### Step 2: Define the Error Messages [](#step-2-define-the-error-messages) You need to define error messages for `jalali`, `jalali_after`, and `jalali_before` rules in validation.php in lang folders. Samples to copy & paste are provided under sample-lang directory of this package. For example, if your project uses Laravel 5 and your Farsi ranslation are under `resources/lang/fa` directory, copy these lines to `resources/lang/fa/validation.php`: ``` 'jalali' => ':attribute وارد شده تاریخ شمسی معتبری طبق فرمت :format نیست (مثال معتبر: :fa-sample).', 'jalali_after' => ':attribute وارد شده باید یک تاریخ شمسی معتبر بعد از :date باشد.', 'jalali_before' => ':attribute وارد شده باید یک تاریخ شمسی معتبر قبل از :date باشد.', ... //the rest of Farsi translations for validation rules. 'attributes' => [ 'birth_date' => 'تاریخ تولد', ... //the rest of Farsi translations for attributes ], ... ``` ### Validation Rules [](#validation-rules) #### jalali:Y/m/d [](#jalaliymd) Determines if an input is a valid Jalali date with the specified format. The default format is `Y/m/d`. #### jalali\_after:1380/1/1,Y/m/d [](#jalali_after138011ymd) Determines if an input is a valid Jalali date with the specified format and it is after a given date. The default format is `Y/m/d` and the default date is today. #### jalali\_before:1395-01-01,Y-m-d [](#jalali_before1395-01-01y-m-d) Determines if an input is a valid Jalali date with the specified format and it is before a given date. The default format is `Y/m/d` and the default date is today. #### jdatetime:"Y/m/d h:i:s" [](#jdatetimeymd-his) Determines if an input is a valid Jalali date-time with the specified format. The default format is `Y/m/d h:i:s`. #### jdatetime\_after:"1380/1/1 12:00:00","Y/m/d h:i:s" [](#jdatetime_after138011-120000ymd-his) Determines if an input is a valid Jalali date-time with the specified format and it is after a given date-time. The default format is `Y/m/d h:i:s` and the default time is now. #### jdatetime\_before:"1395-01-01 h:i","Y-m-d h:i" [](#jdatetime_before1395-01-01-hiy-m-d-hi) Determines if an input is a valid Jalali date-time with the specified format and it is before a given date-time. The default format is `Y/m/d h:i:s` and the default time is now. ### Examples [](#examples) Thanks to Laravel 5, you may use the mentioned validation rules inside rule() function of your domain specific Request objects. If that is not an option, you can use the rules, just like any other Laravel rules with codes like the following: ``` $v = Validator::make([ 'birth_date' => '1380/01/32', 'start_time' => '1395/02/16 12:10:00', ], [ 'birth_date' => 'required|jalali|jalali_before:1381/01/01|jalali_after:1300/01/01,Y/m/d', 'start_time' => 'required|jdatetime_after:"1395/01/01 00:00:00"|jdatetime_before:"1396/01/01 00:00:00"', ]); if ($v->fails()) { var_dump($v->messages()->toArray()); } ``` The output of the code above will be: ``` array(1) { ["birth_date"]=> array(3) { [0]=> string(140) "تاریخ تولد وارد شده تاریخ شمسی معتبری طبق فرمت Y/m/d نیست (مثال معتبر: ۱۳۹۴/۹/۱۳)." [1]=> string(113) "تاریخ تولد وارد شده باید یک تاریخ شمسی معتبر قبل از 1381/01/01 باشد." [2]=> string(113) "تاریخ تولد وارد شده باید یک تاریخ شمسی معتبر بعد از 1300/01/01 باشد." } } ``` License ------- [](#license) The Opilo Farsi package is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT) ### Health Score 33 — LowBetter than 72% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity31 Limited adoption so far Community14 Small or concentrated contributor base Maturity56 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~118 days Recently: every ~386 days Total 15 Last Release 2313d ago PHP version history (3 changes)0.0.0PHP >=5.5.0 0.1.0PHP >=5.4 0.3.0PHP >=7.1.0 ### Community Maintainers ![](https://www.gravatar.com/avatar/99120607c0e363e8400dc96ba32624b746a82a2b2799e3fdcb506e3d6061981d?d=identicon)[opilo](/maintainers/opilo) --- Top Contributors [![halaei](https://avatars.githubusercontent.com/u/7089140?v=4)](https://github.com/halaei "halaei (63 commits)") --- Tags Jalalipersianshamsifarsi ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/opilo-farsi/health.svg) ``` [![Health](https://phpackages.com/badges/opilo-farsi/health.svg)](https://phpackages.com/packages/opilo-farsi) ``` ### Alternatives [hekmatinasser/verta This Package helps developers to work with Jalali Datetime class for Laravel Framework PHP 657550.0k28](/packages/hekmatinasser-verta)[fisharebest/ext-calendar Implementation of the Arabic (Hijri), French, Gregorian, Jewish, Julian and Persian (Jalali) calendars. Also provides a replacement for the PHP ext/calendar extension. 36513.6k11](/packages/fisharebest-ext-calendar)[symfony_persia/symfonyjdate Jalali (Shamsi) DateTime for Symfony2, Supports year higher than 2038 1010.9k](/packages/symfony-persia-symfonyjdate)[iamfarhad/validation 🇮🇷 Complete Laravel Persian validation package - Iranian national ID, mobile numbers, Shamsi dates, IBAN/Sheba, postal codes & more. Modern Laravel 10-13 support with both ValidationRule objects & string-based rules. 3017.3k](/packages/iamfarhad-validation) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)