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::Helper::ShippedQty;
__PACKAGE__->meta->initialize;
}
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 linked_delivery_order_items {
+ my ($self) = @_;
+
+ return $self->linked_records(direction => 'to', to => 'SL::DB::DeliveryOrderItem');
+}
+
+sub delivered_qty { goto &shipped_qty }
+
sub record { goto &order }
1;
=over 4
-=item C<shipped_qty>
+=item C<shipped_qty PARAMS>
-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);>
+Calculates the shipped qty for this orderitem (measured in the current unit)
+and returns it.
-=back
+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.
-=head1 TODO
+Given parameters will be passed to L<SL::Helper::ShippedQty>, so you can force
+the shipped/delivered distinction like this:
-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:
+ $_->shipped_qty(require_stock_out => 0);
-C<delivered_qty>
+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.
-return $self-E<gt>_delivered_qty;
+=item C<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.
+Alias for L</shipped_qty>.
+=back
+=head1 AUTHORS
+G. Richardson E<lt>grichardson@kivitendo-premium.deE<gt>
+=cut