X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultSetColumn.pm;h=596df7c1d89c3709e46a4aeb7d4236bcc1b28b2f;hb=121068ec48336496a7ba216517c8caff27ceb99a;hp=68cc4e0c795f8c765a5e9135da4ef67c7e2bd347;hpb=5d62876f5fe86bc1b3a11a571074164bcce27e7b;p=dbsrgits%2FDBIx-Class.git diff --git a/lib/DBIx/Class/ResultSetColumn.pm b/lib/DBIx/Class/ResultSetColumn.pm index 68cc4e0..596df7c 100644 --- a/lib/DBIx/Class/ResultSetColumn.pm +++ b/lib/DBIx/Class/ResultSetColumn.pm @@ -2,6 +2,7 @@ package DBIx::Class::ResultSetColumn; use strict; use warnings; use base 'DBIx::Class'; +use List::Util; =head1 NAME @@ -36,12 +37,43 @@ sub new { my ($class, $rs, $column) = @_; $class = ref $class if ref $class; my $new_parent_rs = $rs->search_rs; # we don't want to mess up the original, so clone it - $new_parent_rs->{attrs}->{prefetch} = undef; # prefetch causes additional columns to be fetched - my $new = bless { _column => $column, _parent_resultset => $new_parent_rs }, $class; + my $attrs = $new_parent_rs->_resolved_attrs; + $new_parent_rs->{attrs}->{prefetch} = undef; # prefetch cause additional columns to be fetched + + # If $column can be found in the 'as' list of the parent resultset, use the + # corresponding element of its 'select' list (to keep any custom column + # definition set up with 'select' or '+select' attrs), otherwise use $column + # (to create a new column definition on-the-fly). + my $as_list = $attrs->{as} || []; + my $select_list = $attrs->{select} || []; + my $as_index = List::Util::first { ($as_list->[$_] || "") eq $column } 0..$#$as_list; + my $select = defined $as_index ? $select_list->[$as_index] : $column; + + my $new = bless { _select => $select, _as => $column, _parent_resultset => $new_parent_rs }, $class; $new->throw_exception("column must be supplied") unless $column; return $new; } +=head2 as_query (EXPERIMENTAL) + +=over 4 + +=item Arguments: none + +=item Return Value: \[ $sql, @bind ] + +=back + +Returns the SQL query and bind vars associated with the invocant. + +This is generally used as the RHS for a subquery. + +B: This feature is still experimental. + +=cut + +sub as_query { return shift->_resultset->as_query } + =head2 next =over 4 @@ -62,8 +94,7 @@ one value. sub next { my $self = shift; - $self->{_resultset} = $self->{_parent_resultset}->search(undef, {select => [$self->{_column}], as => [$self->{_column}]}) unless ($self->{_resultset}); - my ($row) = $self->{_resultset}->cursor->next; + my ($row) = $self->_resultset->cursor->next; return $row; } @@ -87,7 +118,53 @@ than row objects. sub all { my $self = shift; - return map {$_->[0]} $self->{_parent_resultset}->search(undef, {select => [$self->{_column}], as => [$self->{_column}]})->cursor->all; + return map { $_->[0] } $self->_resultset->cursor->all; +} + +=head2 reset + +=over 4 + +=item Arguments: none + +=item Return Value: $self + +=back + +Resets the underlying resultset's cursor, so you can iterate through the +elements of the column again. + +Much like L. + +=cut + +sub reset { + my $self = shift; + $self->_resultset->cursor->reset; + return $self; +} + +=head2 first + +=over 4 + +=item Arguments: none + +=item Return Value: $value + +=back + +Resets the underlying resultset and returns the next value of the column in the +resultset (or C if there is none). + +Much like L but just returning the one value. + +=cut + +sub first { + my $self = shift; + my ($row) = $self->_resultset->cursor->reset->next; + return $row; } =head2 min @@ -111,6 +188,24 @@ sub min { return shift->func('MIN'); } +=head2 min_rs + +=over 4 + +=item Arguments: none + +=item Return Value: $resultset + +=back + + my $rs = $year_col->min_rs(); + +Wrapper for ->func_rs for function MIN(). + +=cut + +sub min_rs { return shift->func_rs('MIN') } + =head2 max =over 4 @@ -132,6 +227,24 @@ sub max { return shift->func('MAX'); } +=head2 max_rs + +=over 4 + +=item Arguments: none + +=item Return Value: $resultset + +=back + + my $rs = $year_col->max_rs(); + +Wrapper for ->func_rs for function MAX(). + +=cut + +sub max_rs { return shift->func_rs('MAX') } + =head2 sum =over 4 @@ -153,6 +266,24 @@ sub sum { return shift->func('SUM'); } +=head2 sum_rs + +=over 4 + +=item Arguments: none + +=item Return Value: $resultset + +=back + + my $rs = $year_col->sum_rs(); + +Wrapper for ->func_rs for function SUM(). + +=cut + +sub sum_rs { return shift->func_rs('SUM') } + =head2 func =over 4 @@ -175,7 +306,7 @@ value. Produces the following SQL: sub func { my ($self,$function) = @_; - my $cursor = $self->{_parent_resultset}->search(undef, {select => {$function => $self->{_column}}, as => [$self->{_column}]})->cursor; + my $cursor = $self->func_rs($function)->cursor; if( wantarray ) { return map { $_->[ 0 ] } $cursor->all; @@ -184,6 +315,67 @@ sub func { return ( $cursor->next )[ 0 ]; } +=head2 func_rs + +=over 4 + +=item Arguments: $function + +=item Return Value: $resultset + +=back + +Creates the resultset that C uses to run its query. + +=cut + +sub func_rs { + my ($self,$function) = @_; + return $self->{_parent_resultset}->search( + undef, { + select => {$function => $self->{_select}}, + as => [$self->{_as}], + }, + ); +} + +=head2 throw_exception + +See L for details. + +=cut + +sub throw_exception { + my $self=shift; + if (ref $self && $self->{_parent_resultset}) { + $self->{_parent_resultset}->throw_exception(@_) + } else { + croak(@_); + } +} + +# _resultset +# +# Arguments: none +# +# Return Value: $resultset +# +# $year_col->_resultset->next +# +# Returns the underlying resultset. Creates it from the parent resultset if +# necessary. +# +sub _resultset { + my $self = shift; + + return $self->{_resultset} ||= $self->{_parent_resultset}->search(undef, + { + select => [$self->{_select}], + as => [$self->{_as}] + } + ); +} + 1; =head1 AUTHORS