.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
.\"
.\" 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 "DateTime::Format::Builder::Parser::Regex 3"
.TH DateTime::Format::Builder::Parser::Regex 3 2024-09-01 "perl v5.40.0" "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
DateTime::Format::Builder::Parser::Regex \- Regex based date parsing
.SH VERSION
.IX Header "VERSION"
version 0.83
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 4
\&    my $parser = DateTime::Format::Builder\->create_parser(
\&        regex  => qr/^(\ed\ed\ed\ed)(\ed\ed)(\ed\ed)T(\ed\ed)(\ed\ed)(\ed\ed)$/,
\&        params => [qw( year month day hour minute second )],
\&    );
.Ve
.SH SPECIFICATION
.IX Header "SPECIFICATION"
In addition to the common keys, \f(CW\*(C`Regex\*(C'\fR supports:
.IP \(bu 4
regex
.Sp
\&\fBregex\fR is a regular expression that should capture elements of the datetime
string. This is a required element. This is the key whose presence indicates
it's a specification that belongs to this class.
.IP \(bu 4
params
.Sp
\&\fBparams\fR is an arrayref of key names. The captures from the regex are mapped
to these (\f(CW$1\fR to the first element, \f(CW$2\fR to the second, and so on) and
handed to \f(CW\*(C`DateTime\->new\*(C'\fR. This is a required element.
.IP \(bu 4
extra
.Sp
\&\fBextra\fR is a hashref of extra arguments you wish to give to \f(CW\*(C`DateTime\->new\*(C'\fR. For example, you could set the \f(CW\*(C`year\*(C'\fR or \f(CW\*(C`time_zone\*(C'\fR to defaults:
.Sp
.Vb 1
\&    extra => { year => 2004, time_zone => "Australia/Sydney" },
.Ve
.IP \(bu 4
\&\fBconstructor\fR is either an arrayref or a coderef. If an arrayref then the
first element is a class name or object, and the second element is a method
name (or coderef since Perl allows that sort of thing). The arguments to the
call are anything in \f(CW$p\fR and anything given in the \f(CW\*(C`extra\*(C'\fR option above.
.Sp
If only a coderef is supplied, then it is called with arguments of \f(CW$self\fR,
\&\f(CW$p\fR and \f(CW\*(C`extra\*(C'\fR.
.Sp
In short:
.Sp
.Vb 1
\&    $self\->$coderef( %{$p}, %{ $self\->{extra} } );
.Ve
.Sp
The method is expected to return a valid DateTime object, or \f(CW\*(C`undef\*(C'\fR in
event of failure, but can conceivably return anything it likes. So long as
it's 'true'.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\f(CW\*(C`datetime@perl.org\*(C'\fR mailing list.
.PP
http://datetime.perl.org/
.PP
perl, DateTime,
DateTime::Format::Builder
.SH SUPPORT
.IX Header "SUPPORT"
Bugs may be submitted at <https://github.com/houseabsolute/DateTime\-Format\-Builder/issues>.
.PP
I am also usually active on IRC as 'autarch' on \f(CW\*(C`irc://irc.perl.org\*(C'\fR.
.SH SOURCE
.IX Header "SOURCE"
The source code repository for DateTime-Format-Builder can be found at <https://github.com/houseabsolute/DateTime\-Format\-Builder>.
.SH AUTHORS
.IX Header "AUTHORS"
.IP \(bu 4
Dave Rolsky <autarch@urth.org>
.IP \(bu 4
Iain Truskett <spoon@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is Copyright (c) 2020 by Dave Rolsky.
.PP
This is free software, licensed under:
.PP
.Vb 1
\&  The Artistic License 2.0 (GPL Compatible)
.Ve
.PP
The full text of the license can be found in the
\&\fILICENSE\fR file included with this distribution.