use strict;
use warnings;
-use overload
- '0+' => 'count',
- fallback => 1;
+
+=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, $db_class, $sth, $args, $cols) = @_;
- $sth->execute(@{$args || []}) unless $sth->{Active};
- my $new = {
- class => $db_class,
- sth => $sth,
- cols => $cols,
- args => $args };
- return bless ($new, $it_class);
+ die "Virtual method!";
}
+=head2 next
+
+Virtual method. Advances the cursor to the next row.
+
+=cut
+
sub next {
- my ($self) = @_;
- my @row = $self->{sth}->fetchrow_array;
- return unless @row;
- #unless (@row) { $self->{sth}->finish; return; }
- return $self->{class}->_row_to_object($self->{cols}, \@row);
+ die "Virtual method!";
}
-sub count {
- return scalar $_[0]->all; # So inefficient
+=head2 reset
+
+Virtual method. Resets the cursor to the beginning.
+
+=cut
+
+sub reset {
+ die "Virtual method!";
}
+=head2 all
+
+Virtual method. Returns all rows in the L<DBIx::Class::ResultSet>.
+
+=cut
+
sub all {
my ($self) = @_;
$self->reset;
my @all;
- while (my $obj = $self->next) {
- push(@all, $obj);
+ while (my @row = $self->next) {
+ push(@all, \@row);
}
$self->reset;
return @all;
}
-sub reset {
- $_[0]->{sth}->finish if $_[0]->{sth}->{Active};
- $_[0]->{sth}->execute(@{$_[0]->{args} || []});
- return $_[0];
-}
-
-sub first {
- return $_[0]->reset->next;
-}
-
1;