X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRow.pm;h=ad463eb896fe2e7262ecf63d490402bfa62d555c;hb=448f820f2e755def89cb47727a7695ae4aebaa13;hp=16745b506edd346c7e3b447b438ef5fcdfbcfe62;hpb=75d079145a507a0e5ff89b2676d383f4fd1a5511;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Row.pm b/lib/DBIx/Class/Row.pm index 16745b5..ad463eb 100644 --- a/lib/DBIx/Class/Row.pm +++ b/lib/DBIx/Class/Row.pm @@ -6,9 +6,7 @@ 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'); +__PACKAGE__->mk_group_accessors('simple' => qw/_source_handle/); =head1 NAME @@ -34,16 +32,48 @@ 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 = { _column_data => {} }; + bless $new, $class; + + if (my $handle = delete $attrs->{-source_handle}) { + $new->_source_handle($handle); + } + if ($attrs) { $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); + + my ($related,$inflated); + foreach my $key (keys %$attrs) { + if (ref $attrs->{$key}) { + my $info = $class->relationship_info($key); + if ($info && $info->{attrs}{accessor} + && $info->{attrs}{accessor} eq 'single') + { + $new->set_from_related($key, $attrs->{$key}); + $related->{$key} = $attrs->{$key}; + next; + } + elsif ($class->has_column($key) + && exists $class->column_info($key)->{_inflate_info}) + { + $inflated->{$key} = $attrs->{$key}; + next; + } + } + $new->throw_exception("No such column $key on $class") + unless $class->has_column($key); + $new->store_column($key => $attrs->{$key}); } + if (my $source = delete $attrs->{-result_source}) { + $new->result_source($source); + } + + $new->{_relationship_data} = $related if $related; + $new->{_inflated_column} = $inflated if $inflated; } + return $new; } @@ -51,25 +81,28 @@ sub new { $obj->insert; -Inserts an object into the database if it isn't already in there. Returns -the object itself. Requires the object's result source to be set, or the -class to have a result_source_instance method. +Inserts an object into the database if it isn't already in +there. Returns the object itself. Requires the object's result source to +be set, or the class to have a result_source_instance method. To insert +an entirely new object into the database, use C (see +L). =cut sub insert { my ($self) = @_; return $self if $self->in_storage; - $self->{result_source} ||= $self->result_source_instance + my $source = $self->result_source; + $source ||= $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); - $source->storage->insert($source->from, { $self->get_columns }); + + $source->storage->insert($source, { $self->get_columns }); $self->in_storage(1); $self->{_dirty_columns} = {}; $self->{related_resultsets} = {}; + undef $self->{_orig_ident}; return $self; } @@ -90,24 +123,51 @@ sub in_storage { =head2 update - $obj->update; + $obj->update \%columns?; Must be run on an object that is already in the database; issues an SQL -UPDATE query to commit any changes to the object to the db if required. +UPDATE query to commit any changes to the object to the database if +required. + +Also takes an options hashref of C<< column_name => value> pairs >> to update +first. But be aware that this hashref might be edited in place, so dont rely on +it being the same after a call to C. =cut sub update { my ($self, $upd) = @_; $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; + + if ($upd) { + foreach my $key (keys %$upd) { + if (ref $upd->{$key}) { + my $info = $self->relationship_info($key); + if ($info && $info->{attrs}{accessor} + && $info->{attrs}{accessor} eq 'single') + { + my $rel = delete $upd->{$key}; + $self->set_from_related($key => $rel); + $self->{_relationship_data}{$key} = $rel; + } + elsif ($self->has_column($key) + && exists $self->column_info($key)->{_inflate_info}) + { + $self->set_inflated_column($key, delete $upd->{$key}); + } + } + } + $self->set_columns($upd); + } + my %to_update = $self->get_dirty_columns; + return $self unless keys %to_update; my $rows = $self->result_source->storage->update( - $self->result_source->from, \%to_update, $ident_cond); + $self->result_source, \%to_update, + $self->{_orig_ident} || $ident_cond + ); if ($rows == 0) { $self->throw_exception( "Can't update ${self}: row not found" ); } elsif ($rows > 1) { @@ -115,6 +175,7 @@ sub update { } $self->{_dirty_columns} = {}; $self->{related_resultsets} = {}; + undef $self->{_orig_ident}; return $self; } @@ -122,9 +183,14 @@ sub update { $obj->delete -Deletes the object from the database. The object is still perfectly usable, -but ->in_storage() will now return 0 and the object must re inserted using -->insert() before ->update() can be used on it. +Deletes the object from the database. The object is still perfectly +usable, but C<< ->in_storage() >> will now return 0 and the object must +reinserted using C<< ->insert() >> before C<< ->update() >> can be used +on it. If you delete an object in a class with a C +relationship, all the related objects will be deleted as well. To turn +this behavior off, pass C 0> in the C<$attr> +hashref. Any database-level cascade or restrict will take precedence +over a DBIx-Class-based cascading delete. See also L. =cut @@ -140,7 +206,7 @@ sub delete { unless exists $self->{_column_data}{$column}; } $self->result_source->storage->delete( - $self->result_source->from, $ident_cond); + $self->result_source, $ident_cond); $self->in_storage(undef); } else { $self->throw_exception("Can't do class delete without a ResultSource instance") @@ -156,9 +222,10 @@ sub delete { my $val = $obj->get_column($col); -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. +Gets a column value from a row object. Does not do any queries; the column +must have already been fetched from the database and stored in the object. If +there is an inflated value stored that has not yet been deflated, it is deflated +when the method is invoked. =cut @@ -166,13 +233,29 @@ sub get_column { my ($self, $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}; + if (exists $self->{_inflated_column}{$column}) { + return $self->store_column($column, + $self->_deflated_column($column, $self->{_inflated_column}{$column})); + } $self->throw_exception( "No such column '${column}'" ) unless $self->has_column($column); return undef; } +=head2 has_column_loaded + + if ( $obj->has_column_loaded($col) ) { + print "$col has been loaded from db"; + } + +Returns a true value if the column value has been loaded from the +database (or set locally). + +=cut + sub has_column_loaded { my ($self, $column) = @_; $self->throw_exception( "Can't call has_column data as class method" ) unless ref $self; + return 1 if exists $self->{_inflated_column}{$column}; return exists $self->{_column_data}{$column}; } @@ -186,6 +269,12 @@ Does C, for all column values at once. 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->{_column_data}}; } @@ -215,6 +304,7 @@ the column is marked as dirty for when you next call $obj->update. sub set_column { my $self = shift; my ($column) = @_; + $self->{_orig_ident} ||= $self->ident_condition; my $old = $self->get_column($column); my $ret = $self->store_column(@_); $self->{_dirty_columns}{$column} = 1 @@ -232,8 +322,8 @@ Sets more than one column value at once. sub set_columns { my ($self,$data) = @_; - while (my ($col,$val) = each %$data) { - $self->set_column($col,$val); + foreach my $col (keys %$data) { + $self->set_column($col,$data->{$col}); } return $self; } @@ -254,7 +344,11 @@ sub copy { delete $col_data->{$col} if $self->result_source->column_info($col)->{is_auto_increment}; } - my $new = bless { _column_data => $col_data }, ref $self; + + my $new = { _column_data => $col_data }; + bless $new, ref $self; + + $new->result_source($self->result_source); $new->set_columns($changes); $new->insert; foreach my $rel ($self->result_source->relationships) { @@ -297,12 +391,22 @@ Called by ResultSet to inflate a result from storage 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 ($source_handle) = $source; + + if ($source->isa('DBIx::Class::ResultSourceHandle')) { + $source = $source_handle->resolve + } else { + $source_handle = $source->handle + } + + my $new = { + _source_handle => $source_handle, + _column_data => $me, + _in_storage => 1 + }; + bless $new, (ref $class || $class); + my $schema; foreach my $pre (keys %{$prefetch||{}}) { my $pre_val = $prefetch->{$pre}; @@ -349,6 +453,12 @@ sub inflate_result { Updates the object if it's already in the db, else inserts it. +=head2 insert_or_update + + $obj->insert_or_update + +Alias for L + =cut *insert_or_update = \&update_or_insert; @@ -359,7 +469,12 @@ sub update_or_insert { =head2 is_changed - my @changed_col_names = $obj->is_changed + my @changed_col_names = $obj->is_changed(); + if ($obj->is_changed()) { ... } + +In array context returns a list of columns with uncommited changes, or +in scalar context returns a true value if there are uncommitted +changes. =cut @@ -367,21 +482,48 @@ sub is_changed { return keys %{shift->{_dirty_columns} || {}}; } +=head2 is_column_changed + + if ($obj->is_column_changed('col')) { ... } + +Returns a true value if the column has uncommitted changes. + +=cut + +sub is_column_changed { + my( $self, $col ) = @_; + return exists $self->{_dirty_columns}->{$col}; +} + =head2 result_source - Accessor to the ResultSource this object was created from + my $resultsource = $object->result_source; -=head2 register_column +Accessor to the ResultSource this object was created from -=over 4 +=cut -=item Arguments: $column, $column_info +sub result_source { + my $self = shift; -=back + if (@_) { + $self->_source_handle($_[0]->handle); + } else { + $self->_source_handle->resolve; + } +} + +=head2 register_column - 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 + $column_info = { .... }; + $class->register_column($column_name, $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 + +The column_info attributes are described in +L =cut @@ -422,4 +564,3 @@ Matt S. Trout You may distribute this code under the same terms as Perl itself. =cut -