use strict;
use Carp;
+use List::MoreUtils qw(any);
+
use SL::DBUtils;
use SL::DB::MetaSetup::Part;
use SL::DB::Manager::Part;
-
-__PACKAGE__->attr_number('lastcost', places => -2);
-__PACKAGE__->attr_number('listprice', places => -2);
-__PACKAGE__->attr_number('sellprice', places => -2);
+use SL::DB::Chart;
__PACKAGE__->meta->add_relationships(
unit_obj => {
class => 'SL::DB::Assembly',
column_map => { id => 'id' },
},
+ partsgroup => {
+ type => 'one to one',
+ class => 'SL::DB::PartsGroup',
+ column_map => { partsgroup_id => 'id' },
+ },
+ price_factor => {
+ type => 'one to one',
+ class => 'SL::DB::PriceFactor',
+ column_map => { price_factor_id => 'id' },
+ },
);
__PACKAGE__->meta->initialize;
sub is_type {
my $self = shift;
my $type = lc(shift || '');
+ die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
- if ($type =~ m/^part/) {
- return !$self->assembly && $self->inventory_accno_id ? 1 : 0;
-
- } elsif ($type =~ m/^service/) {
- return !$self->inventory_accno_id && !$self->assembly ? 1 : 0;
+ return $self->type eq $type ? 1 : 0;
+}
- } elsif ($type =~ m/^assembl/) {
- return $self->assembly ? 1 : 0;
+sub is_part { $_[0]->is_type('part') }
+sub is_assembly { $_[0]->is_type('assembly') }
+sub is_service { $_[0]->is_type('service') }
+sub type {
+ my ($self, $type) = @_;
+ if (@_ > 1) {
+ die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
+ $self->assembly( $type eq 'assembly' ? 1 : 0);
+ $self->inventory_accno_id($type ne 'service' ? 1 : undef);
}
- confess "Unknown type parameter '$type'";
+ return 'assembly' if $self->assembly;
+ return 'part' if $self->inventory_accno_id;
+ return 'service';
+}
+
+sub new_part {
+ my ($class, %params) = @_;
+ $class->new(%params, type => 'part');
+}
+
+sub new_assembly {
+ my ($class, %params) = @_;
+ $class->new(%params, type => 'assembly');
+}
+
+sub new_service {
+ my ($class, %params) = @_;
+ $class->new(%params, type => 'service');
+}
+
+sub orphaned {
+ my ($self) = @_;
+ die 'not an accessor' if @_ > 1;
+
+ my @relations = qw(
+ SL::DB::InvoiceItem
+ SL::DB::OrderItem
+ SL::DB::Inventory
+ SL::DB::RMAItem
+ );
+
+ for my $class (@relations) {
+ eval "require $class";
+ return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
+ }
+ return 1;
}
sub get_sellprice_info {
shift->unit_obj->convertible_units;
}
+# autogenerated accessor is slightly off...
+sub buchungsgruppe {
+ shift->buchungsgruppen(@_);
+}
+
+sub get_taxkey {
+ my ($self, %params) = @_;
+
+ my $date = $params{date} || DateTime->today_local;
+ my $is_sales = !!$params{is_sales};
+ my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
+
+ $self->{__partpriv_taxkey_information} ||= { };
+ my $tk_info = $self->{__partpriv_taxkey_information};
+
+ $tk_info->{$taxzone} ||= { };
+ $tk_info->{$taxzone}->{$is_sales} ||= { };
+
+ if (!exists $tk_info->{$taxzone}->{$is_sales}->{$date}) {
+ $tk_info->{$taxzone}->{$is_sales}->{$date} =
+ $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
+ ->load
+ ->get_active_taxkey($date);
+ }
+
+ return $tk_info->{$taxzone}->{$is_sales}->{$date};
+}
+
+sub get_chart {
+ my ($self, %params) = @_;
+
+ my $type = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
+ my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
+
+ $self->{__partpriv_get_chart_id} ||= { };
+ my $charts = $self->{__partpriv_get_chart_id};
+
+ $charts->{$taxzone} ||= { };
+
+ if (!exists $charts->{$taxzone}->{$type}) {
+ my $bugru = $self->buchungsgruppe;
+ my $chart_id = ($type eq 'inventory') ? ($self->inventory_accno_id ? $bugru->inventory_accno_id : undef)
+ : $bugru->call_sub("${type}_accno_id_${taxzone}");
+
+ $charts->{$taxzone}->{$type} = $chart_id ? SL::DB::Chart->new(id => $chart_id)->load : undef;
+ }
+
+ return $charts->{$taxzone}->{$type};
+}
+
1;
__END__
=pod
+=encoding utf-8
+
=head1 NAME
SL::DB::Part: Model for the 'parts' table
This is a standard Rose::DB::Object based model and can be used as one.
+=head1 TYPES
+
+Although the base class is called C<Part> we usually talk about C<Articles> if
+we mean instances of this class. This is because articles come in three
+flavours called:
+
+=over 4
+
+=item Part - a single part
+
+=item Service - a part without onhand, and without inventory accounting
+
+=item Assembly - a collection of both parts and services
+
+=back
+
+These types are sadly represented by data inside the class and cannot be
+migrated into a flag. To work around this, each C<Part> object knows what type
+it currently is. Since the type ist data driven, there ist no explicit setting
+method for it, but you can construct them explicitly with C<new_part>,
+C<new_service>, and C<new_assembly>. A Buchungsgruppe should be supplied in this
+case, but it will use the default Buchungsgruppe if you don't.
+
+Matching these there are assorted helper methods dealing with types,
+e.g. L</new_part>, L</new_service>, L</new_assembly>, L</type>,
+L</is_type> and others.
+
=head1 FUNCTIONS
=over 4
-=item is_type $type
+=item C<new_part %PARAMS>
+
+=item C<new_service %PARAMS>
+
+=item C<new_assembly %PARAMS>
+
+Will set the appropriate data fields so that the resulting instance will be of
+tthe requested type. Since part of the distinction are accounting targets,
+providing a C<Buchungsgruppe> is recommended. If none is given the constructor
+will load a default one and set the accounting targets from it.
+
+=item C<type>
+
+Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
+
+=item C<is_type $TYPE>
Tests if the current object is a part, a service or an
assembly. C<$type> must be one of the words 'part', 'service' or
Returns 1 if the requested type matches, 0 if it doesn't and
C<confess>es if an unknown C<$type> parameter is encountered.
-=item get_sellprice_info %params
+=item C<is_part>
+
+=item C<is_service>
+
+=item C<is_assembly>
+
+Shorthand for C<is_type('part')> etc.
+
+=item C<get_sellprice_info %params>
Retrieves the C<sellprice> and C<price_factor_id> for a part under
different conditions and returns a hash reference with those two keys.
If none of the above conditions is met then the information from
C<$self> is used.
-=item get_ordered_qty %params
+=item C<get_ordered_qty %params>
Retrieves the quantity that has been ordered from a vendor but that
has not been delivered yet. Only open purchase orders are considered.
-=item get_uncommissioned_qty %params
+=item C<get_taxkey %params>
+
+Retrieves and returns a taxkey object valid for the given date
+C<$params{date}> and tax zone C<$params{taxzone}>
+(C<$params{taxzone_id}> is also recognized). The date defaults to the
+current date if undefined.
+
+This function looks up the income (for trueish values of
+C<$params{is_sales}>) or expense (for falsish values of
+C<$params{is_sales}>) account for the current part. It uses the part's
+associated buchungsgruppe and uses the fields belonging to the tax
+zone given by C<$params{taxzone}> (range 0..3).
+
+The information retrieved by the function is cached.
+
+=item C<get_chart %params>
+
+Retrieves and returns a chart object valid for the given type
+C<$params{type}> and tax zone C<$params{taxzone}>
+(C<$params{taxzone_id}> is also recognized). The type must be one of
+the three key words C<income>, C<expense> and C<inventory>.
+
+This function uses the part's associated buchungsgruppe and uses the
+fields belonging to the tax zone given by C<$params{taxzone}> (range
+0..3).
+
+The information retrieved by the function is cached.
+
+=item C<orphaned>
+
+Checks if this articke is used in orders, invoices, delivery orders or
+assemblies.
+
+=item C<buchungsgruppe BUCHUNGSGRUPPE>
-Retrieves the quantity that has been ordered by a customer but that
-has not been commissioned yet. Only open sales orders are considered.
+Used to set the accounting informations 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.
=back
-=head1 AUTHOR
+=head1 AUTHORS
-Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
+Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>
=cut
projects / kivitendo-erp.git / blobdiff