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;
25 use Koha::Exceptions::Exception;
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 if ( defined $estimated_from or defined $estimated_to ) {
73 push @delivery_time_conditions, \[ "$date_add IS NOT NULL" ];
75 if ( defined $estimated_from ) {
76 push @delivery_time_conditions, \[ "$date_add >= ?", $dtf->format_date($estimated_from) ];
78 if ( defined $estimated_to ) {
79 push @delivery_time_conditions, \[ "$date_add <= ?", $dtf->format_date($estimated_to) ];
81 if ( defined $estimated_from and not defined $estimated_to ) {
82 push @delivery_time_conditions, \[ "$date_add <= ?", $dtf->format_date(dt_from_string) ];
88 { datereceived => undef },
89 quantityreceived => { '<' => \'quantity' }
91 'basketno.closedate' => [
97 '<=' => $dtf->format_date(
98 dt_from_string->subtract( days => $delay )
104 'datecancellationprinted' => undef,
107 ? ( 'basketno.booksellerid' => $bookseller_id )
111 # ( $branchcode ? ('borrower.branchcode')) # FIXME branch is not a filter we may not need to implement this
113 ( @delivery_time_conditions ? ( -and => \@delivery_time_conditions ) : ()),
115 C4::Context->preference('IndependentBranches')
116 && !C4::Context->IsSuperLibrarian
117 ? ( 'borrower.branchcode' => C4::Context->userenv->{branch} )
121 ( orderstatus => { '!=' => 'cancelled' } ),
125 '+select' => [\"DATE_ADD(basketno.closedate, INTERVAL COALESCE(booksellerid.deliverytime, booksellerid.deliverytime, 0) day)"],
126 '+as' => ['estimated_delivery_date'],
127 join => { 'basketno' => 'booksellerid' },
128 prefetch => {'basketno' => 'booksellerid'},
133 =head3 filter_by_active
135 my $new_rs = $orders->filter_by_active;
137 Returns a new resultset filtering orders that are not active.
141 sub filter_by_active {
143 return $self->search(
146 { 'basket.is_standing' => 1,
147 'orderstatus' => [ 'new', 'ordered', 'partial' ] },
148 { 'orderstatus' => [ 'ordered', 'partial' ] }
155 =head3 filter_by_current
157 $orders->filter_by_current
159 Return the orders of the set that have not been cancelled.
163 sub filter_by_current {
165 return $self->search(
167 datecancellationprinted => undef,
172 =head3 filter_by_cancelled
174 $orders->filter_by_cancelled
176 Return the orders of the set that have been cancelled.
180 sub filter_by_cancelled {
182 return $self->search(
184 datecancellationprinted => { '!=' => undef }
189 =head3 filter_by_id_including_transfers
191 my $orders = $orders->filter_by_id_including_transfers(
193 ordernumber => $ordernumber
197 When searching for orders by I<ordernumber>, include the aqorders_transfers table
198 so we can find orders that have changed their ordernumber as the result of a transfer
202 sub filter_by_id_including_transfers {
203 my ( $self, $params ) = @_;
205 Koha::Exceptions::MissingParameter->throw( "The ordernumber param is mandatory" )
206 unless $params->{ordernumber};
208 return $self->search(
211 { 'me.ordernumber' => $params->{ordernumber} },
212 { 'aqorders_transfers_ordernumber_to.ordernumber_from' => $params->{ordernumber} }
215 { join => 'aqorders_transfers_ordernumber_to' }
219 =head2 Internal methods
234 return 'Koha::Acquisition::Order';