See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

Parent package: Foswiki
Child packages:

    public package Foswiki::LineIterator is a Foswiki::Iterator

    implements Foswiki::Iterator

    Iterator over the lines read from a file handle.

    new( $fh )

    Create a new iterator over the given file handle.

    hasNext() → $boolean

    Returns false when the iterator is exhausted.

    my $it = new Foswiki::ListIterator(\@list);
    while ($it->hasNext()) {

    next() → $data

    Return the next line in the file.

    The iterator object can be customised to pre- and post-process entries from the list before returning them. This is done by setting two fields in the iterator object:

    • {filter} can be defined to be a sub that filters each entry. The entry will be ignored (next() will not return it) if the filter returns false.
    • {process} can be defined to be a sub to process each entry before it is returned by next. The value returned from next is the value returned by the process function.

    For example,
    my $it = new Foswiki::LineIterator("/etc/passwd");
    $it->{filter} = sub { $_[0] =~ m/^.*?:/; return $1; };
    $it->{process} = sub { return "User $_[0]"; };
    while ($it->hasNext()) {
        my $x = $it->next();
        print "$x\n";

    Topic revision: r1 - 06 Aug 2023, UnknownUser
    This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
    Ideas, requests, problems regarding Foswiki? Send feedback