PerlDoc

26 August 2025 - 17:41 | Version 1 |
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::Iterator
Child packages:

    Foswiki::Iterator::EventIterator

    Private subclass of LineIterator that

    ObjectMethod hasNext() → $boolean

    Reads records, reassembling them and skipping until a record qualifies per the requested time and levels.

    The next matching record is parsed and saved into an instance variable until requested.

    Returns true if a cached record is available.

    ObjectMethod snoopNext() → $hashref

    Returns a hash of the fields in the next available record without moving the record pointer. (If the file has not yet been read, the hasNext() method is called, which will read the file until it finds a matching record.

    ObjectMethod next() → \$hash or @array

    Returns a hash, or an array of the fields in the next available record depending on the API version.

    PrivateMethod formatData($this) → ( $hashRef, @array )

    Used by the EventIterator to assemble the read log record into a hash for the Version 1 interface, or the array returned for the original Version 0 interface.