doc improvements

[chaz/p5-DBIx-Class-ResultSet-RecursiveUpdate] / lib / DBIx / Class / ResultSet / RecursiveUpdate.pm

diff --git a/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm b/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm
index 84b61c45edf2aff0e0c4916e98474c2531872ef8..ca0a7715377855ca45adb867d88818c9ca6ca09c 100644 (file)
--- a/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm
+++ b/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm
@@ -256,7 +256,7 @@ sub _update_relation {
     map {s/^foreign\.//} @rel_cols;
 
     #warn "REL_COLS: " . Dumper(@rel_cols); use Data::Dumper;
     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;
 
     # find out if all related columns are nullable
     my $all_fks_nullable = 1;


@@ -321,9 +321,11 @@ sub _update_relation {
                 }
                 push @cond, \%cond_for_obj;
             }
                 }
                 push @cond, \%cond_for_obj;
             }

+

             # only limit resultset if there are related rows left
             # only limit resultset if there are related rows left

-            if (scalar @cond) {
-                $rs_rel_delist = $rs_rel_delist->search_rs( { -not => [@cond] } );
+            if ( scalar @cond ) {
+                $rs_rel_delist =
+                    $rs_rel_delist->search_rs( { -not => [@cond] } );

             }
         }
 
             }
         }
 


@@ -512,61 +514,60 @@ sub _master_relation_cond {
 1;    # Magic true value required at end of module
 __END__
 
 1;    # Magic true value required at end of module
 __END__
 

-=head1 NAME
-
-DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
-

 =head1 SYNOPSIS
 
 =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 => {
         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' );
 
 
     __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
 
 =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).  
 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).  
 
 with the expectation that the missing columns will be filled by it (as in the case of auto_increment 
 primary keys).  
 


@@ -588,16 +589,13 @@ then you need to inform recursive_update about additional predicate with a secon
       [ 'id' ]
     );
 
       [ 'id' ]
     );
 

-This will work with a new DBIC release.
-

 For a many_to_many (pseudo) relation you can supply a list of primary keys
 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
 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.  
 
 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
 
 
 =head1 DESIGN CHOICES
 


@@ -720,7 +718,7 @@ Clearing the relationship:
 
 =head2 Treatment of many-to-many pseudo relations
 
 
 =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
 If it isn't loaded in the ResultSource classes the code relies on the fact that:
 
     if($object->can($name) and