Bug 10572: DBrev 3.13.00.037

[koha.git] / Koha / DateUtils.pm

diff --git a/Koha/DateUtils.pm b/Koha/DateUtils.pm
index 64a8473..4ae0d0c 100644 (file)
--- a/Koha/DateUtils.pm
+++ b/Koha/DateUtils.pm
@@ -13,8 +13,8 @@ package Koha::DateUtils;
 # A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
 #
 # You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 use strict;
 use warnings;
@@ -93,26 +93,32 @@ s/(\d{4})(\d{2})(\d{2})\s+(\d{2})(\d{2})(\d{2})/$1-$2-$3T$4:$5:$6/;
 
 =head2 output_pref
 
-$date_string = output_pref($dt, [$date_format], [$time_format] );
+$date_string = output_pref({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
+$date_string = output_pref( $dt );
 
 Returns a string containing the time & date formatted as per the C4::Context setting,
 or C<undef> if C<undef> was provided.
 
-A second parameter allows overriding of the syspref value. This is for testing only
-In usage use the DateTime objects own methods for non standard formatting
-
-A third parameter allows overriding of the TimeFormat syspref value
-
-A fourth parameter allows to specify if the output format contains the hours and minutes.
-If it is not defined, the default value is 0;
+This routine can either be passed a DateTime object or or a hashref.  If it is
+passed a hashref, the expected keys are a mandatory 'dt' for the DateTime,
+an optional 'dateformat' to override the dateformat system preference, an
+optional 'timeformat' to override the TimeFormat system preference value,
+and an optional 'dateonly' to specify that only the formatted date string
+should be returned without the time.
 
 =cut
 
 sub output_pref {
-    my $dt         = shift;
-    my $force_pref = shift;         # if testing we want to override Context
-    my $force_time = shift;
-    my $dateonly   = shift || 0;    # if you don't want the hours and minutes
+    my $params = shift;
+    my ( $dt, $force_pref, $force_time, $dateonly );
+    if ( ref $params eq 'HASH' ) {
+        $dt         = $params->{dt};
+        $force_pref = $params->{dateformat};         # if testing we want to override Context
+        $force_time = $params->{timeformat};
+        $dateonly   = $params->{dateonly} || 0;    # if you don't want the hours and minutes
+    } else {
+        $dt = $params;
+    }
 
     return unless defined $dt;
 
@@ -153,14 +159,19 @@ sub output_pref {
 
 =head2 output_pref_due
 
-$date_string = output_pref_due($dt, [$format] );
+$date_string = output_pref_due({ dt => $dt [, dateformat => $date_format, timeformat => $time_format, dateonly => 0|1 ] });
+$date_string = output_pref_due($dt);
 
 Returns a string containing the time & date formatted as per the C4::Context setting
 
-A second parameter allows overriding of the syspref value. This is for testing only
-In usage use the DateTime objects own methods for non standard formatting
+This routine can either be passed a DateTime object or or a hashref.  If it is
+passed a hashref, the expected keys are a mandatory 'dt' for the DateTime,
+an optional 'dateformat' to override the dateformat system preference, an
+optional 'timeformat' to override the TimeFormat system preference value,
+and an optional 'dateonly' to specify that only the formatted date string
+should be returned without the time.
 
-This is effectivelyt a wrapper around output_pref for due dates
+This is effectively a wrapper around output_pref for due dates;
 the time portion is stripped if it is '23:59'
 
 =cut
@@ -190,7 +201,12 @@ sub format_sqldatetime {
         my $dt = dt_from_string( $str, 'sql' );
         return q{} unless $dt;
         $dt->truncate( to => 'minute' );
-        return output_pref( $dt, $force_pref, $force_time, $dateonly );
+        return output_pref({
+            dt => $dt,
+            dateformat => $force_pref,
+            timeformat => $force_time,
+            dateonly => $dateonly
+        });
     }
     return q{};
 }
@@ -213,7 +229,12 @@ sub format_sqlduedatetime {
     if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) {
         my $dt = dt_from_string( $str, 'sql' );
         $dt->truncate( to => 'minute' );
-        return output_pref_due( $dt, $force_pref, $force_time, $dateonly );
+        return output_pref_due({
+            dt => $dt,
+            dateformat => $force_pref,
+            timeformat => $force_time,
+            dateonly => $dateonly
+        });
     }
     return q{};
 }