X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRow.pm;h=fd3ad132d9f41baa0c69c01a787cadd579b8af76;hb=9b465d002d544e25ae5756304c4ea59577aca363;hp=2354a7aa2921fa511967e1f01b336ef3c063e179;hpb=8091aa9182ff763aa607dd82f4d61b99f8adab37;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm index 2354a7a..fd3ad13 100644 --- a/lib/DBIx/Class/Row.pm +++ b/lib/DBIx/Class/Row.pm @@ -4,6 +4,11 @@ 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 @@ -14,7 +19,7 @@ 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 @@ -29,11 +34,11 @@ Creates a new row object from column => value mappings passed as a hash ref sub new { my ($class, $attrs) = @_; $class = ref $class if ref $class; - my $new = bless({ _column_data => { } }, $class); + my $new = bless { _column_data => {} }, $class; if ($attrs) { - $new->throw("attrs must be a hashref" ) unless ref($attrs) eq 'HASH'; - while (my ($k, $v) = each %{$attrs}) { - die "No such column $k on $class" unless $class->has_column($k); + $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); } } @@ -45,22 +50,24 @@ sub new { $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} = {}; + $self->{related_resultsets} = {}; return $self; } @@ -79,20 +86,6 @@ sub in_storage { return $self->{_in_storage}; } -=head2 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; -} - =head2 update $obj->update; @@ -104,21 +97,22 @@ 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; - if (ref $upd eq 'HASH') { - $self->$_($upd->{$_}) for keys %$upd; - } - my %to_update; - $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} = {}; + $self->{related_resultsets} = {}; return $self; } @@ -135,20 +129,23 @@ 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; + foreach my $column (keys %$ident_cond) { + $self->throw_exception("Can't delete the object unless it has loaded the primary keys") + unless exists $self->{_column_data}{$column}; + } + $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 { - my $attrs = { }; - if (@_ > 1 && ref $_[$#_] eq 'HASH') { - $attrs = { %{ pop(@_) } }; - } - my $query = (ref $_[0] eq 'HASH' ? $_[0] : {@_}); - $self->storage->delete($self->_table_name, $query); + $self->throw_exception("Can't do class delete without a ResultSource instance") + unless $self->can('result_source_instance'); + my $attrs = @_ > 1 && ref $_[$#_] eq 'HASH' ? { %{pop(@_)} } : {}; + my $query = ref $_[0] eq 'HASH' ? $_[0] : {@_}; + $self->result_source_instance->resultset->search(@_)->delete; } return $self; } @@ -165,13 +162,18 @@ the database and stored in the object. 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->has_column($column); - return $self->{_column_data}{$column} - if exists $self->{_column_data}{$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; } +sub has_column_loaded { + my ($self, $column) = @_; + $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self; + return exists $self->{_column_data}{$column}; +} + =head2 get_columns my %data = $obj->get_columns; @@ -182,7 +184,21 @@ Does C, for all column values at once. sub get_columns { my $self = shift; - return map { $_ => $self->get_column($_) } $self->columns; + 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 @@ -199,7 +215,8 @@ 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; } @@ -216,6 +233,7 @@ sub set_columns { while (my ($col,$val) = each %$data) { $self->set_column($col,$val); } + return $self; } =head2 copy @@ -226,6 +244,30 @@ Inserts a new row with the specified changes. =cut +sub copy { + my ($self, $changes) = @_; + $changes ||= {}; + my $col_data = { %{$self->{_column_data}} }; + foreach my $col (keys %$col_data) { + delete $col_data->{$col} + if $self->result_source->column_info($col)->{is_auto_increment}; + } + my $new = bless { _column_data => $col_data }, ref $self; + $new->set_columns($changes); + $new->insert; + foreach my $rel ($self->result_source->relationships) { + my $rel_info = $self->result_source->relationship_info($rel); + if ($rel_info->{attrs}{cascade_copy}) { + my $resolved = $self->result_source->resolve_condition( + $rel_info->{cond}, $rel, $new); + foreach my $related ($self->search_related($rel)) { + $related->copy($resolved); + } + } + } + return $new; +} + =head2 store_column $obj->store_column($col => $val); @@ -236,38 +278,79 @@ Sets a column value without marking it as dirty. sub store_column { my ($self, $column, $value) = @_; - $self->throw( "No such column '${column}'" ) - unless $self->has_column($column); - $self->throw( "set_column called for ${column} without 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; } -sub _row_to_object { - my ($class, $cols, $row) = @_; - my %vals; - $vals{$cols->[$_]} = $row->[$_] for 0 .. $#$cols; - my $new = bless({ _column_data => \%vals }, ref $class || $class); - $new->in_storage(1); - return $new; -} +=head2 inflate_result -sub copy { - my ($self, $changes) = @_; - my $new = bless({ _column_data => { %{$self->{_column_data}}} }, ref $self); - $new->set_column($_ => $changes->{$_}) for keys %$changes; - return $new->insert; + 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; + foreach my $pre (keys %{$prefetch||{}}) { + my $pre_val = $prefetch->{$pre}; + my $pre_source = $source->related_source($pre); + $class->throw_exception("Can't prefetch non-existent relationship ${pre}") + unless $pre_source; + if (ref($pre_val->[0]) eq 'ARRAY') { # multi + my @pre_objects; + foreach my $pre_rec (@$pre_val) { + unless ($pre_source->primary_columns == grep { exists $pre_rec->[0]{$_} + and defined $pre_rec->[0]{$_} } $pre_source->primary_columns) { + next; + } + push(@pre_objects, $pre_source->result_class->inflate_result( + $pre_source, @{$pre_rec})); + } + $new->related_resultset($pre)->set_cache(\@pre_objects); + } else { + my $fetched; + unless ($pre_source->primary_columns == grep { exists $pre_val->[0]{$_} + and !defined $pre_val->[0]{$_} } $pre_source->primary_columns) + { + $fetched = $pre_source->result_class->inflate_result( + $pre_source, @{$pre_val}); + } + 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("Prefetch not supported with accessor '$accessor'"); + } + } + } + return $new; } -=head2 insert_or_update +=head2 update_or_insert - $obj->insert_or_update + $obj->update_or_insert Updates the object if it's already in the db, else inserts it. =cut -sub insert_or_update { +*insert_or_update = \&update_or_insert; +sub update_or_insert { my $self = shift; return ($self->in_storage ? $self->update : $self->insert); } @@ -282,6 +365,46 @@ sub is_changed { return keys %{shift->{_dirty_columns} || {}}; } +=head2 result_source + + Accessor to the ResultSource this object was created from + +=head2 register_column + +=head3 Arguments: ($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); +} + + +=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