3 package DBIx
::Class
::ResultSet
::RecursiveUpdate
;
5 our $VERSION = '0.013';
7 use base
qw(DBIx::Class::ResultSet);
10 my ( $self, $updates, $fixed_fields ) = @_;
11 return DBIx
::Class
::ResultSet
::RecursiveUpdate
::Functions
::recursive_update
(
14 fixed_fields
=> $fixed_fields
18 package DBIx
::Class
::ResultSet
::RecursiveUpdate
::Functions
;
20 use Scalar
::Util
qw( blessed );
23 sub recursive_update
{
25 my ( $self, $updates, $fixed_fields, $object, $resolved, $if_not_submitted ) = @params{ qw
/resultset updates fixed_fields object resolved if_not_submitted/ };
27 # warn 'entering: ' . $self->result_source->from();
28 carp
'fixed fields needs to be an array ref' if $fixed_fields && ref($fixed_fields) ne 'ARRAY';
30 %fixed_fields = map { $_ => 1 } @$fixed_fields if $fixed_fields;
31 if ( blessed
($updates) && $updates->isa('DBIx::Class::Row') ) {
34 if ( $updates->{id
} ){
35 $object = $self->find( $updates->{id
}, { key
=> 'primary' } );
38 grep { !exists $updates->{$_} && !exists $fixed_fields{$_} } $self->result_source->primary_columns;
39 if ( !$object && !scalar @missing ) {
40 # warn 'finding by: ' . Dumper( $updates ); use Data::Dumper;
41 $object = $self->find( $updates, { key
=> 'primary' } );
43 $updates = { %$updates, %$resolved };
45 grep { !exists $resolved->{$_} } @missing;
46 if ( !$object && !scalar @missing ) {
47 # warn 'finding by +resolved: ' . Dumper( $updates ); use Data::Dumper;
48 $object = $self->find( $updates, { key
=> 'primary' } );
50 $object ||= $self->new( {} );
51 # warn Dumper( $updates ); use Data::Dumper;
52 # direct column accessors
55 # relations that that should be done before the row is inserted into the database
59 # relations that that should be done after the row is inserted into the database
60 # like has_many, might_have and has_one
63 my %columns_by_accessor = _get_columns_by_accessor
( $self );
64 # warn 'resolved: ' . Dumper( $resolved );
65 # warn 'updates: ' . Dumper( $updates ); use Data::Dumper;
66 # warn 'columns: ' . Dumper( \%columns_by_accessor );
67 for my $name ( keys %$updates ) {
68 my $source = $self->result_source;
69 if ( $columns_by_accessor{$name}
70 && !( $source->has_relationship($name) && ref( $updates->{$name} ) )
73 $columns{$name} = $updates->{$name};
76 if( !( $source->has_relationship($name) ) ){
77 $other_methods{$name} = $updates->{$name};
80 my $info = $source->relationship_info($name);
82 _master_relation_cond
(
83 $source, $info->{cond
}, _get_pk_for_related
( $self, $name)
87 $pre_updates{$name} = $updates->{$name};
90 $post_updates{$name} = $updates->{$name};
93 # warn 'other: ' . Dumper( \%other_methods ); use Data::Dumper;
95 # first update columns and other accessors - so that later related records can be found
96 for my $name ( keys %columns ) {
97 $object->$name( $columns{$name} );
99 for my $name ( keys %other_methods) {
100 $object->$name( $updates->{$name} ) if $object->can( $name );
102 for my $name ( keys %pre_updates ) {
103 my $info = $object->result_source->relationship_info($name);
104 _update_relation
( $self, $name, $updates, $object, $info, $if_not_submitted );
106 # $self->_delete_empty_auto_increment($object);
107 # don't allow insert to recurse to related objects - we do the recursion ourselves
108 # $object->{_rel_in_storage} = 1;
110 $object->update_or_insert if $object->is_changed;
112 # updating many_to_many
113 for my $name ( keys %$updates ) {
114 next if exists $columns{$name};
115 my $value = $updates->{$name};
117 if ( is_m2m
( $self, $name) ) {
118 my ($pk) = _get_pk_for_related
( $self, $name);
120 my $result_source = $object->$name->result_source;
122 if( ! defined $value ){
126 @updates = @{ $value };
129 @updates = ( $value );
131 for my $elem ( @updates ) {
133 push @rows, recursive_update
( resultset
=> $result_source->resultset, updates
=> $elem );
137 $result_source->resultset->find( { $pk => $elem } );
140 my $set_meth = 'set_' . $name;
141 $object->$set_meth( \
@rows );
144 for my $name ( keys %post_updates ) {
145 my $info = $object->result_source->relationship_info($name);
146 _update_relation
( $self, $name, $updates, $object, $info, $if_not_submitted );
151 # returns DBIx::Class::ResultSource::column_info as a hash indexed by column accessor || name
152 sub _get_columns_by_accessor
{
154 my $source = $self->result_source;
156 for my $name ( $source->columns ) {
157 my $info = $source->column_info($name);
158 $info->{name
} = $name;
159 $columns{ $info->{accessor
} || $name } = $info;
164 sub _update_relation
{
165 my ( $self, $name, $updates, $object, $info, $if_not_submitted ) = @_;
167 $self->related_resultset($name)->result_source->resultset;
169 if( $self->result_source->can( '_resolve_condition' ) ){
170 $resolved = $self->result_source->_resolve_condition( $info->{cond
}, $name, $object );
173 $resolved = $self->result_source->resolve_condition( $info->{cond
}, $name, $object );
176 # warn 'resolved: ' . Dumper( $resolved ); use Data::Dumper;
178 if defined $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
&& $DBIx::Class
::ResultSource
::UNRESOLVABLE_CONDITION
== $resolved;
179 if ( ref $updates->{$name} eq 'ARRAY' ) {
181 for my $sub_updates ( @{ $updates->{$name} } ) {
183 recursive_update
( resultset
=> $related_result, updates
=> $sub_updates, resolved
=> $resolved );
184 push @updated_ids, $sub_object->id;
186 my @related_pks = $related_result->result_source->primary_columns;
187 if( defined $if_not_submitted && $if_not_submitted eq 'delete' ){
188 # only handles related result classes with single primary keys
189 if ( 1 == scalar @related_pks ){
190 $object->$name->search( { $related_pks[0] => { -not_in
=> \
@updated_ids } } )->delete;
193 elsif( defined $if_not_submitted && $if_not_submitted eq 'set_to_null' ){
194 # only handles related result classes with single primary keys
195 if ( 1 == scalar @related_pks ){
196 my @fk = keys %$resolved;
197 $object->$name->search( { $related_pks[0] => { -not_in
=> \
@updated_ids } } )->update( { $fk[0] => undef } );
202 my $sub_updates = $updates->{$name};
204 if( ref $sub_updates ){
205 # for might_have relationship
206 if( $info->{attrs
}{accessor
} eq 'single' && defined $object->$name ){
207 $sub_object = recursive_update
(
208 resultset
=> $related_result,
209 updates
=> $sub_updates,
210 object
=> $object->$name
215 recursive_update
( resultset
=> $related_result, updates
=> $sub_updates, resolved
=> $resolved );
218 elsif( ! ref $sub_updates ){
219 $sub_object = $related_result->find( $sub_updates )
220 unless (!$sub_updates && (exists $info->{attrs
}{join_type
} && $info->{attrs
}{join_type
} eq 'LEFT'));
222 $object->set_from_related( $name, $sub_object )
223 unless (!$sub_object && !$sub_updates && (exists $info->{attrs
}{join_type
} && $info->{attrs
}{join_type
} eq 'LEFT'));
228 my ( $self, $relation ) = @_;
229 my $rclass = $self->result_class;
231 # DBIx::Class::IntrospectableM2M
232 if ( $rclass->can('_m2m_metadata') ) {
233 return $rclass->_m2m_metadata->{$relation};
235 my $object = $self->new( {} );
236 if ( $object->can($relation)
237 and !$self->result_source->has_relationship($relation)
238 and $object->can( 'set_' . $relation ) )
246 my ( $self, $relation ) = @_;
247 my $rclass = $self->result_class;
249 # DBIx::Class::IntrospectableM2M
250 if ( $rclass->can('_m2m_metadata') ) {
251 return $self->result_source->related_source(
252 $rclass->_m2m_metadata->{$relation}{relation
} )
254 $rclass->_m2m_metadata->{$relation}{foreign_relation
} );
256 my $object = $self->new( {} );
257 my $r = $object->$relation;
258 return $r->result_source;
261 sub _delete_empty_auto_increment
{
262 my ( $self, $object ) = @_;
263 for my $col ( keys %{ $object->{_column_data
} } ) {
265 $object->result_source->column_info($col)->{is_auto_increment
}
266 and ( !defined $object->{_column_data
}{$col}
267 or $object->{_column_data
}{$col} eq '' )
270 delete $object->{_column_data
}{$col};
275 sub _get_pk_for_related
{
276 my ( $self, $relation ) = @_;
278 if ( $self->result_source->has_relationship($relation) ) {
279 $result_source = $self->result_source->related_source($relation);
283 if ( is_m2m
($self, $relation) ) {
284 $result_source = get_m2m_source
($self, $relation);
286 return $result_source->primary_columns;
289 # This function determines wheter a relationship should be done before or
290 # after the row is inserted into the database
291 # relationships before: belongs_to
292 # relationships after: has_many, might_have and has_one
293 sub _master_relation_cond
{
294 my ( $source, $cond, @foreign_ids ) = @_;
295 my $foreign_ids_re = join '|', @foreign_ids;
296 if ( ref $cond eq 'HASH' ) {
297 for my $f_key ( keys %{$cond} ) {
299 # might_have is not master
300 my $col = $cond->{$f_key};
302 if ( $source->column_info($col)->{is_auto_increment
} ) {
305 if ( $f_key =~ /^foreign\.$foreign_ids_re/ ) {
310 elsif ( ref $cond eq 'ARRAY' ) {
311 for my $new_cond (@$cond) {
313 if _master_relation_cond
( $source, $new_cond, @foreign_ids );
319 1; # Magic true value required at end of module
324 DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
328 The functional interface:
330 my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update({
331 resultset => $schema->resultset( 'Dvd' ),
336 title => 'One Flew Over the Cuckoo's Nest'
343 As ResultSet subclass:
345 __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
347 in the Schema file (see t/lib/DBSchema.pm). Or appriopriate 'use base' in the ResultSet classes.
351 my $user = $user_rs->recursive_update( {
355 title => 'One Flew Over the Cuckoo's Nest'
364 This is still experimental. I've added a functional interface so that it can be used
365 in Form Processors and not require modification of the model.
367 You can feed the ->create method with a recursive datastructure and have the related records
368 created. Unfortunately you cannot do a similar thing with update_or_create - this module
369 tries to fill that void.
371 It is a base class for ResultSets providing just one method: recursive_update
372 which works just like update_or_create but can recursively update or create
373 data objects composed of multiple rows. All rows need to be identified by primary keys
374 - so you need to provide them in the update structure (unless they can be deduced from
375 the parent row - for example when you have a belongs_to relationship).
376 If not all colums comprising the primary key are specified - then a new row will be created,
377 with the expectation that the missing columns will be filled by it (as in the case of auto_increment
381 If the resultset itself stores an assignement for the primary key,
384 my $restricted_rs = $user_rs->search( { id => 1 } );
386 then you need to inform recursive_update about additional predicate with a second argument:
388 my $user = $restricted_rs->recursive_update( {
391 title => 'One Flew Over the Cuckoo's Nest'
398 This will work with a new DBIC release.
400 For a many_to_many (pseudo) relation you can supply a list of primary keys
401 from the other table - and it will link the record at hand to those and
402 only those records identified by them. This is convenient for handling web
403 forms with check boxes (or a SELECT box with multiple choice) that let you
404 update such (pseudo) relations.
406 For a description how to set up base classes for ResultSets see load_namespaces
407 in DBIx::Class::Schema.
409 =head1 DESIGN CHOICES
411 Columns and relationships which are excluded from the updates hashref aren't
414 =head2 Treatment of belongs_to relations
416 In case the relationship is included but undefined in the updates hashref,
417 all columns forming the relationship will be set to null.
418 If not all of them are nullable, DBIx::Class will throw an error.
420 Updating the relationship:
422 my $dvd = $dvd_rs->recursive_update( {
427 Clearing the relationship (only works if cols are nullable!):
429 my $dvd = $dvd_rs->recursive_update( {
434 =head2 Treatment of might_have relationships
436 In case the relationship is included but undefined in the updates hashref,
437 all columns forming the relationship will be set to null.
439 Updating the relationship:
441 my $user = $user_rs->recursive_update( {
444 street => "101 Main Street",
450 Clearing the relationship:
452 my $user = $user_rs->recursive_update( {
457 =head2 Treatment of has_many relations
459 If a relationship key is included in the data structure with a value of undef
460 or an empty array, all existing related rows will be deleted, or their foreign
461 key columns will be set to null.
463 The exact behaviour depends on the nullability of the foreign key columns and
464 the value of the "if_not_submitted" parameter. The parameter defaults to
465 undefined which neither nullifies nor deletes.
467 When the array contains elements they are updated if they exist, created when
468 not and deleted if not included.
470 =head3 All foreign table columns are nullable
472 In this case recursive_update defaults to nullifying the foreign columns.
474 =head3 Not all foreign table columns are nullable
476 In this case recursive_update deletes the foreign rows.
478 Updating the relationship:
482 my $dvd = $dvd_rs->recursive_update( {
489 my $dvd = $dvd_rs->recursive_update( {
507 You can even mix them:
509 my $dvd = $dvd_rs->recursive_update( {
511 tags => [ '2', { id => '3' } ],
514 Clearing the relationship:
516 my $dvd = $dvd_rs->recursive_update( {
521 This is the same as passing an empty array:
523 my $dvd = $dvd_rs->recursive_update( {
528 =head2 Treatment of many-to-many pseudo relations
530 The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M.
531 If it is not loaded in the ResultSource classes - then the code relies on the fact that:
532 if($object->can($name) and
533 !$object->result_source->has_relationship($name) and
534 $object->can( 'set_' . $name )
537 then $name must be a many to many pseudo relation. And that in a
538 similarly ugly was I find out what is the ResultSource of objects from
539 that many to many pseudo relation.
546 =head2 recursive_update
548 The method that does the work here.
552 $self->is_m2m( 'name ' ) - answers the question if 'name' is a many to many
553 (pseudo) relation on $self.
555 =head2 get_m2m_source
557 $self->get_m2m_source( 'name' ) - returns the ResultSource linked to by the many
558 to many (pseudo) relation 'name' from $self.
564 =head1 CONFIGURATION AND ENVIRONMENT
566 DBIx::Class::RecursiveUpdate requires no configuration files or environment variables.
572 =head1 INCOMPATIBILITIES
577 =head1 BUGS AND LIMITATIONS
579 No bugs have been reported.
581 Please report any bugs or feature requests to
582 C<bug-dbix-class-recursiveput@rt.cpan.org>, or through the web interface at
583 L<http://rt.cpan.org>.
588 Zbigniew Lukasiak C<< <zby@cpan.org> >>
589 Influenced by code by Pedro Melo.
591 =head1 LICENCE AND COPYRIGHT
593 Copyright (c) 2008, Zbigniew Lukasiak C<< <zby@cpan.org> >>. All rights reserved.
595 This module is free software; you can redistribute it and/or
596 modify it under the same terms as Perl itself. See L<perlartistic>.
599 =head1 DISCLAIMER OF WARRANTY
601 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
602 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
603 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
604 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
605 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
606 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
607 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
608 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
609 NECESSARY SERVICING, REPAIR, OR CORRECTION.
611 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
612 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
613 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
614 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
615 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
616 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
617 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
618 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
619 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF