1 package SL::DB::Helper::TransNumberGenerator;
5 use parent qw(Exporter);
6 our @EXPORT = qw(get_next_trans_number create_trans_number);
9 use List::Util qw(max);
11 use SL::PrefixedNumber;
14 SL::DB::Manager::Order->type_filter($_[0]);
18 SL::DB::Manager::DeliveryOrder->type_filter($_[0]);
22 SL::DB::Manager::Part->type_filter($_[0]);
25 my %specs = ( ar => { number_column => 'invnumber', fill_holes_in_range => 1 },
26 sales_quotation => { number_column => 'quonumber', number_range_column => 'sqnumber', scoping => \&oe_scoping, },
27 sales_order => { number_column => 'ordnumber', number_range_column => 'sonumber', scoping => \&oe_scoping, },
28 request_quotation => { number_column => 'quonumber', number_range_column => 'rfqnumber', scoping => \&oe_scoping, },
29 purchase_order => { number_column => 'ordnumber', number_range_column => 'ponumber', scoping => \&oe_scoping, },
30 sales_delivery_order => { number_column => 'donumber', number_range_column => 'sdonumber', scoping => \&do_scoping, fill_holes_in_range => 1 },
31 purchase_delivery_order => { number_column => 'donumber', number_range_column => 'pdonumber', scoping => \&do_scoping, fill_holes_in_range => 1 },
32 customer => { number_column => 'customernumber', number_range_column => 'customernumber', },
33 vendor => { number_column => 'vendornumber', number_range_column => 'vendornumber', },
34 part => { number_column => 'partnumber', number_range_column => 'articlenumber', scoping => \&parts_scoping },
35 service => { number_column => 'partnumber', number_range_column => 'servicenumber', scoping => \&parts_scoping },
36 assembly => { number_column => 'partnumber', number_range_column => 'assemblynumber', scoping => \&parts_scoping },
39 sub get_next_trans_number {
40 my ($self, %params) = @_;
42 my $spec_type = $specs{ $self->meta->table } ? $self->meta->table : $self->type;
43 my $spec = $specs{ $spec_type } || croak("Unsupported class " . ref($self));
45 my $number_column = $spec->{number_column};
46 my $number = $self->$number_column;
47 my $number_range_column = $spec->{number_range_column} || $number_column;
48 my $scoping_conditions = $spec->{scoping};
49 my $fill_holes_in_range = $spec->{fill_holes_in_range};
51 return $number if $self->id && $number;
53 my %conditions = $scoping_conditions ? ( query => [ $scoping_conditions->($spec_type) ] ) : ();
54 my @numbers = map { $_->$number_column } @{ $self->_get_manager_class->get_all(%conditions) };
55 my %numbers_in_use = map { ( $_ => 1 ) } @numbers;
57 require SL::DB::Default;
58 my $defaults = SL::DB::Default->get;
59 $number_range_column = 'articlenumber' if $number_range_column eq 'assemblynumber' and length($defaults->$number_range_column) < 1;
60 my $sequence = SL::PrefixedNumber->new(number => ($defaults->$number_range_column || 1));
62 $sequence->set_to_max(@numbers) if !$fill_holes_in_range;
64 my $new_number = $sequence->get_next;
65 $new_number = $sequence->get_next while $numbers_in_use{$new_number};
67 $defaults->update_attributes($number_range_column => $new_number) if $params{update_defaults};
68 $self->$number_column($new_number) if $params{update_record};
73 sub create_trans_number {
74 my ($self, %params) = @_;
76 return $self->get_next_trans_number(update_defaults => 1, update_record => 1, %params);
89 SL::DB::Helper::TransNumberGenerator - A mixin for creating unique record numbers
95 =item C<get_next_trans_number %params>
97 Generates a new unique record number for the mixing class. Each record
98 type (invoices, sales quotations, purchase orders etc) has its own
99 number range. Within these ranges all numbers should be unique. The
100 table C<defaults> contains the last record number assigned for all of
103 This function contains hard-coded knowledge about the modules it can
104 be mixed into. This way the models themselves don't have to contain
105 boilerplate code for the details like the the number range column's
106 name in the C<defaults> table.
108 The process of creating a unique number involves the following steps:
110 At first all existing record numbers for the current type are
111 retrieved from the database as well as the last number assigned from
112 the table C<defaults>.
114 The next step is separating the number range from C<defaults> into two
115 parts: an optional non-numeric prefix and its numeric suffix. The
116 prefix, if present, will be kept intact.
118 Now the number itself is increased as often as neccessary to create a
119 unique one by comparing the generated numbers with the existing ones
120 retrieved in the first step. In this step gaps in the assigned numbers
121 are filled for some tables (e.g. invoices) but not for others
124 After creating the unique record number this function can update
125 C<$self> and the C<defaults> table if requested. This is controlled
126 with the following parameters:
130 =item * C<update_record>
132 Determines whether or not C<$self>'s record number field is set to the
133 newly generated number. C<$self> will not be saved even if this
134 parameter is trueish. Defaults to false.
136 =item * C<update_defaults>
138 Determines whether or not the number range value in the C<defaults>
139 table should be updated. Unlike C<$self> the C<defaults> table will be
140 saved. Defaults to false.
144 Always returns the newly generated number. This function cannot fail
145 and return a value. If it fails then it is due to exceptions.
147 =item C<create_trans_number %params>
149 Calls and returns L</get_next_trans_number> with the parameters
150 C<update_defaults = 1> and C<update_record = 1>. C<%params> is passed
157 This mixin exports all of its functions: L</get_next_trans_number> and
158 L</create_trans_number>. There are no optional exports.
166 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>