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=382b33213ab0a970924912102de7e350596ebd54;hpb=9f4710678c1d9c959cc13574e7aa0881d3adbf49;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/InflateColumn.pm b/lib/DBIx/Class/InflateColumn.pm index 382b332..9214582 100644 --- a/lib/DBIx/Class/InflateColumn.pm +++ b/lib/DBIx/Class/InflateColumn.pm @@ -2,30 +2,47 @@ package DBIx::Class::InflateColumn; use strict; use warnings; -use Scalar::Util qw/blessed/; use base qw/DBIx::Class::Row/; =head1 NAME -DBIx::Class::InflateColumn - Automatically create objects from column data +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 -This component translates column data into objects, i.e. "inflating" -the column data. It also "deflates" objects into an appropriate format +This component translates column data into references, i.e. "inflating" +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. + +If you want to filter plain scalar values and replace them with +something else, see L. =head1 METHODS @@ -43,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' => $col); + $colinfo->{_inflate_info} = $attrs; + my $acc = $colinfo->{accessor}; + $self->mk_group_accessors('inflated_column' => [ (defined $acc ? $acc : $col), $col]); return 1; } @@ -85,7 +114,9 @@ sub _inflated_column { sub _deflated_column { my ($self, $col, $value) = @_; - return $value unless ref $value; # If it's not an object, don't touch it +# return $value unless ref $value && blessed($value); # If it's not an object, don't touch it + ## Leave scalar refs (ala SQL::Abstract literal SQL), untouched, deflate all other refs + return $value unless (ref $value && ref($value) ne 'SCALAR'); my $info = $self->column_info($col) or $self->throw_exception("No column info for $col"); return $value unless exists $info->{_inflate_info}; @@ -100,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 @@ -111,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 @@ -125,14 +159,15 @@ analogous to L. =cut sub set_inflated_column { - my ($self, $col, $obj) = @_; - $self->set_column($col, $self->_deflated_column($col, $obj)); - if (blessed $obj) { - $self->{_inflated_column}{$col} = $obj; + my ($self, $col, $inflated) = @_; + $self->set_column($col, $self->_deflated_column($col, $inflated)); +# if (blessed $inflated) { + if (ref $inflated && ref($inflated) ne 'SCALAR') { + $self->{_inflated_column}{$col} = $inflated; } else { - delete $self->{_inflated_column}{$col}; + delete $self->{_inflated_column}{$col}; } - return $obj; + return $inflated; } =head2 store_inflated_column @@ -145,84 +180,15 @@ as dirty. This is directly analogous to L. =cut sub store_inflated_column { - my ($self, $col, $obj) = @_; - unless (blessed $obj) { + my ($self, $col, $inflated) = @_; +# unless (blessed $inflated) { + unless (ref $inflated && ref($inflated) ne 'SCALAR') { delete $self->{_inflated_column}{$col}; - return undef; + $self->store_column($col => $inflated); + return $inflated; } delete $self->{_column_data}{$col}; - return $self->{_inflated_column}{$col} = $obj; -} - -=head2 get_column - -Gets a column value in the same way as L. If there -is an inflated value stored that has not yet been deflated, it is deflated -when the method is invoked. - -=cut - -sub get_column { - my ($self, $col) = @_; - if (exists $self->{_inflated_column}{$col} - && !exists $self->{_column_data}{$col}) { - $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col})); - } - return $self->next::method($col); -} - -sub get_columns { - my $self = shift; - if (exists $self->{_inflated_column}) { - foreach my $col (keys %{$self->{_inflated_column}}) { - $self->store_column($col, $self->_deflated_column($col, $self->{_inflated_column}{$col})) - unless exists $self->{_column_data}{$col}; - } - } - return $self->next::method; -} - -sub has_column_loaded { - my ($self, $col) = @_; - return 1 if exists $self->{_inflated_column}{$col}; - return $self->next::method($col); -} - -=head2 update - -Updates a row in the same way as L, handling -inflation and deflation of columns appropriately. - -=cut - -sub update { - my ($class, $attrs, @rest) = @_; - foreach my $key (keys %{$attrs||{}}) { - if (ref $attrs->{$key} - && exists $class->column_info($key)->{_inflate_info}) { - $class->set_inflated_column($key, delete $attrs->{$key}); - } - } - return $class->next::method($attrs, @rest); -} - -=head2 new - -Creates a row in the same way as L, handling -inflation and deflation of columns appropriately. - -=cut - -sub new { - my ($class, $attrs, @rest) = @_; - my $inflated; - foreach my $key (keys %{$attrs||{}}) { - $inflated->{$key} = delete $attrs->{$key} - if ref $attrs->{$key} && exists $class->column_info($key)->{_inflate_info}; - } - my $obj = $class->next::method($attrs, @rest); - $obj->{_inflated_column} = $inflated if $inflated; - return $obj; + return $self->{_inflated_column}{$col} = $inflated; } =head1 SEE ALSO @@ -230,7 +196,7 @@ sub new { =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 @@ -243,6 +209,8 @@ Matt S. Trout Daniel Westermann-Clark (documentation) +Jess Robinson + =head1 LICENSE You may distribute this code under the same terms as Perl itself.