6 use List::MoreUtils qw(any);
9 use SL::DB::MetaSetup::Part;
10 use SL::DB::Manager::Part;
12 use SL::DB::Helper::AttrHTML;
13 use SL::DB::Helper::TransNumberGenerator;
14 use SL::DB::Helper::CustomVariables (
19 __PACKAGE__->meta->add_relationships(
21 type => 'one to many',
22 class => 'SL::DB::Assembly',
23 column_map => { id => 'id' },
26 type => 'one to many',
27 class => 'SL::DB::Price',
28 column_map => { id => 'parts_id' },
31 type => 'one to many',
32 class => 'SL::DB::MakeModel',
33 column_map => { id => 'parts_id' },
36 type => 'one to many',
37 class => 'SL::DB::Translation',
38 column_map => { id => 'parts_id' },
42 __PACKAGE__->meta->initialize;
44 __PACKAGE__->attr_html('notes');
46 __PACKAGE__->before_save('_before_save_set_partnumber');
48 sub _before_save_set_partnumber {
51 $self->create_trans_number if !$self->partnumber;
57 my $type = lc(shift || '');
58 die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
60 return $self->type eq $type ? 1 : 0;
63 sub is_part { $_[0]->is_type('part') }
64 sub is_assembly { $_[0]->is_type('assembly') }
65 sub is_service { $_[0]->is_type('service') }
68 my ($self, $type) = @_;
70 die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
71 $self->assembly( $type eq 'assembly' ? 1 : 0);
72 $self->inventory_accno_id($type ne 'service' ? 1 : undef);
75 return 'assembly' if $self->assembly;
76 return 'part' if $self->inventory_accno_id;
81 my ($class, %params) = @_;
82 $class->new(%params, type => 'part');
86 my ($class, %params) = @_;
87 $class->new(%params, type => 'assembly');
91 my ($class, %params) = @_;
92 $class->new(%params, type => 'service');
97 die 'not an accessor' if @_ > 1;
105 for my $class (@relations) {
106 eval "require $class";
107 return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
112 sub get_sellprice_info {
116 confess "Missing part id" unless $self->id;
118 my $object = $self->load;
120 return { sellprice => $object->sellprice,
121 price_factor_id => $object->price_factor_id };
124 sub get_ordered_qty {
126 my %result = SL::DB::Manager::Part->get_ordered_qty($self->id);
128 return $result{ $self->id };
131 sub available_units {
132 shift->unit_obj->convertible_units;
135 # autogenerated accessor is slightly off...
137 shift->buchungsgruppen(@_);
141 my ($self, %params) = @_;
143 my $date = $params{date} || DateTime->today_local;
144 my $is_sales = !!$params{is_sales};
145 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
147 $self->{__partpriv_taxkey_information} ||= { };
148 my $tk_info = $self->{__partpriv_taxkey_information};
150 $tk_info->{$taxzone} ||= { };
151 $tk_info->{$taxzone}->{$is_sales} ||= { };
153 if (!exists $tk_info->{$taxzone}->{$is_sales}->{$date}) {
154 $tk_info->{$taxzone}->{$is_sales}->{$date} =
155 $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
157 ->get_active_taxkey($date);
160 return $tk_info->{$taxzone}->{$is_sales}->{$date};
164 my ($self, %params) = @_;
166 my $type = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
167 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
169 $self->{__partpriv_get_chart_id} ||= { };
170 my $charts = $self->{__partpriv_get_chart_id};
172 $charts->{$taxzone} ||= { };
174 if (!exists $charts->{$taxzone}->{$type}) {
175 my $bugru = $self->buchungsgruppe;
176 my $chart_id = ($type eq 'inventory') ? ($self->inventory_accno_id ? $bugru->inventory_accno_id : undef)
177 : $bugru->call_sub("${type}_accno_id_${taxzone}");
179 $charts->{$taxzone}->{$type} = $chart_id ? SL::DB::Chart->new(id => $chart_id)->load : undef;
182 return $charts->{$taxzone}->{$type};
185 # this is designed to ignore chargenumbers, expiration dates and just give a list of how much <-> where
186 sub get_simple_stock {
187 my ($self, %params) = @_;
189 return [] unless $self->id;
192 SELECT sum(qty), warehouse_id, bin_id FROM inventory WHERE parts_id = ?
193 GROUP BY warehouse_id, bin_id
195 my $stock_info = selectall_hashref_query($::form, $::form->get_standard_dbh, $query, $self->id);
196 [ map { bless $_, 'SL::DB::Part::SimpleStock'} @$stock_info ];
198 # helper class to have bin/warehouse accessors in stock result
199 { package SL::DB::Part::SimpleStock;
200 sub warehouse { require SL::DB::Warehouse; SL::DB::Manager::Warehouse->find_by_or_create(id => $_[0]->{warehouse_id}) }
201 sub bin { require SL::DB::Bin; SL::DB::Manager::Bin ->find_by_or_create(id => $_[0]->{bin_id}) }
204 sub long_description {
205 join ' ', grep $_, map $_[0]->$_, qw(partnumber description);
218 SL::DB::Part: Model for the 'parts' table
222 This is a standard Rose::DB::Object based model and can be used as one.
226 Although the base class is called C<Part> we usually talk about C<Articles> if
227 we mean instances of this class. This is because articles come in three
232 =item Part - a single part
234 =item Service - a part without onhand, and without inventory accounting
236 =item Assembly - a collection of both parts and services
240 These types are sadly represented by data inside the class and cannot be
241 migrated into a flag. To work around this, each C<Part> object knows what type
242 it currently is. Since the type ist data driven, there ist no explicit setting
243 method for it, but you can construct them explicitly with C<new_part>,
244 C<new_service>, and C<new_assembly>. A Buchungsgruppe should be supplied in this
245 case, but it will use the default Buchungsgruppe if you don't.
247 Matching these there are assorted helper methods dealing with types,
248 e.g. L</new_part>, L</new_service>, L</new_assembly>, L</type>,
249 L</is_type> and others.
255 =item C<new_part %PARAMS>
257 =item C<new_service %PARAMS>
259 =item C<new_assembly %PARAMS>
261 Will set the appropriate data fields so that the resulting instance will be of
262 tthe requested type. Since part of the distinction are accounting targets,
263 providing a C<Buchungsgruppe> is recommended. If none is given the constructor
264 will load a default one and set the accounting targets from it.
268 Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
270 =item C<is_type $TYPE>
272 Tests if the current object is a part, a service or an
273 assembly. C<$type> must be one of the words 'part', 'service' or
274 'assembly' (their plurals are ok, too).
276 Returns 1 if the requested type matches, 0 if it doesn't and
277 C<confess>es if an unknown C<$type> parameter is encountered.
285 Shorthand for C<is_type('part')> etc.
287 =item C<get_sellprice_info %params>
289 Retrieves the C<sellprice> and C<price_factor_id> for a part under
290 different conditions and returns a hash reference with those two keys.
292 If C<%params> contains a key C<project_id> then a project price list
293 will be consulted if one exists for that project. In this case the
294 parameter C<country_id> is evaluated as well: if a price list entry
295 has been created for this country then it will be used. Otherwise an
296 entry without a country set will be used.
298 If none of the above conditions is met then the information from
301 =item C<get_ordered_qty %params>
303 Retrieves the quantity that has been ordered from a vendor but that
304 has not been delivered yet. Only open purchase orders are considered.
306 =item C<get_taxkey %params>
308 Retrieves and returns a taxkey object valid for the given date
309 C<$params{date}> and tax zone C<$params{taxzone}>
310 (C<$params{taxzone_id}> is also recognized). The date defaults to the
311 current date if undefined.
313 This function looks up the income (for trueish values of
314 C<$params{is_sales}>) or expense (for falsish values of
315 C<$params{is_sales}>) account for the current part. It uses the part's
316 associated buchungsgruppe and uses the fields belonging to the tax
317 zone given by C<$params{taxzone}> (range 0..3).
319 The information retrieved by the function is cached.
321 =item C<get_chart %params>
323 Retrieves and returns a chart object valid for the given type
324 C<$params{type}> and tax zone C<$params{taxzone}>
325 (C<$params{taxzone_id}> is also recognized). The type must be one of
326 the three key words C<income>, C<expense> and C<inventory>.
328 This function uses the part's associated buchungsgruppe and uses the
329 fields belonging to the tax zone given by C<$params{taxzone}> (range
332 The information retrieved by the function is cached.
336 Checks if this articke is used in orders, invoices, delivery orders or
339 =item C<buchungsgruppe BUCHUNGSGRUPPE>
341 Used to set the accounting informations from a L<SL:DB::Buchungsgruppe> object.
342 Please note, that this is a write only accessor, the original Buchungsgruppe can
343 not be retrieved from an article once set.
349 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
350 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>