3 package MooseX::Types::DateTime;
10 use DateTime 0.4302 ();
11 use DateTime::Duration 0.4302 ();
12 use DateTime::Locale 0.4001 ();
13 use DateTime::TimeZone 0.95 ();
15 use MooseX::Types::Moose 0.30 qw/Num HashRef Str/;
17 use namespace::clean 0.08;
19 use MooseX::Types 0.30 -declare => [qw( DateTime Duration TimeZone Locale Now )];
21 class_type "DateTime";
22 class_type "DateTime::Duration";
23 class_type "DateTime::TimeZone";
24 class_type "DateTime::Locale::root" => { name => "DateTime::Locale" };
26 subtype DateTime, as 'DateTime';
27 subtype Duration, as 'DateTime::Duration';
28 subtype TimeZone, as 'DateTime::TimeZone';
29 subtype Locale, as 'DateTime::Locale';
33 where { $_ eq 'now' },
34 ($Moose::VERSION >= 2.0100
35 ? Moose::Util::TypeConstraints::inline_as {
36 'no warnings "uninitialized";'.
37 '!ref(' . $_[1] . ') and '. $_[1] .' eq "now"';
39 : Moose::Util::TypeConstraints::optimize_as {
40 no warnings 'uninitialized';
41 !ref($_[0]) and $_[0] eq 'now';
48 from Num, via { 'DateTime'->from_epoch( epoch => $_ ) },
49 from HashRef, via { 'DateTime'->new( %$_ ) },
50 from Now, via { 'DateTime'->now },
52 "DateTime::Duration" => [
53 from Num, via { DateTime::Duration->new( seconds => $_ ) },
54 from HashRef, via { DateTime::Duration->new( %$_ ) },
56 "DateTime::TimeZone" => [
57 from Str, via { DateTime::TimeZone->new( name => $_ ) },
59 "DateTime::Locale" => [
60 from Moose::Util::TypeConstraints::find_or_create_isa_type_constraint("Locale::Maketext"),
61 via { DateTime::Locale->load($_->language_tag) },
62 from Str, via { DateTime::Locale->load($_) },
66 for my $type ( "DateTime", DateTime ) {
67 coerce $type => @{ $coercions{DateTime} };
70 for my $type ( "DateTime::Duration", Duration ) {
71 coerce $type => @{ $coercions{"DateTime::Duration"} };
74 for my $type ( "DateTime::TimeZone", TimeZone ) {
75 coerce $type => @{ $coercions{"DateTime::TimeZone"} };
78 for my $type ( "DateTime::Locale", Locale ) {
79 coerce $type => @{ $coercions{"DateTime::Locale"} };
90 MooseX::Types::DateTime - L<DateTime> related constraints and coercions for
97 use MooseX::Types::DateTime qw(TimeZone);
105 Class->new( time_zone => "Africa/Timbuktu" );
109 use MooseX::Types::DateTime;
112 isa => 'DateTime::TimeZone',
117 Class->new( time_zone => "Africa/Timbuktu" );
121 This module packages several L<Moose::Util::TypeConstraints> with coercions,
122 designed to work with the L<DateTime> suite of objects.
130 A class type for L<DateTime>.
136 Uses L<DateTime/from_epoch>. Floating values will be used for subsecond
137 percision, see L<DateTime> for details.
139 =item from C<HashRef>
141 Calls L<DateTime/new> with the hash entries as arguments.
147 A class type for L<DateTime::Duration>
153 Uses L<DateTime::Duration/new> and passes the number as the C<seconds> argument.
155 Note that due to leap seconds, DST changes etc this may not do what you expect.
156 For instance passing in C<86400> is not always equivalent to one day, although
157 there are that many seconds in a day. See L<DateTime/"How Date Math is Done">
160 =item from C<HashRef>
162 Calls L<DateTime::Duration/new> with the hash entries as arguments.
166 =item L<DateTime::Locale>
168 A class type for L<DateTime::Locale::root> with the name L<DateTime::Locale>.
174 The string is treated as a language tag (e.g. C<en> or C<he_IL>) and given to
175 L<DateTime::Locale/load>.
177 =item from L<Locale::Maktext>
179 The C<Locale::Maketext/language_tag> attribute will be used with L<DateTime::Locale/load>.
181 =item L<DateTime::TimeZone>
183 A class type for L<DateTime::TimeZone>.
189 Treated as a time zone name or offset. See L<DateTime::TimeZone/USAGE> for more
190 details on the allowed values.
192 Delegates to L<DateTime::TimeZone/new> with the string as the C<name> argument.
202 L<MooseX::Types::DateTime::MoreCoercions>
204 L<DateTime>, L<DateTimeX::Easy>
206 =head1 VERSION CONTROL
208 This module is maintained using git. You can get the latest version from
209 L<git://git.moose.perl.org/MooseX-Types-DateTime.git>.
213 Yuval Kogman E<lt>nothingmuch@woobling.orgE<gt>
215 John Napiorkowski E<lt>jjn1056 at yahoo.comE<gt>
219 Copyright (c) 2008 Yuval Kogman. All rights reserved
220 This program is free software; you can redistribute
221 it and/or modify it under the same terms as Perl itself.