Richard Clamp > Date-Holidays-UK-0.01 > Date::Holidays::UK

Download:
Date-Holidays-UK-0.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  1
View/Report Bugs
Module Version: 0.01   Source  

NAME ^

Date::Holidays::UK - Determine UK Public Holidays

SYNOPSIS ^

  use Date::Holidays::UK;
  my ($year, $month, $day) = (localtime)[ 5, 4, 3 ];
  $year  += 1900;
  $month += 1;
  print "Woohoo" if is_uk_holiday( $year, $month, $day );

DESCRIPTION ^

Naming modules is a tricky thing, especially when similar modules already exist. The awkwardness can be further excaberated when the similar modules don't have consistent apis.

In this case we started by contrasting Date::Japanese::Holiday and Date::Holidays::DE. We've crossed the streams by taking the simple is_*_holiday interface from Date::Japanese::Holiday, and taken the Date::Holidays::<country> convention from Date::Holidays::DE. We hope nothing explodes.

SUBROUTINES ^

is_uk_holiday( $year, $month, $day )

Returns the name of the Holiday that falls on the given day, or undef if there is none.

Holiday Data ^

The DTI's webpage http://www.dti.gov.uk/er/bankhol.htm is taken as the canonical source for bank holidays.

CAVEATS ^

We only currently contain the DTI bank holiday detail, which at the time of writing only covers the years 2004-2007.

AUTHOR ^

Richard Clamp <richardc@fotango.com>, Amelie Guyot, Jerome Parfant.

COPYRIGHT ^

Copyright 2004 Fotango. All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

BUGS ^

None known.

Bugs should be reported to me via the CPAN RT system. http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Date::Holidays::UK.

SEE ALSO ^

Date::Holidays::DE, Date::Japanese::Holiday

syntax highlighting: