0.06000 changes

[dbsrgits/DBIx-Class.git] / lib / DBIx / Class / Storage / DBI / Cursor.pm

diff --git a/lib/DBIx/Class/Storage/DBI/Cursor.pm b/lib/DBIx/Class/Storage/DBI/Cursor.pm
index 5334589..2550adc 100644 (file)
--- a/lib/DBIx/Class/Storage/DBI/Cursor.pm
+++ b/lib/DBIx/Class/Storage/DBI/Cursor.pm
@@ -1,11 +1,39 @@
-package # hide from PAUSE 
-    DBIx::Class::Storage::DBI::Cursor;
+package DBIx::Class::Storage::DBI::Cursor;
 
 use base qw/DBIx::Class::Cursor/;
 
 use strict;
 use warnings;
 
+=head1 NAME
+
+DBIx::Class::Storage::DBI::Cursor - 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
+
+Returns a new L<DBIx::Class::Storage::DBI::Cursor> object.
+
+=cut
+
 sub new {
   my ($class, $storage, $args, $attrs) = @_;
   #use Data::Dumper; warn Dumper(@_);
@@ -23,6 +51,20 @@ sub new {
   return bless ($new, $class);
 }
 
+=head2 next
+
+=over 4
+
+=item Arguments: none
+
+=item Return Value: \@row_columns
+
+=back
+
+Advances the cursor to the next row and returns an arrayref of column values.
+
+=cut
+
 sub next {
   my ($self) = @_;
 
@@ -51,6 +93,21 @@ sub next {
   return @row;
 }
 
+=head2 all
+
+=over 4
+
+=item Arguments: none
+
+=item Return Value: \@row_columns+
+
+=back
+
+Returns a list of arrayrefs of column values for all rows in the
+L<DBIx::Class::ResultSet>.
+
+=cut
+
 sub all {
   my ($self) = @_;
 
@@ -62,6 +119,12 @@ sub all {
   return @{$sth->fetchall_arrayref};
 }
 
+=head2 reset
+
+Resets the cursor to the beginning of the L<DBIx::Class::ResultSet>.
+
+=cut
+
 sub reset {
   my ($self) = @_;