Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jonasbn/perl-date-holidays-super
Release history of Date-Holidays-Super
https://github.com/jonasbn/perl-date-holidays-super
cpan date-holidays hacktoberfest perl perl5
Last synced: 2 months ago
JSON representation
Release history of Date-Holidays-Super
- Host: GitHub
- URL: https://github.com/jonasbn/perl-date-holidays-super
- Owner: jonasbn
- License: other
- Created: 2014-07-31T19:05:36.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-10-28T18:43:55.000Z (2 months ago)
- Last Synced: 2024-10-28T19:46:55.732Z (2 months ago)
- Topics: cpan, date-holidays, hacktoberfest, perl, perl5
- Language: Perl
- Homepage: http://search.cpan.org/dist/Date-Holidays-Super/
- Size: 166 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: Changes
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
[](https://metacpan.org/pod/Date::Holidays::Super)
[](https://github.com/jonasbn/perl-date-holidays-super/actions/workflows/ci.yml)
[](https://coveralls.io/github/jonasbn/Date-Holidays-Super?branch=master)
# NAME
Date::Holidays::Super - a SUPER class for the Date::Holidays::\* modules
# SYNOPSIS
package MyHolidays;
use Date::Holidays::Super;
use vars qw(@ISA);
@ISA = qw(Date::Holidays::Super);
my $mh = MyHolidays->new();
my $bool = $mh->is_holiday( ... );
my $hashref = $mh->holidays( ... );
# VERSION
This POD described version 0.03 of Date::Holidays::Super
# DESCRIPTION
This is a SUPER class intended for use by Date::Holidays::\* modules.
The goal is to have all the existing and future modules implement the
same methods, so they will have a uniform usage and can be used in
polymorphic context or can be easily adapted into the Date::Holidays
class.
The class provides two methods: **is\_holiday** and **holidays** an
alternative to this class is Date::Holidays::Abstract, which does not
implement these methods, but require that they are implemented.
If you want to use Date::Holidays::Super and want to comply with my
suggestions to the methods that ought to be implemented, you should
overload the methods provided by this class, when and if you have the
time in your Date::Holidays::\* module.
- is\_holiday
- holidays
# SUBROUTINES/METHODS
## is\_holiday
Should at least take 3 arguments:
- year, four digits
- month, between 1-12
- day, between 1-31
The return value from is holiday is either a 1 or 0 indicating true of
false, indicating whether the specified date is a holiday in the given
country's national calendar.
**is\_holiday** in the SUPER class returns 0 indicating false, since
nothing intelligent can be said about holidays without specifying a
national calendar.
Additional arguments are at the courtesy of the author of the using
module/class.
## holidays
Should at least take one argument:
- year, four digits
Returns a reference to a hash, where the keys are date represented as
four digits. The two first representing month (01-12) and the last two
representing day (01-31).
The value for the key in question is the local name for the holiday
indicated by the day. The result set will of course vary depending on
the given country's national holiday.
**holidays** in the SUPER class return a reference to an empty hash,
since nothing intelligent can be said about holidays without specifying
a national calendar.
Additional arguments are at the courtesy of the author of the using
module/class.
\--
[Date::Holidays](https://metacpan.org/pod/Date%3A%3AHolidays) uses the requirements defined by this module and this
module can therefor be used with success in conjunction with this.
This is an alternative to the abstract class [Date::Holidays::Abstract](https://metacpan.org/pod/Date%3A%3AHolidays%3A%3AAbstract).
Suggestions for changes and extensions are more than welcome.
# DIAGNOSTICS
No special exceptions/diagnostics are used at this time.
# CONFIGURATION AND ENVIRONMENT
No special configuration and/or environment required
# DEPENDENCIES
No dependencies at this time
# INCOMPATIBILITIES
No known incompatibilities at this time
# BUGS AND LIMITATIONS
Please report issues via GitHub:
- [GitHub Issues](https://github.com/jonasbn/perl-date-holidays-super/issues)
# SEE ALSO
- [Date::Holidays::Abstract](https://metacpan.org/pod/Date%3A%3AHolidays%3A%3AAbstract)
- [Date::Holidays](https://metacpan.org/pod/Date%3A%3AHolidays)
- Date::Holidays::\*
# AUTHOR
- Jonas Brømsø, (jonasbn) - ``
# LICENSE AND COPYRIGHT
Date-Holidays-Super is (C) by Jonas Brømsø, (jonasbn) 2004-2021
Date-Holidays-Super is released under the Artistic License 2.0