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
=over 4
+=item 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 a JOIN clause like
+
+ foo me JOIN bar bar ON bar.foo_id = me.id
+
=cut
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;";
+ eval "require $f_class;";
+ if ($@) {
+ $class->throw($@) unless $@ =~ /Can't locate/;
+ }
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->resolve_condition($cond, \%join) };
+ return unless eval { $f_class->can('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}; #
1;
}
+sub _resolve_join {
+ my ($class, $join, $alias) = @_;
+ if (ref $join eq 'ARRAY') {
+ return map { $class->_resolve_join($_, $alias) } @$join;
+ } elsif (ref $join eq 'HASH') {
+ return map { $class->_resolve_join($_, $alias),
+ $class->_relationships->{$_}{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};
+ $class->throw("No such relationship ${join}") unless $rel_obj;
+ my $j_class = $rel_obj->{class};
+ my %join = (_action => 'join',
+ _aliases => { 'self' => $alias, 'foreign' => $join },
+ _classes => { $alias => $class, $join => $j_class });
+ my $j_cond = $j_class->resolve_condition($rel_obj->{cond}, \%join);
+ return [ { $join => $j_class->_table_name,
+ -join_type => $rel_obj->{attrs}{join_type} || '' }, $j_cond ];
+ }
+}
+
sub resolve_condition {
my ($self, $cond, $attrs) = @_;
if (ref $cond eq 'HASH') {
}
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 {
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);
} elsif ($action eq 'join') {
+ return $key unless $key =~ /\./;
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};
- my $ret = join('.', $alias, $field);
- # return { '=' => \$ret }; # SQL::Abstract doesn't handle this yet :(
- $ret = " = ${ret}";
- return \$ret;
+ 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_value($attrs, $key, $value)
+ return $self->next::method($attrs, $key, $value)
}
+=item search_related
+
+ My::Table->search_related('relname', $cond, $attrs);
+
+=cut
+
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', @_);
)->$meth($query, $attrs);
}
+=item create_related
+
+ My::Table->create_related('relname', \%col_data);
+
+=cut
+
sub create_related {
my $class = shift;
return $class->new_related(@_)->insert;
}
+=item 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" )
return $self->resolve_class($rel_obj->{class})->new(\%fields);
}
+=item find_related
+
+ My::Table->find_related('relname', @pri_vals | \%pri_vals);
+
+=cut
+
+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);
+}
+
+=item 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(@_);
}
+=item 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};
return 1;
}
+=item 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;
}
+=item delete_related
+
+ My::Table->delete_related('relname', $cond, $attrs);
+
+=cut
+
sub delete_related {
my $self = shift;
return $self->search_related(@_)->delete;
=head1 AUTHORS
-Matt S. Trout <perl-stuff@trout.me.uk>
+Matt S. Trout <mst@shadowcatsystems.co.uk>
=head1 LICENSE
projects / dbsrgits/DBIx-Class.git / blobdiff