]> Dogcows Code - chaz/p5-DBIx-Class-ResultSet-RecursiveUpdate/blobdiff - lib/DBIx/Class/ResultSet/RecursiveUpdate.pm
doc improvements
[chaz/p5-DBIx-Class-ResultSet-RecursiveUpdate] / lib / DBIx / Class / ResultSet / RecursiveUpdate.pm
index 27395cccdc03b0b32d3fd84214efce570907a9ed..ca0a7715377855ca45adb867d88818c9ca6ca09c 100644 (file)
@@ -2,8 +2,7 @@ use strict;
 use warnings;
 
 package DBIx::Class::ResultSet::RecursiveUpdate;
-
-our $VERSION = '0.013';
+# ABSTRACT: like update_or_create - but recursive
 
 use base qw(DBIx::Class::ResultSet);
 
@@ -257,7 +256,7 @@ sub _update_relation {
     map {s/^foreign\.//} @rel_cols;
 
     #warn "REL_COLS: " . Dumper(@rel_cols); use Data::Dumper;
-    my $rel_col_cnt = scalar @rel_cols;
+    #my $rel_col_cnt = scalar @rel_cols;
 
     # find out if all related columns are nullable
     my $all_fks_nullable = 1;
@@ -267,21 +266,19 @@ sub _update_relation {
                 ->{is_nullable};
     }
 
-    #warn "\tNULLABLE: $all_fks_nullable\n";
     $if_not_submitted = $all_fks_nullable ? 'nullify' : 'delete'
         unless defined $if_not_submitted;
 
-    # handle undef
-    #if (not defined $updates && $if_not_submitted eq 'delete') {
-    #    warn "$name " . ref $object;
-    #    $object->related_resultset($name)->delete;
-    #    return;
-    #}
+    #warn "\tNULLABLE: $all_fks_nullable ACTION: $if_not_submitted\n";
 
     #warn "RELINFO for $name: " . Dumper($info); use Data::Dumper;
 
     # the only valid datatype for a has_many rels is an arrayref
     if ( $info->{attrs}{accessor} eq 'multi' ) {
+
+        # handle undef like empty arrayref
+        $updates = []
+            unless defined $updates;
         $self->throw_exception(
             "data for has_many relationship '$name' must be an arrayref")
             unless ref $updates eq 'ARRAY';
@@ -301,56 +298,49 @@ sub _update_relation {
 
         #warn "\tcreated and updated related rows\n";
 
-        my @cond;
         my @related_pks = $related_resultset->result_source->primary_columns;
-        for my $obj (@updated_objs) {
-            my %cond_for_obj;
-            for my $col (@related_pks) {
-                $cond_for_obj{$col} = $obj->get_column($col);
+
+        my $rs_rel_delist = $object->$name;
+
+        # foreign table has a single pk column
+        if ( scalar @related_pks == 1 ) {
+            $rs_rel_delist = $rs_rel_delist->search_rs(
+                {   $related_pks[0] =>
+                        { -not_in => [ map ( $_->id, @updated_objs ) ] }
+                }
+            );
+        }
+
+        # foreign table has multiple pk columns
+        else {
+            my @cond;
+            for my $obj (@updated_objs) {
+                my %cond_for_obj;
+                for my $col (@related_pks) {
+                    $cond_for_obj{$col} = $obj->get_column($col);
+                }
+                push @cond, \%cond_for_obj;
+            }
+
+            # only limit resultset if there are related rows left
+            if ( scalar @cond ) {
+                $rs_rel_delist =
+                    $rs_rel_delist->search_rs( { -not => [@cond] } );
             }
-            push @cond, \%cond_for_obj;
         }
-        my %cond = ( -not => [@cond] );
 
         #warn "\tCOND: " . Dumper(\%cond);
-        my $rs_rel_delist = $object->$name->search_rs( \%cond );
-
         #my $rel_delist_cnt = $rs_rel_delist->count;
-        my @foo = $rs_rel_delist->all;
         if ( $if_not_submitted eq 'delete' ) {
 
             #warn "\tdeleting related rows: $rel_delist_cnt\n";
             $rs_rel_delist->delete;
-
-            # # only handles related result classes with single primary keys
-            # if ( 1 == $rel_col_cnt ) {
-            # $object->$name->search(
-            # {   $rel_cols[0] =>
-            # { -not_in => [ map ( $_->id, @updated_objs ) ] }
-            # }
-            # )->delete;
-            # }
-            # else {
-            # warn "multi-column relationships aren't supported\n";
-            # }
         }
         elsif ( $if_not_submitted eq 'set_to_null' ) {
 
             #warn "\tnullifying related rows: $rel_delist_cnt\n";
             my %update = map { $_ => undef } @rel_cols;
             $rs_rel_delist->update( \%update );
-
-            # # only handles related result classes with single primary keys
-            # if ( 1 == $rel_col_cnt ) {
-            # $object->$name->search(
-            # {   $rel_cols[0] =>
-            # { -not_in => [ map ( $_->id, @updated_objs ) ] }
-            # }
-            # )->update( { $rel_cols[0] => undef } );
-            # }
-            # else {
-            # warn "multi-column relationships aren't supported\n";
-            # }
         }
     }
     elsif ($info->{attrs}{accessor} eq 'single'
@@ -524,61 +514,60 @@ sub _master_relation_cond {
 1;    # Magic true value required at end of module
 __END__
 
-=head1 NAME
-
-DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
-
 =head1 SYNOPSIS
 
-The functional interface:
+    # The functional interface:
 
-    my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update({ 
-        resultset => $schema->resultset( 'Dvd' ),
+    my $schema = MyDB::Schema->connect();
+    my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update(
+        resultset => $schema->resultset('User'),
         updates => {
-            id => 1, 
-            owned_dvds => [ 
-                { 
-                  title => 'One Flew Over the Cuckoo's Nest' 
-                } 
-            ] 
+            id => 1,
+            owned_dvds => [
+                {
+                    title => "One Flew Over the Cuckoo's Nest"
+                }
+            ]
         }
     });
 
 
-As ResultSet subclass:
+    # As ResultSet subclass:
 
     __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
 
-in the Schema file (see t/lib/DBSchema.pm).  Or appriopriate 'use base' in the ResultSet classes. 
+    # in the Schema file (see t/lib/DBSchema.pm).  Or appropriate 'use base' in the ResultSet classes.
 
-Then:
+    my $user = $schema->resultset('User')->recursive_update({
+        id => 1,
+        owned_dvds => [
+            {
+                title => "One Flew Over the Cuckoo's Nest"
+            }
+        ]
+    }, {
+        unknown_params_ok => 1,
+    });
 
-    my $user = $user_rs->recursive_update( { 
-        id => 1, 
-        owned_dvds => [ 
-        { 
-          title => 'One Flew Over the Cuckoo's Nest' 
-        } 
-        ] 
-      }
-    );
 
-  
 =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.
+This is still experimental.
 
-You can feed the ->create method with a recursive datastructure and have the related records
-created.  Unfortunately you cannot do a similar thing with update_or_create - this module
-tries to fill that void. 
+You can feed the ->create method of DBIx::Class with a recursive datastructure
+and have the related records created. Unfortunately you cannot do a similar
+thing with update_or_create.
+This module tries to fill that void until L<DBIx::Class> has an api itself.
 
-It is a base class for ResultSets providing just one method: recursive_update
+The functional interface can be used without modifications of the model,
+for example by form processors like L<HTML::FormHandler::Model::DBIC>.
+
+It is a base class for L<DBIx::Class::ResultSet>s providing the method recursive_update
 which works just like update_or_create but can recursively update or create
 data objects composed of multiple rows. All rows need to be identified by primary keys
 - so you need to provide them in the update structure (unless they can be deduced from 
 the parent row - for example when you have a belongs_to relationship).  
-If not all colums comprising the primary key are specified - then a new row will be created,
+If not all columns comprising the primary key are specified a new row will be created,
 with the expectation that the missing columns will be filled by it (as in the case of auto_increment 
 primary keys).  
 
@@ -600,16 +589,13 @@ then you need to inform recursive_update about additional predicate with a secon
       [ 'id' ]
     );
 
-This will work with a new DBIC release.
-
 For a many_to_many (pseudo) relation you can supply a list of primary keys
-from the other table and it will link the record at hand to those and
+from the other table and it will link the record at hand to those and
 only those records identified by them.  This is convenient for handling web
-forms with check boxes (or a SELECT box with multiple choice) that let you
+forms with check boxes (or a select field with multiple choice) that lets you
 update such (pseudo) relations.  
 
-For a description how to set up base classes for ResultSets see load_namespaces
-in DBIx::Class::Schema.
+For a description how to set up base classes for ResultSets see L<DBIx::Class::Schema/load_namespaces>.
 
 =head1 DESIGN CHOICES
 
@@ -732,7 +718,7 @@ Clearing the relationship:
 
 =head2 Treatment of many-to-many pseudo relations
 
-The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M.
+The function gets the information about m2m relations from L<DBIx::Class::IntrospectableM2M>.
 If it isn't loaded in the ResultSource classes the code relies on the fact that:
 
     if($object->can($name) and
@@ -787,40 +773,3 @@ No bugs have been reported.
 Please report any bugs or feature requests to
 C<bug-dbix-class-recursiveput@rt.cpan.org>, or through the web interface at
 L<http://rt.cpan.org>.
-
-
-=head1 AUTHOR
-
-Zbigniew Lukasiak  C<< <zby@cpan.org> >>
-Influenced by code by Pedro Melo.
-
-=head1 LICENCE AND COPYRIGHT
-
-Copyright (c) 2008, Zbigniew Lukasiak C<< <zby@cpan.org> >>. All rights reserved.
-
-This module is free software; you can redistribute it and/or
-modify it under the same terms as Perl itself. See L<perlartistic>.
-
-
-=head1 DISCLAIMER OF WARRANTY
-
-BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
-FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
-OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
-PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
-EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
-WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
-ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
-YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
-NECESSARY SERVICING, REPAIR, OR CORRECTION.
-
-IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
-WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
-REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
-LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
-OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
-THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
-RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
-FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
-SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
-SUCH DAMAGES.
This page took 0.022854 seconds and 4 git commands to generate.