X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FInflateColumn.pm;h=9214582a40bf7fa3e859f58ef142d28daab6aec3;hb=fcf32d045;hp=422d8b9276b07f515bdcb92d446282fafd9d36ad;hpb=43556c5d5b8734dff2ba5cd4897bd69c4e82bd52;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn.pm b/lib/DBIx/Class/InflateColumn.pm index 422d8b9..9214582 100644 --- a/lib/DBIx/Class/InflateColumn.pm +++ b/lib/DBIx/Class/InflateColumn.pm @@ -2,7 +2,6 @@ package DBIx::Class::InflateColumn; use strict; use warnings; -use Scalar::Util qw/blessed/; use base qw/DBIx::Class::Row/; @@ -12,11 +11,17 @@ DBIx::Class::InflateColumn - Automatically create references from column data =head1 SYNOPSIS - # In your table classes - __PACKAGE__->inflate_column('column_name', { - inflate => sub { ... }, - deflate => sub { ... }, - }); + # In your table classes + __PACKAGE__->inflate_column('column_name', { + inflate => sub { + my ($raw_value_from_db, $result_object) = @_; + ... + }, + deflate => sub { + my ($inflated_value_from_user, $result_object) = @_; + ... + }, + }); =head1 DESCRIPTION @@ -25,12 +30,19 @@ the column data. It also "deflates" references 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. +L objects for your date and time fields. There's a +convenience component to actually do that though, try +L. + +It will handle all types of references except scalar references. It +will not handle scalar values, these are ignored and thus passed +through to L. This is to allow setting raw values to +"just work". Scalar references are passed through to the database to +deal with, to allow such settings as C< \'year + 1'> and C< \'DEFAULT' > +to work. -It will accept arrayrefs, hashrefs and blessed references (objects), -but not scalarrefs. Scalar references are passed through to the -database to deal with, to allow such settings as C< \'year + 1'> and -C< \'DEFAULT' > to work. +If you want to filter plain scalar values and replace them with +something else, see L. =head1 METHODS @@ -48,32 +60,44 @@ 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); }, + inflate => sub { + my ($insert_time_raw_value, $event_result_object) = @_; + DateTime->from_epoch( epoch => $insert_time_raw_value ); + }, + deflate => sub { + my ($insert_time_dt_object, $event_result_object) = @_; + $insert_time_dt_object->epoch; + }, }); -(Replace L with the appropriate module for your -database, or consider L.) - The coderefs you set for inflate and deflate are called with two parameters, -the first is the value of the column to be inflated/deflated, the second is the -row object itself. Thus you can call C<< ->result_source->schema->storage->dbh >> on -it, to feed to L. +the first is the value of the column to be inflated/deflated, the second is +the result object itself. 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. +L object. This L object is later "deflated" back +to the integer epoch representation when used in the database layer. +For a much more thorough handling of the above example, please see +L =cut sub inflate_column { my ($self, $col, $attrs) = @_; + + my $colinfo = $self->column_info($col); + + $self->throw_exception("InflateColumn does not work with FilterColumn") + if $self->isa('DBIx::Class::FilterColumn') && + defined $colinfo->{_filter_info}; + $self->throw_exception("No such column $col to inflate") unless $self->has_column($col); $self->throw_exception("inflate_column needs attr hashref") unless ref $attrs eq 'HASH'; - $self->column_info($col)->{_inflate_info} = $attrs; - $self->mk_group_accessors('inflated_column' => [$self->column_info($col)->{accessor} || $col, $col]); + $colinfo->{_inflate_info} = $attrs; + my $acc = $colinfo->{accessor}; + $self->mk_group_accessors('inflated_column' => [ (defined $acc ? $acc : $col), $col]); return 1; } @@ -107,7 +131,7 @@ sub _deflated_column { Fetch a column value in its inflated state. This is directly analogous to L in that it only fetches a -column already retreived from the database, and then inflates it. +column already retrieved from the database, and then inflates it. Throws an exception if the column requested is not an inflated column. =cut @@ -118,8 +142,11 @@ sub get_inflated_column { unless exists $self->column_info($col)->{_inflate_info}; return $self->{_inflated_column}{$col} if exists $self->{_inflated_column}{$col}; - return $self->{_inflated_column}{$col} = - $self->_inflated_column($col, $self->get_column($col)); + + my $val = $self->get_column($col); + return $val if ref $val eq 'SCALAR'; #that would be a not-yet-reloaded sclarref update + + return $self->{_inflated_column}{$col} = $self->_inflated_column($col, $val); } =head2 set_inflated_column @@ -136,9 +163,9 @@ sub set_inflated_column { $self->set_column($col, $self->_deflated_column($col, $inflated)); # if (blessed $inflated) { if (ref $inflated && ref($inflated) ne 'SCALAR') { - $self->{_inflated_column}{$col} = $inflated; + $self->{_inflated_column}{$col} = $inflated; } else { - delete $self->{_inflated_column}{$col}; + delete $self->{_inflated_column}{$col}; } return $inflated; } @@ -169,7 +196,7 @@ sub store_inflated_column { =over 4 =item L - This component is loaded as part of the - "core" L components; generally there is no need to + C L components; generally there is no need to load it directly =back