new¶

This is the constructor, which takes no arguments.

  my $page = Data::Page->new();

There is also an old, deprecated constructor, which currently takes two mandatory arguments, the total number of entries and the number of entries per page. It also optionally takes the current page number:

  my $page = Data::Page->new($total_entries, $entries_per_page, $current_page);

total_entries¶

This method get or sets the total number of entries:

  print "Entries:", $page->total_entries, "\n";

entries_per_page¶

This method gets or sets the total number of entries per page (which defaults to 10):

  print "Per page:", $page->entries_per_page, "\n";

current_page¶

This method gets or sets the current page number (which defaults to 1):

  print "Page: ", $page->current_page, "\n";

entries_on_this_page¶

This methods returns the number of entries on the current page:

  print "There are ", $page->entries_on_this_page, " entries displayed\n";

first_page¶

This method returns the first page. This is put in for reasons of symmetry with last_page, as it always returns 1:

  print "Pages range from: ", $page->first_page, "\n";

last_page¶

This method returns the total number of pages of information:

  print "Pages range to: ", $page->last_page, "\n";

first¶

This method returns the number of the first entry on the current page:

  print "Showing entries from: ", $page->first, "\n";

last¶

This method returns the number of the last entry on the current page:

  print "Showing entries to: ", $page->last, "\n";

previous_page¶

This method returns the previous page number, if one exists. Otherwise it returns undefined:

  if ($page->previous_page) {
    print "Previous page number: ", $page->previous_page, "\n";
  }

next_page¶

This method returns the next page number, if one exists. Otherwise it returns undefined:

  if ($page->next_page) {
    print "Next page number: ", $page->next_page, "\n";
  }

splice¶

This method takes in a listref, and returns only the values which are on the current page:

  @visible_holidays = $page->splice(\@holidays);

skipped¶

This method is useful paging through data in a database using SQL LIMIT clauses. It is simply $page->first - 1:

  $sth = $dbh->prepare(
    q{SELECT * FROM table ORDER BY rec_date LIMIT ?, ?}
  );
  $sth->execute($page->skipped, $page->entries_per_page);

change_entries_per_page¶

This method changes the number of entries per page and the current page number such that the first item on the current page will be present on the new page.

 $page->total_entries(50);
 $page->entries_per_page(20);
 $page->current_page(3);
 print $page->first; # 41
 $page->change_entries_per_page(30);
 print $page->current_page; # 2 - the page that item 41 will show in