X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FResultClass%2FHashRefInflator.pm;h=4d002abeeee030e9d03a3d840c38db1abdecde6b;hb=dac7972a0974db384637b7a8d9a661b08853b3cf;hp=fb35d13f91acdd8fdf0b039aca0597e9c38d8bb7;hpb=2328814a26b6ee181d9999ddf57fc16d862c6ccd;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/ResultClass/HashRefInflator.pm b/lib/DBIx/Class/ResultClass/HashRefInflator.pm
index fb35d13..4d002ab 100644
--- a/lib/DBIx/Class/ResultClass/HashRefInflator.pm
+++ b/lib/DBIx/Class/ResultClass/HashRefInflator.pm
@@ -3,26 +3,38 @@ package DBIx::Class::ResultClass::HashRefInflator;
 use strict;
 use warnings;
 
-our %inflator_cache;
-our $inflate_data;
-
 =head1 NAME
 
-DBIx::Class::ResultClass::HashRefInflator
+DBIx::Class::ResultClass::HashRefInflator - Get raw hashrefs from a resultset
 
 =head1 SYNOPSIS
 
- my $rs = $schema->resultset('CD');
+ use DBIx::Class::ResultClass::HashRefInflator;
 
+ my $rs = $schema->resultset('CD');
  $rs->result_class('DBIx::Class::ResultClass::HashRefInflator');
+ while (my $hashref = $rs->next) {
+   ...
+ }
+
+  OR as an attribute:
+
+ my $rs = $schema->resultset('CD')->search({}, {
+   result_class => 'DBIx::Class::ResultClass::HashRefInflator',
+ });
+ while (my $hashref = $rs->next) {
+   ...
+ }
 
 =head1 DESCRIPTION
 
-DBIx::Class is not built for speed: it's built for convenience and
-ease of use. But sometimes you just need to get the data, and skip the
-fancy objects. That is what this class provides.
+DBIx::Class is faster than older ORMs like Class::DBI but it still isn't
+designed primarily for speed. Sometimes you need to quickly retrieve the data
+from a massive resultset, while skipping the creation of fancy result objects.
+Specifying this class as a C<result_class> for a resultset will change C<< $rs->next >>
+to return a plain data hash-ref (or a list of such hash-refs if C<< $rs->all >> is used).
 
-There are two ways of using this class.
+There are two ways of applying this class to a resultset:
 
 =over
 
@@ -39,115 +51,64 @@ recommended.
 
 =back
 
-=head1 AUTOMATICALLY INFLATING COLUMN VALUES
-
-So you want to skip the DBIx::Class object creation part, but you still want 
-all your data to be inflated according to the rules you defined in your table
-classes. Setting the global variable 
-C<$DBIx::Class::ResultClass::HashRefInflator::inflate_data> to a true value
-will instruct L<mk_hash> to interrogate the processed columns and apply any
-inflation methods declared via L<DBIx::Class::InflateColumn/inflate_column>.
+=cut
 
-For increased speed the inflation method lookups are cached in 
-C<%DBIx::Class::ResultClass::HashRefInflator::inflator_cache>. Make sure to 
-reset this hash if you modify column inflators at run time.
+##############
+# NOTE
+#
+# Generally people use this to gain as much speed as possible. If a new &mk_hash is
+# implemented, it should be benchmarked using the maint/benchmark_hashrefinflator.pl
+# script (in addition to passing all tests of course :)
 
-=head1 METHODS
+# This coderef is a simple recursive function
+# Arguments: ($me, $prefetch, $is_root) from inflate_result() below
+my $mk_hash;
+$mk_hash = sub {
 
-=head2 inflate_result
+  my $hash = {
 
-Inflates the result and prefetched data into a hash-ref using L<mk_hash>.
+    # the main hash could be an undef if we are processing a skipped-over join
+    $_[0] ? %{$_[0]} : (),
 
-=cut
+    # the second arg is a hash of arrays for each prefetched relation
+    map { $_ => (
 
-sub inflate_result {
-    my ($self, $source, $me, $prefetch) = @_;
+      # null-branch or not
+      ref $_[1]->{$_} eq $DBIx::Class::ResultSource::RowParser::Util::null_branch_class
 
-    my $hashref = mk_hash($me, $prefetch);
-    inflate_hash ($source->schema, $source->result_class, $hashref) if $inflate_data;
-    return $hashref;
-}
+        ? ref $_[1]->{$_}[0] eq 'ARRAY' ? [] : undef
 
-=head2 mk_hash
+        : ref $_[1]->{$_}[0] eq 'ARRAY'
+          ? [ map { $mk_hash->( @$_ ) || () } @{$_[1]->{$_}} ]
+          : $mk_hash->( @{$_[1]->{$_}} )
 
-This does all the work of inflating the (pre)fetched data.
+    ) } ($_[1] ? keys %{$_[1]} : ())
+  };
 
-=cut
+  ($_[2] || keys %$hash) ? $hash : undef;
+};
 
