SL::DB::PaymentTerm::calc_date: Berechnung von Fälligkeitsdatum anhand von terms_nett...
authorMoritz Bunkus <m.bunkus@linet-services.de>
Thu, 11 Jul 2013 13:06:00 +0000 (15:06 +0200)
committerMoritz Bunkus <m.bunkus@linet-services.de>
Thu, 11 Jul 2013 13:06:24 +0000 (15:06 +0200)
SL/DB/PaymentTerm.pm

index 6a40a40..c087b7f 100644 (file)
@@ -19,4 +19,83 @@ sub validate {
   return @errors;
 }
 
+sub calc_date {
+  my ($self, %params) = @_;
+
+  my $reference_date  = $params{reference_date} || DateTime->today_local;
+  $reference_date     = DateTime->from_kivitendo($reference_date) unless ref($reference_date) eq 'DateTime';
+
+  my $terms           = ($params{terms} // 'net') eq 'discount' ? 'terms_skonto' : 'terms_netto';
+  my $date            = $reference_date->add(days => $self->$terms);
+
+  my $dow             = $date->day_of_week;
+  $date               = $date->add(days => 8 - $dow) if $dow > 5;
+
+  return $date;
+}
+
 1;
+__END__
+
+=pod
+
+=encoding utf8
+
+=head1 NAME
+
+SL::DB::PaymentTerm - Rose model for the payment_terms table
+
+=head1 SYNOPSIS
+
+  my $terms             = SL::DB::PaymentTerm->new(id => $::form->{payment_id})->load;
+  my $due_date_net      = $erms->calc_date(terms => 'net');      # uses terms_netto
+  my $due_date_discount = $erms->calc_date(terms => 'discount'); # uses terms_skonto
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item C<calc_date [%params]>
+
+Calculates and returns a due date as an instance of L<DateTime> by
+adding one of C<$self>'s terms fields. Note that the resulting date
+will be the following Monday if the result falls on a weekend.
+
+C<%params> can contain the following parameters:
+
+=over 4
+
+=item C<reference_date>
+
+The reference date from which the due date will be calculated. Can be
+either an instance of L<DateTime> or a scalar in which case the scalar
+is parsed via L<DateTime/from_kivitendo>.
+
+Defaults to the current date if unset.
+
+=item C<terms>
+
+Can be either C<net> or C<discount>. For C<net> the number of days to
+add to the reference date are C<$self-E<gt>terms_netto>. For
+C<discount> C<$self-E<gt>terms_skonto> is used.
+
+Defaults to C<net> if unset.
+
+=back
+
+=item C<validate>
+
+Validates before saving and returns an array of human-readable error
+messages in case of an error.
+
+=back
+
+=head1 BUGS
+
+Nothing here yet.
+
+=head1 AUTHOR
+
+Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>
+
+=cut