From: Daniel Westermann-Clark Date: Thu, 5 Jan 2006 22:36:56 +0000 (+0000) Subject: First pass at docs for InflateColumn X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=commitdiff_plain;h=bcae85db99de55c41e24bdb02cce49e70d45ab92;p=dbsrgits%2FDBIx-Class-Historic.git First pass at docs for InflateColumn --- diff --git a/lib/DBIx/Class/InflateColumn.pm b/lib/DBIx/Class/InflateColumn.pm index 25995ab..9cfea79 100644 --- a/lib/DBIx/Class/InflateColumn.pm +++ b/lib/DBIx/Class/InflateColumn.pm @@ -4,6 +4,56 @@ use strict; use warnings; use base qw/DBIx::Class::Row/; +=head1 NAME + +DBIx::Class::InflateColumn - Automatically create objects from column data + +=head1 SYNOPSIS + + # In your table classes + __PACKAGE__->inflate_column('column_name', { + inflate => sub { ... }, + deflate => sub { ... }, + }); + +=head1 DESCRIPTION + +This component translates column data into objects, i.e. "inflating" +the column data. It also "deflates" objects into an appropriate format +for the database. + +It can be used, for example, to automatically convert to and from +L objects for your date and time fields. + +=head1 METHODS + +=head2 inflate_column + +Instruct L to inflate the given column. + +In addition to the column name, you must provide C and +C methods. The C method is called when you access +the field, while the C method is called when the field needs +to used by the database. + +For example, if you have a table C with a timestamp field +named C, you could inflate the column in the +corresponding table class using something like: + + __PACKAGE__->inflate_column('insert_time', { + inflate => sub { DateTime::Format::Pg->parse_datetime(shift); }, + deflate => sub { DateTime::Format::Pg->format_datetime(shift); }, + }); + +(Replace L with the appropriate module for your +database, or consider L.) + +In this example, calls to an event's C accessor return a +L object. This L object is later "deflated" when +used in the database layer. + +=cut + sub inflate_column { my ($self, $col, $attrs) = @_; die "No such column $col to inflate" unless $self->has_column($col); @@ -84,4 +134,28 @@ sub new { return $class->next::method($attrs, @rest); } +=head1 SEE ALSO + +=over 4 + +=item L - This component is loaded as part of the + "core" L components; generally there is no need to + load it directly + +=back + +=head1 AUTHOR + +Matt S. Trout + +=head1 CONTRIBUTORS + +Daniel Westermann-Clark (documentation) + +=head1 LICENSE + +You may distribute this code under the same terms as Perl itself. + +=cut + 1;