6 use List::MoreUtils qw(any);
7 use Rose::DB::Object::Helpers qw(as_tree);
10 use SL::DB::MetaSetup::Part;
11 use SL::DB::Manager::Part;
13 use SL::DB::Helper::AttrHTML;
14 use SL::DB::Helper::TransNumberGenerator;
15 use SL::DB::Helper::CustomVariables (
19 use List::Util qw(sum);
21 __PACKAGE__->meta->add_relationships(
23 type => 'one to many',
24 class => 'SL::DB::Assembly',
25 manager_args => { sort_by => 'position, oid' },
26 column_map => { id => 'id' },
29 type => 'one to many',
30 class => 'SL::DB::Price',
31 column_map => { id => 'parts_id' },
32 manager_args => { with_objects => [ 'pricegroup' ] }
35 type => 'one to many',
36 class => 'SL::DB::MakeModel',
37 manager_args => { sort_by => 'sortorder' },
38 column_map => { id => 'parts_id' },
41 type => 'one to many',
42 class => 'SL::DB::PartCustomerPrice',
43 column_map => { id => 'parts_id' },
46 type => 'one to many',
47 class => 'SL::DB::Translation',
48 column_map => { id => 'parts_id' },
51 type => 'one to many',
52 class => 'SL::DB::AssortmentItem',
53 column_map => { id => 'assortment_id' },
56 type => 'one to many',
57 class => 'SL::DB::History',
58 column_map => { id => 'trans_id' },
59 query_args => [ what_done => 'part' ],
60 manager_args => { sort_by => 'itime' },
63 type => 'one to many',
64 class => 'SL::DB::ShopPart',
65 column_map => { id => 'part_id' },
66 manager_args => { with_objects => [ 'shop' ] },
70 __PACKAGE__->meta->initialize;
72 __PACKAGE__->attr_html('notes');
74 __PACKAGE__->before_save('_before_save_set_partnumber');
76 sub _before_save_set_partnumber {
79 $self->create_trans_number if !$self->partnumber;
86 if ( $self->part_type eq 'assembly' ) {
87 return $self->assemblies;
88 } elsif ( $self->part_type eq 'assortment' ) {
89 return $self->assortment_items;
98 # for detecting if the items of an (orphaned) assembly or assortment have
101 return join(' ', sort map { $_->part->id } @{$self->items});
108 push @errors, $::locale->text('The partnumber is missing.') if $self->id and !$self->partnumber;
109 push @errors, $::locale->text('The unit is missing.') unless $self->unit;
110 push @errors, $::locale->text('The buchungsgruppe is missing.') unless $self->buchungsgruppen_id or $self->buchungsgruppe;
112 unless ( $self->id ) {
113 push @errors, $::locale->text('The partnumber already exists.') if SL::DB::Manager::Part->get_all_count(where => [ partnumber => $self->partnumber ]);
116 if ($self->is_assortment && $self->orphaned && scalar @{$self->assortment_items} == 0) {
117 # when assortment isn't orphaned form doesn't contain any items
118 push @errors, $::locale->text('The assortment doesn\'t have any items.');
121 if ($self->is_assembly && scalar @{$self->assemblies} == 0) {
122 push @errors, $::locale->text('The assembly doesn\'t have any items.');
130 my $type = lc(shift || '');
131 die 'invalid type' unless $type =~ /^(?:part|service|assembly|assortment)$/;
133 return $self->type eq $type ? 1 : 0;
136 sub is_part { $_[0]->part_type eq 'part' }
137 sub is_assembly { $_[0]->part_type eq 'assembly' }
138 sub is_service { $_[0]->part_type eq 'service' }
139 sub is_assortment { $_[0]->part_type eq 'assortment' }
142 return $_[0]->part_type;
143 # my ($self, $type) = @_;
145 # die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
146 # $self->assembly( $type eq 'assembly' ? 1 : 0);
147 # $self->inventory_accno_id($type ne 'service' ? 1 : undef);
150 # return 'assembly' if $self->assembly;
151 # return 'part' if $self->inventory_accno_id;
156 my ($class, %params) = @_;
157 $class->new(%params, part_type => 'part');
161 my ($class, %params) = @_;
162 $class->new(%params, part_type => 'assembly');
166 my ($class, %params) = @_;
167 $class->new(%params, part_type => 'service');
171 my ($class, %params) = @_;
172 $class->new(%params, part_type => 'assortment');
175 sub last_modification {
177 return $self->mtime // $self->itime;
182 die 'not an accessor' if @_ > 1;
184 return 1 unless $self->id;
189 SL::DB::DeliveryOrderItem
192 for my $class (@relations) {
193 eval "require $class";
194 return 1 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
200 die 'not an accessor' if @_ > 1;
202 return 1 unless $self->id;
207 SL::DB::DeliveryOrderItem
209 SL::DB::AssortmentItem
212 for my $class (@relations) {
213 eval "require $class";
214 return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
219 sub get_sellprice_info {
223 confess "Missing part id" unless $self->id;
225 my $object = $self->load;
227 return { sellprice => $object->sellprice,
228 price_factor_id => $object->price_factor_id };
231 sub get_ordered_qty {
233 my %result = SL::DB::Manager::Part->get_ordered_qty($self->id);
235 return $result{ $self->id };
238 sub available_units {
239 shift->unit_obj->convertible_units;
242 # autogenerated accessor is slightly off...
244 shift->buchungsgruppen(@_);
248 my ($self, %params) = @_;
250 my $date = $params{date} || DateTime->today_local;
251 my $is_sales = !!$params{is_sales};
252 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
253 my $tk_info = $::request->cache('get_taxkey');
255 $tk_info->{$self->id} //= {};
256 $tk_info->{$self->id}->{$taxzone} //= { };
257 my $cache = $tk_info->{$self->id}->{$taxzone}->{$is_sales} //= { };
259 if (!exists $cache->{$date}) {
261 $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
262 ->get_active_taxkey($date);
265 return $cache->{$date};
269 my ($self, %params) = @_;
271 my $type = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
272 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
274 my $charts = $::request->cache('get_chart_id/by_part_id_and_taxzone')->{$self->id} //= {};
275 my $all_charts = $::request->cache('get_chart_id/by_id');
277 $charts->{$taxzone} ||= { };
279 if (!exists $charts->{$taxzone}->{$type}) {
280 require SL::DB::Buchungsgruppe;
281 my $bugru = SL::DB::Buchungsgruppe->load_cached($self->buchungsgruppen_id);
282 my $chart_id = ($type eq 'inventory') ? ($self->is_part ? $bugru->inventory_accno_id : undef)
283 : $bugru->call_sub("${type}_accno_id", $taxzone);
286 my $chart = $all_charts->{$chart_id} // SL::DB::Chart->load_cached($chart_id)->load;
287 $all_charts->{$chart_id} = $chart;
288 $charts->{$taxzone}->{$type} = $chart;
292 return $charts->{$taxzone}->{$type};
296 my ($self, %params) = @_;
298 return undef unless $self->id;
300 my $query = 'SELECT SUM(qty) FROM inventory WHERE parts_id = ?';
301 my @values = ($self->id);
303 if ( $params{bin_id} ) {
304 $query .= ' AND bin_id = ?';
305 push(@values, $params{bin_id});
308 if ( $params{warehouse_id} ) {
309 $query .= ' AND warehouse_id = ?';
310 push(@values, $params{warehouse_id});
313 if ( $params{shippingdate} ) {
314 die unless ref($params{shippingdate}) eq 'DateTime';
315 $query .= ' AND shippingdate <= ?';
316 push(@values, $params{shippingdate});
319 my ($stock) = selectrow_query($::form, $self->db->dbh, $query, @values);
321 return $stock || 0; # never return undef
325 # this is designed to ignore chargenumbers, expiration dates and just give a list of how much <-> where
326 sub get_simple_stock {
327 my ($self, %params) = @_;
329 return [] unless $self->id;
332 SELECT sum(qty), warehouse_id, bin_id FROM inventory WHERE parts_id = ?
333 GROUP BY warehouse_id, bin_id
335 my $stock_info = selectall_hashref_query($::form, $::form->get_standard_dbh, $query, $self->id);
336 [ map { bless $_, 'SL::DB::Part::SimpleStock'} @$stock_info ];
338 # helper class to have bin/warehouse accessors in stock result
339 { package SL::DB::Part::SimpleStock;
340 sub warehouse { require SL::DB::Warehouse; SL::DB::Manager::Warehouse->find_by_or_create(id => $_[0]->{warehouse_id}) }
341 sub bin { require SL::DB::Bin; SL::DB::Manager::Bin ->find_by_or_create(id => $_[0]->{bin_id}) }
344 sub displayable_name {
345 join ' ', grep $_, map $_[0]->$_, qw(partnumber description);
348 sub clone_and_reset_deep {
351 my $clone = $self->clone_and_reset; # resets id and partnumber (primary key and unique constraint)
352 $clone->makemodels( map { $_->clone_and_reset } @{$self->makemodels} ) if @{$self->makemodels};
353 $clone->translations( map { $_->clone_and_reset } @{$self->translations} ) if @{$self->translations};
355 if ( $self->is_assortment ) {
356 # use clone rather than reset_and_clone because the unique constraint would also remove parts_id
357 $clone->assortment_items( map { $_->clone } @{$self->assortment_items} );
358 $_->assortment_id(undef) foreach @{ $clone->assortment_items }
361 if ( $self->is_assembly ) {
362 $clone->assemblies( map { $_->clone_and_reset } @{$self->assemblies});
365 if ( $self->prices ) {
366 $clone->prices( map { $_->clone } @{$self->prices}); # pricegroup_id gets reset here because it is part of a unique contraint
367 if ( $clone->prices ) {
368 foreach my $price ( @{$clone->prices} ) {
370 $price->parts_id(undef);
379 my ($self, $comparison_part) = @_;
381 die "item_diffs needs a part object" unless ref($comparison_part) eq 'SL::DB::Part';
382 die "part and comparison_part need to be of the same part_type" unless
383 ( $self->part_type eq 'assembly' or $self->part_type eq 'assortment' )
384 and ( $comparison_part->part_type eq 'assembly' or $comparison_part->part_type eq 'assortment' )
385 and $self->part_type eq $comparison_part->part_type;
387 # return [], [] if $self->items_checksum eq $comparison_part->items_checksum;
388 my @self_part_ids = map { $_->parts_id } $self->items;
389 my @comparison_part_ids = map { $_->parts_id } $comparison_part->items;
391 my %orig = map{ $_ => 1 } @self_part_ids;
392 my %comparison = map{ $_ => 1 } @comparison_part_ids;
393 my (@additions, @removals);
394 @additions = grep { !exists( $orig{$_} ) } @comparison_part_ids if @comparison_part_ids;
395 @removals = grep { !exists( $comparison{$_} ) } @self_part_ids if @self_part_ids;
397 return \@additions, \@removals;
400 sub items_sellprice_sum {
401 my ($self, %params) = @_;
403 return unless $self->is_assortment or $self->is_assembly;
404 return unless $self->items;
406 if ($self->is_assembly) {
407 return sum map { $_->linetotal_sellprice } @{$self->items};
409 return sum map { $_->linetotal_sellprice(%params) } grep { $_->charge } @{$self->items};
413 sub items_lastcost_sum {
416 return unless $self->is_assortment or $self->is_assembly;
417 return unless $self->items;
418 sum map { $_->linetotal_lastcost } @{$self->items};
431 SL::DB::Part: Model for the 'parts' table
435 This is a standard Rose::DB::Object based model and can be used as one.
439 Although the base class is called C<Part> we usually talk about C<Articles> if
440 we mean instances of this class. This is because articles come in three
445 =item Part - a single part
447 =item Service - a part without onhand, and without inventory accounting
449 =item Assembly - a collection of both parts and services
451 =item Assortment - a collection of items (parts or assemblies)
455 These types are sadly represented by data inside the class and cannot be
456 migrated into a flag. To work around this, each C<Part> object knows what type
457 it currently is. Since the type is data driven, there ist no explicit setting
458 method for it, but you can construct them explicitly with C<new_part>,
459 C<new_service>, C<new_assembly> and C<new_assortment>. A Buchungsgruppe should be supplied in this
460 case, but it will use the default Buchungsgruppe if you don't.
462 Matching these there are assorted helper methods dealing with types,
463 e.g. L</new_part>, L</new_service>, L</new_assembly>, L</type>,
464 L</is_type> and others.
470 =item C<new_part %PARAMS>
472 =item C<new_service %PARAMS>
474 =item C<new_assembly %PARAMS>
476 Will set the appropriate data fields so that the resulting instance will be of
477 the requested type. Since accounting targets are part of the distinction,
478 providing a C<Buchungsgruppe> is recommended. If none is given the constructor
479 will load a default one and set the accounting targets from it.
483 Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
485 =item C<is_type $TYPE>
487 Tests if the current object is a part, a service or an
488 assembly. C<$type> must be one of the words 'part', 'service' or
489 'assembly' (their plurals are ok, too).
491 Returns 1 if the requested type matches, 0 if it doesn't and
492 C<confess>es if an unknown C<$type> parameter is encountered.
500 Shorthand for C<is_type('part')> etc.
502 =item C<get_sellprice_info %params>
504 Retrieves the C<sellprice> and C<price_factor_id> for a part under
505 different conditions and returns a hash reference with those two keys.
507 If C<%params> contains a key C<project_id> then a project price list
508 will be consulted if one exists for that project. In this case the
509 parameter C<country_id> is evaluated as well: if a price list entry
510 has been created for this country then it will be used. Otherwise an
511 entry without a country set will be used.
513 If none of the above conditions is met then the information from
516 =item C<get_ordered_qty %params>
518 Retrieves the quantity that has been ordered from a vendor but that
519 has not been delivered yet. Only open purchase orders are considered.
521 =item C<get_taxkey %params>
523 Retrieves and returns a taxkey object valid for the given date
524 C<$params{date}> and tax zone C<$params{taxzone}>
525 (C<$params{taxzone_id}> is also recognized). The date defaults to the
526 current date if undefined.
528 This function looks up the income (for trueish values of
529 C<$params{is_sales}>) or expense (for falsish values of
530 C<$params{is_sales}>) account for the current part. It uses the part's
531 associated buchungsgruppe and uses the fields belonging to the tax
532 zone given by C<$params{taxzone}>.
534 The information retrieved by the function is cached.
536 =item C<get_chart %params>
538 Retrieves and returns a chart object valid for the given type
539 C<$params{type}> and tax zone C<$params{taxzone}>
540 (C<$params{taxzone_id}> is also recognized). The type must be one of
541 the three key words C<income>, C<expense> and C<inventory>.
543 This function uses the part's associated buchungsgruppe and uses the
544 fields belonging to the tax zone given by C<$params{taxzone}>.
546 The information retrieved by the function is cached.
548 =item C<used_in_record>
550 Checks if this article has been used in orders, invoices or delivery orders.
554 Checks if this article is used in orders, invoices, delivery orders or
557 =item C<buchungsgruppe BUCHUNGSGRUPPE>
559 Used to set the accounting information from a L<SL:DB::Buchungsgruppe> object.
560 Please note, that this is a write only accessor, the original Buchungsgruppe can
561 not be retrieved from an article once set.
563 =item C<items_lastcost_sum>
565 Non-recursive lastcost sum of all the items in an assembly or assortment.
567 =item C<get_stock %params>
569 Fetches stock qty in the default unit for a part.
571 bin_id and warehouse_id may be passed as params. If only a bin_id is passed,
572 the stock qty for that bin is returned. If only a warehouse_id is passed, the
573 stock qty for all bins in that warehouse is returned. If a shippingdate is
574 passed the stock qty for that date is returned.
577 my $qty = $part->get_stock(bin_id => 52);
579 $part->get_stock(shippingdate => DateTime->today->add(days => -5));
585 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
586 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>