Download the PHP package bahaicalendar/badical without Composer
On this page you can find all versions of the php package bahaicalendar/badical. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download bahaicalendar/badical
More information about bahaicalendar/badical
Files in bahaicalendar/badical
Package badical
Short Description Library to convert between Gregorian and Badi calendars.
License MIT
Informations about the package badical
BadiCalPHP
Library to convert between Gregorian and Badi / Bahai calendars.
Previously at BadiCal but that repo is being split into individual languages in the BahaiCalendar group.
There are currently versions for:
- PHP (this)
- Javascript
As the Badi date starts at sunset, every conversion has two possibilities. Converting from Gregorian to Badi, you can get either the Badi date before sunset or after sunset for that Gregorian day; the former is the default. Converting from Badi to Gregorian, you can get either the Gregorian date before midnight or after midnight; the default is the latter.
For example, 2015-03-21 (Gregorian) converts to the end of 172-01-01 (Badi: Bahá 1, 172 ie. Naw Ruz) as the default, and optionally to the start of 172-01-02 (Badi). Consequently, 172-01-01 (Badi) converts to the start of 2015-03-21 (Gregorian) as the defauls, and optionally as the end of 2015-03-20 (Gregorian).
The default is always the daytime conversion.
The library uses precalculated NawRuz dates from http://wilmetteinstitute.org/wp-content/uploads/2014/11/Bahai-Dates-172-to-221-B-E-_UK-December-2014.pdf . Please report any errors (see BadiCal.NAWRUZ).
Loading
If not using Composer, you can autoload all classes by requiring the load.php file at the root of this repo.
Usage
The usage is currently extremely simple. There are two static conversion functions which return \BahaiCalendar\BadiCal\Date objects.
Gregorian to Badi
\BahaiCalendar\BadiCal\Convert::GregorianToBadi
- @param year - the Gregorian year
- @param month - the Gregorian month
- @param date - the Gregorian date
- @param startOf - [OPTIONAL, default=FALSE] whether the returned date is the Badi date ending on (TRUE, evening) or starting on (FALSE, daytime) this Gregorian date.
Which outputs:
Badi to Gregorian
\BahaiCalendar\BadiCal\Convert::BadiToGregorian
- @param year - the Badi year
- @param month - the Badi month
- @param date - the Badi date
- @param startsOn - [OPTIONAL, default=FALSE] whether the returned date is the Gregorian date that starts on (TRUE, evening) or ends on (FALSE, daytime) this Badi date.
Which outputs:
Date object
The \BahaiCalendar\BadiCal\Date class has the following:
Methods
year($formatted) @param bool formatted - [OPTIONAL, default=false] will pad the output with a zero @return the year
month($formatted) @param bool formatted - [OPTIONAL, default=false] will pad the output with a zero @return the month
monthName() @return the name of the month according to the appropriate calendar
day($formatted) @param bool formatted - [OPTIONAL, default=false] will pad the output with a zero @return the day
Properties
type Either \BahaiCalendar\BadiCal\Date::GREGORIAN ('GREGORIAN') or \BahaiCalendar\BadiCal\Date::BADI ('BADI')
Static Values / Methods
\BahaiCalendar\BadiCal\Date::GREGORIAN: 'GREGORIAN', used for the Date->type
\BahaiCalendar\BadiCal\Date::BADI: 'BADI', used for the Date->type
\BahaiCalendar\BadiCal\Date::BADI_MONTHS: Array with names for Badi Calendar months (zero based). Includes Ayyam-i-Há.
\BahaiCalendar\BadiCal\Convert::getAyyamiha($badi_year): @param badi_year - The year in the Badi calendar @return \BahaiCalendar\BadiCal\Date
Testing
You must have the BadiTest repository to test the library. Simple use test.php to run a test group from BadiTest by specifying the path to the test group file, like:
Which currently results in: