X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRelationship%2FBase.pm;h=9a979b8ae3e1ab651afef1069ca93b26a5fa5b3f;hb=8452e496;hp=7c84ace32b0c2527166aaaedd7529b45aa367945;hpb=fcafefc824f3bf50f256213efb123723c552c331;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index 7c84ace..9a979b8 100644 --- a/lib/DBIx/Class/Relationship/Base.pm +++ b/lib/DBIx/Class/Relationship/Base.pm @@ -3,13 +3,13 @@ package DBIx::Class::Relationship::Base; use strict; use warnings; -use base qw/Class::Data::Inheritable/; +use base qw/DBIx::Class/; __PACKAGE__->mk_classdata('_relationships', { } ); =head1 NAME -DBIx::Class::Relationship - Inter-table relationships +DBIx::Class::Relationship::Base - Inter-table relationships =head1 SYNOPSIS @@ -21,44 +21,66 @@ on searches. =head1 METHODS -=over 4 - -=item add_relationship +=head2 add_relationship __PACKAGE__->add_relationship('relname', 'Foreign::Class', $cond, $attrs); The condition needs to be an SQL::Abstract-style representation of the -join between the tables - for example if you're creating a rel from Foo to Bar +join between the tables. For example, if you're creating a rel from Foo to Bar, { 'foreign.foo_id' => 'self.id' } -will result in a JOIN clause like +will result in the JOIN clause foo me JOIN bar bar ON bar.foo_id = me.id +You can specify as many foreign => self mappings as necessary. + +Valid attributes are as follows: + +=over 4 + +=item join_type + +Explicitly specifies the type of join to use in the relationship. Any SQL +join type is valid, e.g. C or C. It will be placed in the SQL +command immediately before C. + +=item proxy + +An arrayref containing a list of accessors in the foreign class to proxy in +the main class. If, for example, you do the following: + + __PACKAGE__->might_have(bar => 'Bar', undef, { proxy => qw[/ margle /] }); + +Then, assuming Bar has an accessor named margle, you can do: + + my $obj = Foo->find(1); + $obj->margle(10); # set margle; Bar object is created if it doesn't exist + +=item accessor + +Specifies the type of accessor that should be created for the relationship. +Valid values are C (for when there is only a single related object), +C (when there can be many), and C (for when there is a single +related object, but you also want the relationship accessor to double as +a column accessor). For C accessors, an add_to_* method is also +created, which calls C for the relationship. + +=back + =cut sub add_relationship { - my ($class, $rel, $f_class, $cond, $attrs) = @_; - die "Can't create relationship without join condition" unless $cond; - $attrs ||= {}; - eval "require $f_class;"; - my %rels = %{ $class->_relationships }; - $rels{$rel} = { class => $f_class, - cond => $cond, - attrs => $attrs }; - $class->_relationships(\%rels); - #warn %{$f_class->_columns}; - - return unless eval { %{$f_class->_columns}; }; # Foreign class not loaded - eval { $class->_resolve_join($rel, 'me') }; - - if ($@) { # If the resolve failed, back out and re-throw the error - delete $rels{$rel}; # - $class->_relationships(\%rels); - $class->throw("Error creating relationship $rel: $@"); - } - 1; + shift->result_source->add_relationship(@_); +} + +sub relationships { + shift->result_source->relationships(@_); +} + +sub relationship_info { + shift->result_source->relationship_info(@_); } sub _resolve_join { @@ -67,12 +89,13 @@ sub _resolve_join { return map { $class->_resolve_join($_, $alias) } @$join; } elsif (ref $join eq 'HASH') { return map { $class->_resolve_join($_, $alias), - $class->_relationships->{$_}{class}->_resolve_join($join->{$_}, $_) } + $class->relationship_info($_)->{class}->_resolve_join($join->{$_}, $_) } keys %$join; } elsif (ref $join) { $class->throw("No idea how to resolve join reftype ".ref $join); } else { - my $rel_obj = $class->_relationships->{$join}; + my $rel_obj = $class->relationship_info($join); + #use Data::Dumper; warn Dumper($class->result_source) unless $rel_obj; $class->throw("No such relationship ${join}") unless $rel_obj; my $j_class = $rel_obj->{class}; my %join = (_action => 'join', @@ -104,27 +127,31 @@ sub resolve_condition { } sub _cond_key { - my ($self, $attrs, $key) = @_; + my ($self, $attrs, $key, $alias) = @_; my $action = $attrs->{_action} || ''; if ($action eq 'convert') { unless ($key =~ s/^foreign\.//) { $self->throw("Unable to convert relationship to WHERE clause: invalid key ${key}"); } - return $key; + if (defined (my $alias = $attrs->{_aliases}{foreign})) { + return "${alias}.${key}"; + } else { + return $key; + } } elsif ($action eq 'join') { return $key unless $key =~ /\./; my ($type, $field) = split(/\./, $key); if (my $alias = $attrs->{_aliases}{$type}) { my $class = $attrs->{_classes}{$alias}; $self->throw("Unknown column $field on $class as $alias") - unless exists $class->_columns->{$field}; + unless $class->has_column($field); return join('.', $alias, $field); } else { $self->throw( "Unable to resolve type ${type}: only have aliases for ". join(', ', keys %{$attrs->{_aliases} || {}}) ); } } - return $self->NEXT::ACTUAL::_cond_key($attrs, $key); + return $self->next::method($attrs, $key); } sub _cond_value { @@ -134,7 +161,7 @@ sub _cond_value { unless ($value =~ s/^self\.//) { $self->throw( "Unable to convert relationship to WHERE clause: invalid value ${value}" ); } - unless ($self->_columns->{$value}) { + unless ($self->has_column($value)) { $self->throw( "Unable to convert relationship to WHERE clause: no such accessor ${value}" ); } return $self->get_column($value); @@ -144,7 +171,7 @@ sub _cond_value { if (my $alias = $attrs->{_aliases}{$type}) { my $class = $attrs->{_classes}{$alias}; $self->throw("Unknown column $field on $class as $alias") - unless exists $class->_columns->{$field}; + unless $class->has_column($field); return join('.', $alias, $field); } else { $self->throw( "Unable to resolve type ${type}: only have aliases for ". @@ -152,10 +179,10 @@ sub _cond_value { } } - return $self->NEXT::ACTUAL::_cond_value($attrs, $key, $value) + return $self->next::method($attrs, $key, $value) } -=item search_related +=head2 search_related My::Table->search_related('relname', $cond, $attrs); @@ -163,29 +190,12 @@ sub _cond_value { sub search_related { my $self = shift; - return $self->_query_related('search', @_); -} - -=item count_related - - My::Table->count_related('relname', $cond, $attrs); - -=cut - -sub count_related { - my $self = shift; - return $self->_query_related('count', @_); -} - -sub _query_related { - my $self = shift; - my $meth = shift; my $rel = shift; my $attrs = { }; if (@_ > 1 && ref $_[$#_] eq 'HASH') { $attrs = { %{ pop(@_) } }; } - my $rel_obj = $self->_relationships->{$rel}; + my $rel_obj = $self->relationship_info($rel); $self->throw( "No such relationship ${rel}" ) unless $rel_obj; $attrs = { %{$rel_obj->{attrs} || {}}, %{$attrs || {}} }; @@ -199,11 +209,22 @@ sub _query_related { #use Data::Dumper; warn Dumper($query); #warn $rel_obj->{class}." $meth $cond ".join(', ', @{$attrs->{bind}||[]}); delete $attrs->{_action}; - return $self->resolve_class($rel_obj->{class} - )->$meth($query, $attrs); + return $self->result_source->schema->resultset($rel_obj->{class} + )->search($query, $attrs); +} + +=head2 count_related + + My::Table->count_related('relname', $cond, $attrs); + +=cut + +sub count_related { + my $self = shift; + return $self->search_related(@_)->count; } -=item create_related +=head2 create_related My::Table->create_related('relname', \%col_data); @@ -211,10 +232,11 @@ sub _query_related { sub create_related { my $class = shift; - return $class->new_related(@_)->insert; + my $rel = shift; + return $class->search_related($rel)->create(@_); } -=item new_related +=head2 new_related My::Table->new_related('relname', \%col_data); @@ -222,23 +244,10 @@ sub create_related { sub new_related { my ($self, $rel, $values, $attrs) = @_; - $self->throw( "Can't call new_related as class method" ) - unless ref $self; - $self->throw( "new_related needs a hash" ) - unless (ref $values eq 'HASH'); - my $rel_obj = $self->_relationships->{$rel}; - $self->throw( "No such relationship ${rel}" ) unless $rel_obj; - $self->throw( "Can't abstract implicit create for ${rel}, condition not a hash" ) - unless ref $rel_obj->{cond} eq 'HASH'; - $attrs = { %{$rel_obj->{attrs}}, %{$attrs || {}}, _action => 'convert' }; - - my %fields = %{$self->resolve_condition($rel_obj->{cond},$attrs)}; - $fields{$_} = $values->{$_} for keys %$values; - - return $self->resolve_class($rel_obj->{class})->new(\%fields); + return $self->search_related($rel)->new($values, $attrs); } -=item find_related +=head2 find_related My::Table->find_related('relname', @pri_vals | \%pri_vals); @@ -247,20 +256,10 @@ sub new_related { sub find_related { my $self = shift; my $rel = shift; - my $rel_obj = $self->_relationships->{$rel}; - $self->throw( "No such relationship ${rel}" ) unless $rel_obj; - my ($cond) = $self->resolve_condition($rel_obj->{cond}, { _action => 'convert' }); - $self->throw( "Invalid query: @_" ) if (@_ > 1 && (@_ % 2 == 1)); - my $attrs = { }; - if (@_ > 1 && ref $_[$#_] eq 'HASH') { - $attrs = { %{ pop(@_) } }; - } - my $query = ((@_ > 1) ? {@_} : shift); - $query = ($query ? { '-and' => [ $cond, $query ] } : $cond); - return $self->resolve_class($rel_obj->{class})->find($query); + return $self->search_related($rel)->find(@_); } -=item find_or_create_related +=head2 find_or_create_related My::Table->find_or_create_related('relname', \%col_data); @@ -271,7 +270,7 @@ sub find_or_create_related { return $self->find_related(@_) || $self->create_related(@_); } -=item set_from_related +=head2 set_from_related My::Table->set_from_related('relname', $rel_obj); @@ -279,13 +278,13 @@ sub find_or_create_related { sub set_from_related { my ($self, $rel, $f_obj) = @_; - my $rel_obj = $self->_relationships->{$rel}; + my $rel_obj = $self->relationship_info($rel); $self->throw( "No such relationship ${rel}" ) unless $rel_obj; my $cond = $rel_obj->{cond}; $self->throw( "set_from_related can only handle a hash condition; the " ."condition for $rel is of type ".(ref $cond ? ref $cond : 'plain scalar')) unless ref $cond eq 'HASH'; - my $f_class = $self->resolve_class($rel_obj->{class}); + my $f_class = $self->result_source->schema->class($rel_obj->{class}); $self->throw( "Object $f_obj isn't a ".$f_class ) unless $f_obj->isa($f_class); foreach my $key (keys %$cond) { @@ -300,7 +299,7 @@ sub set_from_related { return 1; } -=item update_from_related +=head2 update_from_related My::Table->update_from_related('relname', $rel_obj); @@ -312,7 +311,7 @@ sub update_from_related { $self->update; } -=item delete_related +=head2 delete_related My::Table->delete_related('relname', $cond, $attrs); @@ -325,8 +324,6 @@ sub delete_related { 1; -=back - =head1 AUTHORS Matt S. Trout