X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=Koha%2FDateUtils.pm;h=4ae0d0ce694935d3f9eac3c699c0a21e19cfa0a9;hb=568f32606c2c9c247b2b477193a2d6814f738fa6;hp=4ffc1603dff5fb62693269f746074b7bc575221d;hpb=9f3ceb1b008d7827c93a6e9707fb8feff543cb48;p=koha.git diff --git a/Koha/DateUtils.pm b/Koha/DateUtils.pm index 4ffc1603df..4ae0d0ce69 100644 --- 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,48 +93,64 @@ 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, [$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 if C 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 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 $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; + $dt->set_time_zone( C4::Context->tz ); + my $pref = defined $force_pref ? $force_pref : C4::Context->preference('dateformat'); + + my $time_format = $force_time || C4::Context->preference('TimeFormat'); + my $time = ( $time_format eq '12hr' ) ? '%I:%M %p' : '%H:%M'; + given ($pref) { when (/^iso/) { return $dateonly - ? $dt->strftime('%Y-%m-%d') - : $dt->strftime('%Y-%m-%d %H:%M'); + ? $dt->strftime("%Y-%m-%d") + : $dt->strftime("%Y-%m-%d $time"); } when (/^metric/) { return $dateonly - ? $dt->strftime('%d/%m/%Y') - : $dt->strftime('%d/%m/%Y %H:%M'); + ? $dt->strftime("%d/%m/%Y") + : $dt->strftime("%d/%m/%Y $time"); } when (/^us/) { + return $dateonly - ? $dt->strftime('%m/%d/%Y') - : $dt->strftime('%m/%d/%Y %H:%M'); + ? $dt->strftime("%m/%d/%Y") + : $dt->strftime("%m/%d/%Y $time"); } default { return $dateonly - ? $dt->strftime('%Y-%m-%d') - : $dt->strftime('%Y-%m-%d %H:%M'); + ? $dt->strftime("%Y-%m-%d") + : $dt->strftime("%Y-%m-%d $time"); } } @@ -143,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 @@ -173,11 +194,19 @@ with output_pref as it is a frequent activity in scripts sub format_sqldatetime { my $str = shift; my $force_pref = shift; # if testing we want to override Context + my $force_time = shift; + my $dateonly = shift; + if ( defined $str && $str =~ m/^\d{4}-\d{2}-\d{2}/ ) { my $dt = dt_from_string( $str, 'sql' ); return q{} unless $dt; $dt->truncate( to => 'minute' ); - return output_pref( $dt, $force_pref ); + return output_pref({ + dt => $dt, + dateformat => $force_pref, + timeformat => $force_time, + dateonly => $dateonly + }); } return q{}; } @@ -194,10 +223,18 @@ with output_pref_due as it is a frequent activity in scripts sub format_sqlduedatetime { my $str = shift; my $force_pref = shift; # if testing we want to override Context + my $force_time = shift; + my $dateonly = shift; + 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 ); + return output_pref_due({ + dt => $dt, + dateformat => $force_pref, + timeformat => $force_time, + dateonly => $dateonly + }); } return q{}; }