.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "HTML::FormFu::Deflator::Strftime 3pm"
.TH HTML::FormFu::Deflator::Strftime 3pm 2024-04-10 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
HTML::FormFu::Deflator::Strftime \- Strftime deflator
.SH VERSION
.IX Header "VERSION"
version 2.07
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    $form\->deflator( Strftime => \*(Aqstart_time\*(Aq )
\&        \->strftime( \*(Aq%d/%m/%Y\*(Aq );
\&
\&    \-\-\-
\&    elements:
\&        \- type: Text
\&          inflators:
\&              \- type: DateTime
\&                parser:
\&                    strptime: "%Y/%m/%d"
\&          deflator:
\&              \- type: Strftime
\&                strftime: "%Y/%m/%d"
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Strftime deflator for DateTime objects.
.PP
When you redisplay a form to the user following an invalid submission,
any fields with DateTime inflators will stringify to something like
\&'1970\-01\-01T00:00:00'. In most cases it makes more sense to use the same
format you've asked the user for. This deflator allows you to specify a
more suitable and user-friendly format.
.PP
This deflator calls DateTime's \f(CW\*(C`strftime\*(C'\fR method. Possible values for
the format string are documented at
<http://search.cpan.org/dist/DateTime/lib/DateTime.pm#strftime_Patterns>.
.PP
If you set the form's locale (see "locale" in HTML::FormFu) this is set on the DateTime object. Now you can use \f(CW%x\fR to get the default date or \f(CW%X\fR for the default time for the object's locale.
.SH AUTHOR
.IX Header "AUTHOR"
Carl Franks, \f(CW\*(C`cfranks@cpan.org\*(C'\fR
.SH LICENSE
.IX Header "LICENSE"
This library is free software, you can redistribute it and/or modify it under
the same terms as Perl itself.
.SH AUTHOR
.IX Header "AUTHOR"
Carl Franks <cpan@fireartist.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2018 by Carl Franks.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.