.\" -*- 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::Inflator::CompoundDateTime 3pm"
.TH HTML::FormFu::Inflator::CompoundDateTime 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::Inflator::CompoundDateTime \- CompoundDateTime inflator
.SH VERSION
.IX Header "VERSION"
version 2.07
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    \-\-\-
\&    element:
\&      \- type: Multi
\&        name: date
\&
\&        elements:
\&          \- name: day
\&          \- name: month
\&          \- name: year
\&
\&        inflator:
\&          \- type: CompoundDateTime
\&
\&    # get the submitted value as a DateTime object
\&
\&    my $date = $form\->param_value(\*(Aqdate\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
For use with a HTML::FormFu::Element::Multi group of fields.
.PP
Changes the input from several fields into a single DateTime value.
.PP
By default, expects the field names to be any of the following:
.IP year 4
.IX Item "year"
.PD 0
.IP month 4
.IX Item "month"
.IP day 4
.IX Item "day"
.IP hour 4
.IX Item "hour"
.IP minute 4
.IX Item "minute"
.IP second 4
.IX Item "second"
.IP nanosecond 4
.IX Item "nanosecond"
.IP time_zone 4
.IX Item "time_zone"
.PD
.SH METHODS
.IX Header "METHODS"
.SS field_order
.IX Subsection "field_order"
Arguments: \e@order
.PP
If your field names doesn't follow the convention listed above, you must
provide an arrayref containing the above names, in the order they correspond
with your own fields.
.PP
.Vb 4
\&    \-\-\-
\&    element:
\&      \- type: Multi
\&        name: date
\&
\&        elements:
\&          \- name: m
\&          \- name: d
\&          \- name: y
\&
\&        inflator:
\&          \- type: CompoundDateTime
\&            field_order:
\&              \- month
\&              \- day
\&              \- year
.Ve
.SS strptime
.IX Subsection "strptime"
Arguments: \e%args
.PP
Arguments: \f(CW$string\fR
.PP
Optional. Define the format that should be used if the DateTime object is
stringified.
.PP
Accepts a hashref of arguments to be passed to
"new" in DateTime::Format::Strptime. Alternatively, accepts a single string
argument, suitable for passing to
\&\f(CW\*(C`DateTime::Format::Strptime\->new( pattern => $string )\*(C'\fR.
.PP
.Vb 6
\&    \-\-\-
\&    inflator:
\&      \- type: CompoundDateTime
\&        strptime:
\&          pattern: \*(Aq%d\-%b\-%Y\*(Aq
\&          locale: de
\&
\&    \-\-\-
\&    inflator:
\&      \- type: CompoundDateTime
\&        strptime: \*(Aq%d\-%m\-%Y\*(Aq
.Ve
.SH AUTHOR
.IX Header "AUTHOR"
Carl Franks
.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.