X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FRelationship%2FBase.pm;h=e4d74888800a0d3e4f0d1a3c0fd6b3e3d3f66191;hb=701da8c4d6f0b78ffc015085aa410a6cacfcdb40;hp=aedfa5656eaf33a55dbc96e8fc30a365fee1449b;hpb=55e2d745a1887534cbcbfe351278d0883dce8ac5;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/Relationship/Base.pm b/lib/DBIx/Class/Relationship/Base.pm index aedfa56..e4d7488 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,181 +21,195 @@ on searches. =head1 METHODS +=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, + + { 'foreign.foo_id' => 'self.id' } + +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 -=cut +=item join_type -sub add_relationship { - my ($class, $rel, $f_class, $cond, $attrs) = @_; - die "Can't create relationship without join condition" unless $cond; - $attrs ||= {}; - eval "use $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 - my %join = (%$attrs, _action => 'join', - _aliases => { 'self' => 'me', 'foreign' => $rel }, - _classes => { 'me' => $class, $rel => $f_class }); - eval { $class->_cond_resolve($cond, \%join) }; - - 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; -} +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. -sub _cond_key { - my ($self, $attrs, $key) = @_; - 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; - } elsif ($action eq 'join') { - 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}; - 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); -} +=item proxy -sub _cond_value { - my ($self, $attrs, $key, $value) = @_; - my $action = $attrs->{_action} || ''; - if ($action eq 'convert') { - unless ($value =~ s/^self\.//) { - $self->throw( "Unable to convert relationship to WHERE clause: invalid value ${value}" ); - } - unless ($self->_columns->{$value}) { - $self->throw( "Unable to convert relationship to WHERE clause: no such accessor ${value}" ); - } - push(@{$attrs->{bind}}, $self->get_column($value)); - return '?'; - } elsif ($action eq 'join') { - my ($type, $field) = split(/\./, $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}; - 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_value($attrs, $key, $value) -} +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: -sub search_related { - my $self = shift; - return $self->_query_related('search', @_); -} + my $obj = Foo->find(1); + $obj->margle(10); # set margle; Bar object is created if it doesn't exist + +=item accessor -sub count_related { - my $self = shift; - return $self->_query_related('count', @_); -} +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 + +=head2 register_relationship($relname, $rel_info) + +Registers a relationship on the class + +=cut + +sub register_relationship { } + +=head2 search_related + + My::Table->search_related('relname', $cond, $attrs); -sub _query_related { +=cut + +sub search_related { my $self = shift; - my $meth = shift; + die "Can't call *_related as class methods" unless ref $self; my $rel = shift; my $attrs = { }; if (@_ > 1 && ref $_[$#_] eq 'HASH') { $attrs = { %{ pop(@_) } }; } - my $rel_obj = $self->_relationships->{$rel}; - $self->throw( "No such relationship ${rel}" ) unless $rel_obj; + my $rel_obj = $self->relationship_info($rel); + $self->throw_exception( "No such relationship ${rel}" ) unless $rel_obj; $attrs = { %{$rel_obj->{attrs} || {}}, %{$attrs || {}} }; - $self->throw( "Invalid query: @_" ) if (@_ > 1 && (@_ % 2 == 1)); + $self->throw_exception( "Invalid query: @_" ) if (@_ > 1 && (@_ % 2 == 1)); my $query = ((@_ > 1) ? {@_} : shift); - $attrs->{_action} = 'convert'; # shouldn't we resolve the cond to something - # to merge into the AST really? - my ($cond) = $self->_cond_resolve($rel_obj->{cond}, $attrs); - $query = ($query ? { '-and' => [ \$cond, $query ] } : \$cond); - #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); + my ($cond) = $self->result_source->resolve_condition($rel_obj->{cond}, $rel, $self); + $query = ($query ? { '-and' => [ $cond, $query ] } : $cond); + #use Data::Dumper; warn Dumper($cond); + #warn $rel_obj->{class}." $meth $cond ".join(', ', @{$attrs->{bind}||[]}); + return $self->result_source->related_source($rel + )->resultset->search($query, $attrs); +} + +=head2 count_related + + $obj->count_related('relname', $cond, $attrs); + +=cut + +sub count_related { + my $self = shift; + return $self->search_related(@_)->count; } +=head2 create_related + + My::Table->create_related('relname', \%col_data); + +=cut + sub create_related { - my $class = shift; - return $class->new_related(@_)->insert; + my $self = shift; + my $rel = shift; + return $self->search_related($rel)->create(@_); } +=head2 new_related + + My::Table->new_related('relname', \%col_data); + +=cut + 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 = %$values; - while (my ($k, $v) = each %{$rel_obj->{cond}}) { - $self->_cond_value($attrs, $k => $v); - $fields{$self->_cond_key($attrs, $k)} = (@{delete $attrs->{bind}})[0]; - } - return $self->resolve_class($rel_obj->{class})->new(\%fields); + return $self->search_related($rel)->new($values, $attrs); } +=head2 find_related + + My::Table->find_related('relname', @pri_vals | \%pri_vals); + +=cut + +sub find_related { + my $self = shift; + my $rel = shift; + return $self->search_related($rel)->find(@_); +} + +=head2 find_or_create_related + + My::Table->find_or_create_related('relname', \%col_data); + +=cut + sub find_or_create_related { my $self = shift; - return ($self->search_related(@_))[0] || $self->create_related(@_); + return $self->find_related(@_) || $self->create_related(@_); } +=head2 set_from_related + + My::Table->set_from_related('relname', $rel_obj); + +=cut + sub set_from_related { my ($self, $rel, $f_obj) = @_; - my $rel_obj = $self->_relationships->{$rel}; - $self->throw( "No such relationship ${rel}" ) unless $rel_obj; + my $rel_obj = $self->relationship_info($rel); + $self->throw_exception( "No such relationship ${rel}" ) unless $rel_obj; my $cond = $rel_obj->{cond}; - $self->throw( "set_from_related can only handle a hash condition; the " + $self->throw_exception( "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}); - $self->throw( "Object $f_obj isn't a ".$f_class ) + my $f_class = $self->result_source->schema->class($rel_obj->{class}); + $self->throw_exception( "Object $f_obj isn't a ".$f_class ) unless $f_obj->isa($f_class); foreach my $key (keys %$cond) { next if ref $cond->{$key}; # Skip literals and complex conditions - $self->throw("set_from_related can't handle $key as key") + $self->throw_exception("set_from_related can't handle $key as key") unless $key =~ m/^foreign\.([^\.]+)$/; my $val = $f_obj->get_column($1); - $self->throw("set_from_related can't handle ".$cond->{$key}." as value") + $self->throw_exception("set_from_related can't handle ".$cond->{$key}." as value") unless $cond->{$key} =~ m/^self\.([^\.]+)$/; $self->set_column($1 => $val); } return 1; } +=head2 update_from_related + + My::Table->update_from_related('relname', $rel_obj); + +=cut + sub update_from_related { my $self = shift; $self->set_from_related(@_); $self->update; } +=head2 delete_related + + My::Table->delete_related('relname', $cond, $attrs); + +=cut + sub delete_related { my $self = shift; return $self->search_related(@_)->delete; @@ -203,11 +217,9 @@ sub delete_related { 1; -=back - =head1 AUTHORS -Matt S. Trout +Matt S. Trout =head1 LICENSE