NAME

Date::Hebrew::Simple - Represents Hebrew date.

VERSION

Version 0.12

DESCRIPTION

Represents the Hebrew date.

SYNOPSIS

    use strict; use warnings;
    use Date::Hebrew::Simple;

    # prints today's Hebrew date.
    print Date::Hebrew::Simple->new, "\n";

    my $date = Date::Hebrew::Simple->new({ year => 5778, month => 11, day => 1 });

    # prints the given Hebrew date
    print $date->as_string, "\n";

    # prints the equivalent Julian day
    print $date->to_julian, "\n";

    # prints the equivalent Gregorian date
    print sprintf("%04d-%02d-%02d", $date->to_gregorian), "\n";

    # prints day of the week index (0 for Yom Rishon, 1 for Yom Sheni and so on).
    print $date->day_of_week, "\n";

    # prints the Hebrew date equivalent of the Gregorian date (2018-02-12).
    print $date->from_gregorian(2018, 02, 12), "\n";

    # prints the Hebrew date equivalent of the Julian day (2458134.5).
    print $date->from_julian(2458134.5), "\n";

METHODS

to_julian()

Returns julian day equivalent of the Hebrew date.

from_julian($julian_day)

Returns Hebrew date as an object of type Date::Hebrew::Simple equivalent of the the Julian date $julian_day.

to_gregorian()

Returns gregorian date as list (yyyy,mm,dd) equivalent of the Hebrew date.

from_gregorian($year, $month, $day)

Returns Hebrew date as an object of type Date::Hebrew::Simple equivalent of the given Gregorian date $year, $month and $day.

day_of_week()

Returns day of the week, starting 0 for Yom Rishon, 1 for Yom Sheni and so on.

    +-------+---------------+---------------------------------------------------+
    | Index | Hebrew Name   | English Name                                      |
    +-------+---------------+---------------------------------------------------+
    |     0 | Yom Rishon    | Sunday                                            |
    |     1 | Yom Sheni     | Monday                                            |
    |     2 | Yom Shelishi  | Tuesday                                           |
    |     3 | Yom Revil     | Wednesday                                         |
    |     4 | Yom Hamishi   | Thursday                                          |
    |     5 | Yom Shishi    | Friday                                            |
    |     6 | Shabbat       | Saturday                                          |
    +-------+---------------+---------------------------------------------------+

is_leap_year($year)

Returns 0 or 1 if the given Hebrew year $year is a leap year or not.

AUTHOR

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

REPOSITORY

https://github.com/manwar/Date-Hebrew-Simple

SEE ALSO

Date::Bahai::Simple
Date::Gregorian::Simple
Date::Hijri::Simple
Date::Persian::Simple
Date::Saka::Simple

BUGS

Please report any bugs / feature requests to bug-date-hebrew-simple at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Date-Hebrew-Simple. 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 Date::Hebrew::Simple

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright (C) 2017 Mohammad S Anwar.

This program is free software; you can redistribute it and / or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License.By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you,you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement,then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.