1 package DBIx
::Class
::ResultSet
::RecursiveUpdate
;
3 use version
; $VERSION = qv
('0.001');
9 use base
qw(DBIx::Class::ResultSet);
11 sub recursive_update
{
12 my( $self, $updates ) = @_;
14 $object = $self->find( $updates, { key
=> 'primary' } ) || $self->new( {} );
16 for my $name ( keys %$updates ){
17 if($object->can($name)){
18 my $value = $updates->{$name};
20 # updating relations that that should be done before the row is inserted into the database
22 if( $object->result_source->has_relationship($name)
26 my $info = $object->result_source->relationship_info( $name );
27 if( $info and not $info->{attrs
}{accessor
} eq 'multi'
29 _master_relation_cond
( $object, $info->{cond
}, $self->_get_pk_for_related( $name ) )
31 my $related_result = $object->related_resultset( $name );
32 my $sub_object = $related_result->recursive_update( $value );
33 $object->set_from_related( $name, $sub_object );
36 # columns and other accessors
37 elsif( $object->result_source->has_column($name)
39 !$object->can( 'set_' . $name )
41 $object->$name($value);
44 #warn Dumper($object->{_column_data}); use Data::Dumper;
46 $self->_delete_empty_auto_increment($object);
47 # don't allow insert to recurse to related objects - we do the recursion ourselves
48 $object->{_rel_in_storage
} = 1;
49 $object->update_or_insert;
51 # updating relations that can be done only after the row is inserted into the database
52 # like has_many and many_to_many
53 for my $name ( keys %$updates ){
54 my $value = $updates->{$name};
56 if( $self->is_m2m( $name ) ) {
57 my ( $pk ) = $self->_get_pk_for_related( $name );
59 my $result_source = $object->$name->result_source;
60 for my $elem ( @{$updates->{$name}} ){
62 push @rows, $result_source->resultset->find( $elem );
65 push @rows, $result_source->resultset->find( { $pk => $elem } );
68 my $set_meth = 'set_' . $name;
69 $object->$set_meth( \
@rows );
71 elsif( $object->result_source->has_relationship($name) ){
72 my $info = $object->result_source->relationship_info( $name );
74 if( ref $updates->{$name} eq 'ARRAY' ){
75 for my $sub_updates ( @{$updates->{$name}} ) {
76 my $sub_object = $object->search_related( $name )->recursive_update( $sub_updates );
79 # might_have and has_one case
80 elsif ( ! _master_relation_cond
( $object, $info->{cond
}, $self->_get_pk_for_related( $name ) ) ){
81 my $sub_object = $object->search_related( $name )->recursive_update( $value );
82 #$object->set_from_related( $name, $sub_object );
90 my( $self, $relation ) = @_;
91 my $object = $self->new({});
92 if ( $object->can($relation) and
93 !$object->result_source->has_relationship($relation) and
94 $object->can( 'set_' . $relation)
102 my( $self, $relation ) = @_;
103 my $object = $self->new({});
104 my $r = $object->$relation;
105 return $r->result_source;
109 sub _delete_empty_auto_increment
{
110 my ( $self, $object ) = @_;
111 for my $col ( keys %{$object->{_column_data
}}){
112 if( $object->result_source->column_info( $col )->{is_auto_increment
}
114 ( ! defined $object->{_column_data
}{$col} or $object->{_column_data
}{$col} eq '' )
116 delete $object->{_column_data
}{$col}
121 sub _get_pk_for_related
{
122 my ( $self, $relation ) = @_;
125 if( $self->result_source->has_relationship( $relation ) ){
126 $result_source = $self->result_source->related_source( $relation );
129 if ( $self->is_m2m( $relation ) ) {
130 $result_source = $self->get_m2m_source( $relation );
132 return $result_source->primary_columns;
135 sub _master_relation_cond
{
136 my ( $object, $cond, @foreign_ids ) = @_;
137 my $foreign_ids_re = join '|', @foreign_ids;
138 if ( ref $cond eq 'HASH' ){
139 for my $f_key ( keys %{$cond} ) {
140 # might_have is not master
141 my $col = $cond->{$f_key};
143 if( $object->column_info( $col )->{is_auto_increment
} ){
146 if( $f_key =~ /^foreign\.$foreign_ids_re/ ){
150 }elsif ( ref $cond eq 'ARRAY' ){
151 for my $new_cond ( @$cond ) {
152 return 1 if _master_relation_cond
( $object, $new_cond, @foreign_ids );
158 # Module implementation here
161 1; # Magic true value required at end of module
166 DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive
171 This document describes DBIx::Class::ResultSet::RecursiveUpdate version 0.001
176 __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' );
178 in the Schema file (see t/lib/DBSchema.pm). Or appriopriate 'use base' in the ResultSet classes.
182 my $user = $user_rs->recursive_update( {
187 title => 'One Flew Over the Cuckoo's Nest'
196 You can feed the ->create method with a recursive datastructure and have the related records
197 created. Unfortunately you cannot do a similar thing with update_or_create - this module
198 tries to fill that void.
200 It is a base class for ResultSets providing just one method: recursive_update
201 which works just like update_or_create but can recursively update or create
202 data objects composed of multiple rows. All rows need to be identified by primary keys
203 - so you need to provide them in the update structure (unless they can be deduced from
204 the parent row - for example when you have a belongs_to relationship).
205 When creating new rows in a table with auto_increment primary keys you need to
206 put 'undef' for the key value - this is then removed
207 and a correct INSERT statement is generated.
209 For a many_to_many (pseudo) relation you can supply a list of primary keys
210 from the other table - and it will link the record at hand to those and
211 only those records identified by them. This is convenient for handling web
212 forms with check boxes (or a SELECT box with multiple choice) that let you
213 update such (pseudo) relations.
215 For a description how to set up base classes for ResultSets see load_namespaces
216 in DBIx::Class::Schema.
218 =head1 DESIGN CHOICES
220 =head2 Treatment of many to many pseudo relations
222 Matt Trout expressed following criticism of the support for many to many in
223 RecursiveUpdate and since this is an extension of his DBIx::Class I feel obliged to
224 reply to it. It is about two points leading in his opinion to 'fragile and
225 implicitely broken code'.
227 1. That I rely on the fact that
229 if($object->can($name) and
230 !$object->result_source->has_relationship($name) and
231 $object->can( 'set_' . $name )
234 then $name must be a many to many pseudo relation. And that in a
235 similarly ugly was I find out what is the ResultSource of objects from
236 that many to many pseudo relation.
238 2. That I treat uniformly relations and many to many (which are
239 different from relations because they require traversal of the bridge
242 To answer 1) I've refactored that 'dirty' code into is_m2m and get_m2m_source so
243 that it can be easily overridden. I agree that this code is not too nice - but
244 currenlty it is the only way to do what I need - and I'll replace it as soon as
245 there is a more clean way. I don't think it is extremely brittle - sure it will
246 break if many to many (pseudo) relations don't get 'set_*' methods anymore - but
247 I would say it is rather justified for this kind of change in underlying library
251 Ad 2) - first this is not strictly true - RecursiveUpdate does have
252 different code to cope with m2m and other cases (see the point above for
253 example) - but it let's the user to treat m2m and 'normal' relations in a
254 uniform way. I consider this a form of abstraction - it is the work that
255 RecursiveUpdate does for the programmer.
262 =head2 recursive_update
264 The method that does the work here.
268 $self->is_m2m( 'name ' ) - answers the question if 'name' is a many to many
269 (pseudo) relation on $self.
271 =head2 get_m2m_source
273 $self->get_m2m_source( 'name' ) - returns the ResultSource linked to by the many
274 to many (pseudo) relation 'name' from $self.
280 =head1 CONFIGURATION AND ENVIRONMENT
282 DBIx::Class::RecursiveUpdate requires no configuration files or environment variables.
288 =head1 INCOMPATIBILITIES
290 =for author to fill in:
295 =head1 BUGS AND LIMITATIONS
297 =for author to fill in:
299 No bugs have been reported.
301 Please report any bugs or feature requests to
302 C<bug-dbix-class-recursiveput@rt.cpan.org>, or through the web interface at
303 L<http://rt.cpan.org>.
308 Zbigniew Lukasiak C<< <zby@cpan.org> >>
309 Influenced by code by Pedro Melo.
311 =head1 LICENCE AND COPYRIGHT
313 Copyright (c) 2008, Zbigniew Lukasiak C<< <zby@cpan.org> >>. All rights reserved.
315 This module is free software; you can redistribute it and/or
316 modify it under the same terms as Perl itself. See L<perlartistic>.
319 =head1 DISCLAIMER OF WARRANTY
321 BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
322 FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
323 OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
324 PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER
325 EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
326 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE
327 ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH
328 YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL
329 NECESSARY SERVICING, REPAIR, OR CORRECTION.
331 IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
332 WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
333 REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE
334 LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL,
335 OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
336 THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING
337 RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A
338 FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF
339 SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF