Tony Bowden > Data-Paginated-1.01 > Data::Paginated

Download:
Data-Paginated-1.01.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1.01   Source  

NAME ^

Data::Paginated - paginate a list of data

SYNOPSIS ^

        my $paginator = Data::Paginated->new({
                entries => \@my_list,
                entries_per_page => $entries_per_page, 
                current_page => $current_page,
        });

        my @to_print = $paginator->page_data;

DESCRIPTION ^

Data::Paginated is a thin wrapper around Data::Pageset which adds the extra functionality of being able to get all the entries from a list that are on a given page.

METHODS ^

new

        my $paginator = Data::Paginated->new({
                entries => \@my_list,
                entries_per_page => $entries_per_page,
                current_page => $current_page,
        });

This can take all the arguments that can be passed to Data::Pageset, with the exception that instead of passing simply the total number of items in question, you actually pass the items as a reference.

page_data

        my @to_print = $paginator->page_data;

This returns a list of the entries that will be on the current page.

So, if you have a list of [ 1 .. 10 ], 3 entries per page, and current page is 2, this will return (4, 5, 6).

AUTHOR ^

Tony Bowden

BUGS and QUERIES ^

Please direct all correspondence regarding this module to: bug-Data-Paginated@rt.cpan.org

COPYRIGHT AND LICENSE ^

  Copyright (C) 2004-2005 Kasei

  This program is free software; you can redistribute it and/or modify it under
  the terms of the GNU General Public License; either version 2 of the License,
  or (at your option) any later version.

  This program 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 ALSO ^

Data::Pageset, Data::Page.

syntax highlighting: