Merge branch 'master' into dev

[kivitendo-erp.git] / SL / Helper / DateTime.pm

diff --git a/SL/Helper/DateTime.pm b/SL/Helper/DateTime.pm
index fa035eb..b72207f 100644 (file)
--- a/SL/Helper/DateTime.pm
+++ b/SL/Helper/DateTime.pm
@@ -1,5 +1,7 @@
 package DateTime;
 
+use strict;
+
 sub now_local {
   return shift->now(time_zone => $::locale->get_local_time_zone);
 }
@@ -8,14 +10,26 @@ sub today_local {
   return shift->now(time_zone => $::locale->get_local_time_zone)->truncate(to => 'day');
 }
 
+sub to_kivitendo {
+  my $self   = shift;
+  my %params = (scalar(@_) == 1) && (ref($_[0]) eq 'HASH') ? %{ $_[0] } : @_;
+  return $::locale->format_date_object($self, %params);
+}
+
 sub to_lxoffice {
-  return $::locale->format_date(\%::myconfig, $_[0]);
+  # Legacy name.
+  goto &to_kivitendo;
 }
 
-sub from_lxoffice {
+sub from_kivitendo {
   return $::locale->parse_date_to_object(\%::myconfig, $_[1]);
 }
 
+sub from_lxoffice {
+  # Legacy name.
+  goto &from_kivitendo;
+}
+
 1;
 
 __END__
@@ -38,16 +52,23 @@ Returns the current time with the time zone set to the local time zone.
 
 Returns the current date with the time zone set to the local time zone.
 
-=item C<to_lxoffice>
+=item C<to_kivitendo %param>
+
+Formats the date and time according to the current kivitendo user's
+date format with L<Locale::format_datetime_object>.
 
-Formats the date according to the current Lx-Office user's date
-format.
+The legacy name C<to_lxoffice> is still supported.
 
-=item C<from_lxoffice>
+=item C<from_kivitendo $string>
 
-Parses a date string formatted in the current Lx-Office user's date
+Parses a date string formatted in the current kivitendo user's date
 format and returns an instance of L<DateTime>.
 
+Note that only dates can be parsed at the moment, not the time
+component (as opposed to L<to_kivitendo>).
+
+The legacy name C<from_lxoffice> is still supported.
+
 =back
 
 =head1 AUTHOR