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";
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";
103 $pre_updates{$name} = $updates->{$name};
108 #warn "$name is a post-update rel";
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";
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 $self->throw_exception(
132 "No such column, relationship, many-to-many helper accessor or generic accessor '$name'"
136 # warn 'other: ' . Dumper( \%other_methods ); use Data::Dumper;
138 # first update columns and other accessors
139 # so that later related records can be found
140 for my $name ( keys %columns ) {
141 $object->$name( $columns{$name} );
143 for my $name ( keys %other_methods ) {
144 $object->$name( $updates->{$name} );
146 for my $name ( keys %pre_updates ) {
147 _update_relation
( $self, $name, $updates->{$name}, $object,
151 # $self->_delete_empty_auto_increment($object);
152 # don't allow insert to recurse to related objects
153 # do the recursion ourselves
154 # $object->{_rel_in_storage} = 1;
155 $object->update_or_insert if $object->is_changed;
157 # updating many_to_many
158 for my $name ( keys %$updates ) {
159 next if exists $columns{$name};
160 my $value = $updates->{$name};
162 if ( is_m2m
( $self, $name ) ) {
163 my ($pk) = _get_pk_for_related
( $self, $name );
165 my $result_source = $object->$name->result_source;
167 if ( !defined $value ) {
170 elsif ( ref $value ) {
171 @updates = @{$value};
176 for my $elem (@updates) {
180 resultset
=> $result_source->resultset,
186 $result_source->resultset->find( { $pk => $elem } );
189 my $set_meth = 'set_' . $name;
190 $object->$set_meth( \
@rows );
193 for my $name ( keys %post_updates ) {
194 _update_relation
( $self, $name, $updates->{$name}, $object,
200 # returns DBIx::Class::ResultSource::column_info as a hash indexed by column accessor || name
201 sub _get_columns_by_accessor
{
203 my $source = $self->result_source;
205 for my $name ( $source->columns ) {
206 my $info = $source->column_info($name);
207 $info->{name
} = $name;
208 $columns{ $info->{accessor
} || $name } = $info;
213 # Arguments: $name, $updates, $object, $if_not_submitted
215 sub _update_relation
{
216 my ( $self, $name, $updates, $object, $if_not_submitted ) = @_;
218 # this should never happen because we're checking the paramters passed to
219 # recursive_update, but just to be sure...
220 $object->throw_exception("No such relationship '$name' on ")
221 unless $object->has_relationship($name);
223 my $info = $object->result_source->relationship_info($name);
225 # get a related resultset without a condition
226 my $related_resultset =
227 $self->related_resultset($name)->result_source->resultset;
229 if ( $self->result_source->can('_resolve_condition') ) {
231 $self->result_source->_resolve_condition( $info->{cond
}, $name,
235 # warn "$name resolved: " . Dumper( $resolved ); use Data::Dumper;
237 if defined $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
238 && $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
241 my $rel_col_cnt = scalar keys %{ $info->{cond
} };
243 warn "RELINFO for $name: " . Dumper
($info);
244 warn "REL_COL_CNT: $rel_col_cnt";
246 #warn "REV RELINFO for $name: " . Dumper($revrelinfo);
248 # the only valid datatype for a has_many rels is an arrayref
249 if ( $info->{attrs
}{accessor
} eq 'multi') {
250 $self->throw_exception( "data for has_many relationship '$name' must be an arrayref")
251 unless ref $updates eq 'ARRAY';
254 for my $sub_updates ( @{$updates} ) {
255 warn "updating $name";
256 my $sub_object = recursive_update
(
257 resultset
=> $related_resultset,
258 updates
=> $sub_updates,
259 resolved
=> $resolved
261 push @updated_ids, $sub_object->id;
263 my @related_pks = $related_resultset->result_source->primary_columns;
264 if ( defined $if_not_submitted && $if_not_submitted eq 'delete' ) {
266 # only handles related result classes with single primary keys
267 if ( 1 == scalar @related_pks ) {
268 $object->$name->search(
269 { $related_pks[0] => { -not_in
=> \
@updated_ids } } )
273 elsif ( defined $if_not_submitted
274 && $if_not_submitted eq 'set_to_null' )
277 # only handles related result classes with single primary keys
278 if ( 1 == scalar @related_pks ) {
279 my @fk = keys %$resolved;
280 $object->$name->search(
281 { $related_pks[0] => { -not_in
=> \
@updated_ids } } )
282 ->update( { $fk[0] => undef } );
286 elsif ($info->{attrs
}{accessor
} eq 'single'
287 || $info->{attrs
}{accessor
} eq 'filter' )
290 if ( ref $updates ) {
292 # for might_have relationship
293 if ( $info->{attrs
}{accessor
} eq 'single'
294 && defined $object->$name )
296 $sub_object = recursive_update
(
297 resultset
=> $related_resultset,
299 object
=> $object->$name
303 $sub_object = recursive_update
(
304 resultset
=> $related_resultset,
306 resolved
=> $resolved
310 elsif ( !ref $updates ) {
311 $sub_object = $related_resultset->find($updates)
314 && ( exists $info->{attrs
}{join_type
}
315 && $info->{attrs
}{join_type
} eq 'LEFT' )
318 $object->set_from_related( $name, $sub_object )
322 && ( exists $info->{attrs
}{join_type
}
323 && $info->{attrs
}{join_type
} eq 'LEFT' )
327 $self->throw_exception( "recursive_update doesn't now how to handle relationship '$name' with accessor " . $info->{attrs
}{accessor
});
332 my ( $self, $relation ) = @_;
333 my $rclass = $self->result_class;
335 # DBIx::Class::IntrospectableM2M
336 if ( $rclass->can('_m2m_metadata') ) {
337 return $rclass->_m2m_metadata->{$relation};
339 my $object = $self->new( {} );
340 if ( $object->can($relation)
341 and !$self->result_source->has_relationship($relation)
342 and $object->can( 'set_' . $relation ) )
350 my ( $self, $relation ) = @_;
351 my $rclass = $self->result_class;
353 # DBIx::Class::IntrospectableM2M
354 if ( $rclass->can('_m2m_metadata') ) {
355 return $self->result_source->related_source(
356 $rclass->_m2m_metadata->{$relation}{relation
} )
358 $rclass->_m2m_metadata->{$relation}{foreign_relation
} );
360 my $object = $self->new( {} );
361 my $r = $object->$relation;
362 return $r->result_source;
365 sub _delete_empty_auto_increment
{
366 my ( $self, $object ) = @_;
367 for my $col ( keys %{ $object->{_column_data
} } ) {
368 if ($object->result_source->column_info($col)->{is_auto_increment
}
369 and ( !defined $object->{_column_data
}{$col}
370 or $object->{_column_data
}{$col} eq '' )
373 delete $object->{_column_data
}{$col};
378 sub _get_pk_for_related
{
379 my ( $self, $relation ) = @_;
381 if ( $self->result_source->has_relationship($relation) ) {
382 $result_source = $self->result_source->related_source($relation);
386 if ( is_m2m
( $self, $relation ) ) {
387 $result_source = get_m2m_source
( $self, $relation );
389 return $result_source->primary_columns;
392 # This function determines wheter a relationship should be done before or
393 # after the row is inserted into the database
394 # relationships before: belongs_to
395 # relationships after: has_many, might_have and has_one
396 sub _master_relation_cond
{
397 my ( $source, $cond, @foreign_ids ) = @_;
398 my $foreign_ids_re = join '|', @foreign_ids;
399 if ( ref $cond eq 'HASH' ) {
400 for my $f_key ( keys %{$cond} ) {
402 # might_have is not master
403 my $col = $cond->{$f_key};
405 if ( $source->column_info($col)->{is_auto_increment
} ) {
408 if ( $f_key =~ /^foreign\.$foreign_ids_re/ ) {
413 elsif ( ref $cond eq 'ARRAY' ) {
414 for my $new_cond (@$cond) {
415 return _master_relation_cond
( $source, $new_cond, @foreign_ids );
421 1; # Magic true value required at end of module
426 DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
430 The functional interface:
432 my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update({
433 resultset => $schema->resultset( 'Dvd' ),
438 title => 'One Flew Over the Cuckoo's Nest'
445 As ResultSet subclass:
447 __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
449 in the Schema file (see t/lib/DBSchema.pm). Or appriopriate 'use base' in the ResultSet classes.
453 my $user = $user_rs->recursive_update( {
457 title => 'One Flew Over the Cuckoo's Nest'
466 This is still experimental. I've added a functional interface so that it can be used
467 in Form Processors and not require modification of the model.
469 You can feed the ->create method with a recursive datastructure and have the related records
470 created. Unfortunately you cannot do a similar thing with update_or_create - this module
471 tries to fill that void.
473 It is a base class for ResultSets providing just one method: recursive_update
474 which works just like update_or_create but can recursively update or create
475 data objects composed of multiple rows. All rows need to be identified by primary keys
476 - so you need to provide them in the update structure (unless they can be deduced from
477 the parent row - for example when you have a belongs_to relationship).
478 If not all colums comprising the primary key are specified - then a new row will be created,
479 with the expectation that the missing columns will be filled by it (as in the case of auto_increment
483 If the resultset itself stores an assignement for the primary key,
486 my $restricted_rs = $user_rs->search( { id => 1 } );
488 then you need to inform recursive_update about additional predicate with a second argument:
490 my $user = $restricted_rs->recursive_update( {
493 title => 'One Flew Over the Cuckoo's Nest'
500 This will work with a new DBIC release.
502 For a many_to_many (pseudo) relation you can supply a list of primary keys
503 from the other table - and it will link the record at hand to those and
504 only those records identified by them. This is convenient for handling web
505 forms with check boxes (or a SELECT box with multiple choice) that let you
506 update such (pseudo) relations.
508 For a description how to set up base classes for ResultSets see load_namespaces
509 in DBIx::Class::Schema.
511 =head1 DESIGN CHOICES
513 Columns and relationships which are excluded from the updates hashref aren't
516 =head2 Treatment of belongs_to relations
518 In case the relationship is included but undefined in the updates hashref,
519 all columns forming the relationship will be set to null.
520 If not all of them are nullable, DBIx::Class will throw an error.
522 Updating the relationship:
524 my $dvd = $dvd_rs->recursive_update( {
529 Clearing the relationship (only works if cols are nullable!):
531 my $dvd = $dvd_rs->recursive_update( {
536 =head2 Treatment of might_have relationships
538 In case the relationship is included but undefined in the updates hashref,
539 all columns forming the relationship will be set to null.
541 Updating the relationship:
543 my $user = $user_rs->recursive_update( {
546 street => "101 Main Street",
552 Clearing the relationship:
554 my $user = $user_rs->recursive_update( {
559 =head2 Treatment of has_many relations
561 If a relationship key is included in the data structure with a value of undef
562 or an empty array, all existing related rows will be deleted, or their foreign
563 key columns will be set to null.
565 The exact behaviour depends on the nullability of the foreign key columns and
566 the value of the "if_not_submitted" parameter. The parameter defaults to
567 undefined which neither nullifies nor deletes.
569 When the array contains elements they are updated if they exist, created when
570 not and deleted if not included.
572 =head3 All foreign table columns are nullable
574 In this case recursive_update defaults to nullifying the foreign columns.
576 =head3 Not all foreign table columns are nullable
578 In this case recursive_update deletes the foreign rows.
580 Updating the relationship:
584 my $dvd = $dvd_rs->recursive_update( {
591 my $dvd = $dvd_rs->recursive_update( {
609 You can even mix them:
611 my $dvd = $dvd_rs->recursive_update( {
613 tags => [ '2', { id => '3' } ],
616 Clearing the relationship:
618 my $dvd = $dvd_rs->recursive_update( {
623 This is the same as passing an empty array:
625 my $dvd = $dvd_rs->recursive_update( {
630 =head2 Treatment of many-to-many pseudo relations
632 The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M.
633 If it isn't loaded in the ResultSource classes the code relies on the fact that:
635 if($object->can($name) and
636 !$object->result_source->has_relationship($name) and
637 $object->can( 'set_' . $name )
640 Then $name must be a many to many pseudo relation.
641 And that in a similarly ugly was I find out what is the ResultSource of
642 objects from that many to many pseudo relation.
649 =head2 recursive_update
651 The method that does the work here.
655 $self->is_m2m( 'name ' ) - answers the question if 'name' is a many to many
656 (pseudo) relation on $self.
658 =head2 get_m2m_source
660 $self->get_m2m_source( 'name' ) - returns the ResultSource linked to by the many
661 to many (pseudo) relation 'name' from $self.
667 =head1 CONFIGURATION AND ENVIRONMENT
669 DBIx::Class::RecursiveUpdate requires no configuration files or environment variables.
675 =head1 INCOMPATIBILITIES
680 =head1 BUGS AND LIMITATIONS
682 No bugs have been reported.
684 Please report any bugs or feature requests to
685 C<bug-dbix-class-recursiveput@rt.cpan.org>, or through the web interface at
686 L<http://rt.cpan.org>.
691 Zbigniew Lukasiak C<< <zby@cpan.org> >>
692 Influenced by code by Pedro Melo.
694 =head1 LICENCE AND COPYRIGHT
696 Copyright (c) 2008, Zbigniew Lukasiak C<< <zby@cpan.org> >>. All rights reserved.
698 This module is free software; you can redistribute it and/or
699 modify it under the same terms as Perl itself. See L<perlartistic>.
702 =head1 DISCLAIMER OF WARRANTY
704 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
705 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
706 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
707 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
708 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
709 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
710 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
711 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
712 NECESSARY SERVICING, REPAIR, OR CORRECTION.
714 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
715 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
716 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
717 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
718 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
719 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
720 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
721 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
722 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF