X-Git-Url: http://git.shadowcat.co.uk/gitweb/gitweb.cgi?a=blobdiff_plain;f=lib%2FDBIx%2FClass%2FCursor.pm;h=14816abed20c8554b1f7397b8bc7ad014d9e3f28;hb=64ae166780d0cb2b9577e506da9b9b240c146d20;hp=3cd5505d30aea72b4ba8300c432ee0781d984b00;hpb=223b8fe3185dba976b275c120ba7a07c05c06644;p=dbsrgits%2FDBIx-Class.git

diff --git a/lib/DBIx/Class/Cursor.pm b/lib/DBIx/Class/Cursor.pm
index 3cd5505..14816ab 100644
--- a/lib/DBIx/Class/Cursor.pm
+++ b/lib/DBIx/Class/Cursor.pm
@@ -3,45 +3,77 @@ package DBIx::Class::Cursor;
 use strict;
 use warnings;
 
+use base qw/DBIx::Class/;
+
+=head1 NAME
+
+DBIx::Class::Cursor - Abstract object representing a query cursor on a
+resultset.
+
+=head1 SYNOPSIS
+
+  my $cursor = $schema->resultset('CD')->cursor();
+  my $first_cd = $cursor->next;
+
+=head1 DESCRIPTION
+
+A Cursor represents a query cursor on a L<DBIx::Class::ResultSet> object. It
+allows for traversing the result set with L</next>, retrieving all results with
+L</all> and resetting the cursor with L</reset>.
+
+Usually, you would use the cursor methods built into L<DBIx::Class::ResultSet>
+to traverse it. See L<DBIx::Class::ResultSet/next>,
+L<DBIx::Class::ResultSet/reset> and L<DBIx::Class::ResultSet/all> for more
+information.
+
+=head1 METHODS
+
+=head2 new
+
+Virtual method. Returns a new L<DBIx::Class::Cursor> object.
+
+=cut
+
 sub new {
-  my ($it_class, $sth, $args, $attrs) = @_;
-  #use Data::Dumper; warn Dumper(@_);
-  $it_class = ref $it_class if ref $it_class;
-  my $new = {
-    sth => $sth,
-    args => $args,
-    pos => 0,
-    attrs => $attrs };
-  return bless ($new, $it_class);
+  die "Virtual method!";
 }
 
+=head2 next
+
+Virtual method. Advances the cursor to the next row. Returns an array of
+column values (the result of L<DBI/fetchrow_array> method).
+
+=cut
+
 sub next {
-  my ($self) = @_;
-  return if $self->{attrs}{rows}
-    && $self->{pos} >= $self->{attrs}{rows}; # + $self->{attrs}{offset});
-  unless ($self->{live_sth}) {
-    $self->{sth}->execute(@{$self->{args} || []});
-    if (my $offset = $self->{attrs}{offset}) {
-      $self->{sth}->fetch for 1 .. $offset;
-    }
-    $self->{live_sth} = 1;
-  }
-  my @row = $self->{sth}->fetchrow_array;
-  $self->{pos}++ if @row;
-  return @row;
+  die "Virtual method!";
 }
 
+=head2 reset
+
+Virtual method. Resets the cursor to the beginning.
+
+=cut
+
 sub reset {
-  my ($self) = @_;
-  $self->{sth}->finish if $self->{sth}->{Active};
-  $self->{pos} = 0;
-  $self->{live_sth} = 0;
-  return $self;
+  die "Virtual method!";
 }
 
-sub DESTROY {
+=head2 all
+
+Virtual method. Returns all rows in the L<DBIx::Class::ResultSet>.
+
+=cut
+
+sub all {
   my ($self) = @_;
-  $self->{sth}->finish if $self->{sth}->{Active};
+  $self->reset;
+  my @all;
+  while (my @row = $self->next) {
+    push(@all, \@row);
+  }
+  $self->reset;
+  return @all;
 }
 
 1;