1 package SL::DB::DeliveryOrder;
7 use Rose::DB::Object::Helpers ();
9 use SL::DB::MetaSetup::DeliveryOrder;
10 use SL::DB::Manager::DeliveryOrder;
11 use SL::DB::Helper::FlattenToForm;
12 use SL::DB::Helper::LinkedRecords;
13 use SL::DB::Helper::TransNumberGenerator;
15 use List::Util qw(first);
17 __PACKAGE__->meta->add_relationship(orderitems => { type => 'one to many',
18 class => 'SL::DB::DeliveryOrderItem',
19 column_map => { id => 'delivery_order_id' },
20 manager_args => { with_objects => [ 'part' ] }
24 class => 'SL::DB::Shipto',
25 column_map => { id => 'trans_id' },
26 query_args => [ module => 'DO' ],
30 __PACKAGE__->meta->initialize;
32 __PACKAGE__->before_save('_before_save_set_donumber');
36 sub _before_save_set_donumber {
39 $self->create_trans_number if !$self->donumber;
46 sub items { goto &orderitems; }
51 return [ sort {$a->id <=> $b->id } @{ $self->items } ];
59 require SL::DB::Order;
60 my $orders = SL::DB::Manager::Order->get_all(
62 ordnumber => $self->ordnumber,
63 @{ $params{query} || [] },
67 return first { $_->is_type('sales_order') } @{ $orders };
71 return shift->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
74 sub displayable_state {
78 ($self->closed ? $::locale->text('closed') : $::locale->text('open')),
79 ($self->delivered ? $::locale->text('delivered') : $::locale->text('not delivered'));
86 sub _clone_orderitem_cvar {
89 my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
90 $cloned->sub_module('delivery_order_items');
96 my ($class, $source, %params) = @_;
98 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
100 my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_terms->terms_netto : 0;
102 my %args = ( map({ ( $_ => $source->$_ ) } qw(cp_id currency_id customer_id cusordnumber department_id employee_id globalproject_id intnotes language_id notes
103 ordnumber reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
106 is_sales => !!$source->customer_id,
109 transdate => DateTime->today_local,
112 # Custom shipto addresses (the ones specific to the sales/purchase
113 # record and not to the customer/vendor) are only linked from
114 # shipto -> delivery_orders. Meaning delivery_orders.shipto_id
115 # will not be filled in that case. Therefore we have to return the
116 # new shipto object as a separate object so that the caller can
119 if (!$source->shipto_id && $source->id) {
120 my $old = $source->custom_shipto;
122 $custom_shipto = SL::DB::Shipto->new(
123 map { +($_ => $old->$_) }
124 grep { !m{^ (?: itime | mtime | shipto_id | trans_id ) $}x }
126 @{ $old->meta->columns }
128 $custom_shipto->module('DO');
132 $args{shipto_id} = $source->shipto_id;
135 my $delivery_order = $class->new(%args, %{ $params{attributes} || {} });
138 my $source_item = $_;
139 my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
141 SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
142 qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor ordnumber parts_id price_factor price_factor_id
143 project_id qty reqdate sellprice serialnumber transdate unit
145 custom_variables => \@custom_variables);
147 } @{ $source->items_sorted };
149 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
151 $delivery_order->items(\@items);
153 return ($delivery_order, $custom_shipto);
165 SL::DB::DeliveryOrder - Rose model for delivery orders (table
174 An alias for C<transdate> for compatibility with other sales/purchase models.
176 =item C<displayable_state>
178 Returns a human-readable description of the state regarding being
179 closed and delivered.
183 An alias for C<deliver_orer_items> for compatibility with other
184 sales/purchase models.
186 =item C<items_sorted>
188 Returns the delivery order items sorted by their ID (same order they
189 appear in the frontend delivery order masks).
191 =item C<new_from $source, %params>
193 Creates a new C<SL::DB::DeliveryOrder> instance and copies as much
194 information from C<$source> as possible. At the moment only instances
195 of C<SL::DB::Order> (sales quotations, sales orders, requests for
196 quotations and purchase orders) are supported as sources.
198 The conversion copies order items into delivery order items. Dates are copied
199 as appropriate, e.g. the C<transdate> field will be set to the current date.
201 Returns one or two objects depending on the context. In list context
202 the new delivery order instance and a shipto instance will be
203 returned. In scalar instance only the delivery order instance is
206 Custom shipto addresses (the ones specific to the sales/purchase
207 record and not to the customer/vendor) are only linked from C<shipto>
208 to C<delivery_orders>. Meaning C<delivery_orders.shipto_id> will not
209 be filled in that case. That's why a separate shipto object is created
212 The objects returned are not saved.
214 C<%params> can include the following options:
218 =item C<skip_items_zero_qty>
220 If trueish then items with a quantity of 0 are skipped.
224 An optional hash reference. If it exists then it is passed to C<new>
225 allowing the caller to set certain attributes for the new delivery
232 TODO: Describe sales_order
236 Returns a stringdescribing this record's type: either
237 C<sales_delivery_order> or C<purchase_delivery_order>.
247 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>