.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man v6.0.2 (Pod::Simple 3.45)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Required to disable full justification in groff 1.23.0.
.if n .ds AD l
.\" ========================================================================
.\"
.IX Title "WeekCalculator 3pm"
.TH WeekCalculator 3pm 2025-09-28 "Lire 2.1.1" "LogReport's Lire Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Lire::WeekCalculator \- handle different weeknumbering schemes
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    use Lire::WeekCalculator;
\&
\&    my $week_calc = new Lire::WeekCalculator();
\&    my $week_no   = $week_calc\->week_number( $time );
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
We support three values for LR_WEEK_NUMBERING: ISO (strftime\*(Aqs \f(CW%V\fR):
week starts on monday; W (week starts on monday) and U (week starts on
sunday). See \fBstrftime\fR\|(1).
.SH CONSTRUCTOR
.IX Header "CONSTRUCTOR"
.ie n .SS "new( %params )"
.el .SS "new( \f(CW%params\fP )"
.IX Subsection "new( %params )"
Creates a new week calculator. The style of week numbering is selected
using the \f(CW\*(C`style\*(C'\fR parameter. If that parameter is omitted, it
defaults to the style set in \*(Aqlr_week_numbering\*(Aq configuration variable.
.SS \fBstyle()\fP
.IX Subsection "style()"
Returns the week numbering style used. This will be either \f(CW\*(C`U\*(C'\fR, \f(CW\*(C`W\*(C'\fR
or \f(CW\*(C`ISO\*(C'\fR.
.ie n .SS "week_number( $time )"
.el .SS "week_number( \f(CW$time\fP )"
.IX Subsection "week_number( $time )"
Returns the week number of \f(CW$time\fR according the current week numbering
scheme. The week number returned is between 1 and 53.
.ie n .SS "week_idx( $time )"
.el .SS "week_idx( \f(CW$time\fP )"
.IX Subsection "week_idx( $time )"
Returns the week index of \f(CW$time\fR 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 \fBweek_number()\fR \- 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.
.SS last_week_of_year($year)
.IX Subsection "last_week_of_year($year)"
Returns the week number of the last week in the year \f(CW$year\fR.
.ie n .SS "week_start( $year, $week_no )"
.el .SS "week_start( \f(CW$year\fP, \f(CW$week_no\fP )"
.IX Subsection "week_start( $year, $week_no )"
Returns the epoch time of the first day of week \f(CW$week_no\fR in year \f(CW$year\fR
when calculated using current style.
.SS find_year_week1_start_date($year)
.IX Subsection "find_year_week1_start_date($year)"
Returns the date (epoch) at which the first day of the first week
of the year \f(CW$year\fR starts.
.SS \fBstrformat()\fP
.IX Subsection "strformat()"
Returns a string that can be used as the format specificier in calls
to strftime to print the week number of this style.
.SS \fBstrfdate()\fP
.IX Subsection "strfdate()"
Emulates \fBPOSIX::strftime()\fR but picks up the \f(CW%V\fR if the system strftime
doesn\*(Aqt support it. Should be called whenever you use format strings
that may contain week\-of\-the\-year\-codes.
.SH AUTHORS
.IX Header "AUTHORS"
.Vb 3
\&  Joost van Baal <joostvb@logreport.org>,
\&  Francis J. Lacoste <flacoste@logreport.org>,
\&  Wessel Dankers <wsl@logreport.org>
.Ve
.SH VERSION
.IX Header "VERSION"
\&\f(CW$Id:\fR WeekCalculator.pm,v 1.16 2006/07/23 13:16:30 vanbaal Exp $
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (C) 2002 Stichting LogReport Foundation LogReport@LogReport.org
.PP
This file is part of Lire.
.PP
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.
.PP
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.
.PP
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.