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 ($item_parent_id_column, $item_parent_column);
102 if (ref($source) eq 'SL::DB::Order') {
103 $item_parent_id_column = 'trans_id';
104 $item_parent_column = 'order';
107 my $terms = $source->can('payment_id') && $source->payment_id ? $source->payment_terms->terms_netto : 0;
109 my %args = ( map({ ( $_ => $source->$_ ) } qw(cp_id currency_id customer_id cusordnumber department_id employee_id globalproject_id intnotes language_id notes
110 ordnumber reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
113 is_sales => !!$source->customer_id,
116 transdate => DateTime->today_local,
119 # Custom shipto addresses (the ones specific to the sales/purchase
120 # record and not to the customer/vendor) are only linked from
121 # shipto -> delivery_orders. Meaning delivery_orders.shipto_id
122 # will not be filled in that case. Therefore we have to return the
123 # new shipto object as a separate object so that the caller can
126 if (!$source->shipto_id && $source->id) {
127 my $old = $source->custom_shipto;
129 $custom_shipto = SL::DB::Shipto->new(
130 map { +($_ => $old->$_) }
131 grep { !m{^ (?: itime | mtime | shipto_id | trans_id ) $}x }
133 @{ $old->meta->columns }
135 $custom_shipto->module('DO');
139 $args{shipto_id} = $source->shipto_id;
142 my $delivery_order = $class->new(%args);
143 $delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
144 my $items = delete($params{items}) || $source->items_sorted;
148 my $source_item = $_;
149 my $source_item_id = $_->$item_parent_id_column;
150 my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
152 $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
153 my $item_parent = $item_parents{$source_item_id};
155 SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
156 qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor parts_id price_factor price_factor_id
157 project_id qty reqdate sellprice serialnumber transdate unit
159 custom_variables => \@custom_variables,
160 ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
165 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
167 $delivery_order->items(\@items);
169 return ($delivery_order, $custom_shipto);
181 SL::DB::DeliveryOrder - Rose model for delivery orders (table
190 An alias for C<transdate> for compatibility with other sales/purchase models.
192 =item C<displayable_state>
194 Returns a human-readable description of the state regarding being
195 closed and delivered.
199 An alias for C<deliver_orer_items> for compatibility with other
200 sales/purchase models.
202 =item C<items_sorted>
204 Returns the delivery order items sorted by their ID (same order they
205 appear in the frontend delivery order masks).
207 =item C<new_from $source, %params>
209 Creates a new C<SL::DB::DeliveryOrder> instance and copies as much
210 information from C<$source> as possible. At the moment only instances
211 of C<SL::DB::Order> (sales quotations, sales orders, requests for
212 quotations and purchase orders) are supported as sources.
214 The conversion copies order items into delivery order items. Dates are copied
215 as appropriate, e.g. the C<transdate> field will be set to the current date.
217 Returns one or two objects depending on the context. In list context
218 the new delivery order instance and a shipto instance will be
219 returned. In scalar instance only the delivery order instance is
222 Custom shipto addresses (the ones specific to the sales/purchase
223 record and not to the customer/vendor) are only linked from C<shipto>
224 to C<delivery_orders>. Meaning C<delivery_orders.shipto_id> will not
225 be filled in that case. That's why a separate shipto object is created
228 The objects returned are not saved.
230 C<%params> can include the following options:
236 An optional array reference of RDBO instances for the items to use. If
237 missing then the method C<items_sorted> will be called on
238 C<$source>. This option can be used to override the sorting, to
239 exclude certain positions or to add additional ones.
241 =item C<skip_items_zero_qty>
243 If trueish then items with a quantity of 0 are skipped.
247 An optional hash reference. If it exists then it is passed to C<new>
248 allowing the caller to set certain attributes for the new delivery
255 TODO: Describe sales_order
259 Returns a stringdescribing this record's type: either
260 C<sales_delivery_order> or C<purchase_delivery_order>.
270 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>