4 package DBIx
::Class
::ResultSet
::RecursiveUpdate
;
6 our $VERSION = '0.013';
8 use base
qw(DBIx::Class::ResultSet);
10 sub recursive_update
{
11 my ( $self, $updates, $fixed_fields ) = @_;
13 DBIx
::Class
::ResultSet
::RecursiveUpdate
::Functions
::recursive_update
(
16 fixed_fields
=> $fixed_fields
20 package DBIx
::Class
::ResultSet
::RecursiveUpdate
::Functions
;
22 use Scalar
::Util
qw( blessed );
24 sub recursive_update
{
26 my ( $self, $updates, $fixed_fields, $object, $resolved,
29 qw
/resultset updates fixed_fields object resolved if_not_submitted/};
32 # warn 'entering: ' . $self->result_source->from();
33 carp
'fixed fields needs to be an array ref'
34 if $fixed_fields && ref($fixed_fields) ne 'ARRAY';
36 %fixed_fields = map { $_ => 1 } @$fixed_fields if $fixed_fields;
37 if ( blessed
($updates) && $updates->isa('DBIx::Class::Row') ) {
40 if ( $updates->{id
} ) {
41 $object = $self->find( $updates->{id
}, { key
=> 'primary' } );
44 grep { !exists $updates->{$_} && !exists $fixed_fields{$_} }
45 $self->result_source->primary_columns;
46 if ( !$object && !scalar @missing ) {
48 # warn 'finding by: ' . Dumper( $updates ); use Data::Dumper;
49 $object = $self->find( $updates, { key
=> 'primary' } );
51 $updates = { %$updates, %$resolved };
53 grep { !exists $resolved->{$_} } @missing;
54 if ( !$object && !scalar @missing ) {
56 # warn 'finding by +resolved: ' . Dumper( $updates ); use Data::Dumper;
57 $object = $self->find( $updates, { key
=> 'primary' } );
59 $object ||= $self->new( {} );
61 # warn Dumper( $updates ); use Data::Dumper;
62 # direct column accessors
65 # relations that that should be done before the row is inserted into the
66 # database like belongs_to
69 # relations that that should be done after the row is inserted into the
70 # database like has_many, might_have and has_one
73 my %columns_by_accessor = _get_columns_by_accessor
($self);
75 # warn 'resolved: ' . Dumper( $resolved );
76 # warn 'updates: ' . Dumper( $updates ); use Data::Dumper;
77 # warn 'columns: ' . Dumper( \%columns_by_accessor );
78 for my $name ( keys %$updates ) {
79 my $source = $self->result_source;
82 if ( exists $columns_by_accessor{$name}
83 && !( $source->has_relationship($name)
84 && ref( $updates->{$name} ) ) )
87 #warn "$name is a column\n";
88 $columns{$name} = $updates->{$name};
93 if ( $source->has_relationship($name) ) {
94 my $info = $source->relationship_info($name);
95 if (_master_relation_cond
(
96 $source, $info->{cond
},
97 _get_pk_for_related
( $self, $name )
102 #warn "$name is a pre-update rel\n";
103 $pre_updates{$name} = $updates->{$name};
108 #warn "$name is a post-update rel\n";
109 $post_updates{$name} = $updates->{$name};
114 # many-to-many helper accessors
115 if ( is_m2m
( $self, $name ) ) {
117 #warn "$name is a many-to-many helper accessor\n";
118 $other_methods{$name} = $updates->{$name};
123 if ( $object->can($name) && not $source->has_relationship($name) ) {
125 #warn "$name is an accessor";
126 $other_methods{$name} = $updates->{$name};
131 # TODO: don't throw a warning instead of an exception to give users
132 # time to adapt to the new API
133 $self->throw_exception(
134 "No such column, relationship, many-to-many helper accessor or generic accessor '$name'"
138 # warn 'other: ' . Dumper( \%other_methods ); use Data::Dumper;
140 # first update columns and other accessors
141 # so that later related records can be found
142 for my $name ( keys %columns ) {
143 #warn "update col $name\n";
144 $object->$name( $columns{$name} );
146 for my $name ( keys %other_methods ) {
147 #warn "update other $name\n";
148 $object->$name( $updates->{$name} );
150 for my $name ( keys %pre_updates ) {
151 #warn "pre_update $name\n";
152 _update_relation
( $self, $name, $pre_updates{$name}, $object,
156 # $self->_delete_empty_auto_increment($object);
157 # don't allow insert to recurse to related objects
158 # do the recursion ourselves
159 # $object->{_rel_in_storage} = 1;
160 #warn "CHANGED: " . $object->is_changed . " IN STOR: " . $object->in_storage . "\n";
161 $object->update_or_insert if $object->is_changed;
163 # updating many_to_many
164 for my $name ( keys %$updates ) {
165 next if exists $columns{$name};
166 my $value = $updates->{$name};
168 if ( is_m2m
( $self, $name ) ) {
169 #warn "update m2m $name\n";
170 my ($pk) = _get_pk_for_related
( $self, $name );
172 my $result_source = $object->$name->result_source;
174 if ( !defined $value ) {
177 elsif ( ref $value ) {
178 @updates = @{$value};
183 for my $elem (@updates) {
187 resultset
=> $result_source->resultset,
193 $result_source->resultset->find( { $pk => $elem } );
196 my $set_meth = 'set_' . $name;
197 $object->$set_meth( \
@rows );
200 for my $name ( keys %post_updates ) {
201 #warn "post_update $name\n";
202 _update_relation
( $self, $name, $post_updates{$name}, $object,
208 # returns DBIx::Class::ResultSource::column_info as a hash indexed by column accessor || name
209 sub _get_columns_by_accessor
{
211 my $source = $self->result_source;
213 for my $name ( $source->columns ) {
214 my $info = $source->column_info($name);
215 $info->{name
} = $name;
216 $columns{ $info->{accessor
} || $name } = $info;
221 # Arguments: $rs, $name, $updates, $row, $if_not_submitted
223 sub _update_relation
{
224 my ( $self, $name, $updates, $object, $if_not_submitted ) = @_;
226 # this should never happen because we're checking the paramters passed to
227 # recursive_update, but just to be sure...
228 $object->throw_exception("No such relationship '$name'")
229 unless $object->has_relationship($name);
231 #warn "_update_relation $name: OBJ: " . ref($object) . " IN STOR: " . $object->in_storage . "\n";
233 my $info = $object->result_source->relationship_info($name);
235 # get a related resultset without a condition
236 my $related_resultset =
237 $self->related_resultset($name)->result_source->resultset;
239 if ( $self->result_source->can('_resolve_condition') ) {
241 $self->result_source->_resolve_condition( $info->{cond
}, $name,
245 # warn "$name resolved: " . Dumper( $resolved ); use Data::Dumper;
247 if defined $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
248 && $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
251 my $rel_col_cnt = scalar keys %{ $info->{cond
} };
253 warn "RELINFO for $name: " . Dumper
($info);
254 warn "REL_COL_CNT: $rel_col_cnt";
256 #warn "REV RELINFO for $name: " . Dumper($revrelinfo);
258 # the only valid datatype for a has_many rels is an arrayref
259 if ( $info->{attrs
}{accessor
} eq 'multi' ) {
260 $self->throw_exception(
261 "data for has_many relationship '$name' must be an arrayref")
262 unless ref $updates eq 'ARRAY';
265 for my $sub_updates ( @{$updates} ) {
266 my $sub_object = recursive_update
(
267 resultset
=> $related_resultset,
268 updates
=> $sub_updates,
269 resolved
=> $resolved
271 push @updated_ids, $sub_object->id;
273 my @related_pks = $related_resultset->result_source->primary_columns;
274 if ( defined $if_not_submitted && $if_not_submitted eq 'delete' ) {
276 # only handles related result classes with single primary keys
277 if ( 1 == scalar @related_pks ) {
278 $object->$name->search(
279 { $related_pks[0] => { -not_in
=> \
@updated_ids } } )
283 elsif ( defined $if_not_submitted
284 && $if_not_submitted eq 'set_to_null' )
287 # only handles related result classes with single primary keys
288 if ( 1 == scalar @related_pks ) {
289 my @fk = keys %$resolved;
290 $object->$name->search(
291 { $related_pks[0] => { -not_in
=> \
@updated_ids } } )
292 ->update( { $fk[0] => undef } );
296 elsif ($info->{attrs
}{accessor
} eq 'single'
297 || $info->{attrs
}{accessor
} eq 'filter' )
299 #warn "\tupdating rel '$name': $if_not_submitted\n";
301 if ( ref $updates ) {
303 # for might_have relationship
304 if ( $info->{attrs
}{accessor
} eq 'single'
305 && defined $object->$name )
307 $sub_object = recursive_update
(
308 resultset
=> $related_resultset,
310 object
=> $object->$name
314 $sub_object = recursive_update
(
315 resultset
=> $related_resultset,
317 resolved
=> $resolved
322 $sub_object = $related_resultset->find($updates)
325 && ( exists $info->{attrs
}{join_type
}
326 && $info->{attrs
}{join_type
} eq 'LEFT' )
329 $object->set_from_related( $name, $sub_object )
333 && ( exists $info->{attrs
}{join_type
}
334 && $info->{attrs
}{join_type
} eq 'LEFT' )
338 $self->throw_exception(
339 "recursive_update doesn't now how to handle relationship '$name' with accessor "
340 . $info->{attrs
}{accessor
} );
345 my ( $self, $relation ) = @_;
346 my $rclass = $self->result_class;
348 # DBIx::Class::IntrospectableM2M
349 if ( $rclass->can('_m2m_metadata') ) {
350 return $rclass->_m2m_metadata->{$relation};
352 my $object = $self->new( {} );
353 if ( $object->can($relation)
354 and !$self->result_source->has_relationship($relation)
355 and $object->can( 'set_' . $relation ) )
363 my ( $self, $relation ) = @_;
364 my $rclass = $self->result_class;
366 # DBIx::Class::IntrospectableM2M
367 if ( $rclass->can('_m2m_metadata') ) {
368 return $self->result_source->related_source(
369 $rclass->_m2m_metadata->{$relation}{relation
} )
371 $rclass->_m2m_metadata->{$relation}{foreign_relation
} );
373 my $object = $self->new( {} );
374 my $r = $object->$relation;
375 return $r->result_source;
378 sub _delete_empty_auto_increment
{
379 my ( $self, $object ) = @_;
380 for my $col ( keys %{ $object->{_column_data
} } ) {
381 if ($object->result_source->column_info($col)->{is_auto_increment
}
382 and ( !defined $object->{_column_data
}{$col}
383 or $object->{_column_data
}{$col} eq '' )
386 delete $object->{_column_data
}{$col};
391 sub _get_pk_for_related
{
392 my ( $self, $relation ) = @_;
394 if ( $self->result_source->has_relationship($relation) ) {
395 $result_source = $self->result_source->related_source($relation);
399 if ( is_m2m
( $self, $relation ) ) {
400 $result_source = get_m2m_source
( $self, $relation );
402 return $result_source->primary_columns;
405 # This function determines wheter a relationship should be done before or
406 # after the row is inserted into the database
407 # relationships before: belongs_to
408 # relationships after: has_many, might_have and has_one
409 # true means before, false after
410 sub _master_relation_cond
{
411 my ( $source, $cond, @foreign_ids ) = @_;
412 my $foreign_ids_re = join '|', @foreign_ids;
413 if ( ref $cond eq 'HASH' ) {
414 for my $f_key ( keys %{$cond} ) {
416 # might_have is not master
417 my $col = $cond->{$f_key};
419 if ( $source->column_info($col)->{is_auto_increment
} ) {
422 if ( $f_key =~ /^foreign\.$foreign_ids_re/ ) {
427 elsif ( ref $cond eq 'ARRAY' ) {
428 for my $new_cond (@$cond) {
429 return _master_relation_cond
( $source, $new_cond, @foreign_ids );
435 1; # Magic true value required at end of module
440 DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
444 The functional interface:
446 my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update({
447 resultset => $schema->resultset( 'Dvd' ),
452 title => 'One Flew Over the Cuckoo's Nest'
459 As ResultSet subclass:
461 __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
463 in the Schema file (see t/lib/DBSchema.pm). Or appriopriate 'use base' in the ResultSet classes.
467 my $user = $user_rs->recursive_update( {
471 title => 'One Flew Over the Cuckoo's Nest'
480 This is still experimental. I've added a functional interface so that it can be used
481 in Form Processors and not require modification of the model.
483 You can feed the ->create method with a recursive datastructure and have the related records
484 created. Unfortunately you cannot do a similar thing with update_or_create - this module
485 tries to fill that void.
487 It is a base class for ResultSets providing just one method: recursive_update
488 which works just like update_or_create but can recursively update or create
489 data objects composed of multiple rows. All rows need to be identified by primary keys
490 - so you need to provide them in the update structure (unless they can be deduced from
491 the parent row - for example when you have a belongs_to relationship).
492 If not all colums comprising the primary key are specified - then a new row will be created,
493 with the expectation that the missing columns will be filled by it (as in the case of auto_increment
497 If the resultset itself stores an assignement for the primary key,
500 my $restricted_rs = $user_rs->search( { id => 1 } );
502 then you need to inform recursive_update about additional predicate with a second argument:
504 my $user = $restricted_rs->recursive_update( {
507 title => 'One Flew Over the Cuckoo's Nest'
514 This will work with a new DBIC release.
516 For a many_to_many (pseudo) relation you can supply a list of primary keys
517 from the other table - and it will link the record at hand to those and
518 only those records identified by them. This is convenient for handling web
519 forms with check boxes (or a SELECT box with multiple choice) that let you
520 update such (pseudo) relations.
522 For a description how to set up base classes for ResultSets see load_namespaces
523 in DBIx::Class::Schema.
525 =head1 DESIGN CHOICES
527 Columns and relationships which are excluded from the updates hashref aren't
530 =head2 Treatment of belongs_to relations
532 In case the relationship is included but undefined in the updates hashref,
533 all columns forming the relationship will be set to null.
534 If not all of them are nullable, DBIx::Class will throw an error.
536 Updating the relationship:
538 my $dvd = $dvd_rs->recursive_update( {
543 Clearing the relationship (only works if cols are nullable!):
545 my $dvd = $dvd_rs->recursive_update( {
550 =head2 Treatment of might_have relationships
552 In case the relationship is included but undefined in the updates hashref,
553 all columns forming the relationship will be set to null.
555 Updating the relationship:
557 my $user = $user_rs->recursive_update( {
560 street => "101 Main Street",
566 Clearing the relationship:
568 my $user = $user_rs->recursive_update( {
573 =head2 Treatment of has_many relations
575 If a relationship key is included in the data structure with a value of undef
576 or an empty array, all existing related rows will be deleted, or their foreign
577 key columns will be set to null.
579 The exact behaviour depends on the nullability of the foreign key columns and
580 the value of the "if_not_submitted" parameter. The parameter defaults to
581 undefined which neither nullifies nor deletes.
583 When the array contains elements they are updated if they exist, created when
584 not and deleted if not included.
586 =head3 All foreign table columns are nullable
588 In this case recursive_update defaults to nullifying the foreign columns.
590 =head3 Not all foreign table columns are nullable
592 In this case recursive_update deletes the foreign rows.
594 Updating the relationship:
598 my $dvd = $dvd_rs->recursive_update( {
605 my $dvd = $dvd_rs->recursive_update( {
623 You can even mix them:
625 my $dvd = $dvd_rs->recursive_update( {
627 tags => [ '2', { id => '3' } ],
630 Clearing the relationship:
632 my $dvd = $dvd_rs->recursive_update( {
637 This is the same as passing an empty array:
639 my $dvd = $dvd_rs->recursive_update( {
644 =head2 Treatment of many-to-many pseudo relations
646 The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M.
647 If it isn't loaded in the ResultSource classes the code relies on the fact that:
649 if($object->can($name) and
650 !$object->result_source->has_relationship($name) and
651 $object->can( 'set_' . $name )
654 Then $name must be a many to many pseudo relation.
655 And that in a similarly ugly was I find out what is the ResultSource of
656 objects from that many to many pseudo relation.
663 =head2 recursive_update
665 The method that does the work here.
669 $self->is_m2m( 'name ' ) - answers the question if 'name' is a many to many
670 (pseudo) relation on $self.
672 =head2 get_m2m_source
674 $self->get_m2m_source( 'name' ) - returns the ResultSource linked to by the many
675 to many (pseudo) relation 'name' from $self.
681 =head1 CONFIGURATION AND ENVIRONMENT
683 DBIx::Class::RecursiveUpdate requires no configuration files or environment variables.
689 =head1 INCOMPATIBILITIES
694 =head1 BUGS AND LIMITATIONS
696 No bugs have been reported.
698 Please report any bugs or feature requests to
699 C<bug-dbix-class-recursiveput@rt.cpan.org>, or through the web interface at
700 L<http://rt.cpan.org>.
705 Zbigniew Lukasiak C<< <zby@cpan.org> >>
706 Influenced by code by Pedro Melo.
708 =head1 LICENCE AND COPYRIGHT
710 Copyright (c) 2008, Zbigniew Lukasiak C<< <zby@cpan.org> >>. All rights reserved.
712 This module is free software; you can redistribute it and/or
713 modify it under the same terms as Perl itself. See L<perlartistic>.
716 =head1 DISCLAIMER OF WARRANTY
718 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
719 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
720 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
721 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
722 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
723 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
724 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
725 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
726 NECESSARY SERVICING, REPAIR, OR CORRECTION.
728 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
729 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
730 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
731 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
732 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
733 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
734 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
735 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
736 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF