Fey::ORM::Role::Iterator(3)

NAME
Fey::ORM::Role::Iterator - A role for things that iterate over Fey::Object::Table objects

VERSION
version 0.47

SYNOPSIS
  package My::Iterator;

  use Moose;

  with 'Fey::ORM::Role::Iterator';

DESCRIPTION
This role provides some common methods used by "Fey::Object::Iterator" classes, as well as defining a consistent interface for iterators.

REQUIRED METHODS
Classes which consume this role must provide "_get_next_result()" and "reset()" methods.

PROVIDED ATTRIBUTES
This role provides the following attributes.

  $iterator->classes()
An array reference of class names. Each class must be a subclass of Fey::Object::Table.

  $iterator->index()
The current iterator index. Also provides "_inc_index()" and "_reset_index()" methods.

PROVIDED METHODS
This role provides the following methods. These methods are documented in Fey::Object::Iterator::FromSelect.

  $iterator->next

  $iterator->next_as_hash()

  $iterator->all()

  $iterator->all_as_hashes()

  $iterator->remaining()

  $iterator->remaining_as_hashes()

AUTHOR
Dave Rolsky <autarch@urth.org>

COPYRIGHT AND LICENSE
This software is copyright (c) 2011 - 2015 by Dave Rolsky.

This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.