NAME

Koha::Calendar - Object containing a branches calendar

SYNOPSIS

  use Koha::Calendar

  my $c = Koha::Calendar->new( branchcode => 'MAIN' );
  my $dt = dt_from_string();

  # are we open
  $open = $c->is_holiday($dt);
  # when will item be due if loan period = $dur (a DateTime::Duration object)
  $duedate = $c->addDuration($dt,$dur,'days');

DESCRIPTION

  Implements those features of C4::Calendar needed for Staffs Rolling Loans

METHODS

new : Create a calendar object

my $calendar = Koha::Calendar->new( branchcode => 'MAIN' );

The option branchcode is required

addDuration

    my $dt = $calendar->addDuration($date, $dur, $unit)

$date is a DateTime object representing the starting date of the interval.

$offset is a DateTime::Duration to add to it

$unit is a string value 'days' or 'hours' toflag granularity of duration

Currently unit is only used to invoke Staffs return Monday at 10 am rule this parameter will be removed when issuingrules properly cope with that

addHours

    my $dt = $calendar->addHours($date, $dur, $return_by_hour )

$date is a DateTime object representing the starting date of the interval.

$offset is a DateTime::Duration to add to it

$return_by_hour is an integer value representing the opening hour for the branch

get_push_amt

    my $amt = $calendar->get_push_amt($date)

$date is a DateTime object representing a closed return date

Using the days_mode syspref value and the nature of the closed return date, return how many days we should jump forward to find another return date

addDays

    my $dt = $calendar->addDays($date, $dur)

$date is a DateTime object representing the starting date of the interval.

$offset is a DateTime::Duration to add to it

$unit is a string value 'days' or 'hours' toflag granularity of duration

Currently unit is only used to invoke Staffs return Monday at 10 am rule this parameter will be removed when issuingrules properly cope with that

is_holiday

$yesno = $calendar->is_holiday($dt);

passed a DateTime object returns 1 if it is a closed day 0 if not according to the calendar

days_between

$duration = $calendar->days_between($start_dt, $end_dt);

Passed two dates returns a DateTime::Duration object measuring the length between them ignoring closed days. Always returns a positive number irrespective of the relative order of the parameters.

Note: This routine assumes neither the passed start_dt nor end_dt can be a closed day

hours_between

$duration = $calendar->hours_between($start_dt, $end_dt);

Passed two dates returns a DateTime::Duration object measuring the length between them ignoring closed days. Always returns a positive number irrespective of the relative order of the parameters.

Note: This routine assumes neither the passed start_dt nor end_dt can be a closed day

next_open_days

$datetime = $calendar->next_open_days($duedate_dt, $to_add)

Passed a Datetime and number of days, returns another Datetime representing the next open day after adding the passed number of days. It is intended for use to calculate the due date when useDaysMode syspref is set to either 'Datedue', 'Calendar' or 'Dayweek'.

prev_open_days

$datetime = $calendar->prev_open_days($duedate_dt, $to_sub)

Passed a Datetime and a number of days, returns another Datetime representing the previous open day after subtracting the number of passed days. It is intended for use to calculate the due date when useDaysMode syspref is set to either 'Datedue', 'Calendar' or 'Dayweek'.

days_forward

$datetime = $calendar->days_forward($start_dt, $to_add)

set_daysmode

For testing only allows the calling script to change days mode

clear_weekly_closed_days

In test mode changes the testing set of closed days to a new set with no closed days. TODO passing an array of closed days to this would allow testing of more configurations

add_holiday

Passed a datetime object this will add it to the calendar's list of closed days. This is for testing so that we can alter the Calenfar object's list of specified dates

DIAGNOSTICS

Will croak if not passed a branchcode in new

BUGS AND LIMITATIONS

This only contains a limited subset of the functionality in C4::Calendar Only enough to support Staffs Rolling loans

AUTHOR

Colin Campbell colin.campbell@ptfs-europe.com

LICENSE AND COPYRIGHT

Koha 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 3 of the License, or (at your option) any later version.

Koha 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 Koha; if not, see <http://www.gnu.org/licenses>.