File Coverage

lib/Class/DBI/Lite/Iterator.pm

Criterion	Covered	Total	%
statement	17	17	100.0
branch	3	4	75.0
condition			n/a
subroutine	8	8	100.0
pod	3	6	50.0
total	31	35	88.5

package Class::DBI::Lite::Iterator;

use strict;
use warnings 'all';


sub new
{
  my ($class, $data) = @_;

  my $s = bless {
    data  => $data,
    count => scalar(@$data),
    idx   => 0
  }, $class;
  $s->init();

  return $s;
}# end new()


sub init { }


sub first
{
  return unless $_[0]->{data}->[0];
  $_[0]->{data}->[0];
}# end first()


sub next
{
  my $s = shift;
  return unless $s->{idx} < $s->{count};
  $s->{data}->[ $s->{idx}++ ];
}# end next()


sub count
{
  $_[0]->{count};
}# end count()


sub reset
{
  $_[0]->{idx} = 0;
}# end reset()

1;# return true:


=pod

=head1 NAME

Class::DBI::Lite::Iterator - Simple iterator for Class::DBI::Lite

=head1 SYNOPSIS

  # Get an iterator somehow:
  my $iter = app::artist->retrieve_all;

  my $artist = $iter->first;

  my $record_count = $iter->count;

  while( my $artist = $iter->next )
  {
    ...
  }# end while()

  # We can reset the iterator to go back to the beginning:
  $iter->reset;
  print $_->id . "\n" while $_ = $iter->next;

=head1 DESCRIPTION

Provides a simple iterator-based approach to Class::DBI::Lite resultsets.

=head1 PUBLIC PROPERTIES

=head2 count

Returns the number of records in the Iterator.

=head1 PUBLIC METHODS

=head2 next

Returns the next object in the series, or undef.

Moves the internal cursor to the next object if one exists.

=head2 reset

Resets the internal cursor to the first object if one exists.

=head1 SEE ALSO

L

=head1 AUTHOR

John Drago .

=head1 LICENSE AND COPYRIGHT

Copyright 2008 John Drago .  All rights reserved.

This software is Free software and may be used and distributed under the same
terms as perl itself.

=cut