use warnings;
package DBIx::Class::ResultSet::RecursiveUpdate;
-our $VERSION = '0.012';
+our $VERSION = '0.013';
use base qw(DBIx::Class::ResultSet);
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 );
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;
}
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 } );
}
}
elsif( ! ref $sub_updates ){
- $sub_object = $related_result->find( $sub_updates )
- unless (!$sub_updates && ($info->{attrs}{join_type} eq 'LEFT'));
+ $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 )
- unless (!$sub_object && !$sub_updates && ($info->{attrs}{join_type} eq 'LEFT'));
+ 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
+
+If a relationship key is included in the data structure with a value of undef
+or an empty array, all existing related rows will be deleted, or their foreign
+key columns will be set to null.
+
+The exact behaviour depends on the nullability of the foreign key columns and
+the value of the "if_not_submitted" parameter. The parameter defaults to
+undefined which neither nullifies nor deletes.
+
+When the array contains elements they are updated if they exist, created when
+not and deleted if not included.
+
+=head3 All foreign table columns are nullable
+
+In this case recursive_update defaults to nullifying the foreign columns.
+
+=head3 Not all foreign table columns are nullable
+
+In this case recursive_update deletes the foreign rows.
+
+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