-##############
-# NOTE
-#
-# Generally people use this to gain as much speed as possible. If a new mk_hash is
-# implemented, it should be benchmarked using the maint/benchmark_hashrefinflator.pl
-# script (in addition to passing all tests of course :). Additional instructions are 
-# provided in the script itself.
-#
-
-sub mk_hash { 
-    if (ref $_[0] eq 'ARRAY') {     # multi relationship
-        return [ map { mk_hash (@$_) || () } (@_) ];
-    }
-    else {
-        my $hash = {
-            # the main hash could be an undef if we are processing a skipped-over join
-            $_[0] ? %{$_[0]} : (),
-
-            # the second arg is a hash of arrays for each prefetched relation
-            map
-                { $_ => mk_hash( @{$_[1]->{$_}} ) }
-                ( $_[1] ? (keys %{$_[1]}) : () )
-        };
-
-        # if there is at least one defined column consider the resultset real
-        # (and not an emtpy has_many rel containing one empty hashref)
-        for (values %$hash) {
-            return $hash if defined $_;
-        }
-
-        return undef;
-    }
-}
+=head1 METHODS
 
-=head2 inflate_hash
+=head2 inflate_result
 
-This walks through a hashref produced by L<mk_hash> and inflates any data 
-for which there is a registered inflator in the C<column_info>
+Inflates the result and prefetched data into a hash-ref (invoked by L<DBIx::Class::ResultSet>)
 
 =cut
 
-sub inflate_hash {
-    my ($schema, $rc, $data) = @_;
-
-    foreach my $column (keys %{$data}) {
-
-        if (ref $data->{$column} eq 'HASH') {
-            inflate_hash ($schema, $schema->source ($rc)->related_class ($column), $data->{$column});
-        } 
-        elsif (ref $data->{$column} eq 'ARRAY') {
-            foreach my $rel (@{$data->{$column}}) {
-                inflate_hash ($schema, $schema->source ($rc)->related_class ($column), $rel);
-            }
-        }
-        else {
-            # "null is null is null"
-            next if not defined $data->{$column};
-
-            # cache the inflator coderef
-            unless (exists $inflator_cache{$rc}{$column}) {
-                $inflator_cache{$rc}{$column} = exists $schema->source ($rc)->_relationships->{$column}
-                    ? undef     # currently no way to inflate a column sharing a name with a rel 
-                    : $rc->column_info($column)->{_inflate_info}{inflate}
-                ;
-            }
-
-            if ($inflator_cache{$rc}{$column}) {
-                $data->{$column} = $inflator_cache{$rc}{$column}->($data->{$column});
-            }
-        }
-    }
+##################################################################################
+# inflate_result is invoked as:
+# HRI->inflate_result ($resultsource_instance, $main_data_hashref, $prefetch_data_hashref)
+sub inflate_result {
+  return $mk_hash->($_[2], $_[3], 'is_root');
 }
 
-=head1 CAVEAT
+
+=head1 CAVEATS
+
+=over
+
+=item *
 
 This will not work for relationships that have been prefetched. Consider the
 following:
@@ -156,12 +117,20 @@ following:
 
  my $cds = $artist->cds;
  $cds->result_class('DBIx::Class::ResultClass::HashRefInflator');
- my $first = $cds->first; 
+ my $first = $cds->first;
 
-C<$first> will B<not> be a hashref, it will be a normal CD row since 
+C<$first> will B<not> be a hashref, it will be a normal CD row since
 HashRefInflator only affects resultsets at inflation time, and prefetch causes
 relations to be inflated when the master C<$artist> row is inflated.
 
+=item *
+
+Column value inflation, e.g., using modules like
+L<DBIx::Class::InflateColumn::DateTime>, is not performed.
+The returned hash contains the raw database values.
+
+=back
+
 =cut
 
 1;