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' },
42 type => 'one to many',
43 class => 'SL::DB::AssortmentItem',
44 column_map => { id => 'assortment_id' },
48 __PACKAGE__->meta->initialize;
50 __PACKAGE__->attr_html('notes');
52 __PACKAGE__->before_save('_before_save_set_partnumber');
54 sub _before_save_set_partnumber {
57 $self->create_trans_number if !$self->partnumber;
65 push @errors, $::locale->text('The partnumber is missing.') unless $self->partnumber;
66 push @errors, $::locale->text('The unit is missing.') unless $self->unit;
67 push @errors, $::locale->text('The buchungsgruppe is missing.') unless $self->buchungsgruppen_id or $self->buchungsgruppe;
69 unless ( $self->id ) {
70 push @errors, $::locale->text('The partnumber already exists.') if SL::DB::Manager::Part->get_all_count(where => [ partnumber => $self->partnumber ]);
73 if ($self->is_assortment && scalar @{$self->assortment_items} == 0) {
74 push @errors, $::locale->text('The assortment doesn\'t have any items.');
77 if ($self->is_assembly && scalar @{$self->assemblies} == 0) {
78 push @errors, $::locale->text('The assembly doesn\'t have any items.');
86 my $type = lc(shift || '');
87 die 'invalid type' unless $type =~ /^(?:part|service|assembly|assortment)$/;
89 return $self->type eq $type ? 1 : 0;
92 sub is_part { $_[0]->part_type eq 'part' }
93 sub is_assembly { $_[0]->part_type eq 'assembly' }
94 sub is_service { $_[0]->part_type eq 'service' }
95 sub is_assortment { $_[0]->part_type eq 'assortment' }
98 return $_[0]->part_type;
99 # my ($self, $type) = @_;
101 # die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
102 # $self->assembly( $type eq 'assembly' ? 1 : 0);
103 # $self->inventory_accno_id($type ne 'service' ? 1 : undef);
106 # return 'assembly' if $self->assembly;
107 # return 'part' if $self->inventory_accno_id;
112 my ($class, %params) = @_;
113 $class->new(%params, part_type => 'part');
117 my ($class, %params) = @_;
118 $class->new(%params, part_type => 'assembly');
122 my ($class, %params) = @_;
123 $class->new(%params, part_type => 'service');
127 my ($class, %params) = @_;
128 $class->new(%params, part_type => 'assortment');
133 die 'not an accessor' if @_ > 1;
140 SL::DB::AssortmentItem
143 for my $class (@relations) {
144 eval "require $class";
145 return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
150 sub get_sellprice_info {
154 confess "Missing part id" unless $self->id;
156 my $object = $self->load;
158 return { sellprice => $object->sellprice,
159 price_factor_id => $object->price_factor_id };
162 sub get_ordered_qty {
164 my %result = SL::DB::Manager::Part->get_ordered_qty($self->id);
166 return $result{ $self->id };
169 sub available_units {
170 shift->unit_obj->convertible_units;
173 # autogenerated accessor is slightly off...
175 shift->buchungsgruppen(@_);
179 my ($self, %params) = @_;
181 my $date = $params{date} || DateTime->today_local;
182 my $is_sales = !!$params{is_sales};
183 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
184 my $tk_info = $::request->cache('get_taxkey');
186 $tk_info->{$self->id} //= {};
187 $tk_info->{$self->id}->{$taxzone} //= { };
188 my $cache = $tk_info->{$self->id}->{$taxzone}->{$is_sales} //= { };
190 if (!exists $cache->{$date}) {
192 $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
193 ->get_active_taxkey($date);
196 return $cache->{$date};
200 my ($self, %params) = @_;
202 my $type = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
203 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
205 my $charts = $::request->cache('get_chart_id/by_part_id_and_taxzone')->{$self->id} //= {};
206 my $all_charts = $::request->cache('get_chart_id/by_id');
208 $charts->{$taxzone} ||= { };
210 if (!exists $charts->{$taxzone}->{$type}) {
211 require SL::DB::Buchungsgruppe;
212 my $bugru = SL::DB::Buchungsgruppe->load_cached($self->buchungsgruppen_id);
213 my $chart_id = ($type eq 'inventory') ? ($self->inventory_accno_id ? $bugru->inventory_accno_id : undef)
214 : $bugru->call_sub("${type}_accno_id", $taxzone);
217 my $chart = $all_charts->{$chart_id} // SL::DB::Chart->load_cached($chart_id)->load;
218 $all_charts->{$chart_id} = $chart;
219 $charts->{$taxzone}->{$type} = $chart;
223 return $charts->{$taxzone}->{$type};
226 # this is designed to ignore chargenumbers, expiration dates and just give a list of how much <-> where
227 sub get_simple_stock {
228 my ($self, %params) = @_;
230 return [] unless $self->id;
233 SELECT sum(qty), warehouse_id, bin_id FROM inventory WHERE parts_id = ?
234 GROUP BY warehouse_id, bin_id
236 my $stock_info = selectall_hashref_query($::form, $::form->get_standard_dbh, $query, $self->id);
237 [ map { bless $_, 'SL::DB::Part::SimpleStock'} @$stock_info ];
239 # helper class to have bin/warehouse accessors in stock result
240 { package SL::DB::Part::SimpleStock;
241 sub warehouse { require SL::DB::Warehouse; SL::DB::Manager::Warehouse->find_by_or_create(id => $_[0]->{warehouse_id}) }
242 sub bin { require SL::DB::Bin; SL::DB::Manager::Bin ->find_by_or_create(id => $_[0]->{bin_id}) }
245 sub displayable_name {
246 join ' ', grep $_, map $_[0]->$_, qw(partnumber description);
259 SL::DB::Part: Model for the 'parts' table
263 This is a standard Rose::DB::Object based model and can be used as one.
267 Although the base class is called C<Part> we usually talk about C<Articles> if
268 we mean instances of this class. This is because articles come in three
273 =item Part - a single part
275 =item Service - a part without onhand, and without inventory accounting
277 =item Assembly - a collection of both parts and services
279 =item Assortment - a collection of parts
283 These types are sadly represented by data inside the class and cannot be
284 migrated into a flag. To work around this, each C<Part> object knows what type
285 it currently is. Since the type is data driven, there ist no explicit setting
286 method for it, but you can construct them explicitly with C<new_part>,
287 C<new_service>, C<new_assembly> and C<new_assortment>. A Buchungsgruppe should be supplied in this
288 case, but it will use the default Buchungsgruppe if you don't.
290 Matching these there are assorted helper methods dealing with types,
291 e.g. L</new_part>, L</new_service>, L</new_assembly>, L</type>,
292 L</is_type> and others.
298 =item C<new_part %PARAMS>
300 =item C<new_service %PARAMS>
302 =item C<new_assembly %PARAMS>
304 Will set the appropriate data fields so that the resulting instance will be of
305 the requested type. Since accounting targets are part of the distinction,
306 providing a C<Buchungsgruppe> is recommended. If none is given the constructor
307 will load a default one and set the accounting targets from it.
311 Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
313 =item C<is_type $TYPE>
315 Tests if the current object is a part, a service or an
316 assembly. C<$type> must be one of the words 'part', 'service' or
317 'assembly' (their plurals are ok, too).
319 Returns 1 if the requested type matches, 0 if it doesn't and
320 C<confess>es if an unknown C<$type> parameter is encountered.
328 Shorthand for C<is_type('part')> etc.
330 =item C<get_sellprice_info %params>
332 Retrieves the C<sellprice> and C<price_factor_id> for a part under
333 different conditions and returns a hash reference with those two keys.
335 If C<%params> contains a key C<project_id> then a project price list
336 will be consulted if one exists for that project. In this case the
337 parameter C<country_id> is evaluated as well: if a price list entry
338 has been created for this country then it will be used. Otherwise an
339 entry without a country set will be used.
341 If none of the above conditions is met then the information from
344 =item C<get_ordered_qty %params>
346 Retrieves the quantity that has been ordered from a vendor but that
347 has not been delivered yet. Only open purchase orders are considered.
349 =item C<get_taxkey %params>
351 Retrieves and returns a taxkey object valid for the given date
352 C<$params{date}> and tax zone C<$params{taxzone}>
353 (C<$params{taxzone_id}> is also recognized). The date defaults to the
354 current date if undefined.
356 This function looks up the income (for trueish values of
357 C<$params{is_sales}>) or expense (for falsish values of
358 C<$params{is_sales}>) account for the current part. It uses the part's
359 associated buchungsgruppe and uses the fields belonging to the tax
360 zone given by C<$params{taxzone}>.
362 The information retrieved by the function is cached.
364 =item C<get_chart %params>
366 Retrieves and returns a chart object valid for the given type
367 C<$params{type}> and tax zone C<$params{taxzone}>
368 (C<$params{taxzone_id}> is also recognized). The type must be one of
369 the three key words C<income>, C<expense> and C<inventory>.
371 This function uses the part's associated buchungsgruppe and uses the
372 fields belonging to the tax zone given by C<$params{taxzone}>.
374 The information retrieved by the function is cached.
378 Checks if this article is used in orders, invoices, delivery orders or
381 =item C<buchungsgruppe BUCHUNGSGRUPPE>
383 Used to set the accounting information from a L<SL:DB::Buchungsgruppe> object.
384 Please note, that this is a write only accessor, the original Buchungsgruppe can
385 not be retrieved from an article once set.
391 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
392 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>