/ 
Calendar-Hijri-0.01
River stage one • 1 direct dependent • 1 total dependent
/ Calendar::Hijri

NAME

Calendar::Hijri - Interface to Islamic calendar (Hijri).

VERSION

Version 0.01

SYNOPSIS

Hijri Calendar begins with the migration from Mecca to Medina of Mohammad, the Prophet of Islam, an event known as the Hegira. The initials A.H. before a date mean "anno Hegirae" or "after Hegira". The first day of the year is fixed in the Quran as the first day of the month of Muharram. In 17 AH Umar I, the second caliph, established the beginning of the era of the Hegira (1 Muharram 1 AH) as the date that is 16 July 622 CE in the Julian Calendar.

The years are lunar and consist of 12 lunar months. There is no intercalary period, since the Quran (Sura IX, verses 36,37) sets the calendar year at 12 months. Because the year in the Hijri calendar is shorter than a solar year, the months drift with respect to the seasons, in a cycle 32.50 years.

NOTE: The Hijri date produced by this module can have +1/-1 day error.

Month Names

-----------------------------
| Number |    Name          |
-----------------------------
|   1    |  Muharram        |
|   2    |  Safar           |
|   3    |  Rabi' al-awwal  |
|   4    |  Rabi' al-thani  |
|   5    |  Jumada al-awwal |
|   6    |  Jumada al-thani |  
|   7    |  Rajab           |
|   8    |  Sha'aban        |
|   9    |  Ramadan         |
|  10    |  Shawwal         |
|  11    |  Dhu al-Qi'dah   |
|  12    |  Dhu al-Hijjah   |
-----------------------------

METHODS

today()

Return today's date is Hijri Calendar as list in the format yyyy,mm,dd.

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new();
my ($yyyy, $mm, $dd) = $calendar->today();
print "Year [$yyyy] Month [$mm] Day [$dd]\n";

as_string()

Return Hijri date in human readable format.

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new(1432, 7, 27);
print "Hijri date is " . $calendar->as_string() . "\n";

is_leap_year()

Return 1 or 0 depending on whether the given year is a leap year or not in Hijri Calendar.

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new(1432, 7, 27);
($calendar->is_leap_year())
?
(print "YES Leap Year\n")
:
(print "NO Leap Year\n");

days_in_year()

Returns the number of days in the given year of Hijri Calendar.

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new(1432, 7, 27);
print "Total number of days in year 1432: " . $calendar->days_in_year() . "\n";

days_in_year_month

Return number of days in the given year and month of Hijri Calendar.

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new(1432,7,26);
print "Days is Rajab   1432: [" . $calendar->days_in_year_month() . "]\n";

print "Days is Shawwal 1432: [" . $calendar->days_in_year_month(1432, 8) . "]\n";

days_up_until_year_month(yyyy, mm)

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new(1432, 7, 27);
print "Total number of days up until Rajab 1432: " . $calendar->days_up_until_year_month() . "\n";

add_day()

Returns new date in Hijri Calendar after adding the given number of day(s) to the original date.

my $calendar = Calendar::Hijri->new(1432, 7, 27);
print "Hijri Date 1:" . $calendar->as_string() . "\n";
$calendar->add_day(2);
print "Hijri Date 2:" . $calendar->as_string() . "\n";

get_calendar()

Return Hijri Calendar for the given month and year. In case of missing month and year, it would return current month Hijri Calendar.

use strict; use warnings;
use Calendar::Hijri;

my $calendar = Calendar::Hijri->new(1432, 7, 27);
print $calendar->get_calendar();

AUTHOR

Mohammad S Anwar, <mohammad.anwar at yahoo.com>

BUGS

Please report any bugs or feature requests to bug-calendar-hijri at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Calendar-Hijri. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Calendar::Hijri

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2011 Mohammad S Anwar.

This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.

See http://dev.perl.org/licenses/ for more information.

DISCLAIMER

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.