.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Class::DBI::Pager 3"
.TH Class::DBI::Pager 3 2023-01-20 "perl v5.36.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Class::DBI::Pager \- Pager utility for Class::DBI
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&  package CD;
\&  use base qw(Class::DBI);
\&  _\|_PACKAGE_\|_\->set_db(...);
\&
\&  use Class::DBI::Pager;        # just use it
\&
\&  # then, in client code!
\&  package main;
\&
\&  use CD;
\&  my $pager = CD\->pager(20, 1);     # ($items_per_page, $current_page)
\&  my @disks = $pager\->retrieve_all;
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class::DBI::Pager is a plugin for Class::DBI, which glues Data::Page
with Class::DBI. This module reduces your work a lot, for example when
you have to do something like:
.PP
.Vb 2
\&  * retrieve objects from a database
\&  * display objects with 20 items per page
.Ve
.PP
In addition, your work will be reduced more, when you use
Template-Toolkit as your templating engine. See "EXAMPLE" for
details.
.SH EXAMPLE
.IX Header "EXAMPLE"
.Vb 3
\&  # Controller: (MVC\*(Aqs C)
\&  my $query    = CGI\->new;
\&  my $template = Template\->new;
\&
\&  my $pager    = Film\->pager(20, $query\->param(\*(Aqpage\*(Aq) || 1);
\&  my $movies   = $pager\->retrieve_all;
\&  $template\->process($input, {
\&      movies => $movies,
\&      pager  => $pager,
\&  });
\&
\&  # View: (MVC\*(Aqs V)
\&  Matched [% pager.total_entries %] items.
\&
\&  [% WHILE (movie = movies.next) %]
\&  Title: [% movie.title | html %]
\&  [% END %]
\&
\&  ### navigation like: [1] [2] [3]
\&  [% FOREACH num = [pager.first_page .. pager.last_page] %]
\&  [% IF num == pager.current_page %][[% num %]]
\&  [% ELSE %]<a href="display?page=[% num %]">[[% num %]]</a>[% END %]
\&  [% END %]
\&
\&  ### navigation like: prev 20 | next 20
\&  [% IF pager.previous_page %]
\&  <a href="display?page=[% pager.previous_page %]">
\&  prev [% pager.entries_per_page %]</a> |
\&  [% END %]
\&  [% IF pager.next_page %]
\&  <a href="display?page=[% pager.next_page %]">
\&  next [% pager.entries_per_page %]</a>
\&  [% END %]
.Ve
.SH "NOTE / TODO"
.IX Header "NOTE / TODO"
This modules internally retrieves itertors, then creates \f(CW\*(C`Data::Page\*(C'\fR
object for paging utility. Using SQL clauses \f(CW\*(C`LIMIT\*(C'\fR and/or \f(CW\*(C`OFFSET\*(C'\fR
with \f(CW\*(C`DBIx::Pager\*(C'\fR might be more memory efficient.
.SH AUTHOR
.IX Header "AUTHOR"
Tatsuhiko Miyagawa <miyagawa@bulknews.net>
.PP
Original idea by Tomohiro Ikebe <ikebe@cpan.org>
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
Class::DBI, Data::Page