.\" -*- 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::Element::DateTime 3pm"
.TH HTML::FormFu::Element::DateTime 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::Element::DateTime \- Date / Time combo field
.SH VERSION
.IX Header "VERSION"
version 2.07
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 6
\&    \-\-\-
\&    elements:
\&      \- type: DateTime
\&        name: start_datetime
\&        label: \*(AqStart:\*(Aq
\&        auto_inflate: 1
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Sub-class of Date element, providing extra
\&\f(CW\*(C`hour\*(C'\fR and \f(CW\*(C`minute\*(C'\fR Select menus.
.SH METHODS
.IX Header "METHODS"
.SS hour
.IX Subsection "hour"
Arguments: \e%setting
.PP
Set values effecting the \f(CW\*(C`hour\*(C'\fR select menu. Known keys are:
.PP
\fIname\fR
.IX Subsection "name"
.PP
Override the auto-generated name of the select menu.
.PP
\fIdefault\fR
.IX Subsection "default"
.PP
Set the default value of the select menu
.PP
\fIprefix\fR
.IX Subsection "prefix"
.PP
Arguments: \f(CW$value\fR
.PP
Arguments: \e@values
.PP
A string or arrayref of strings to be inserted into the start of the select
menu.
.PP
Each value is only used as the label for a select item \- the value for each
of these items is always the empty string \f(CW\*(Aq\*(Aq\fR.
.PP
\fIprefix_loc\fR
.IX Subsection "prefix_loc"
.PP
Arguments: \f(CW$localization_key\fR
.PP
Arguments: \e@localization_keys
.PP
A localized string or arrayref of localized strings to be inserted into the
start of the select menu.
.PP
Each value is localized and then only used as the label for a select item
\&\- the value for each of these items is always the empty string \f(CW\*(Aq\*(Aq\fR.
.PP
Use \f(CW\*(C`prefix_loc\*(C'\fR insted of \f(CW\*(C`prefix\*(C'\fR.
.SS minute
.IX Subsection "minute"
Arguments: \e%setting
.PP
Set values effecting the \f(CW\*(C`minute\*(C'\fR select menu. Known keys are:
.PP
\fIname\fR
.IX Subsection "name"
.PP
Override the auto-generated name of the select menu.
.PP
\fIdefault\fR
.IX Subsection "default"
.PP
Set the default value of the select menu
.PP
\fIprefix\fR
.IX Subsection "prefix"
.PP
Arguments: \f(CW$value\fR
.PP
Arguments: \e@values
.PP
A string or arrayref of strings to be inserted into the start of the select
menu.
.PP
Each value is only used as the label for a select item \- the value for each
of these items is always the empty string \f(CW\*(Aq\*(Aq\fR.
.PP
\fIprefix_loc\fR
.IX Subsection "prefix_loc"
.PP
Arguments: \f(CW$localization_key\fR
.PP
Arguments: \e@localization_keys
.PP
A localized string or arrayref of localized strings to be inserted into the
start of the select menu.
.PP
Each value is localized and then only used as the label for a select item
\&\- the value for each of these items is always the empty string \f(CW\*(Aq\*(Aq\fR.
.PP
Use \f(CW\*(C`prefix_loc\*(C'\fR insted of \f(CW\*(C`prefix\*(C'\fR.
.SS second
.IX Subsection "second"
Arguments: \e%setting
.PP
Set values effecting the \f(CW\*(C`second\*(C'\fR select menu. Known keys are:
.PP
\fIname\fR
.IX Subsection "name"
.PP
Override the auto-generated name of the select menu.
.PP
\fIdefault\fR
.IX Subsection "default"
.PP
Set the default value of the select menu
.PP
\fIprefix\fR
.IX Subsection "prefix"
.PP
Arguments: \f(CW$value\fR
.PP
Arguments: \e@values
.PP
A string or arrayref of strings to be inserted into the start of the select
menu.
.PP
Each value is only used as the label for a select item \- the value for each
of these items is always the empty string \f(CW\*(Aq\*(Aq\fR.
.PP
\fIprefix_loc\fR
.IX Subsection "prefix_loc"
.PP
Arguments: \f(CW$localization_key\fR
.PP
Arguments: \e@localization_keys
.PP
A localized string or arrayref of localized strings to be inserted into the
start of the select menu.
.PP
Each value is localized and then only used as the label for a select item
\&\- the value for each of these items is always the empty string \f(CW\*(Aq\*(Aq\fR.
.PP
Use \f(CW\*(C`prefix_loc\*(C'\fR insted of \f(CW\*(C`prefix\*(C'\fR.
.SS field_order
.IX Subsection "field_order"
Arguments: \e@fields
.PP
Default Value: ['day', 'month', 'year', 'hour', 'minute']
.PP
Specify the order of the date fields in the rendered HTML.
.PP
If you want the "second" selector to display, you must set both
\&\f(CW\*(C`/field_order\*(C'\fR and strftime
yourself. Eg:
.PP
.Vb 5
\&    elements:
\&      type: DateTime
\&      name: foo
\&      strftime: \*(Aq%d\-%m\-%Y %H:%M:%S\*(Aq
\&      field_order: [\*(Aqday\*(Aq, \*(Aqmonth\*(Aq, \*(Aqyear\*(Aq, \*(Aqhour\*(Aq, \*(Aqminute\*(Aq, \*(Aqsecond\*(Aq]
.Ve
.PP
Not all fields are required. No single field can be used more than once.
.SH CAVEATS
.IX Header "CAVEATS"
See "CAVEATS" in HTML::FormFu::Element::Date
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Is a sub-class of, and inherits methods from
HTML::FormFu::Element::Date
HTML::FormFu::Role::Element::Field,
HTML::FormFu::Element::Multi,
HTML::FormFu::Element::Block,
HTML::FormFu::Element
.PP
HTML::FormFu
.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.