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 (
20 __PACKAGE__->meta->add_relationships(
22 type => 'one to many',
23 class => 'SL::DB::Assembly',
24 column_map => { id => 'id' },
27 type => 'one to many',
28 class => 'SL::DB::Price',
29 column_map => { id => 'parts_id' },
32 type => 'one to many',
33 class => 'SL::DB::MakeModel',
34 column_map => { id => 'parts_id' },
37 type => 'one to many',
38 class => 'SL::DB::Translation',
39 column_map => { id => 'parts_id' },
43 __PACKAGE__->meta->initialize;
45 __PACKAGE__->attr_html('notes');
47 __PACKAGE__->before_save('_before_save_set_partnumber');
49 sub _before_save_set_partnumber {
52 $self->create_trans_number if !$self->partnumber;
58 my $type = lc(shift || '');
59 die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
61 return $self->type eq $type ? 1 : 0;
64 sub is_part { $_[0]->is_type('part') }
65 sub is_assembly { $_[0]->is_type('assembly') }
66 sub is_service { $_[0]->is_type('service') }
69 my ($self, $type) = @_;
71 die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
72 $self->assembly( $type eq 'assembly' ? 1 : 0);
73 $self->inventory_accno_id($type ne 'service' ? 1 : undef);
76 return 'assembly' if $self->assembly;
77 return 'part' if $self->inventory_accno_id;
82 my ($class, %params) = @_;
83 $class->new(%params, type => 'part');
87 my ($class, %params) = @_;
88 $class->new(%params, type => 'assembly');
92 my ($class, %params) = @_;
93 $class->new(%params, type => 'service');
98 die 'not an accessor' if @_ > 1;
106 for my $class (@relations) {
107 eval "require $class";
108 return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
113 sub get_sellprice_info {
117 confess "Missing part id" unless $self->id;
119 my $object = $self->load;
121 return { sellprice => $object->sellprice,
122 price_factor_id => $object->price_factor_id };
125 sub get_ordered_qty {
127 my %result = SL::DB::Manager::Part->get_ordered_qty($self->id);
129 return $result{ $self->id };
132 sub available_units {
133 shift->unit_obj->convertible_units;
136 # autogenerated accessor is slightly off...
138 shift->buchungsgruppen(@_);
142 my ($self, %params) = @_;
144 my $date = $params{date} || DateTime->today_local;
145 my $is_sales = !!$params{is_sales};
146 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
148 $self->{__partpriv_taxkey_information} ||= { };
149 my $tk_info = $self->{__partpriv_taxkey_information};
151 $tk_info->{$taxzone} ||= { };
152 $tk_info->{$taxzone}->{$is_sales} ||= { };
154 if (!exists $tk_info->{$taxzone}->{$is_sales}->{$date}) {
155 $tk_info->{$taxzone}->{$is_sales}->{$date} =
156 $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
158 ->get_active_taxkey($date);
161 return $tk_info->{$taxzone}->{$is_sales}->{$date};
165 my ($self, %params) = @_;
167 my $type = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
168 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
170 $self->{__partpriv_get_chart_id} ||= { };
171 my $charts = $self->{__partpriv_get_chart_id};
173 $charts->{$taxzone} ||= { };
175 if (!exists $charts->{$taxzone}->{$type}) {
176 my $bugru = $self->buchungsgruppe;
177 my $chart_id = ($type eq 'inventory') ? ($self->inventory_accno_id ? $bugru->inventory_accno_id : undef)
178 : $bugru->call_sub("${type}_accno_id_${taxzone}");
180 $charts->{$taxzone}->{$type} = $chart_id ? SL::DB::Chart->new(id => $chart_id)->load : undef;
183 return $charts->{$taxzone}->{$type};
186 # this is designed to ignore chargenumbers, expiration dates and just give a list of how much <-> where
187 sub get_simple_stock {
188 my ($self, %params) = @_;
190 return [] unless $self->id;
193 SELECT sum(qty), warehouse_id, bin_id FROM inventory WHERE parts_id = ?
194 GROUP BY warehouse_id, bin_id
196 my $stock_info = selectall_hashref_query($::form, $::form->get_standard_dbh, $query, $self->id);
197 [ map { bless $_, 'SL::DB::Part::SimpleStock'} @$stock_info ];
199 # helper class to have bin/warehouse accessors in stock result
200 { package SL::DB::Part::SimpleStock;
201 sub warehouse { require SL::DB::Warehouse; SL::DB::Manager::Warehouse->find_by_or_create(id => $_[0]->{warehouse_id}) }
202 sub bin { require SL::DB::Bin; SL::DB::Manager::Bin ->find_by_or_create(id => $_[0]->{bin_id}) }
205 sub long_description {
206 join ' ', grep $_, map $_[0]->$_, qw(partnumber description);
219 SL::DB::Part: Model for the 'parts' table
223 This is a standard Rose::DB::Object based model and can be used as one.
227 Although the base class is called C<Part> we usually talk about C<Articles> if
228 we mean instances of this class. This is because articles come in three
233 =item Part - a single part
235 =item Service - a part without onhand, and without inventory accounting
237 =item Assembly - a collection of both parts and services
241 These types are sadly represented by data inside the class and cannot be
242 migrated into a flag. To work around this, each C<Part> object knows what type
243 it currently is. Since the type ist data driven, there ist no explicit setting
244 method for it, but you can construct them explicitly with C<new_part>,
245 C<new_service>, and C<new_assembly>. A Buchungsgruppe should be supplied in this
246 case, but it will use the default Buchungsgruppe if you don't.
248 Matching these there are assorted helper methods dealing with types,
249 e.g. L</new_part>, L</new_service>, L</new_assembly>, L</type>,
250 L</is_type> and others.
256 =item C<new_part %PARAMS>
258 =item C<new_service %PARAMS>
260 =item C<new_assembly %PARAMS>
262 Will set the appropriate data fields so that the resulting instance will be of
263 tthe requested type. Since part of the distinction are accounting targets,
264 providing a C<Buchungsgruppe> is recommended. If none is given the constructor
265 will load a default one and set the accounting targets from it.
269 Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
271 =item C<is_type $TYPE>
273 Tests if the current object is a part, a service or an
274 assembly. C<$type> must be one of the words 'part', 'service' or
275 'assembly' (their plurals are ok, too).
277 Returns 1 if the requested type matches, 0 if it doesn't and
278 C<confess>es if an unknown C<$type> parameter is encountered.
286 Shorthand for C<is_type('part')> etc.
288 =item C<get_sellprice_info %params>
290 Retrieves the C<sellprice> and C<price_factor_id> for a part under
291 different conditions and returns a hash reference with those two keys.
293 If C<%params> contains a key C<project_id> then a project price list
294 will be consulted if one exists for that project. In this case the
295 parameter C<country_id> is evaluated as well: if a price list entry
296 has been created for this country then it will be used. Otherwise an
297 entry without a country set will be used.
299 If none of the above conditions is met then the information from
302 =item C<get_ordered_qty %params>
304 Retrieves the quantity that has been ordered from a vendor but that
305 has not been delivered yet. Only open purchase orders are considered.
307 =item C<get_taxkey %params>
309 Retrieves and returns a taxkey object valid for the given date
310 C<$params{date}> and tax zone C<$params{taxzone}>
311 (C<$params{taxzone_id}> is also recognized). The date defaults to the
312 current date if undefined.
314 This function looks up the income (for trueish values of
315 C<$params{is_sales}>) or expense (for falsish values of
316 C<$params{is_sales}>) account for the current part. It uses the part's
317 associated buchungsgruppe and uses the fields belonging to the tax
318 zone given by C<$params{taxzone}> (range 0..3).
320 The information retrieved by the function is cached.
322 =item C<get_chart %params>
324 Retrieves and returns a chart object valid for the given type
325 C<$params{type}> and tax zone C<$params{taxzone}>
326 (C<$params{taxzone_id}> is also recognized). The type must be one of
327 the three key words C<income>, C<expense> and C<inventory>.
329 This function uses the part's associated buchungsgruppe and uses the
330 fields belonging to the tax zone given by C<$params{taxzone}> (range
333 The information retrieved by the function is cached.
337 Checks if this articke is used in orders, invoices, delivery orders or
340 =item C<buchungsgruppe BUCHUNGSGRUPPE>
342 Used to set the accounting informations from a L<SL:DB::Buchungsgruppe> object.
343 Please note, that this is a write only accessor, the original Buchungsgruppe can
344 not be retrieved from an article once set.
350 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
351 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>