6 use List::MoreUtils qw(any);
9 use SL::DB::MetaSetup::Part;
10 use SL::DB::Manager::Part;
12 use SL::DB::Helper::TransNumberGenerator;
13 use SL::DB::Helper::CustomVariables (
18 __PACKAGE__->meta->add_relationships(
21 class => 'SL::DB::Unit',
22 column_map => { unit => 'name' },
25 type => 'one to many',
26 class => 'SL::DB::Assembly',
27 column_map => { id => 'id' },
31 class => 'SL::DB::PartsGroup',
32 column_map => { partsgroup_id => 'id' },
36 class => 'SL::DB::PriceFactor',
37 column_map => { price_factor_id => 'id' },
40 type => 'one to many',
41 class => 'SL::DB::Price',
42 column_map => { id => 'parts_id' },
45 type => 'one to many',
46 class => 'SL::DB::MakeModel',
47 column_map => { id => 'parts_id' },
50 type => 'one to many',
51 class => 'SL::DB::Translation',
52 column_map => { id => 'parts_id' },
55 type => 'one to many',
56 class => 'SL::DB::CustomVariable',
57 column_map => { id => 'trans_id' },
58 query_args => [ config_id => [ \"(SELECT custom_variable_configs.id FROM custom_variable_configs WHERE custom_variable_configs.module = 'IC')" ] ],
62 __PACKAGE__->meta->initialize;
64 __PACKAGE__->before_save('_before_save_set_partnumber');
66 sub _before_save_set_partnumber {
69 $self->create_trans_number if $self->partnumber eq '';
75 my $type = lc(shift || '');
76 die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
78 return $self->type eq $type ? 1 : 0;
81 sub is_part { $_[0]->is_type('part') }
82 sub is_assembly { $_[0]->is_type('assembly') }
83 sub is_service { $_[0]->is_type('service') }
86 my ($self, $type) = @_;
88 die 'invalid type' unless $type =~ /^(?:part|service|assembly)$/;
89 $self->assembly( $type eq 'assembly' ? 1 : 0);
90 $self->inventory_accno_id($type ne 'service' ? 1 : undef);
93 return 'assembly' if $self->assembly;
94 return 'part' if $self->inventory_accno_id;
99 my ($class, %params) = @_;
100 $class->new(%params, type => 'part');
104 my ($class, %params) = @_;
105 $class->new(%params, type => 'assembly');
109 my ($class, %params) = @_;
110 $class->new(%params, type => 'service');
115 die 'not an accessor' if @_ > 1;
124 for my $class (@relations) {
125 eval "require $class";
126 return 0 if $class->_get_manager_class->get_all_count(query => [ parts_id => $self->id ]);
131 sub get_sellprice_info {
135 confess "Missing part id" unless $self->id;
137 my $object = $self->load;
139 return { sellprice => $object->sellprice,
140 price_factor_id => $object->price_factor_id };
143 sub get_ordered_qty {
145 my %result = SL::DB::Manager::Part->get_ordered_qty($self->id);
147 return $result{ $self->id };
150 sub available_units {
151 shift->unit_obj->convertible_units;
154 # autogenerated accessor is slightly off...
156 shift->buchungsgruppen(@_);
160 my ($self, %params) = @_;
162 my $date = $params{date} || DateTime->today_local;
163 my $is_sales = !!$params{is_sales};
164 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
166 $self->{__partpriv_taxkey_information} ||= { };
167 my $tk_info = $self->{__partpriv_taxkey_information};
169 $tk_info->{$taxzone} ||= { };
170 $tk_info->{$taxzone}->{$is_sales} ||= { };
172 if (!exists $tk_info->{$taxzone}->{$is_sales}->{$date}) {
173 $tk_info->{$taxzone}->{$is_sales}->{$date} =
174 $self->get_chart(type => $is_sales ? 'income' : 'expense', taxzone => $taxzone)
176 ->get_active_taxkey($date);
179 return $tk_info->{$taxzone}->{$is_sales}->{$date};
183 my ($self, %params) = @_;
185 my $type = (any { $_ eq $params{type} } qw(income expense inventory)) ? $params{type} : croak("Invalid 'type' parameter '$params{type}'");
186 my $taxzone = $params{ defined($params{taxzone}) ? 'taxzone' : 'taxzone_id' } * 1;
188 $self->{__partpriv_get_chart_id} ||= { };
189 my $charts = $self->{__partpriv_get_chart_id};
191 $charts->{$taxzone} ||= { };
193 if (!exists $charts->{$taxzone}->{$type}) {
194 my $bugru = $self->buchungsgruppe;
195 my $chart_id = ($type eq 'inventory') ? ($self->inventory_accno_id ? $bugru->inventory_accno_id : undef)
196 : $bugru->call_sub("${type}_accno_id_${taxzone}");
198 $charts->{$taxzone}->{$type} = $chart_id ? SL::DB::Chart->new(id => $chart_id)->load : undef;
201 return $charts->{$taxzone}->{$type};
214 SL::DB::Part: Model for the 'parts' table
218 This is a standard Rose::DB::Object based model and can be used as one.
222 Although the base class is called C<Part> we usually talk about C<Articles> if
223 we mean instances of this class. This is because articles come in three
228 =item Part - a single part
230 =item Service - a part without onhand, and without inventory accounting
232 =item Assembly - a collection of both parts and services
236 These types are sadly represented by data inside the class and cannot be
237 migrated into a flag. To work around this, each C<Part> object knows what type
238 it currently is. Since the type ist data driven, there ist no explicit setting
239 method for it, but you can construct them explicitly with C<new_part>,
240 C<new_service>, and C<new_assembly>. A Buchungsgruppe should be supplied in this
241 case, but it will use the default Buchungsgruppe if you don't.
243 Matching these there are assorted helper methods dealing with types,
244 e.g. L</new_part>, L</new_service>, L</new_assembly>, L</type>,
245 L</is_type> and others.
251 =item C<new_part %PARAMS>
253 =item C<new_service %PARAMS>
255 =item C<new_assembly %PARAMS>
257 Will set the appropriate data fields so that the resulting instance will be of
258 tthe requested type. Since part of the distinction are accounting targets,
259 providing a C<Buchungsgruppe> is recommended. If none is given the constructor
260 will load a default one and set the accounting targets from it.
264 Returns the type as a string. Can be one of C<part>, C<service>, C<assembly>.
266 =item C<is_type $TYPE>
268 Tests if the current object is a part, a service or an
269 assembly. C<$type> must be one of the words 'part', 'service' or
270 'assembly' (their plurals are ok, too).
272 Returns 1 if the requested type matches, 0 if it doesn't and
273 C<confess>es if an unknown C<$type> parameter is encountered.
281 Shorthand for C<is_type('part')> etc.
283 =item C<get_sellprice_info %params>
285 Retrieves the C<sellprice> and C<price_factor_id> for a part under
286 different conditions and returns a hash reference with those two keys.
288 If C<%params> contains a key C<project_id> then a project price list
289 will be consulted if one exists for that project. In this case the
290 parameter C<country_id> is evaluated as well: if a price list entry
291 has been created for this country then it will be used. Otherwise an
292 entry without a country set will be used.
294 If none of the above conditions is met then the information from
297 =item C<get_ordered_qty %params>
299 Retrieves the quantity that has been ordered from a vendor but that
300 has not been delivered yet. Only open purchase orders are considered.
302 =item C<get_taxkey %params>
304 Retrieves and returns a taxkey object valid for the given date
305 C<$params{date}> and tax zone C<$params{taxzone}>
306 (C<$params{taxzone_id}> is also recognized). The date defaults to the
307 current date if undefined.
309 This function looks up the income (for trueish values of
310 C<$params{is_sales}>) or expense (for falsish values of
311 C<$params{is_sales}>) account for the current part. It uses the part's
312 associated buchungsgruppe and uses the fields belonging to the tax
313 zone given by C<$params{taxzone}> (range 0..3).
315 The information retrieved by the function is cached.
317 =item C<get_chart %params>
319 Retrieves and returns a chart object valid for the given type
320 C<$params{type}> and tax zone C<$params{taxzone}>
321 (C<$params{taxzone_id}> is also recognized). The type must be one of
322 the three key words C<income>, C<expense> and C<inventory>.
324 This function uses the part's associated buchungsgruppe and uses the
325 fields belonging to the tax zone given by C<$params{taxzone}> (range
328 The information retrieved by the function is cached.
332 Checks if this articke is used in orders, invoices, delivery orders or
335 =item C<buchungsgruppe BUCHUNGSGRUPPE>
337 Used to set the accounting informations from a L<SL:DB::Buchungsgruppe> object.
338 Please note, that this is a write only accessor, the original Buchungsgruppe can
339 not be retrieved from an article once set.
345 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>,
346 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>