NAME
Template::Iterator - Base iterator class used by the FOREACH directive.
SYNOPSIS
DOCUMENTATION NOTES
This documentation describes the Template::Iterator module and is aimed at people who wish to understand, extend or build template processing applications with the Template Toolkit.
For a general overview and information of how to use the modules, write and render templates, see Template-Toolkit.
DESCRIPTION
PUBLIC METHODS
new(\@data)
first()
Returns a ($value, $error) pair for the first item in the iterator set. Returns an error of STATUS_DONE if the list is empty.
next()
Returns a ($value, $error) pair for the next item in the iterator set. Returns an error of STATUS_DONE if all items in the list have been visited.
AUTHOR
Andy Wardley <cre.canon.co.uk>
REVISION
$Revision: 1.4 $
COPYRIGHT
Copyright (C) 1996-1999 Andy Wardley. All Rights Reserved. Copyright (C) 1998-1999 Canon Research Centre Europe Ltd.
This module is free software; you can redistribute it and/or modify it under the same terms as Perl itself.