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::AttrHTML;
12 use SL::DB::Helper::AttrSorted;
13 use SL::DB::Helper::FlattenToForm;
14 use SL::DB::Helper::LinkedRecords;
15 use SL::DB::Helper::TransNumberGenerator;
17 use List::Util qw(first);
19 __PACKAGE__->meta->add_relationship(orderitems => { type => 'one to many',
20 class => 'SL::DB::DeliveryOrderItem',
21 column_map => { id => 'delivery_order_id' },
22 manager_args => { with_objects => [ 'part' ] }
26 class => 'SL::DB::Shipto',
27 column_map => { id => 'trans_id' },
28 query_args => [ module => 'DO' ],
32 __PACKAGE__->meta->initialize;
34 __PACKAGE__->attr_html('notes');
35 __PACKAGE__->attr_sorted('items');
37 __PACKAGE__->before_save('_before_save_set_donumber');
41 sub _before_save_set_donumber {
44 $self->create_trans_number if !$self->donumber;
51 sub items { goto &orderitems; }
52 sub add_items { goto &add_orderitems; }
53 sub payment_terms { goto &payment; }
60 require SL::DB::Order;
61 my $orders = SL::DB::Manager::Order->get_all(
63 ordnumber => $self->ordnumber,
64 @{ $params{query} || [] },
68 return first { $_->is_type('sales_order') } @{ $orders };
72 return shift->customer_id ? 'sales_delivery_order' : 'purchase_delivery_order';
75 sub displayable_state {
79 ($self->closed ? $::locale->text('closed') : $::locale->text('open')),
80 ($self->delivered ? $::locale->text('delivered') : $::locale->text('not delivered'));
87 sub _clone_orderitem_cvar {
90 my $cloned = Rose::DB::Object::Helpers::clone_and_reset($_);
91 $cloned->sub_module('delivery_order_items');
97 my ($class, $source, %params) = @_;
99 croak("Unsupported source object type '" . ref($source) . "'") unless ref($source) eq 'SL::DB::Order';
101 my ($item_parent_id_column, $item_parent_column);
103 if (ref($source) eq 'SL::DB::Order') {
104 $item_parent_id_column = 'trans_id';
105 $item_parent_column = 'order';
108 my %args = ( map({ ( $_ => $source->$_ ) } qw(cp_id currency_id customer_id cusordnumber department_id employee_id globalproject_id intnotes language_id notes
109 ordnumber payment_id reqdate salesman_id shippingpoint shipvia taxincluded taxzone_id transaction_description vendor_id
112 is_sales => !!$source->customer_id,
114 transdate => DateTime->today_local,
117 # Custom shipto addresses (the ones specific to the sales/purchase
118 # record and not to the customer/vendor) are only linked from
119 # shipto -> delivery_orders. Meaning delivery_orders.shipto_id
120 # will not be filled in that case. Therefore we have to return the
121 # new shipto object as a separate object so that the caller can
124 if (!$source->shipto_id && $source->id) {
125 my $old = $source->custom_shipto;
127 $custom_shipto = SL::DB::Shipto->new(
128 map { +($_ => $old->$_) }
129 grep { !m{^ (?: itime | mtime | shipto_id | trans_id ) $}x }
131 @{ $old->meta->columns }
133 $custom_shipto->module('DO');
137 $args{shipto_id} = $source->shipto_id;
140 my $delivery_order = $class->new(%args);
141 $delivery_order->assign_attributes(%{ $params{attributes} }) if $params{attributes};
142 my $items = delete($params{items}) || $source->items_sorted;
146 my $source_item = $_;
147 my $source_item_id = $_->$item_parent_id_column;
148 my @custom_variables = map { _clone_orderitem_cvar($_) } @{ $source_item->custom_variables };
150 $item_parents{$source_item_id} ||= $source_item->$item_parent_column;
151 my $item_parent = $item_parents{$source_item_id};
153 SL::DB::DeliveryOrderItem->new(map({ ( $_ => $source_item->$_ ) }
154 qw(base_qty cusordnumber description discount lastcost longdescription marge_price_factor parts_id price_factor price_factor_id
155 project_id qty reqdate sellprice serialnumber transdate unit active_discount_source active_price_source
157 custom_variables => \@custom_variables,
158 ordnumber => ref($item_parent) eq 'SL::DB::Order' ? $item_parent->ordnumber : $source_item->ordnumber,
163 @items = grep { $params{item_filter}->($_) } @items if $params{item_filter};
164 @items = grep { $_->qty * 1 } @items if $params{skip_items_zero_qty};
165 @items = grep { $_->qty >=0 } @items if $params{skip_items_negative_qty};
167 $delivery_order->items(\@items);
169 return ($delivery_order, $custom_shipto);
173 $_[0]->is_sales ? $_[0]->customer : $_[0]->vendor;
185 SL::DB::DeliveryOrder - Rose model for delivery orders (table
194 An alias for C<transdate> for compatibility with other sales/purchase models.
196 =item C<displayable_state>
198 Returns a human-readable description of the state regarding being
199 closed and delivered.
203 An alias for C<deliver_orer_items> for compatibility with other
204 sales/purchase models.
206 =item C<new_from $source, %params>
208 Creates a new C<SL::DB::DeliveryOrder> instance and copies as much
209 information from C<$source> as possible. At the moment only instances
210 of C<SL::DB::Order> (sales quotations, sales orders, requests for
211 quotations and purchase orders) are supported as sources.
213 The conversion copies order items into delivery order items. Dates are copied
214 as appropriate, e.g. the C<transdate> field will be set to the current date.
216 Returns one or two objects depending on the context. In list context
217 the new delivery order instance and a shipto instance will be
218 returned. In scalar instance only the delivery order instance is
221 Custom shipto addresses (the ones specific to the sales/purchase
222 record and not to the customer/vendor) are only linked from C<shipto>
223 to C<delivery_orders>. Meaning C<delivery_orders.shipto_id> will not
224 be filled in that case. That's why a separate shipto object is created
227 The objects returned are not saved.
229 C<%params> can include the following options:
235 An optional array reference of RDBO instances for the items to use. If
236 missing then the method C<items_sorted> will be called on
237 C<$source>. This option can be used to override the sorting, to
238 exclude certain positions or to add additional ones.
240 =item C<skip_items_negative_qty>
242 If trueish then items with a negative quantity are skipped. Items with
243 a quantity of 0 are not affected by this option.
245 =item C<skip_items_zero_qty>
247 If trueish then items with a quantity of 0 are skipped.
251 An optional code reference that is called for each item with the item
252 as its sole parameter. Items for which the code reference returns a
253 falsish value will be skipped.
257 An optional hash reference. If it exists then it is passed to C<new>
258 allowing the caller to set certain attributes for the new delivery
265 TODO: Describe sales_order
269 Returns a stringdescribing this record's type: either
270 C<sales_delivery_order> or C<purchase_delivery_order>.
280 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>