1 package Koha::Acquisition::Orders;
3 # This file is part of Koha.
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.
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.
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>.
23 use Koha::DateUtils qw( dt_from_string );
24 use Koha::Acquisition::Order;
27 use base qw(Koha::Objects);
31 Koha::Acquisition::Orders object set class
37 =head3 filter_by_lates
39 my $late_orders = $orders->filter_by_lates($params);
41 Filter an order set given different parameters.
43 This is the equivalent method of the former GetLateOrders C4 subroutine
49 =item C<delay> the number of days the basket has been closed
51 =item C<bookseller_id> the bookseller id
53 =item C<estimated_from> Beginning of the estimated delivery date
55 =item C<estimated_to> End of the estimated delivery date
62 my ( $self, $params ) = @_;
63 my $delay = $params->{delay};
64 my $bookseller_id = $params->{bookseller_id};
65 # my $branchcode = $params->{branchcode}; # FIXME do we really need this
66 my $estimated_from = $params->{estimated_from};
67 my $estimated_to = $params->{estimated_to};
68 my $dtf = Koha::Database->new->schema->storage->datetime_parser;
70 my @delivery_time_conditions;
71 my $date_add = "DATE_ADD(basketno.closedate, INTERVAL COALESCE(booksellerid.deliverytime, booksellerid.deliverytime, 0) day)";
72 my @estimated_delivery_time_conditions;
73 if ( defined $estimated_from or defined $estimated_to ) {
74 push @delivery_time_conditions, \[ "$date_add IS NOT NULL" ];
75 push @delivery_time_conditions, \[ "estimated_delivery_date IS NULL" ];
76 push @estimated_delivery_time_conditions, \[ "estimated_delivery_date IS NOT NULL" ];
78 if ( defined $estimated_from ) {
79 push @delivery_time_conditions, \[ "$date_add >= ?", $dtf->format_date($estimated_from) ];
80 push @estimated_delivery_time_conditions, \[ "estimated_delivery_date >= ?", $dtf->format_date($estimated_from) ];
82 if ( defined $estimated_to ) {
83 push @delivery_time_conditions, \[ "$date_add <= ?", $dtf->format_date($estimated_to) ];
84 push @estimated_delivery_time_conditions, \[ "estimated_delivery_date <= ?", $dtf->format_date($estimated_to) ];
86 if ( defined $estimated_from and not defined $estimated_to ) {
87 push @delivery_time_conditions, \[ "$date_add <= ?", $dtf->format_date(dt_from_string) ];
88 push @estimated_delivery_time_conditions, \[ "estimated_delivery_date <= ?", $dtf->format_date(dt_from_string) ];
94 { datereceived => undef },
95 quantityreceived => { '<' => \'quantity' }
97 'basketno.closedate' => [
103 '<=' => $dtf->format_date(
104 dt_from_string->subtract( days => $delay )
110 'datecancellationprinted' => undef,
113 ? ( 'basketno.booksellerid' => $bookseller_id )
117 # ( $branchcode ? ('borrower.branchcode')) # FIXME branch is not a filter we may not need to implement this
119 ( ( @delivery_time_conditions and @estimated_delivery_time_conditions ) ?
122 -and => \@estimated_delivery_time_conditions,
123 -and => \@delivery_time_conditions
129 C4::Context->preference('IndependentBranches')
130 && !C4::Context->IsSuperLibrarian
131 ? ( 'borrower.branchcode' => C4::Context->userenv->{branch} )
135 ( orderstatus => { '!=' => 'cancelled' } ),
140 \"DATE_ADD(basketno.closedate, INTERVAL COALESCE(booksellerid.deliverytime, booksellerid.deliverytime, 0) day)",
143 calculated_estimated_delivery_date
145 join => { 'basketno' => 'booksellerid' },
146 prefetch => {'basketno' => 'booksellerid'},
151 =head3 filter_by_active
153 my $new_rs = $orders->filter_by_active;
155 Returns a new resultset filtering orders that are not active.
159 sub filter_by_active {
161 return $self->search(
164 { 'basket.is_standing' => 1,
165 'orderstatus' => [ 'new', 'ordered', 'partial' ] },
166 { 'orderstatus' => [ 'ordered', 'partial' ] }
173 =head3 filter_by_current
175 $orders->filter_by_current
177 Return the orders of the set that have not been cancelled.
181 sub filter_by_current {
183 return $self->search(
185 datecancellationprinted => undef,
190 =head3 filter_by_cancelled
192 $orders->filter_by_cancelled
194 Return the orders of the set that have been cancelled.
198 sub filter_by_cancelled {
200 return $self->search(
202 datecancellationprinted => { '!=' => undef }
207 =head3 filter_by_id_including_transfers
209 my $orders = $orders->filter_by_id_including_transfers(
211 ordernumber => $ordernumber
215 When searching for orders by I<ordernumber>, include the aqorders_transfers table
216 so we can find orders that have changed their ordernumber as the result of a transfer
220 sub filter_by_id_including_transfers {
221 my ( $self, $params ) = @_;
223 Koha::Exceptions::MissingParameter->throw( "The ordernumber param is mandatory" )
224 unless $params->{ordernumber};
226 return $self->search(
229 { 'me.ordernumber' => $params->{ordernumber} },
230 { 'aqorders_transfers_ordernumber_to.ordernumber_from' => $params->{ordernumber} }
233 { join => 'aqorders_transfers_ordernumber_to' }
237 =head2 Internal methods
252 return 'Koha::Acquisition::Order';