Part: makemodels_sorted accessor
[kivitendo-erp.git] / SL / DB / Part.pm
index be6851e..5b5b4a2 100644 (file)
@@ -11,6 +11,7 @@ use SL::DB::MetaSetup::Part;
 use SL::DB::Manager::Part;
 use SL::DB::Chart;
 use SL::DB::Helper::AttrHTML;
+use SL::DB::Helper::AttrSorted;
 use SL::DB::Helper::TransNumberGenerator;
 use SL::DB::Helper::CustomVariables (
   module      => 'IC',
@@ -29,6 +30,7 @@ __PACKAGE__->meta->add_relationships(
     type         => 'one to many',
     class        => 'SL::DB::Price',
     column_map   => { id => 'parts_id' },
+    manager_args => { with_objects => [ 'pricegroup' ] }
   },
   makemodels     => {
     type         => 'one to many',
@@ -36,6 +38,11 @@ __PACKAGE__->meta->add_relationships(
     manager_args => { sort_by => 'sortorder' },
     column_map   => { id => 'parts_id' },
   },
+  customerprices => {
+    type         => 'one to many',
+    class        => 'SL::DB::PartCustomerPrice',
+    column_map   => { id => 'parts_id' },
+  },
   translations   => {
     type         => 'one to many',
     class        => 'SL::DB::Translation',
@@ -53,11 +60,18 @@ __PACKAGE__->meta->add_relationships(
     query_args      => [ what_done => 'part' ],
     manager_args    => { sort_by => 'itime' },
   },
+  shop_parts     => {
+    type         => 'one to many',
+    class        => 'SL::DB::ShopPart',
+    column_map   => { id => 'part_id' },
+    manager_args => { with_objects => [ 'shop' ] },
+  },
 );
 
 __PACKAGE__->meta->initialize;
 
 __PACKAGE__->attr_html('notes');
+__PACKAGE__->attr_sorted({ unsorted => 'makemodels', position => 'sortorder' });
 
 __PACKAGE__->before_save('_before_save_set_partnumber');
 
@@ -68,11 +82,32 @@ sub _before_save_set_partnumber {
   return 1;
 }
 
+sub items {
+  my ($self) = @_;
+
+  if ( $self->part_type eq 'assembly' ) {
+    return $self->assemblies;
+  } elsif ( $self->part_type eq 'assortment' ) {
+    return $self->assortment_items;
+  } else {
+    return undef;
+  }
+}
+
+sub items_checksum {
+  my ($self) = @_;
+
+  # for detecting if the items of an (orphaned) assembly or assortment have
+  # changed when saving
+
+  return join(' ', sort map { $_->part->id } @{$self->items});
+};
+
 sub validate {
   my ($self) = @_;
 
   my @errors;
-  push @errors, $::locale->text('The partnumber is missing.')     unless $self->partnumber;
+  push @errors, $::locale->text('The partnumber is missing.')     if $self->id and !$self->partnumber;
   push @errors, $::locale->text('The unit is missing.')           unless $self->unit;
   push @errors, $::locale->text('The buchungsgruppe is missing.') unless $self->buchungsgruppen_id or $self->buchungsgruppe;
 
@@ -80,7 +115,8 @@ sub validate {
     push @errors, $::locale->text('The partnumber already exists.') if SL::DB::Manager::Part->get_all_count(where => [ partnumber => $self->partnumber ]);
   };
 
-  if ($self->is_assortment && scalar @{$self->assortment_items} == 0) {
+  if ($self->is_assortment && $self->orphaned && scalar @{$self->assortment_items} == 0) {
+    # when assortment isn't orphaned form doesn't contain any items
     push @errors, $::locale->text('The assortment doesn\'t have any items.');
   }
 
@@ -140,18 +176,38 @@ sub new_assortment {
 
 sub last_modification {
   my ($self) = @_;
-  return $self->mtime or $self->itime;
+  return $self->mtime // $self->itime;
 };
 
+sub used_in_record {
+  my ($self) = @_;
+  die 'not an accessor' if @_ > 1;
+
+  return 1 unless $self->id;
+
+  my @relations = qw(
+    SL::DB::InvoiceItem
+    SL::DB::OrderItem
+    SL::DB::DeliveryOrderItem
+  );
+
+  for my $class (@relations) {
+    eval "require $class";
+    return 1 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
+  }
+  return 0;
+}
 sub orphaned {
   my ($self) = @_;
   die 'not an accessor' if @_ > 1;
 
+  return 1 unless $self->id;
+
   my @relations = qw(
     SL::DB::InvoiceItem
     SL::DB::OrderItem
+    SL::DB::DeliveryOrderItem
     SL::DB::Inventory
-    SL::DB::Assembly
     SL::DB::AssortmentItem
   );
 
@@ -238,6 +294,36 @@ sub get_chart {
   return $charts->{$taxzone}->{$type};
 }
 
+sub get_stock {
+  my ($self, %params) = @_;
+
+  return undef unless $self->id;
+
+  my $query = 'SELECT SUM(qty) FROM inventory WHERE parts_id = ?';
+  my @values = ($self->id);
+
+  if ( $params{bin_id} ) {
+    $query .= ' AND bin_id = ?';
+    push(@values, $params{bin_id});
+  }
+
+  if ( $params{warehouse_id} ) {
+    $query .= ' AND warehouse_id = ?';
+    push(@values, $params{warehouse_id});
+  }
+
+  if ( $params{shippingdate} ) {
+    die unless ref($params{shippingdate}) eq 'DateTime';
+    $query .= ' AND shippingdate <= ?';
+    push(@values, $params{shippingdate});
+  }
+
+  my ($stock) = selectrow_query($::form, $self->db->dbh, $query, @values);
+
+  return $stock || 0; # never return undef
+};
+
+
 # this is designed to ignore chargenumbers, expiration dates and just give a list of how much <-> where
 sub get_simple_stock {
   my ($self, %params) = @_;
@@ -265,14 +351,13 @@ sub clone_and_reset_deep {
   my ($self) = @_;
 
   my $clone = $self->clone_and_reset; # resets id and partnumber (primary key and unique constraint)
-  $clone->makemodels(       map { $_->clone_and_reset } @{$self->makemodels});
-  $clone->translations(     map { $_->clone_and_reset } @{$self->translations});
+  $clone->makemodels(   map { $_->clone_and_reset } @{$self->makemodels}   ) if @{$self->makemodels};
+  $clone->translations( map { $_->clone_and_reset } @{$self->translations} ) if @{$self->translations};
 
   if ( $self->is_assortment ) {
+    # use clone rather than reset_and_clone because the unique constraint would also remove parts_id
     $clone->assortment_items( map { $_->clone } @{$self->assortment_items} );
-      foreach my $ai ( @{ $clone->assortment_items } ) {
-        $ai->assortment_id(undef);
-      };
+    $_->assortment_id(undef) foreach @{ $clone->assortment_items }
   };
 
   if ( $self->is_assembly ) {
@@ -292,32 +377,47 @@ sub clone_and_reset_deep {
   return $clone;
 }
 
-sub assembly_sellprice_sum {
-  my ($self) = @_;
+sub item_diffs {
+  my ($self, $comparison_part) = @_;
 
-  return unless $self->is_assembly;
-  sum map { $_->linetotal_sellprice } @{$self->assemblies};
-};
+  die "item_diffs needs a part object" unless ref($comparison_part) eq 'SL::DB::Part';
+  die "part and comparison_part need to be of the same part_type" unless
+        ( $self->part_type eq 'assembly' or $self->part_type eq 'assortment' )
+    and ( $comparison_part->part_type eq 'assembly' or $comparison_part->part_type eq 'assortment' )
+    and $self->part_type eq $comparison_part->part_type;
 
-sub assembly_lastcost_sum {
-  my ($self) = @_;
+  # return [], [] if $self->items_checksum eq $comparison_part->items_checksum;
+  my @self_part_ids       = map { $_->parts_id } $self->items;
+  my @comparison_part_ids = map { $_->parts_id } $comparison_part->items;
 
-  return unless $self->is_assembly;
-  sum map { $_->linetotal_lastcost } @{$self->assemblies};
+  my %orig       = map{ $_ => 1 } @self_part_ids;
+  my %comparison = map{ $_ => 1 } @comparison_part_ids;
+  my (@additions, @removals);
+  @additions = grep { !exists( $orig{$_}       ) } @comparison_part_ids if @comparison_part_ids;
+  @removals  = grep { !exists( $comparison{$_} ) } @self_part_ids       if @self_part_ids;
+
+  return \@additions, \@removals;
 };
 
-sub assortment_sellprice_sum {
-  my ($self) = @_;
+sub items_sellprice_sum {
+  my ($self, %params) = @_;
 
-  return unless $self->is_assortment;
-  sum map { $_->linetotal_sellprice } @{$self->assortment_items};
-};
+  return unless $self->is_assortment or $self->is_assembly;
+  return unless $self->items;
+
+  if ($self->is_assembly) {
+    return sum map { $_->linetotal_sellprice          } @{$self->items};
+  } else {
+    return sum map { $_->linetotal_sellprice(%params) } grep { $_->charge } @{$self->items};
+  }
+}
 
-sub assortment_lastcost_sum {
+sub items_lastcost_sum {
   my ($self) = @_;
 
-  return unless $self->is_assortment;
-  sum map { $_->linetotal_lastcost } @{$self->assortment_items};
+  return unless $self->is_assortment or $self->is_assembly;
+  return unless $self->items;
+  sum map { $_->linetotal_lastcost } @{$self->items};
 };
 
 1;
@@ -350,7 +450,7 @@ flavours called:
 
 =item Assembly - a collection of both parts and services
 
-=item Assortment - a collection of parts
+=item Assortment - a collection of items (parts or assemblies)
 
 =back
 
@@ -447,6 +547,10 @@ fields belonging to the tax zone given by C<$params{taxzone}>.
 
 The information retrieved by the function is cached.
 
+=item C<used_in_record>
+
+Checks if this article has been used in orders, invoices or delivery orders.
+
 =item C<orphaned>
 
 Checks if this article is used in orders, invoices, delivery orders or
@@ -458,21 +562,23 @@ Used to set the accounting information from a L<SL:DB::Buchungsgruppe> object.
 Please note, that this is a write only accessor, the original Buchungsgruppe can
 not be retrieved from an article once set.
 
-=item C<assembly_sellprice_sum>
-
-Non-recursive sellprice sum of all the assembly item sellprices.
+=item C<items_lastcost_sum>
 
-=item C<assortment_sellprice_sum>
+Non-recursive lastcost sum of all the items in an assembly or assortment.
 
-Non-recursive sellprice sum of all the assortment item sellprices.
+=item C<get_stock %params>
 
-=item C<assembly_lastcost_sum>
+Fetches stock qty in the default unit for a part.
 
-Non-recursive lastcost sum of all the assembly item lastcosts.
+bin_id and warehouse_id may be passed as params. If only a bin_id is passed,
+the stock qty for that bin is returned. If only a warehouse_id is passed, the
+stock qty for all bins in that warehouse is returned.  If a shippingdate is
+passed the stock qty for that date is returned.
 
-=item C<assortment_lastcost_sum>
+Examples:
+ my $qty = $part->get_stock(bin_id => 52);
 
-Non-recursive lastcost sum of all the assortment item lastcosts.
+ $part->get_stock(shippingdate => DateTime->today->add(days => -5));
 
 =back