use warnings;
package DBIx::Class::ResultSet::RecursiveUpdate;
-use version; our $VERSION = qv('0.006');
+our $VERSION = '0.013';
use base qw(DBIx::Class::ResultSet);
sub recursive_update {
my %params = @_;
- my ( $self, $updates, $fixed_fields, $object ) = @params{ qw/resultset updates fixed_fields object/ };
+ my ( $self, $updates, $fixed_fields, $object, $resolved, $if_not_submitted ) = @params{ qw/resultset updates fixed_fields object resolved if_not_submitted/ };
+ $resolved ||= {};
# warn 'entering: ' . $self->result_source->from();
carp 'fixed fields needs to be an array ref' if $fixed_fields && ref($fixed_fields) ne 'ARRAY';
my %fixed_fields;
if ( blessed($updates) && $updates->isa('DBIx::Class::Row') ) {
return $updates;
}
+ if ( $updates->{id} ){
+ $object = $self->find( $updates->{id}, { key => 'primary' } );
+ }
+ my @missing =
+ grep { !exists $updates->{$_} && !exists $fixed_fields{$_} } $self->result_source->primary_columns;
+ if ( !$object && !scalar @missing ) {
+# warn 'finding by: ' . Dumper( $updates ); use Data::Dumper;
+ $object = $self->find( $updates, { key => 'primary' } );
+ }
+ $updates = { %$updates, %$resolved };
+ @missing =
+ grep { !exists $resolved->{$_} } @missing;
+ if ( !$object && !scalar @missing ) {
+# warn 'finding by +resolved: ' . Dumper( $updates ); use Data::Dumper;
+ $object = $self->find( $updates, { key => 'primary' } );
+ }
+ $object ||= $self->new( {} );
# warn Dumper( $updates ); use Data::Dumper;
# direct column accessors
my %columns;
my %pre_updates;
# relations that that should be done after the row is inserted into the database
- # like has_many and might_have
+ # like has_many, might_have and has_one
my %post_updates;
my %other_methods;
my %columns_by_accessor = _get_columns_by_accessor( $self );
+# warn 'resolved: ' . Dumper( $resolved );
+# warn 'updates: ' . Dumper( $updates ); use Data::Dumper;
+# warn 'columns: ' . Dumper( \%columns_by_accessor );
for my $name ( keys %$updates ) {
my $source = $self->result_source;
- if( $name eq 'id'
-# && scalar @{$source->primary_columns} == 1
- && !$source->has_column( 'id' )
- ){
- my @ids = ( $updates->{id} );
- if( ref $updates->{id} ){
- @ids = @{ $updates->{id} };
- }
- my $i = 0;
- for my $key ( $source->primary_columns ){
- $columns{ $key } = $ids[ $i++ ];
- }
- next;
- }
if ( $columns_by_accessor{$name}
&& !( $source->has_relationship($name) && ref( $updates->{$name} ) )
)
}
# warn 'other: ' . Dumper( \%other_methods ); use Data::Dumper;
- my @missing =
- grep { !exists $columns{$_} && !exists $fixed_fields{$_} } $self->result_source->primary_columns;
- if ( !$object && !scalar @missing ) {
- $object = $self->find( \%columns, { key => 'primary' } );
- }
- $object ||= $self->new( {} );
# first update columns and other accessors - so that later related records can be found
for my $name ( keys %columns ) {
$object->$name( $columns{$name} );
}
for my $name ( keys %pre_updates ) {
my $info = $object->result_source->relationship_info($name);
- _update_relation( $self, $name, $updates, $object, $info );
+ _update_relation( $self, $name, $updates, $object, $info, $if_not_submitted );
}
# $self->_delete_empty_auto_increment($object);
# don't allow insert to recurse to related objects - we do the recursion ourselves
# $object->{_rel_in_storage} = 1;
- $object->update_or_insert;
+
+ $object->update_or_insert if $object->is_changed;
# updating many_to_many
for my $name ( keys %$updates ) {
}
for my $elem ( @updates ) {
if ( ref $elem ) {
- push @rows, $result_source->resultset->find($elem);
+ push @rows, recursive_update( resultset => $result_source->resultset, updates => $elem );
}
else {
push @rows,
}
for my $name ( keys %post_updates ) {
my $info = $object->result_source->relationship_info($name);
- _update_relation( $self, $name, $updates, $object, $info );
+ _update_relation( $self, $name, $updates, $object, $info, $if_not_submitted );
}
return $object;
}
+# returns DBIx::Class::ResultSource::column_info as a hash indexed by column accessor || name
sub _get_columns_by_accessor {
my $self = shift;
my $source = $self->result_source;
}
sub _update_relation {
- my ( $self, $name, $updates, $object, $info ) = @_;
+ my ( $self, $name, $updates, $object, $info, $if_not_submitted ) = @_;
my $related_result =
$self->related_resultset($name)->result_source->resultset;
- my $resolved =
- $self->result_source->resolve_condition( $info->{cond}, $name, $object );
+ my $resolved;
+ if( $self->result_source->can( '_resolve_condition' ) ){
+ $resolved = $self->result_source->_resolve_condition( $info->{cond}, $name, $object );
+ }
+ else{
+ $resolved = $self->result_source->resolve_condition( $info->{cond}, $name, $object );
+ }
# warn 'resolved: ' . Dumper( $resolved ); use Data::Dumper;
- $resolved = undef
+ $resolved = {}
if defined $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION && $DBIx::Class::ResultSource::UNRESOLVABLE_CONDITION == $resolved;
if ( ref $updates->{$name} eq 'ARRAY' ) {
+ my @updated_ids;
for my $sub_updates ( @{ $updates->{$name} } ) {
- $sub_updates = { %$sub_updates, %$resolved } if $resolved && ref( $sub_updates ) eq 'HASH';
my $sub_object =
- recursive_update( resultset => $related_result, updates => $sub_updates );
+ recursive_update( resultset => $related_result, updates => $sub_updates, resolved => $resolved );
+ push @updated_ids, $sub_object->id;
+ }
+ my @related_pks = $related_result->result_source->primary_columns;
+ if( defined $if_not_submitted && $if_not_submitted eq 'delete' ){
+ # only handles related result classes with single primary keys
+ if ( 1 == scalar @related_pks ){
+ $object->$name->search( { $related_pks[0] => { -not_in => \@updated_ids } } )->delete;
+ }
+ }
+ elsif( defined $if_not_submitted && $if_not_submitted eq 'set_to_null' ){
+ # only handles related result classes with single primary keys
+ if ( 1 == scalar @related_pks ){
+ my @fk = keys %$resolved;
+ $object->$name->search( { $related_pks[0] => { -not_in => \@updated_ids } } )->update( { $fk[0] => undef } );
+ }
}
}
else {
my $sub_updates = $updates->{$name};
my $sub_object;
if( ref $sub_updates ){
- $sub_updates = { %$sub_updates, %$resolved } if $resolved && ref( $sub_updates ) eq 'HASH';
# for might_have relationship
if( $info->{attrs}{accessor} eq 'single' && defined $object->$name ){
$sub_object = recursive_update(
object => $object->$name
);
}
- else{
+ else{
$sub_object =
- recursive_update( resultset => $related_result, updates => $sub_updates );
+ recursive_update( resultset => $related_result, updates => $sub_updates, resolved => $resolved );
}
}
elsif( ! ref $sub_updates ){
- $sub_object = $related_result->find( $sub_updates );
+ $sub_object = $related_result->find( $sub_updates )
+ unless (!$sub_updates && (exists $info->{attrs}{join_type} && $info->{attrs}{join_type} eq 'LEFT'));
}
- $object->set_from_related( $name, $sub_object );
+ $object->set_from_related( $name, $sub_object )
+ unless (!$sub_object && !$sub_updates && (exists $info->{attrs}{join_type} && $info->{attrs}{join_type} eq 'LEFT'));
}
}
return $result_source->primary_columns;
}
+# This function determines wheter a relationship should be done before or
+# after the row is inserted into the database
+# relationships before: belongs_to
+# relationships after: has_many, might_have and has_one
sub _master_relation_cond {
my ( $source, $cond, @foreign_ids ) = @_;
my $foreign_ids_re = join '|', @foreign_ids;
DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
-
-=head1 VERSION
-
-This document describes DBIx::Class::ResultSet::RecursiveUpdate version 0.006
-
-
=head1 SYNOPSIS
The functional interface:
=head1 DESCRIPTION
+
This is still experimental. I've added a functional interface so that it can be used
in Form Processors and not require modification of the model.
=head1 DESIGN CHOICES
-=head2 Treatment of many to many pseudo relations
+Columns and relationships which are excluded from the updates hashref aren't
+touched at all.
+
+=head2 Treatment of belongs_to relations
+
+In case the relationship is included but undefined in the updates hashref,
+all columns forming the relationship will be set to null.
+If not all of them are nullable, DBIx::Class will throw an error.
+
+Updating the relationship:
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ owner => $user->id,
+ });
+
+Clearing the relationship (only works if cols are nullable!):
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ owner => undef,
+ });
+
+=head2 Treatment of might_have relationships
+
+In case the relationship is included but undefined in the updates hashref,
+all columns forming the relationship will be set to null.
+
+Updating the relationship:
+
+ my $user = $user_rs->recursive_update( {
+ id => 1,
+ address => {
+ street => "101 Main Street",
+ city => "Podunk",
+ state => "New York",
+ }
+ });
+
+Clearing the relationship:
+
+ my $user = $user_rs->recursive_update( {
+ id => 1,
+ address => undef,
+ });
+
+=head2 Treatment of has_many relations
+
+In case the relationship is included but undefined or an empty array, the
+related rows will be deleted or their foreign key column set to null depending
+on if_not_submitted parameter (set_to_null or delete).
+It defaults to undefined which skips both.
+
+Updating the relationship:
+
+ Passing ids:
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ tags => [1, 2],
+ });
+
+ Passing hashrefs:
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ tags => [
+ {
+ id => 1,
+ file => 'file0'
+ },
+ {
+ id => 2,
+ file => 'file1',
+ },
+ ],
+ });
+
+ Passing objects:
+
+ TODO
+
+ You can even mix them:
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ tags => [ '2', { id => '3' } ],
+ });
+
+Clearing the relationship:
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ tags => undef,
+ });
+
+ This is the same as passing an empty array:
+
+ my $dvd = $dvd_rs->recursive_update( {
+ id => 1,
+ tags => [],
+ });
+
+=head2 Treatment of many-to-many pseudo relations
The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M.
If it is not loaded in the ResultSource classes - then the code relies on the fact that:
=head1 INCOMPATIBILITIES
-=for author to fill in:
-
None reported.
=head1 BUGS AND LIMITATIONS
-=for author to fill in:
-
No bugs have been reported.
Please report any bugs or feature requests to
projects / chaz / p5-DBIx-Class-ResultSet-RecursiveUpdate / blobdiff