X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRow.pm;h=f59532a3f24113a6ccf99ae6a8290cf8afa58edf;hb=fc27a8673e1a18b155da3619c93e992bf9ec676f;hp=f789b2907481ddda1344b1a6cb1f4c114d3160f6;hpb=c7ce65e6f0d957656f8e3ca26944cd9c1f03ddbc;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm index f789b29..f59532a 100644 --- a/lib/DBIx/Class/Row.pm +++ b/lib/DBIx/Class/Row.pm @@ -3,6 +3,13 @@ package DBIx::Class::Row; use strict; use warnings; +use base qw/DBIx::Class/; +use Carp::Clan qw/^DBIx::Class/; + +__PACKAGE__->load_components(qw/AccessorGroup/); + +__PACKAGE__->mk_group_accessors('simple' => 'result_source'); + =head1 NAME DBIx::Class::Row - Basic row methods @@ -12,13 +19,11 @@ DBIx::Class::Row - Basic row methods =head1 DESCRIPTION This class is responsible for defining and doing basic operations on rows -derived from L objects. +derived from L objects. =head1 METHODS -=over 4 - -=item new +=head2 new my $obj = My::Class->new($attrs); @@ -31,39 +36,40 @@ sub new { $class = ref $class if ref $class; my $new = bless({ _column_data => { } }, $class); if ($attrs) { - $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH'; + $new->throw_exception("attrs must be a hashref" ) unless ref($attrs) eq 'HASH'; while (my ($k, $v) = each %{$attrs}) { + $new->throw_exception("No such column $k on $class") unless $class->has_column($k); $new->store_column($k => $v); } } return $new; } -=item insert +=head2 insert $obj->insert; Inserts an object into the database if it isn't already in there. Returns -the object itself. +the object itself. Requires the object's result source to be set, or the +class to have a result_source_instance method. =cut sub insert { my ($self) = @_; return $self if $self->in_storage; + $self->{result_source} ||= $self->result_source_instance + if $self->can('result_source_instance'); + my $source = $self->{result_source}; + $self->throw_exception("No result_source set on this object; can't insert") unless $source; #use Data::Dumper; warn Dumper($self); - my %in; - $in{$_} = $self->get_column($_) - for grep { defined $self->get_column($_) } $self->columns; - my %out = %{ $self->storage->insert($self->_table_name, \%in) }; - $self->store_column($_, $out{$_}) - for grep { $self->get_column($_) ne $out{$_} } keys %out; + $source->storage->insert($source->from, { $self->get_columns }); $self->in_storage(1); $self->{_dirty_columns} = {}; return $self; } -=item in_storage +=head2 in_storage $obj->in_storage; # Get value $obj->in_storage(1); # Set value @@ -78,21 +84,7 @@ sub in_storage { return $self->{_in_storage}; } -=item create - - my $new = My::Class->create($attrs); - -A shortcut for My::Class->new($attrs)->insert; - -=cut - -sub create { - my ($class, $attrs) = @_; - $class->throw( "create needs a hashref" ) unless ref $attrs eq 'HASH'; - return $class->new($attrs)->insert; -} - -=item update +=head2 update $obj->update; @@ -103,29 +95,25 @@ UPDATE query to commit any changes to the object to the db if required. sub update { my ($self, $upd) = @_; - $self->throw( "Not in database" ) unless $self->in_storage; - my %to_update = %{$upd || {}}; - $to_update{$_} = $self->get_column($_) for $self->is_changed; - return -1 unless keys %to_update; - my $rows = $self->storage->update($self->_table_name, \%to_update, - $self->ident_condition); + $self->throw_exception( "Not in database" ) unless $self->in_storage; + $self->set_columns($upd) if $upd; + my %to_update = $self->get_dirty_columns; + return $self unless keys %to_update; + my $ident_cond = $self->ident_condition; + $self->throw_exception("Cannot safely update a row in a PK-less table") + if ! keys %$ident_cond; + my $rows = $self->result_source->storage->update( + $self->result_source->from, \%to_update, $ident_cond); if ($rows == 0) { - $self->throw( "Can't update ${self}: row not found" ); + $self->throw_exception( "Can't update ${self}: row not found" ); } elsif ($rows > 1) { - $self->throw("Can't update ${self}: updated more than one row"); + $self->throw_exception("Can't update ${self}: updated more than one row"); } $self->{_dirty_columns} = {}; return $self; } -sub ident_condition { - my ($self) = @_; - my %cond; - $cond{$_} = $self->get_column($_) for keys %{$self->_primaries}; - return \%cond; -} - -=item delete +=head2 delete $obj->delete @@ -138,47 +126,78 @@ be re ->insert'ed before it can be ->update'ed sub delete { my $self = shift; if (ref $self) { - $self->throw( "Not in database" ) unless $self->in_storage; - #warn $self->_ident_cond.' '.join(', ', $self->_ident_values); - $self->storage->delete($self->_table_name, $self->ident_condition); + $self->throw_exception( "Not in database" ) unless $self->in_storage; + my $ident_cond = $self->ident_condition; + $self->throw_exception("Cannot safely delete a row in a PK-less table") + if ! keys %$ident_cond; + $self->result_source->storage->delete( + $self->result_source->from, $ident_cond); $self->in_storage(undef); - #$self->store_column($_ => undef) for $self->primary_columns; - # Should probably also arrange to trash PK if auto - # but if we do, post-delete cascade triggers fail :/ } else { + $self->throw_exception("Can't do class delete without a ResultSource instance") + unless $self->can('result_source_instance'); my $attrs = { }; if (@_ > 1 && ref $_[$#_] eq 'HASH') { $attrs = { %{ pop(@_) } }; } my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_}); - $self->storage->delete($self->_table_name, $query); + $self->result_source_instance->resultset->search(@_)->delete; } return $self; } -=item get_column +=head2 get_column my $val = $obj->get_column($col); -Fetches a column value +Gets a column value from a row object. Currently, does not do +any queries; the column must have already been fetched from +the database and stored in the object. =cut sub get_column { my ($self, $column) = @_; - $self->throw( "Can't fetch data as class method" ) unless ref $self; - $self->throw( "No such column '${column}'" ) unless $self->_columns->{$column}; + $self->throw_exception( "Can't fetch data as class method" ) unless ref $self; return $self->{_column_data}{$column} if exists $self->{_column_data}{$column}; + $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column); return undef; } -=item set_column +=head2 get_columns + + my %data = $obj->get_columns; + +Does C, for all column values at once. + +=cut + +sub get_columns { + my $self = shift; + return %{$self->{_column_data}}; +} + +=head2 get_dirty_columns + + my %data = $obj->get_dirty_columns; + +Identical to get_columns but only returns those that have been changed. + +=cut + +sub get_dirty_columns { + my $self = shift; + return map { $_ => $self->{_column_data}{$_} } + keys %{$self->{_dirty_columns}}; +} + +=head2 set_column $obj->set_column($col => $val); -Sets a column value; if the new value is different to the old the column -is marked as dirty for when you next call $obj->update +Sets a column value. If the new value is different from the old one, +the column is marked as dirty for when you next call $obj->update. =cut @@ -187,40 +206,33 @@ sub set_column { my ($column) = @_; my $old = $self->get_column($column); my $ret = $self->store_column(@_); - $self->{_dirty_columns}{$column} = 1 unless defined $old && $old eq $ret; + $self->{_dirty_columns}{$column} = 1 + if (defined $old ^ defined $ret) || (defined $old && $old ne $ret); return $ret; } -=item store_column +=head2 set_columns - $obj->store_column($col => $val); + my $copy = $orig->set_columns({ $col => $val, ... }); -Sets a column value without marking it as dirty +Sets more than one column value at once. =cut -sub store_column { - my ($self, $column, $value) = @_; - $self->throw( "No such column '${column}'" ) - unless $self->_columns->{$column}; - $self->throw( "set_column called for ${column} without value" ) - if @_ < 3; - return $self->{_column_data}{$column} = $value; -} - -sub _row_to_object { - my ($class, $cols, $row) = @_; - my %vals; - $vals{$cols->[$_]} = $row->[$_] for 0 .. $#$cols; - my $new = $class->new(\%vals); - $new->in_storage(1); - return $new; +sub set_columns { + my ($self,$data) = @_; + while (my ($col,$val) = each %$data) { + $self->set_column($col,$val); + } + return $self; } -=item copy +=head2 copy my $copy = $orig->copy({ change => $to, ... }); +Inserts a new row with the specified changes. + =cut sub copy { @@ -230,11 +242,69 @@ sub copy { return $new->insert; } -=item insert_or_update +=head2 store_column + + $obj->store_column($col => $val); + +Sets a column value without marking it as dirty. + +=cut + +sub store_column { + my ($self, $column, $value) = @_; + $self->throw_exception( "No such column '${column}'" ) + unless exists $self->{_column_data}{$column} || $self->has_column($column); + $self->throw_exception( "set_column called for ${column} without value" ) + if @_ < 3; + return $self->{_column_data}{$column} = $value; +} + +=head2 inflate_result + + Class->inflate_result($result_source, \%me, \%prefetch?) + +Called by ResultSet to inflate a result from storage + +=cut + +sub inflate_result { + my ($class, $source, $me, $prefetch) = @_; + #use Data::Dumper; print Dumper(@_); + my $new = bless({ result_source => $source, + _column_data => $me, + _in_storage => 1 + }, + ref $class || $class); + my $schema; + PRE: foreach my $pre (keys %{$prefetch||{}}) { + my $pre_source = $source->related_source($pre); + $class->throw_exception("Can't prefetch non-existant relationship ${pre}") unless $pre_source; + my $fetched; + unless ($pre_source->primary_columns == grep { exists $prefetch->{$pre}[0]{$_} + and !defined $prefetch->{$pre}[0]{$_} } $pre_source->primary_columns) + { + $fetched = $pre_source->result_class->inflate_result( + $pre_source, @{$prefetch->{$pre}}); + } + my $accessor = $source->relationship_info($pre)->{attrs}{accessor}; + $class->throw_exception("No accessor for prefetched $pre") + unless defined $accessor; + if ($accessor eq 'single') { + $new->{_relationship_data}{$pre} = $fetched; + } elsif ($accessor eq 'filter') { + $new->{_inflated_column}{$pre} = $fetched; + } else { + $class->throw_exception("Don't know how to store prefetched $pre"); + } + } + return $new; +} + +=head2 insert_or_update $obj->insert_or_update -Updates the object if it's already in the db, else inserts it +Updates the object if it's already in the db, else inserts it. =cut @@ -243,7 +313,7 @@ sub insert_or_update { return ($self->in_storage ? $self->update : $self->insert); } -=item is_changed +=head2 is_changed my @changed_col_names = $obj->is_changed @@ -253,9 +323,45 @@ sub is_changed { return keys %{shift->{_dirty_columns} || {}}; } -1; +=head2 result_source + + Accessor to the ResultSource this object was created from + +=head2 register_column($column, $column_info) + + Registers a column on the class. If the column_info has an 'accessor' key, + creates an accessor named after the value if defined; if there is no such + key, creates an accessor with the same name as the column + +=cut + +sub register_column { + my ($class, $col, $info) = @_; + my $acc = $col; + if (exists $info->{accessor}) { + return unless defined $info->{accessor}; + $acc = [ $info->{accessor}, $col ]; + } + $class->mk_group_accessors('column' => $acc); +} -=back + +=head2 throw_exception + +See Schema's throw_exception. + +=cut + +sub throw_exception { + my $self=shift; + if (ref $self && ref $self->result_source) { + $self->result_source->schema->throw_exception(@_); + } else { + croak(@_); + } +} + +1; =head1 AUTHORS