The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

LSAUNDERS / DBIx-Class-0.08099_04 / lib / DBIx / Class / InflateColumn / DateTime.pm 

            

              
1
2
3
4
5
—
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
—
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
—
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137

              
package DBIx::Class::InflateColumn::DateTime;
use strict;
use warnings;
use base qw/DBIx::Class/;
=head1 NAME
DBIx::Class::InflateColumn::DateTime - Auto-create DateTime objects from date and datetime columns.
=head1 SYNOPSIS
Load this component and then declare one or more 
columns to be of the datetime, timestamp or date datatype.
  package Event;
  __PACKAGE__->load_components(qw/InflateColumn::DateTime Core/);
  __PACKAGE__->add_columns(
    starts_when => { data_type => 'datetime' }
  );
Then you can treat the specified column as a L<DateTime> object.
  print "This event starts the month of ".
    $event->starts_when->month_name();
If you want to set a specific timezone for that field, use:
  __PACKAGE__->add_columns(
    starts_when => { data_type => 'datetime', extra => { timezone => "America/Chicago" } }
  );
=head1 DESCRIPTION
This module figures out the type of DateTime::Format::* class to 
inflate/deflate with based on the type of DBIx::Class::Storage::DBI::* 
that you are using.  If you switch from one database to a different 
one your code should continue to work without modification (though note
that this feature is new as of 0.07, so it may not be perfect yet - bug
reports to the list very much welcome).
For more help with using components, see L<DBIx::Class::Manual::Component/USING>.
=cut
__PACKAGE__->load_components(qw/InflateColumn/);
__PACKAGE__->mk_group_accessors('simple' => '__datetime_parser');
=head2 register_column
Chains with the L<DBIx::Class::Row/register_column> method, and sets
up datetime columns appropriately.  This would not normally be
directly called by end users.
In the case of an invalid date, L<DateTime> will throw an exception.  To
bypass these exceptions and just have the inflation return undef, use
the C<datetime_undef_if_invalid> option in the column info:
   
    "broken_date",
    {
        data_type => "datetime",
        default_value => '0000-00-00',
        is_nullable => 1,
        datetime_undef_if_invalid => 1
    }
=cut
sub register_column {
  my ($self, $column, $info, @rest) = @_;
  $self->next::method($column, $info, @rest);
  return unless defined($info->{data_type});
  my $type = lc($info->{data_type});
  $type = 'datetime' if ($type =~ /^timestamp/);
  my $timezone;
  if ( exists $info->{extra} and exists $info->{extra}{timezone} and defined $info->{extra}{timezone} ) {
    $timezone = $info->{extra}{timezone};
  }
  my $undef_if_invalid = $info->{datetime_undef_if_invalid};
  if ($type eq 'datetime' || $type eq 'date') {
    my ($parse, $format) = ("parse_${type}", "format_${type}");
    $self->inflate_column(
      $column =>
        {
          inflate => sub {
            my ($value, $obj) = @_;
            my $dt = eval { $obj->_datetime_parser->$parse($value); };
            die "Error while inflating ${value} for ${column} on ${self}: $@"
              if $@ and not $undef_if_invalid;
            $dt->set_time_zone($timezone) if $timezone;
            return $dt;
          },
          deflate => sub {
            my ($value, $obj) = @_;
            $value->set_time_zone($timezone) if $timezone;
            $obj->_datetime_parser->$format($value);
          },
        }
    );
  }
}
sub _datetime_parser {
  my $self = shift;
  if (my $parser = $self->__datetime_parser) {
    return $parser;
  }
  my $parser = $self->result_source->storage->datetime_parser(@_);
  return $self->__datetime_parser($parser);
}
1;
__END__
=head1 SEE ALSO
=over 4
=item More information about the add_columns method, and column metadata, 
      can be found in the documentation for L<DBIx::Class::ResultSource>.
=back
=head1 AUTHOR
Matt S. Trout <mst@shadowcatsystems.co.uk>
=head1 CONTRIBUTORS
Aran Deltac <bluefeet@cpan.org>
=head1 LICENSE
You may distribute this code under the same terms as Perl itself.