1 package SL::DB::Helper::Paginated;
6 our @ISA = qw(Exporter);
7 our @EXPORT = qw(paginate);
10 my ($self, %params) = @_;
11 my $page = $params{page} || 1;
12 my %args = %{ $params{args} || {} };
16 $ret->{per_page} = per_page($self, %params);
17 $ret->{max} = ceil($self->get_all_count(%args), $ret->{per_page}) || 1;
18 $ret->{cur} = $page < 1 ? 1
19 : $page > $ret->{max} ? $ret->{max}
21 $ret->{common} = make_common_pages($ret->{cur}, $ret->{max});
23 $params{args}{page} = $ret->{cur};
24 $params{args}{per_page} = $ret->{per_page};
25 delete $params{args}{limit};
26 delete $params{args}{offset};
32 my ($self, %params) = @_;
34 return $params{per_page} if exists $params{per_page};
35 return $self->default_objects_per_page;
43 return $a / $b + ($a % $b ? 1 : 0);
46 sub make_common_pages {
64 SL::Helper::Paginated - Manager mixin for paginating results.
70 use SL::Helper::Paginated;
72 __PACKAGE__->default_objects_per_page(10); # optional, defaults to 20
77 query => [ id => $params{list_of_selected_ids},
78 other_attr => $::form->{other_attr}, ],
81 $self->{pages} = SL::DB::Manager::MyObject->paginate(args => \%args, page => $::form->{page});
82 $self->{objects} = SL::DB::Manager::MyObject->get_all(%args);
86 [% PROCESS 'common/paginate.html'
88 base_url=L.url_for(action='list', ...)
95 =item C<paginate> args => HREF, page => $page, [ per_page => $per_page ]
97 Paginate will prepare information to be used for paginating, change the given
98 args to use them, and return a data structure containing information for later
101 C<args> needs to contain a reference to a hash, which will be used as an
102 argument for C<get_all>. After C<paginate> the keys C<page> and C<per_page>
103 will be set. The keys C<limit> and C<offset> will be unset, should they exist,
104 since they don't make sense with paginating.
106 C<page> should contain a value between 1 and the maximum pages. Will be
109 The parameter C<per_page> is optional. If not given the default value of the
110 Manager will be used.
114 =head1 TEMPLATE HELPERS
118 =item C<common/paginate.html> pages=SELF.pages, base_url=URL
120 The template will render a simple list of links to the
121 various other pages. A C<base_url> must be given for the links to work.
131 Sven Schöling E<lt>s.schoeling@linet-services.deE<gt>