1 package Koha::Calendar;
8 use DateTime::Duration;
14 my ( $classname, %options ) = @_;
16 bless $self, $classname;
17 for my $o_name ( keys %options ) {
19 $self->{$o} = $options{$o_name};
21 if ( exists $options{TEST_MODE} ) {
25 if ( !defined $self->{branchcode} ) {
26 croak 'No branchcode argument passed to Koha::Calendar->new';
34 my $branch = $self->{branchcode};
35 my $dbh = C4::Context->dbh();
36 my $repeat_sth = $dbh->prepare(
37 'SELECT * from repeatable_holidays WHERE branchcode = ? AND ISNULL(weekday) = ?'
39 $repeat_sth->execute( $branch, 0 );
40 $self->{weekly_closed_days} = [ 0, 0, 0, 0, 0, 0, 0 ];
41 Readonly::Scalar my $sunday => 7;
42 while ( my $tuple = $repeat_sth->fetchrow_hashref ) {
43 $self->{weekly_closed_days}->[ $tuple->{weekday} ] = 1;
45 $repeat_sth->execute( $branch, 1 );
46 $self->{day_month_closed_days} = {};
47 while ( my $tuple = $repeat_sth->fetchrow_hashref ) {
48 $self->{day_month_closed_days}->{ $tuple->{day} }->{ $tuple->{month} } =
51 my $special = $dbh->prepare(
52 'SELECT day, month, year, title, description FROM special_holidays WHERE ( branchcode = ? ) AND (isexception = ?)'
54 $special->execute( $branch, 1 );
56 while ( my ( $day, $month, $year, $title, $description ) =
57 $special->fetchrow ) {
63 time_zone => C4::Context->tz()
64 )->truncate( to => 'day' );
66 $self->{exception_holidays} =
67 DateTime::Set->from_datetimes( dates => $dates );
68 $special->execute( $branch, 1 );
70 while ( my ( $day, $month, $year, $title, $description ) =
71 $special->fetchrow ) {
77 time_zone => C4::Context->tz()
78 )->truncate( to => 'day' );
80 $self->{single_holidays} = DateTime::Set->from_datetimes( dates => $dates );
81 $self->{days_mode} = C4::Context->preference('useDaysMode');
86 my ( $self, $base_date, $add_duration, $unit ) = @_;
87 if ( ref $add_duration ne 'DateTime::Duration' ) {
88 $add_duration = DateTime::Duration->new( days => $add_duration );
90 my $days_mode = $self->{days_mode};
91 Readonly::Scalar my $return_by_hour => 10;
92 my $day_dur = DateTime::Duration->new( days => 1 );
93 if ( $add_duration->is_negative() ) {
96 if ( $days_mode eq 'Datedue' ) {
98 my $dt = $base_date + $add_duration;
99 while ( $self->is_holiday($dt) ) {
101 # TODOP if hours set to 10 am
102 $dt->add_duration($day_dur);
103 if ( $unit eq 'hours' ) {
104 $dt->set_hour($return_by_hour); # Staffs specific
108 } elsif ( $days_mode eq 'Calendar' ) {
109 if ( $unit eq 'hours' ) {
110 $base_date->add_duration($add_duration);
111 while ( $self->is_holiday($base_date) ) {
112 $base_date->add_duration($day_dur);
117 my $days = $add_duration->in_units('days');
119 $base_date->add_duration($day_dur);
120 if ( $self->is_holiday($base_date) ) {
127 if ( $unit eq 'hours' ) {
128 my $dt = $base_date->clone()->subtract( days => 1 );
129 if ( $self->is_holiday($dt) ) {
130 $base_date->set_hour($return_by_hour); # Staffs specific
135 return $base_date + $add_duration;
140 my ( $self, $dt ) = @_;
141 my $dow = $dt->day_of_week;
145 if ( $self->{weekly_closed_days}->[$dow] == 1 ) {
148 $dt->truncate( to => 'days' );
150 my $month = $dt->month;
151 if ( exists $self->{day_month_closed_days}->{$month}->{$day} ) {
154 if ( $self->{exception_holidays}->contains($dt) ) {
157 if ( $self->{single_holidays}->contains($dt) ) {
161 # damn have to go to work after all
167 my $start_dt = shift;
169 $start_dt->truncate( to => 'hours' );
170 $end_dt->truncate( to => 'hours' );
172 # start and end should not be closed days
173 my $duration = $end_dt - $start_dt;
174 $start_dt->truncate( to => 'days' );
175 $end_dt->truncate( to => 'days' );
176 while ( DateTime->compare( $start_dt, $end_dt ) == -1 ) {
177 $start_dt->add( days => 1 );
178 if ( $self->is_holiday($start_dt) ) {
179 $duration->subtract( days => 1 );
188 $self->{weekly_closed_days} = [ 1, 0, 0, 0, 0, 0, 0 ]; # Sunday only
189 $self->{day_month_closed_days} = { 6 => { 16 => 1, } };
191 $self->{exception_holidays} =
192 DateTime::Set->from_datetimes( dates => $dates );
193 my $special = DateTime->new(
197 time_zone => 'Europe/London',
199 push @{$dates}, $special;
200 $self->{single_holidays} = DateTime::Set->from_datetimes( dates => $dates );
201 $self->{days_mode} = 'Calendar';
210 Koha::Calendar - Object containing a branches calendar
214 This documentation refers to Koha::Calendar version 0.0.1
220 my $c = Koha::Calender->new( branchcode => 'MAIN' );
221 my $dt = DateTime->now();
224 $open = $c->is_holiday($dt);
225 # when will item be due if loan period = $dur (a DateTime::Duration object)
226 $duedate = $c->addDate($dt,$dur,'days');
231 Implements those features of C4::Calendar needed for Staffs Rolling Loans
235 =head2 new : Create a calendar object
237 my $calendar = Koha::Calendar->new( branchcode => 'MAIN' );
239 The option branchcode is required
244 my $dt = $calendar->addDate($date, $dur, $unit)
246 C<$date> is a DateTime object representing the starting date of the interval.
248 C<$offset> is a DateTime::Duration to add to it
250 C<$unit> is a string value 'days' or 'hours' toflag granularity of duration
252 Currently unit is only used to invoke Staffs return Monday at 10 am rule this
253 parameter will be removed when issuingrules properly cope with that
258 $yesno = $calendar->is_holiday($dt);
260 passed at DateTime object returns 1 if it is a closed day
261 0 if not according to the calendar
265 $duration = $calendar->days_between($start_dt, $end_dt);
267 Passed two dates returns a DateTime::Duration object measuring the length between them
272 Will croak if not passed a branchcode in new
274 =head1 BUGS AND LIMITATIONS
276 This only contains a limited subset of the functionality in C4::Calendar
277 Only enough to support Staffs Rolling loans
281 Colin Campbell colin.campbell@ptfs-europe.com
283 =head1 LICENSE AND COPYRIGHT
285 Copyright (c) 2011 PTFS-Europe Ltd All rights reserved
287 This program is free software: you can redistribute it and/or modify
288 it under the terms of the GNU General Public License as published by
289 the Free Software Foundation, either version 2 of the License, or
290 (at your option) any later version.
292 This program is distributed in the hope that it will be useful,
293 but WITHOUT ANY WARRANTY; without even the implied warranty of
294 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
295 GNU General Public License for more details.
297 You should have received a copy of the GNU General Public License
298 along with this program. If not, see <http://www.gnu.org/licenses/>.