Koha/Koha/MetadataIterator.pm
Jonathan Druart 7d8b96803f
Bug 24545: Fix license statements
Bug 9978 should have fixed them all, but some were missing.
We want all the license statements part of Koha to be identical, and
using the GPLv3 statement.

Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2020-02-24 13:31:26 +00:00

74 lines
1.5 KiB
Perl

package Koha::MetadataIterator;
# This contains an iterator over biblio and authority records
# Copyright 2014 Catalyst IT
#
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
=head1 NAME
Koha::MetadataIterator - iterates over records
=head1 DESCRIPTION
This provides a fairly generic iterator that will return records provided
by a function.
=head1 SYNOPSIS
use Koha::MetadataIterator;
my $next_func = sub {
# something that'll return each record
};
my $iterator = Koha::MetadataIterator->new($next_func);
while ( my $record = $iterator->next() ) {
# do something with $record
}
=head1 METHODS
=cut
use Modern::Perl;
=head2 new
my $it = new($next_func);
Takes a function that will provide the next bit of data.
=cut
sub new {
my ( $class, $next_func ) = @_;
bless { next_func => $next_func, }, $class;
}
=head2 next()
Provides the next record.
=cut
sub next {
my ($self) = @_;
return $self->{next_func}->();
}
1;