X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fp5-DBIx-Class-ResultSet-RecursiveUpdate;a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSet%2FRecursiveUpdate.pm;h=2d0c235ae5370a532b3add0ce8401ac6c0f70b39;hp=2d3efb8dfd19a60157ec56d86bc6876749384389;hb=d94f7e813dcc0fa5de6d46a0c9739fdba22b44cf;hpb=11512e7c3673e8467fd7a743a455defcf1f71c41 diff --git a/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm b/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm index 2d3efb8..2d0c235 100644 --- a/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm +++ b/lib/DBIx/Class/ResultSet/RecursiveUpdate.pm @@ -3,44 +3,63 @@ use warnings; package DBIx::Class::ResultSet::RecursiveUpdate; -our $VERSION = '0.013'; +# ABSTRACT: like update_or_create - but recursive use base qw(DBIx::Class::ResultSet); sub recursive_update { - my ( $self, $updates, $fixed_fields ) = @_; + my ( $self, $updates, $attrs ) = @_; + + my $fixed_fields; + my $unknown_params_ok; + + # 0.21+ api + if ( defined $attrs && ref $attrs eq 'HASH' ) { + $fixed_fields = $attrs->{fixed_fields}; + $unknown_params_ok = $attrs->{unknown_params_ok}; + } + + # pre 0.21 api + elsif ( defined $attrs && ref $attrs eq 'ARRAY' ) { + $fixed_fields = $attrs; + } + return DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update( - resultset => $self, - updates => $updates, - fixed_fields => $fixed_fields + resultset => $self, + updates => $updates, + fixed_fields => $fixed_fields, + unknown_params_ok => $unknown_params_ok, ); } package DBIx::Class::ResultSet::RecursiveUpdate::Functions; -use Carp; +use Carp::Clan qw/^DBIx::Class|^HTML::FormHandler|^Try::Tiny/; use Scalar::Util qw( blessed ); use List::MoreUtils qw/ any /; sub recursive_update { my %params = @_; my ( $self, $updates, $fixed_fields, $object, $resolved, - $if_not_submitted ) + $if_not_submitted, $unknown_params_ok ) = @params{ - qw/resultset updates fixed_fields object resolved if_not_submitted/}; + qw/resultset updates fixed_fields object resolved if_not_submitted unknown_params_ok/ + }; $resolved ||= {}; # warn 'entering: ' . $self->result_source->from(); carp 'fixed fields needs to be an array ref' - if $fixed_fields && ref($fixed_fields) ne 'ARRAY'; - my %fixed_fields; - %fixed_fields = map { $_ => 1 } @$fixed_fields if $fixed_fields; + if defined $fixed_fields && ref $fixed_fields ne 'ARRAY'; + if ( blessed($updates) && $updates->isa('DBIx::Class::Row') ) { return $updates; } if ( $updates->{id} ) { $object = $self->find( $updates->{id}, { key => 'primary' } ); } + + my %fixed_fields = map { $_ => 1 } @$fixed_fields + if $fixed_fields; my @missing = grep { !exists $updates->{$_} && !exists $fixed_fields{$_} } $self->result_source->primary_columns; @@ -123,11 +142,16 @@ sub recursive_update { } # unknown - # TODO: don't throw a warning instead of an exception to give users - # time to adapt to the new API - $self->throw_exception( + + # don't throw a warning instead of an exception to give users + # time to adapt to the new API + carp( "No such column, relationship, many-to-many helper accessor or generic accessor '$name'" - ); + ) unless $unknown_params_ok; + +#$self->throw_exception( +# "No such column, relationship, many-to-many helper accessor or generic accessor '$name'" +#); } # warn 'other: ' . Dumper( \%other_methods ); use Data::Dumper; @@ -257,7 +281,7 @@ sub _update_relation { map {s/^foreign\.//} @rel_cols; #warn "REL_COLS: " . Dumper(@rel_cols); use Data::Dumper; - my $rel_col_cnt = scalar @rel_cols; + #my $rel_col_cnt = scalar @rel_cols; # find out if all related columns are nullable my $all_fks_nullable = 1; @@ -299,7 +323,6 @@ sub _update_relation { #warn "\tcreated and updated related rows\n"; - my @cond; my @related_pks = $related_resultset->result_source->primary_columns; my $rs_rel_delist = $object->$name; @@ -315,6 +338,7 @@ sub _update_relation { # foreign table has multiple pk columns else { + my @cond; for my $obj (@updated_objs) { my %cond_for_obj; for my $col (@related_pks) { @@ -322,7 +346,12 @@ sub _update_relation { } push @cond, \%cond_for_obj; } - $rs_rel_delist = $rs_rel_delist->search_rs( { -not => [@cond] } ); + + # only limit resultset if there are related rows left + if ( scalar @cond ) { + $rs_rel_delist = + $rs_rel_delist->search_rs( { -not => [@cond] } ); + } } #warn "\tCOND: " . Dumper(\%cond); @@ -510,92 +539,112 @@ sub _master_relation_cond { 1; # Magic true value required at end of module __END__ -=head1 NAME - -DBIx::Class::ResultSet::RecursiveUpdate - like update_or_create - but recursive - =head1 SYNOPSIS -The functional interface: + # The functional interface: - my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update({ - resultset => $schema->resultset( 'Dvd' ), + my $schema = MyDB::Schema->connect(); + my $new_item = DBIx::Class::ResultSet::RecursiveUpdate::Functions::recursive_update( + resultset => $schema->resultset('User'), updates => { - id => 1, - owned_dvds => [ - { - title => 'One Flew Over the Cuckoo's Nest' - } - ] - } - }); + id => 1, + owned_dvds => [ + { + title => "One Flew Over the Cuckoo's Nest" + } + ] + }, + unknown_params_ok => 1, + ); -As ResultSet subclass: + # As ResultSet subclass: __PACKAGE__->load_namespaces( default_resultset_class => '+DBIx::Class::ResultSet::RecursiveUpdate' ); -in the Schema file (see t/lib/DBSchema.pm). Or appriopriate 'use base' in the ResultSet classes. + # in the Schema file (see t/lib/DBSchema.pm). Or appropriate 'use base' in the ResultSet classes. -Then: + my $user = $schema->resultset('User')->recursive_update({ + id => 1, + owned_dvds => [ + { + title => "One Flew Over the Cuckoo's Nest" + } + ] + }, { + unknown_params_ok => 1, + }); - my $user = $user_rs->recursive_update( { - id => 1, - owned_dvds => [ - { - title => 'One Flew Over the Cuckoo's Nest' - } - ] - } - ); + # You'll get a warning if you pass non-result specific data to + # recursive_update. See L + # for more information how to prevent this. - =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. +This is still experimental. -You can feed the ->create method with a recursive datastructure and have the related records -created. Unfortunately you cannot do a similar thing with update_or_create - this module -tries to fill that void. +You can feed the ->create method of DBIx::Class with a recursive datastructure +and have the related records created. Unfortunately you cannot do a similar +thing with update_or_create. This module tries to fill that void until +L has an api itself. -It is a base class for ResultSets providing just one method: recursive_update -which works just like update_or_create but can recursively update or create -data objects composed of multiple rows. All rows need to be identified by primary keys -- so you need to provide them in the update structure (unless they can be deduced from -the parent row - for example when you have a belongs_to relationship). -If not all colums comprising the primary key are specified - then a new row will be created, -with the expectation that the missing columns will be filled by it (as in the case of auto_increment -primary keys). +The functional interface can be used without modifications of the model, +for example by form processors like L. +It is a base class for Ls providing the method +recursive_update which works just like update_or_create but can recursively +update or create result objects composed of multiple rows. All rows need to be +identified by primary keys so you need to provide them in the update structure +(unless they can be deduced from the parent row. For example a related row of +a belongs_to relationship). If any of the primary key columns are missing, +a new row will be created, with the expectation that the missing columns will +be filled by it (as in the case of auto_increment primary keys). -If the resultset itself stores an assignement for the primary key, +If the resultset itself stores an assignment for the primary key, like in the case of: my $restricted_rs = $user_rs->search( { id => 1 } ); -then you need to inform recursive_update about additional predicate with a second argument: +you need to inform recursive_update about the additional predicate with the fixed_fields attribute: - my $user = $restricted_rs->recursive_update( { - owned_dvds => [ - { - title => 'One Flew Over the Cuckoo's Nest' - } - ] - }, - [ 'id' ] + my $user = $restricted_rs->recursive_update( { + owned_dvds => [ + { + title => 'One Flew Over the Cuckoo's Nest' + } + ] + }, + { + fixed_fields => [ 'id' ], + } ); -This will work with a new DBIC release. - For a many_to_many (pseudo) relation you can supply a list of primary keys -from the other table - and it will link the record at hand to those and -only those records identified by them. This is convenient for handling web -forms with check boxes (or a SELECT box with multiple choice) that let you +from the other table and it will link the record at hand to those and +only those records identified by them. This is convenient for handling web +forms with check boxes (or a select field with multiple choice) that lets you update such (pseudo) relations. -For a description how to set up base classes for ResultSets see load_namespaces -in DBIx::Class::Schema. +For a description how to set up base classes for ResultSets see +L. + +=head2 Additional data in the updates hashref + +If you pass additional data to recursive_update which doesn't match a column +name, column accessor, relationship or many-to-many helper accessor, it will +throw a warning by default. To disable this behaviour you can set the +unknown_params_ok attribute to a true value. + +The warning thrown is: +"No such column, relationship, many-to-many helper accessor or generic accessor '$key'" + +When used by L this can happen if you have +additional form fields that aren't relevant to the database but don't have the +noupdate attribute set to a true value. + +NOTE: in a future version this behaviour will change and throw an exception +instead of a warning! + =head1 DESIGN CHOICES @@ -666,6 +715,67 @@ In this case recursive_update defaults to nullifying the foreign columns. In this case recursive_update deletes the foreign rows. +Updating the relationship: + + Passing ids: + + my $user = $user_rs->recursive_update( { + id => 1, + owned_dvds => [1, 2], + }); + + Passing hashrefs: + + my $user = $user_rs->recursive_update( { + id => 1, + owned_dvds => [ + { + name => 'temp name 1', + }, + { + name => 'temp name 2', + }, + ], + }); + + Passing objects: + + my $user = $user_rs->recursive_update( { + id => 1, + owned_dvds => [ $dvd1, $dvd2 ], + }); + + You can even mix them: + + my $user = $user_rs->recursive_update( { + id => 1, + owned_dvds => [ 1, { id => 2 } ], + }); + +Clearing the relationship: + + my $user = $user_rs->recursive_update( { + id => 1, + owned_dvds => undef, + }); + + This is the same as passing an empty array: + + my $user = $user_rs->recursive_update( { + id => 1, + owned_dvds => [], + }); + +=head2 Treatment of many-to-many pseudo relations + +If a many-to-many accessor key is included in the data structure with a value +of undef or an empty array, all existing related rows are unlinked. + +When the array contains elements they are updated if they exist, created when +not and deleted if not included. + +See L for many-to-many pseudo relationship detection. + Updating the relationship: Passing ids: @@ -693,13 +803,16 @@ Updating the relationship: Passing objects: - TODO + my $dvd = $dvd_rs->recursive_update( { + id => 1, + tags => [ $tag1, $tag2 ], + }); You can even mix them: my $dvd = $dvd_rs->recursive_update( { id => 1, - tags => [ '2', { id => '3' } ], + tags => [ 2, { id => 3 } ], }); Clearing the relationship: @@ -716,20 +829,6 @@ Clearing the relationship: tags => [], }); -=head2 Treatment of many-to-many pseudo relations - -The function gets the information about m2m relations from DBIx::Class::IntrospectableM2M. -If it isn't loaded in the ResultSource classes the code relies on the fact that: - - if($object->can($name) and - !$object->result_source->has_relationship($name) and - $object->can( 'set_' . $name ) - ) - -Then $name must be a many to many pseudo relation. -And that in a similarly ugly was I find out what is the ResultSource of -objects from that many to many pseudo relation. - =head1 INTERFACE @@ -741,17 +840,39 @@ The method that does the work here. =head2 is_m2m -$self->is_m2m( 'name ' ) - answers the question if 'name' is a many to many -(pseudo) relation on $self. +=over 4 + +=item Arguments: $name + +=item Return Value: true, if $name is a many to many pseudo-relationship + +=back + +The function gets the information about m2m relations from +L. If it isn't loaded in the ResultSource +class, the code relies on the fact: + + if($object->can($name) and + !$object->result_source->has_relationship($name) and + $object->can( 'set_' . $name ) + ) + +to identify a many to many pseudo relationship. In a similar ugly way the +ResultSource of that many to many pseudo relationship is detected. + +So if you need many to many pseudo relationship support, it's strongly +recommended to load L in your ResultSource +class! =head2 get_m2m_source -$self->get_m2m_source( 'name' ) - returns the ResultSource linked to by the many -to many (pseudo) relation 'name' from $self. +=over 4 +=item Arguments: $name -=head1 DIAGNOSTICS +=item Return Value: $result_source +=back =head1 CONFIGURATION AND ENVIRONMENT @@ -761,6 +882,9 @@ DBIx::Class::RecursiveUpdate requires no configuration files or environment vari DBIx::Class +optional but recommended: + DBIx::Class::IntrospectableM2M + =head1 INCOMPATIBILITIES None reported. @@ -768,45 +892,8 @@ None reported. =head1 BUGS AND LIMITATIONS -No bugs have been reported. +The list of reported bugs can be viewed at L. Please report any bugs or feature requests to C, or through the web interface at L. - - -=head1 AUTHOR - -Zbigniew Lukasiak C<< >> -Influenced by code by Pedro Melo. - -=head1 LICENCE AND COPYRIGHT - -Copyright (c) 2008, Zbigniew Lukasiak C<< >>. All rights reserved. - -This module is free software; you can redistribute it and/or -modify it under the same terms as Perl itself. See L. - - -=head1 DISCLAIMER OF WARRANTY - -BECAUSE THIS SOFTWARE IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY -FOR THE SOFTWARE, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN -OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES -PROVIDE THE SOFTWARE "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER -EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE -ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE SOFTWARE IS WITH -YOU. SHOULD THE SOFTWARE PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL -NECESSARY SERVICING, REPAIR, OR CORRECTION. - -IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING -WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR -REDISTRIBUTE THE SOFTWARE AS PERMITTED BY THE ABOVE LICENCE, BE -LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL, -OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE -THE SOFTWARE (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA BEING -RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A -FAILURE OF THE SOFTWARE TO OPERATE WITH ANY OTHER SOFTWARE), EVEN IF -SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF -SUCH DAMAGES.