.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.28)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 turned on, 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
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Data::Faker::DateTime 3pm"
.TH Data::Faker::DateTime 3pm "2013-02-25" "perl v5.20.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"
Data::Faker::DateTime \- Data::Faker plugin
.SH "SYNOPSIS AND USAGE"
.IX Header "SYNOPSIS AND USAGE"
See Data::Faker
.SH "DATA PROVIDERS"
.IX Header "DATA PROVIDERS"
.IP "unixtime" 4
.IX Item "unixtime"
Return a unix time (seconds since the epoch) for a random time between the
epoch and now.
.IP "date" 4
.IX Item "date"
Return a random date as a string, using a random date format (see date_format).
.IP "time" 4
.IX Item "time"
Return a random time as a string, using a random time format (see time_format).
.IP "rfc822" 4
.IX Item "rfc822"
Return an \s-1RFC 822\s0 formatted random date.  This method may not work on systems
using a non-GNU strftime implementation (kindly let me know if that is the
case.)
.IP "ampm" 4
.IX Item "ampm"
Returns am or pm randomly (in the current locale) using one of the formats
specified in ampm_format.
.IP "time_format" 4
.IX Item "time_format"
Return a random time format.
.IP "date_format" 4
.IX Item "date_format"
Return a random date format.
.IP "ampm_format" 4
.IX Item "ampm_format"
Return a random am/pm format.
.IP "datetime_format" 4
.IX Item "datetime_format"
Return a random date and time format.
.IP "month" 4
.IX Item "month"
Return a random month name, unabbreviated, in the current locale.
.IP "month_abbr" 4
.IX Item "month_abbr"
Return a random month name, abbreviated, in the current locale.
.IP "weekday" 4
.IX Item "weekday"
Return a random weekday name, unabbreviated, in the current locale.
.IP "weekday_abbr" 4
.IX Item "weekday_abbr"
Return a random weekday name, abbreviated, in the current locale.
.IP "sqldate" 4
.IX Item "sqldate"
Return a random date in the \s-1ISO8601\s0 format commonly used by \s-1SQL\s0 servers
(YYYY-MM-DD).
.IP "datetime_locale" 4
.IX Item "datetime_locale"
Return a datetime string in the preferred date representation for the
current locale, for a random date.
.IP "date_locale" 4
.IX Item "date_locale"
Return a date string in the preferred date representation for the
current locale, for a random date.
.IP "time_locale" 4
.IX Item "time_locale"
Return a time string in the preferred date representation for the
current locale, for a random date.
.IP "century" 4
.IX Item "century"
Return a random century number.
.IP "dayofmonth" 4
.IX Item "dayofmonth"
Return a random day of the month.
.SH "UTILITY METHODS"
.IX Header "UTILITY METHODS"
.IP "Data::Faker::DateTime::timestr($format);" 4
.IX Item "Data::Faker::DateTime::timestr($format);"
Given a strftime format specifier, this method passes it through to
POSIX::strftime along with a random date to display in that format.
.Sp
Perl passes this through to the strftime function of your system library, so
it is possible that some of the formatting tokens used here will not work on
your system.
.SH "NOTES AND CAVEATS"
.IX Header "NOTES AND CAVEATS"
.IP "Be careful building timestamps from pieces" 4
.IX Item "Be careful building timestamps from pieces"
Be very careful about building date/time representations in formats that
are not already listed here.  For example if you wanted to get a date that
consists of just the month and day, you should \s-1NOT\s0 do this:
.Sp
.Vb 2
\&  my $faker = Data::Faker\->new();
\&  print join(\*(Aq \*(Aq,$faker\->month,$faker\->dayofmonth)."\en";
.Ve
.Sp
This is bad because you might end up with 'February 31' for example.  Instead
you should use the timestr utility function to provide you a formatted time
for a valid date, or better still, write a plugin function that does it:
.Sp
.Vb 2
\&  my $faker = Data::Faker\->new();
\&  print $faker\->my_short_date()."\en";
\&
\&  package Data::Faker::MyExtras;
\&  use base qw(Data::Faker);
\&  use Data::Faker::DateTime;
\&  _\|_PACKAGE_\|_\->register_plugin(
\&    my_short_date => sub { Data::Faker::DateTime::timestr(\*(Aq%M %e\*(Aq) },
\&  );
.Ve
.IP "POSIX::strftime" 4
.IX Item "POSIX::strftime"
See the documentation above regarding the timestr utility method for some
caveats related to strftime and your system library.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Data::Faker
.SH "AUTHOR"
.IX Header "AUTHOR"
Jason Kohles, <email@jasonkohles.com>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright 2004\-2005 by Jason Kohles
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.