Koha/CurbsidePickups.pm

   1 package Koha::CurbsidePickups;
   2
   3 # This file is part of Koha.
   4 #
   5 # Koha is free software; you can redistribute it and/or modify it
   6 # under the terms of the GNU General Public License as published by
   7 # the Free Software Foundation; either version 3 of the License, or
   8 # (at your option) any later version.
   9 #
  10 # Koha is distributed in the hope that it will be useful, but
  11 # WITHOUT ANY WARRANTY; without even the implied warranty of
  12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13 # GNU General Public License for more details.
  14 #
  15 # You should have received a copy of the GNU General Public License
  16 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  17
  18 use Modern::Perl;
  19
  20 use Carp;
  21
  22 use Koha::Database;
  23 use Koha::DateUtils qw( dt_from_string );
  24
  25 use Koha::CurbsidePickup;
  26
  27 use base qw(Koha::Objects);
  28
  29 =head1 NAME
  30
  31 Koha::CurbsidePickups - Koha Curbside Pickup Object set class
  32
  33 =head1 API
  34
  35 =head2 Class Methods
  36
  37 =cut
  38
  39 =head3 filter_by_to_be_staged
  40
  41 Filter by pickups that have not been staged yet
  42
  43 =cut
  44
  45 sub filter_by_to_be_staged {
  46     my ($self) = @_;
  47     return $self->search( { staged_datetime => undef } );
  48 }
  49
  50 =head3 filter_by_staged_and_ready
  51
  52 Filter by pickups that have been staged and are ready
  53
  54 =cut
  55
  56 sub filter_by_staged_and_ready {
  57     my ($self) = @_;
  58     return $self->search(
  59         { staged_datetime => { -not => undef }, arrival_datetime => undef } );
  60 }
  61
  62 =head3 filter_by_patron_outside
  63
  64 Filter by pickups with patrons waiting outside
  65
  66 =cut
  67
  68 sub filter_by_patron_outside {
  69     my ($self) = @_;
  70     return $self->search(
  71         { arrival_datetime => { -not => undef }, delivered_datetime => undef }
  72     );
  73 }
  74
  75 =head3 filter_by_delivered
  76
  77 Filter by pickups that have been delivered already
  78
  79 =cut
  80
  81 sub filter_by_delivered {
  82     my ($self) = @_;
  83     return $self->search( { delivered_datetime => { -not => undef } } );
  84 }
  85
  86 =head3 filter_by_scheduled_today
  87
  88 Filter by pickups that are scheduled today
  89
  90 =cut
  91 sub filter_by_scheduled_today {
  92     my ($self) = @_;
  93     my $dtf  = Koha::Database->new->schema->storage->datetime_parser;
  94     return $self->search( { scheduled_pickup_datetime => { '>' => $dtf->format_date(dt_from_string) } } );
  95 }
  96
  97 =head2 Internal Methods
  98
  99 =cut
 100
 101 =head3 _type
 102
 103 =cut
 104
 105 sub _type {
 106     return 'CurbsidePickup';
 107 }
 108
 109 =head3 object_class
 110
 111 =cut
 112
 113 sub object_class {
 114     return 'Koha::CurbsidePickup';
 115 }
 116
 117 1;