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 6efee00..cc0a92f 100644 (file)
--- a/SL/DB/OrderItem.pm
+++ b/SL/DB/OrderItem.pm
@@ -3,67 +3,90 @@ package SL::DB::OrderItem;
 use strict;
 
 use SL::DB::MetaSetup::OrderItem;
+use SL::DB::Manager::OrderItem;
+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,
   overloads   => {
-    parts_id => 'SL::DB::Part',
+    parts_id => {
+      class => 'SL::DB::Part',
+      module => 'IC',
+    }
   },
 );
-
-__PACKAGE__->meta->add_relationship(
-  part => {
-    type         => 'one to one',
-    class        => 'SL::DB::Part',
-    column_map   => { parts_id => 'id' },
-  },
-  price_factor_obj => {
-    type           => 'one to one',
-    class          => 'SL::DB::PriceFactor',
-    column_map     => { price_factor_id => 'id' },
-  },
-  unit_obj       => {
-    type         => 'one to one',
-    class        => 'SL::DB::Unit',
-    column_map   => { unit => 'name' },
-  },
-  order => {
-    type         => 'one to one',
-    class        => 'SL::DB::Order',
-    column_map   => { trans_id => 'id' },
-  },
-);
-
-# Creates get_all, get_all_count, get_all_iterator, delete_all and update_all.
-__PACKAGE__->meta->make_manager_class;
+use SL::Helper::ShippedQty;
 
 __PACKAGE__->meta->initialize;
 
+__PACKAGE__->configure_acts_as_list(group_by => [qw(trans_id)]);
+
 sub is_price_update_available {
   my $self = shift;
   return $self->origprice > $self->part->sellprice;
 }
 
-package SL::DB::Manager::OrderItem;
-
-use SL::DB::Helper::Paginated;
-use SL::DB::Helper::Sorted;
-
-sub _sort_spec {
-  return ( columns => { delivery_date => [ 'deliverydate',        ],
-                        description   => [ 'lower(orderitems.description)',  ],
-                        partnumber    => [ 'part.partnumber',     ],
-                        qty           => [ 'qty'                  ],
-                        ordnumber     => [ 'order.ordnumber'      ],
-                        customer      => [ 'lower(customer.name)', ],
-                        position      => [ 'trans_id', 'runningnumber' ],
-                        transdate     => [ 'transdate', 'lower(order.reqdate::text)' ],
-                      },
-           default => [ 'position', 1 ],
-           nulls   => { }
-         );
+sub shipped_qty {
+  my ($self, %params) = @_;
+
+  my $force = delete $params{force};
+
+  SL::Helper::ShippedQty->new(%params)->calculate($self)->write_to_objects if $force || !defined $self->{shipped_qty};
+
+  $self->{shipped_qty};
+}
+
+sub linked_delivery_order_items {
+  my ($self) = @_;
+
+  return $self->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrderItem');
 }
 
-sub default_objects_per_page { 40 }
+sub delivered_qty { goto &shipped_qty }
+
+sub record { goto &order }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+SL::DB::OrderItems: Rose model for orderitems
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<shipped_qty PARAMS>
+
+Calculates the shipped qty for this orderitem (measured in the current unit)
+and returns it.
+
+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.
+
+Given parameters will be passed to L<SL::Helper::ShippedQty>, so you can force
+the shipped/delivered distinction like this:
+
+  $_->shipped_qty(require_stock_out => 0);
+
+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.
+
+=item C<delivered_qty>
+
+Alias for L</shipped_qty>.
+
+=back
+
+=head1 AUTHORS
+
+G. Richardson E<lt>grichardson@kivitendo-premium.deE<gt>
+
+=cut