Lee ♫ Goddard > Date-Holidays-UK-EnglandAndWales > Date::Holidays::UK::EnglandAndWales

Download:
Date-Holidays-UK-EnglandAndWales-0.03.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 0.03   Source  

NAME ^

Date::Holidays::UK::EnglandAndWales - Public Holidays in England and Wales

SYNOPSIS ^

  use Date::Holidays::UK::EnglandAndWales;
  my ($year, $month, $day) = (localtime)[ 5, 4, 3 ];
  $year  += 1900;
  $month += 1;
  warn "Holiday" if is_uk_holiday( $year, $month, $day );
  warn "Holiday" if Date::Holidays::UK::EnglandAndWales->is_holiday( $year, $month, $day );

DESCRIPTION ^

These bank and public holidays are holidays in England and Wales, and not necessarily for Scotland and Northern Ireland.

MODULE HISTORY

This module is based on Date::Holidays::UK by Richard Clamp, Amelie Guyot, Jerome Parfant, which did not contain the dates needed by my clients.

As Msrs Clamp et al note in the POD for their module, Naming modules is a tricky thing: I've named this EnglandAndWales because the UK module cannot include holidays for Northern Ireland and Scotland, and maintain its API, since the dates vary across the UK for events of the same name.

USE

is_uk_holiday( $year, $month, $day )

is_holiday( $year, $month, $day );

Date::Holidays::UK::EnglandAndWales->is_holiday( $year, $month, $day )

May be called as class method or subroutine. Returns the name of the Holiday that falls on the given day, or undef if there is none.

Year must be four-digit. Strips any leading zeros from month and day.

Can be included or imported to a class as an object method, since the first argument supplied is discarded if an reference.

EXPORTS

is_uk_holiday is exported by default, but this is deprecated and will be removed in a future version.

SOURCE ^

The DTI's webpage http://www.dti.gov.uk/employment/bank-public-holidays/index.html 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-2014.

These Bank and Public Holidays are holidays in England and Wales, and not necessarily in Scotland and Northern Ireland.

AUTHOR ^

Lee Goddard.

Simply an update of work by Richard Clamp <richardc@fotango.com>, Amelie Guyot, Jerome Parfant.

COPYRIGHT ^

Copyright (C) 2004 Fotango. All Rights Reserved. Copyright (C) 2007, 2011 Lee Goddard. 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 via the CPAN RT system. http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Date::Holidays::UK::EnglandAndWales.

SEE ALSO ^

Date::Holidays::UK

syntax highlighting: