epic-ts
[kivitendo-erp.git] / SL / DB / OrderItem.pm
index f24abca..5fcb8be 100644 (file)
@@ -3,45 +3,28 @@ package SL::DB::OrderItem;
 use strict;
 
 use List::Util qw(sum);
-use SL::AM;
 
 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,
   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;
-
 __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;
@@ -53,33 +36,55 @@ sub shipped_qty {
   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;
 
+  require SL::AM;
   return sum(map { AM->convert_unit($_->unit => $self->unit) * $_->qty } @doi);
 }
 
-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' ],
-                        reqdate       => [ 'COALESCE(orderitems.reqdate, order.reqdate)' ],
-                        orddate       => [ 'order.orddate' ],
-                        sellprice     => [ 'sellprice' ],
-                        discount      => [ 'discount' ],
-                        transdate     => [ 'transdate::date', 'order.reqdate' ],
-                      },
-           default => [ 'position', 1 ],
-           nulls   => { }
-         );
-}
-
-sub default_objects_per_page { 40 }
+sub record { goto &order }
 
 1;
+
+__END__
+
+=pod
+
+=head1 NAME
+
+SL::DB::OrderItems: Rose model for orderitems
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<shipped_qty>
+
+returns the number of orderitems which are already linked to Delivery Orders.
+The linked key is parts_id and not orderitems (id) -> delivery_order_items (id).
+Therefore this function is not safe for identical parts_id.
+Sample call:
+C<$::form-E<gt>format_amount(\%::myconfig, $_[0]-E<gt>shipped_qty);>
+
+=back
+
+=head1 TODO
+
+Older versions of OrderItem.pm had more functions which where used for calculating the
+qty for the different states of the Delivery Order.
+For example to get the qty in already marked as delivered Delivery Orders:
+
+C<delivered_qty>
+
+return $self-E<gt>_delivered_qty;
+
+  sub _delivered_qty {
+  (..)
+    my @d_orders_delivered = grep { $_-E<gt>delivered } @$d_orders;
+    my @doi_delivered      = grep { $_-E<gt>parts_id == $self-E<gt>parts_id } map { $_-E<gt>orderitems } @d_orders_delivered;
+  }
+
+In general the function C<shipped_qty> and all (project) related functions should be marked deprecate,
+ because of the better linked item to item data in the record_links table.
+
+
+
+