NAME

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

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>

BUGS

See Fey::ORM for details.

COPYRIGHT & LICENSE

Copyright 2006-2009 Dave Rolsky, All Rights Reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. The full text of the license can be found in the LICENSE file included with this module.