Merge branch 'b-3.6.1' of ../kivitendo-erp_20220811

[kivitendo-erp.git] / SL / DB / OrderItem.pm

diff --git a/SL/DB/OrderItem.pm b/SL/DB/OrderItem.pm
index 6ab16ac..cc0a92f 100644 (file)
--- a/SL/DB/OrderItem.pm
+++ b/SL/DB/OrderItem.pm
@@ -2,13 +2,11 @@ package SL::DB::OrderItem;
 
 use strict;
 
-use List::Util qw(sum);
-
 use SL::DB::MetaSetup::OrderItem;
 use SL::DB::Manager::OrderItem;
-use SL::DB::DeliveryOrderItemsStock;
 use SL::DB::Helper::ActsAsList;
 use SL::DB::Helper::LinkedRecords;
+use SL::DB::Helper::RecordItem;
 use SL::DB::Helper::CustomVariables (
   sub_module  => 'orderitems',
   cvars_alias => 1,
@@ -19,6 +17,7 @@ use SL::DB::Helper::CustomVariables (
     }
   },
 );
+use SL::Helper::ShippedQty;
 
 __PACKAGE__->meta->initialize;
 
@@ -30,67 +29,64 @@ sub is_price_update_available {
 }
 
 sub shipped_qty {
-  my ($self) = @_;
+  my ($self, %params) = @_;
+
+  my $force = delete $params{force};
 
-  my $d_orders = $self->order->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrder');
-  my @doi      = grep { $_->parts_id == $self->parts_id } map { $_->orderitems } @$d_orders;
+  SL::Helper::ShippedQty->new(%params)->calculate($self)->write_to_objects if $force || !defined $self->{shipped_qty};
 
-  require SL::AM;
-  return sum(map { AM->convert_unit($_->unit => $self->unit) * $_->qty } @doi);
+  $self->{shipped_qty};
 }
 
-sub delivered_qty {
+sub linked_delivery_order_items {
   my ($self) = @_;
 
-  return $self->_delivered_qty;
+  return $self->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrderItem');
 }
 
-sub _delivered_qty {
-  my ($self) = @_;
+sub delivered_qty { goto &shipped_qty }
 
-  return $self->{delivered_qty} if $self->{delivered_qty};
+sub record { goto &order }
 
-  my $d_orders = $self->order->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrder');
+1;
 
-  my @d_orders_delivered = grep { $_->delivered } @$d_orders;
+__END__
 
-  my @doi_delivered      = grep { $_->parts_id == $self->parts_id } map { $_->orderitems } @d_orders_delivered;
+=pod
 
-  require SL::AM;
-  $self->{delivered_qty} =  sum(map { AM->convert_unit($_->unit => $self->unit) * $_->qty } @doi_delivered);
+=head1 NAME
 
-  return $self->{delivered_qty};
-}
+SL::DB::OrderItems: Rose model for orderitems
 
-sub value_of_goods {
-  my ($self) = @_;
+=head1 FUNCTIONS
 
-  my $price_factor = $self->price_factor || 1;
+=over 4
 
-  $self->_delivered_qty;
-  return ($self->_delivered_qty * $self->sellprice * (1 - $self->discount ) / $price_factor);
-}
+=item C<shipped_qty PARAMS>
 
-sub stocked_qty {
-  my ($self) = @_;
+Calculates the shipped qty for this orderitem (measured in the current unit)
+and returns it.
 
-  my $d_orders   = $self->order->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrder');
-  my @doi        = grep { $_->parts_id == $self->parts_id } map { $_->orderitems } @$d_orders;
+Note that the shipped qty is expected not to change within the request and is
+cached in C<shipped_qty> once calculated. If C<< force => 1 >> is passed, the
+existibng cache is ignored.
 
-  return 0 if !@doi;
+Given parameters will be passed to L<SL::Helper::ShippedQty>, so you can force
+the shipped/delivered distinction like this:
 
-  my $doi_stocks = SL::DB::Manager::DeliveryOrderItemsStock->get_all(query => [delivery_order_item_id => [ map {$_->id} @doi ]]);
+  $_->shipped_qty(require_stock_out => 0);
 
-  require SL::AM;
-  return sum(map { AM->convert_unit($_->unit => $self->unit) * $_->qty } @{ $doi_stocks });
-}
+Note however that calculating shipped_qty on individual Orderitems is generally
+a bad idea. See L<SL::Helper::ShippedQty> for way to compute these all at once.
 
-sub taxincluded {
-  my ($self) = @_;
+=item C<delivered_qty>
 
-  return SL::DB::Manager::Order->find_by(id => $self->trans_id)->taxincluded ?  $::locale->text('WARN: Tax included value!') : '';
-}
+Alias for L</shipped_qty>.
 
-sub record { goto &order }
+=back
 
-1;
+=head1 AUTHORS
+
+G. Richardson E<lt>grichardson@kivitendo-premium.deE<gt>
+
+=cut