epic-ts

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

diff --git a/SL/DB/OrderItem.pm b/SL/DB/OrderItem.pm
index 0c28a52..5fcb8be 100644 (file)
--- a/SL/DB/OrderItem.pm
+++ b/SL/DB/OrderItem.pm
@@ -6,6 +6,10 @@ 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 +23,8 @@ use SL::DB::Helper::CustomVariables (
 
 __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;
@@ -34,40 +40,51 @@ sub shipped_qty {
   return sum(map { AM->convert_unit($_->unit => $self->unit) * $_->qty } @doi);
 }
 
-sub delivered_qty {
-  my ($self) = @_;
+sub record { goto &order }
 
-  $self->_delivered_qty;
-  return $self->{delivered_qty};
-}
+1;
 
-sub _delivered_qty {
-  my ($self) = @_;
+__END__
 
-  return if $self->{delivered_qty};
+=pod
 
-  my $d_orders = $self->order->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrder');
+=head1 NAME
 
-  my @d_orders_delivered = grep { $_->delivered } @$d_orders;
+SL::DB::OrderItems: Rose model for orderitems
 
-  my @doi_delivered      = grep { $_->parts_id == $self->parts_id } map { $_->orderitems } @d_orders_delivered;
+=head1 FUNCTIONS
 
-  require SL::AM;
-  $self->{delivered_qty} =  sum(map { AM->convert_unit($_->unit => $self->unit) * $_->qty } @doi_delivered);
-}
+=over 4
 
-sub value_of_goods {
-  my ($self) = @_;
+=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.
 
-  my $price_factor = $self->price_factor || 1;
 
-  $self->_delivered_qty;
-  return ($self->{delivered_qty} * $self->sellprice * (1 - $self->discount ) / $price_factor);
-}
 
-sub taxincluded {
-  my ($self) = @_;
 
-  return SL::DB::Manager::Order->find_by(id => $self->trans_id)->taxincluded ?  $::locale->text('WARN: Tax included value!') : '';
-}
-1;