man Lire::WeekCalculator () - handle different weeknumbering schemes

NAME

Lire::WeekCalculator - handle different weeknumbering schemes

SYNOPSIS

    use Lire::WeekCalculator;


    my $week_calc = new Lire::WeekCalculator();
    my $week_no   = $week_calc->week_number( $time );

DESCRIPTION

We support three values for LR_WEEK_NUMBERING: ISO (strftime's CW%V): week starts on monday; W (week starts on monday) and U (week starts on sunday). See strftime(1).

CONSTRUCTOR

Creates a new week calculator. The style of week numbering is selected using the CWstyle parameter. If that parameter is omitted, it defaults to the style set in 'lr_week_numbering' configuration variable.

style()

Returns the week numbering style used. This will be either CWU, CWW or CWISO. Returns the week number of CW$time according the current week numbering scheme. The week number returned is between 1 and 53. Returns the week index of CW$time according to the week numbering scheme. The week index is Lire specific and is used to normalise computations between different scheme in regards of the first incomplete week of the year. In the ISO case, the week index is always equals to week_number() - 1, for the other style, the week index of the week 0 will be one less than the last week number of the previous year.

last_week_of_year($year)

Returns the week number of the last week in the year CW$year. Returns the epoch time of the first day of week CW$week_no in year CW$year when calculated using current style.

find_year_week1_start_date($year)

Returns the date (epoch) at which the first day of the first week of the year CW$year starts.

strformat()

Returns a string that can be used as the format specificier in calls to strftime to print the week number of this style.

strfdate()

Emulates POSIX::strftime() but picks up the CW%V if the system strftime doesn't support it. Should be called whenever you use format strings that may contain week-of-the-year-codes.

AUTHORS

  Joost van Baal <joostvb@logreport.org>,
  Francis J. Lacoste <flacoste@logreport.org>,
  Wessel Dankers <wsl@logreport.org>

VERSION

$Id: WeekCalculator.pm,v 1.15 2004/07/02 00:42:44 flacoste Exp $

COPYRIGHT

Copyright (C) 2002 Stichting LogReport Foundation LogReport@LogReport.org

This file is part of Lire.

Lire is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

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. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program (see COPYING); if not, check with http://www.gnu.org/copyleft/gpl.html or write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111, USA.