jalaali/jalaali-php

PHP functions for converting Jalaali and Gregorian calendar systems to each other.

Jalaali PHP

PHP implementation of jalaali.js which contains functions for converting Jalaali and Gregorian calendar systems to each other., _(*1)

Jalaali calendar system has different names such as:, _(*2)

• Jalaali
• Khayyami
• Khorshidi
• Persian
• Shamsi

The base algorithm is a derived work of Omar Khayyam, who completed the calendar system more than 900 years ago., _(*3)

About

Jalaali calendar is a solar calendar that was used in Persia, variants of which today are still in use in Iran as well as Afghanistan. Read more or see Calendar Converter., _(*4)

Calendar conversion is based on the algorithm provided by Kazimierz M. Borkowski and has a very good performance., _(*5)

Install

composer require jalaali/jalaali-php, _(*6)

API

Base Jalaali class is defined with 10 static methods inside Jalaali namespace, so there's no need for instantiation. For example, to convert Gregorian date to Jalaali use this code:, _(*7)

// PHP 3.0.x date to Jalaali :)
\Jalaali\Jalaali::toJalaali(2000, 10, 20)

There is a complete documentation page for this project on docs/api folder but the list of methods is as follows:, _(*8)

toJalaali($gy, $gm, $gd) : Converts a Gregorian date to Jalaali, _(*9)

toGregorian($jy, $jm, $jd) : Converts a Jalaali date to Gregorian, _(*10)

isValidJalaaliDate($jy, $jm, $jd) : Checks whether a Jalaali date is valid or not, _(*11)

isLeapJalaaliYear($jy) : Checks whether this is a leap year or not, _(*12)

jalaaliMonthLength($jy, $jm) : Number of days in a given month in Jalaali year, _(*13)

jalaaliCalendar($jy) : Base Algorithm, _(*14)

j2d($jy, $jm, $jd) : Converts a date of the Jalaali calendar to the Julian Day Number, _(*15)

d2j($jdn) : Converts the Julian Day Number to a date in the Jalaali calendar, _(*16)

g2d($gy, $gm, $gd) : Calculates the Julian Day number from Gregorian or Julian calendar dates, _(*17)

d2g($jdn) : Calculates Gregorian and Julian calendar dates from the Julian Day number, _(*18)