Koha/Checkouts.pm

   1 package Koha::Checkouts;
   2
   3 # Copyright ByWater Solutions 2015
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22
  23 use C4::Context;
  24 use C4::Circulation qw( AddReturn );
  25 use Koha::Checkout;
  26 use Koha::Database;
  27 use Koha::DateUtils qw( dt_from_string );
  28
  29 use base qw(Koha::Objects);
  30
  31 =head1 NAME
  32
  33 Koha::Checkouts - Koha Checkout object set class
  34
  35 =head1 API
  36
  37 =head2 Class Methods
  38
  39 =cut
  40
  41 =head3 calculate_dropbox_date
  42
  43 my $dt = Koha::Checkouts::calculate_dropbox_date();
  44
  45 =cut
  46
  47 sub calculate_dropbox_date {
  48     my $userenv    = C4::Context->userenv;
  49     my $branchcode = $userenv->{branch} // q{};
  50
  51     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
  52         {
  53             categorycode => undef,
  54             itemtype     => undef,
  55             branchcode   => $branchcode,
  56         }
  57     );
  58     my $calendar     = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
  59     my $today        = dt_from_string;
  60     my $dropbox_date = $calendar->addDuration( $today, -1 );
  61
  62     return $dropbox_date;
  63 }
  64
  65 =head3 automatic_checkin
  66
  67 my $automatic_checkins = Koha::Checkouts->automatic_checkin()
  68
  69 Checks in every due issue which itemtype has automatic_checkin enabled
  70
  71 =cut
  72
  73 sub automatic_checkin {
  74     my ($self, $params) = @_;
  75
  76     my $current_date = dt_from_string;
  77
  78     my $dtf = Koha::Database->new->schema->storage->datetime_parser;
  79     my $due_checkouts = $self->search(
  80         { date_due => { '<=' => $dtf->format_datetime($current_date) } },
  81         { prefetch => 'item'}
  82     );
  83
  84     while ( my $checkout = $due_checkouts->next ) {
  85         if ( $checkout->item->itemtype->automatic_checkin ) {
  86             C4::Circulation::AddReturn( $checkout->item->barcode,
  87                 $checkout->branchcode, undef, dt_from_string($checkout->date_due) );
  88         }
  89     }
  90 }
  91
  92 =head3 type
  93
  94 =cut
  95
  96 sub _type {
  97     return 'Issue';
  98 }
  99
 100 =head3 object_class
 101
 102 =cut
 103
 104 sub object_class {
 105     return 'Koha::Checkout';
 106 }
 107
 108 =head1 AUTHOR
 109
 110 Kyle M Hall <kyle@bywatersolutions.com>
 111
 112 =cut
 113
 114 1;