| 1 | package Catmandu::Paged; | ||||||||||||||||||||||||||||
| 2 | |||||||||||||||||||||||||||||
| 3 | 15 | ▶ | use Catmandu::Sane; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 4 | |||||||||||||||||||||||||||||
| 5 | 15 | our $VERSION = '1.0201_02'; | |||||||||||||||||||||||||||
| 6 | |||||||||||||||||||||||||||||
| 7 | 15 | ▶ | use Moo::Role; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 8 | 15 | ▶ | use namespace::clean; | ||||||||||||||||||||||||||
|
Subroutine
BEGIN: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 9 | |||||||||||||||||||||||||||||
| 10 | 15 | requires 'start'; | |||||||||||||||||||||||||||
| 11 | 15 | requires 'limit'; | |||||||||||||||||||||||||||
| 12 | 15 | requires 'total'; | |||||||||||||||||||||||||||
| 13 | |||||||||||||||||||||||||||||
| 14 | 3 | ▶ | has max_pages_in_spread => (is => 'rw', lazy => 1, default => sub {5}); | ||||||||||||||||||||||||||
|
Subroutine
__ANON__: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 15 | |||||||||||||||||||||||||||||
| 16 | # function _do_pagination copied from Data::SpreadPagination, | ||||||||||||||||||||||||||||
| 17 | # decrease dependencies for Catmandu | ||||||||||||||||||||||||||||
| 18 | |||||||||||||||||||||||||||||
| 19 | sub _ceil { | ||||||||||||||||||||||||||||
| 20 | 58 | ▶ | my $x = shift; | ||||||||||||||||||||||||||
|
Subroutine
_ceil: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 21 | 58 | return int($x + 0.9999999); | |||||||||||||||||||||||||||
| 22 | } | ||||||||||||||||||||||||||||
| 23 | |||||||||||||||||||||||||||||
| 24 | sub _floor { | ||||||||||||||||||||||||||||
| 25 | 4 | ▶ | my $x = shift; | ||||||||||||||||||||||||||
|
Subroutine
_floor: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 26 | 4 | return int $x; | |||||||||||||||||||||||||||
| 27 | } | ||||||||||||||||||||||||||||
| 28 | |||||||||||||||||||||||||||||
| 29 | sub _round { | ||||||||||||||||||||||||||||
| 30 | 6 | ▶ | my $x = shift; | ||||||||||||||||||||||||||
|
Subroutine
_round: called CC=1 SCAR=0.0
| |||||||||||||||||||||||||||||
| 31 | 6 | return int($x + 0.5); | |||||||||||||||||||||||||||
| 32 | } | ||||||||||||||||||||||||||||
| 33 | |||||||||||||||||||||||||||||
| 34 | sub _do_pagination { | ||||||||||||||||||||||||||||
| 35 | 3 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
_do_pagination: called CC=11 SCAR=26.0
| |||||||||||||||||||||||||||||
| 36 | 3 | my $total_entries = $self->total; | |||||||||||||||||||||||||||
| 37 | 3 | my $entries_per_page = $self->limit; | |||||||||||||||||||||||||||
| 38 | 3 | my $current_page = $self->page; | |||||||||||||||||||||||||||
| 39 | 3 | my $max_pages = $self->max_pages_in_spread; | |||||||||||||||||||||||||||
| 40 | |||||||||||||||||||||||||||||
| 41 | # qNsizes | ||||||||||||||||||||||||||||
| 42 | 3 | my @q_size = (); | |||||||||||||||||||||||||||
| 43 | 3 | my ($add_pages, $adj); | |||||||||||||||||||||||||||
| 44 | |||||||||||||||||||||||||||||
| 45 | # step 2 | ||||||||||||||||||||||||||||
| 46 | 3 | my $total_pages = _ceil($total_entries / $entries_per_page); | |||||||||||||||||||||||||||
| 47 | 3 | ▶ | my $visible_pages | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 48 | = $max_pages < ($total_pages - 1) ? $max_pages : $total_pages - 1; | ||||||||||||||||||||||||||||
| 49 | 3 | ▶ | if ($total_pages - 1 <= $max_pages) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 50 | 1 | @q_size = ($current_page - 1, 0, 0, $total_pages - $current_page); | |||||||||||||||||||||||||||
| 51 | } | ||||||||||||||||||||||||||||
| 52 | else { | ||||||||||||||||||||||||||||
| 53 | 2 | @q_size = ( | |||||||||||||||||||||||||||
| 54 | _floor($visible_pages / 4), | ||||||||||||||||||||||||||||
| 55 | _round($visible_pages / 4), | ||||||||||||||||||||||||||||
| 56 | _ceil($visible_pages / 4), | ||||||||||||||||||||||||||||
| 57 | _round(($visible_pages - _round($visible_pages / 4)) / 3) | ||||||||||||||||||||||||||||
| 58 | ); | ||||||||||||||||||||||||||||
| 59 | 2 | ▶ | if ($current_page - $q_size[0] < 1) { | ||||||||||||||||||||||||||
|
Branch: 4 branches
| |||||||||||||||||||||||||||||
| 60 | 1 | $add_pages = $q_size[0] + $q_size[1] - $current_page + 1; | |||||||||||||||||||||||||||
| 61 | 1 | @q_size = ( | |||||||||||||||||||||||||||
| 62 | $current_page - 1, | ||||||||||||||||||||||||||||
| 63 | 0, | ||||||||||||||||||||||||||||
| 64 | $q_size[2] + _ceil($add_pages / 2), | ||||||||||||||||||||||||||||
| 65 | $q_size[3] + _floor($add_pages / 2) | ||||||||||||||||||||||||||||
| 66 | ); | ||||||||||||||||||||||||||||
| 67 | } | ||||||||||||||||||||||||||||
| 68 | elsif ( | ||||||||||||||||||||||||||||
| 69 | $current_page - $q_size[1] - _ceil($q_size[1] / 3) <= $q_size[0]) | ||||||||||||||||||||||||||||
| 70 | { | ||||||||||||||||||||||||||||
| 71 | 1 | $adj = _ceil((3 * ($current_page - $q_size[0] - 1)) / 4); | |||||||||||||||||||||||||||
| 72 | 1 | $add_pages = $q_size[1] - $adj; | |||||||||||||||||||||||||||
| 73 | 1 | @q_size = ( | |||||||||||||||||||||||||||
| 74 | $q_size[0], $adj, | ||||||||||||||||||||||||||||
| 75 | $q_size[2] + _ceil($add_pages / 2), | ||||||||||||||||||||||||||||
| 76 | $q_size[3] + _floor($add_pages / 2) | ||||||||||||||||||||||||||||
| 77 | ); | ||||||||||||||||||||||||||||
| 78 | } | ||||||||||||||||||||||||||||
| 79 | elsif ($current_page + $q_size[3] >= $total_pages) { | ||||||||||||||||||||||||||||
| 80 | 0 | $add_pages | |||||||||||||||||||||||||||
| 81 | = $q_size[2] + $q_size[3] - $total_pages + $current_page; | ||||||||||||||||||||||||||||
| 82 | 0 | @q_size = ( | |||||||||||||||||||||||||||
| 83 | $q_size[0] + _floor($add_pages / 2), | ||||||||||||||||||||||||||||
| 84 | $q_size[1] + _ceil($add_pages / 2), | ||||||||||||||||||||||||||||
| 85 | 0, $total_pages - $current_page | ||||||||||||||||||||||||||||
| 86 | ); | ||||||||||||||||||||||||||||
| 87 | } | ||||||||||||||||||||||||||||
| 88 | elsif ($current_page + $q_size[2] >= $total_pages - $q_size[3]) { | ||||||||||||||||||||||||||||
| 89 | 0 | $adj = _ceil( | |||||||||||||||||||||||||||
| 90 | (3 * ($total_pages - $current_page - $q_size[3])) / 4); | ||||||||||||||||||||||||||||
| 91 | 0 | $add_pages = $q_size[2] - $adj; | |||||||||||||||||||||||||||
| 92 | 0 | @q_size = ( | |||||||||||||||||||||||||||
| 93 | $q_size[0] + _floor($add_pages / 2), | ||||||||||||||||||||||||||||
| 94 | $q_size[1] + _ceil($add_pages / 2), | ||||||||||||||||||||||||||||
| 95 | $adj, $q_size[3] | ||||||||||||||||||||||||||||
| 96 | ); | ||||||||||||||||||||||||||||
| 97 | } | ||||||||||||||||||||||||||||
| 98 | } | ||||||||||||||||||||||||||||
| 99 | |||||||||||||||||||||||||||||
| 100 | # step 3 (PROFIT) | ||||||||||||||||||||||||||||
| 101 | $self->{PAGE_RANGES} = [ | ||||||||||||||||||||||||||||
| 102 | 3 | ▶ | $q_size[0] == 0 ? undef : [1, $q_size[0]], | ||||||||||||||||||||||||||
|
Branch: 4 branches
| |||||||||||||||||||||||||||||
| 103 | $q_size[1] == 0 ? undef | ||||||||||||||||||||||||||||
| 104 | : [$current_page - $q_size[1], $current_page - 1], | ||||||||||||||||||||||||||||
| 105 | $q_size[2] == 0 ? undef | ||||||||||||||||||||||||||||
| 106 | : [$current_page + 1, $current_page + $q_size[2]], | ||||||||||||||||||||||||||||
| 107 | $q_size[3] == 0 ? undef | ||||||||||||||||||||||||||||
| 108 | : [$total_pages - $q_size[3] + 1, $total_pages], | ||||||||||||||||||||||||||||
| 109 | ]; | ||||||||||||||||||||||||||||
| 110 | |||||||||||||||||||||||||||||
| 111 | } | ||||||||||||||||||||||||||||
| 112 | |||||||||||||||||||||||||||||
| 113 | sub first_page { | ||||||||||||||||||||||||||||
| 114 | 3 | ▶ | return 1; | ||||||||||||||||||||||||||
|
Subroutine
first_page: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 115 | } | ||||||||||||||||||||||||||||
| 116 | |||||||||||||||||||||||||||||
| 117 | sub last_page { | ||||||||||||||||||||||||||||
| 118 | 29 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
last_page: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 119 | |||||||||||||||||||||||||||||
| 120 | 29 | my $last = $self->total / $self->limit; | |||||||||||||||||||||||||||
| 121 | 29 | return _ceil($last); | |||||||||||||||||||||||||||
| 122 | } | ||||||||||||||||||||||||||||
| 123 | |||||||||||||||||||||||||||||
| 124 | sub page { | ||||||||||||||||||||||||||||
| 125 | 30 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
page: called CC=3 SCAR=11.0
Pod
documented
| |||||||||||||||||||||||||||||
| 126 | |||||||||||||||||||||||||||||
| 127 | 30 | ▶ | ($self->start == 0) && (return 1); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 128 | |||||||||||||||||||||||||||||
| 129 | 20 | my $page = _ceil(($self->start + 1) / $self->limit); | |||||||||||||||||||||||||||
| 130 | 20 | ▶ | ($page < $self->last_page) ? (return $page) : (return $self->last_page); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 131 | } | ||||||||||||||||||||||||||||
| 132 | |||||||||||||||||||||||||||||
| 133 | sub previous_page { | ||||||||||||||||||||||||||||
| 134 | 3 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
previous_page: called CC=2 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 135 | |||||||||||||||||||||||||||||
| 136 | 3 | ▶ | ($self->page > 1) ? (return $self->page - 1) : (return undef); | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 137 | } | ||||||||||||||||||||||||||||
| 138 | |||||||||||||||||||||||||||||
| 139 | sub next_page { | ||||||||||||||||||||||||||||
| 140 | 3 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
next_page: called CC=2 SCAR=7.2
Pod
documented
| |||||||||||||||||||||||||||||
| 141 | |||||||||||||||||||||||||||||
| 142 | 3 | ▶ | ($self->page < $self->last_page) | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 143 | ? (return $self->page + 1) | ||||||||||||||||||||||||||||
| 144 | : (return undef); | ||||||||||||||||||||||||||||
| 145 | } | ||||||||||||||||||||||||||||
| 146 | |||||||||||||||||||||||||||||
| 147 | sub first_on_page { | ||||||||||||||||||||||||||||
| 148 | 3 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
first_on_page: called CC=2 SCAR=7.2
Pod
documented
| |||||||||||||||||||||||||||||
| 149 | |||||||||||||||||||||||||||||
| 150 | 3 | ▶ | ($self->total == 0) | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 151 | ? (return 0) | ||||||||||||||||||||||||||||
| 152 | : (return (($self->page - 1) * $self->limit) + 1); | ||||||||||||||||||||||||||||
| 153 | } | ||||||||||||||||||||||||||||
| 154 | |||||||||||||||||||||||||||||
| 155 | sub last_on_page { | ||||||||||||||||||||||||||||
| 156 | 3 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
last_on_page: called CC=2 SCAR=7.2
Pod
undocumented
| |||||||||||||||||||||||||||||
| 157 | |||||||||||||||||||||||||||||
| 158 | 3 | ▶ | ($self->page == $self->last_page) | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 159 | ? (return $self->total) | ||||||||||||||||||||||||||||
| 160 | : (return ($self->page * $self->limit)); | ||||||||||||||||||||||||||||
| 161 | } | ||||||||||||||||||||||||||||
| 162 | |||||||||||||||||||||||||||||
| 163 | sub page_size { | ||||||||||||||||||||||||||||
| 164 | 3 | ▶ | my $self = shift,; | ||||||||||||||||||||||||||
|
Subroutine
page_size: called CC=1 SCAR=0.0
Pod
documented
| |||||||||||||||||||||||||||||
| 165 | 3 | return $self->limit; | |||||||||||||||||||||||||||
| 166 | } | ||||||||||||||||||||||||||||
| 167 | |||||||||||||||||||||||||||||
| 168 | sub page_ranges { | ||||||||||||||||||||||||||||
| 169 | 0 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
page_ranges: not called CC=1 SCAR=6.9
Pod
documented
| |||||||||||||||||||||||||||||
| 170 | |||||||||||||||||||||||||||||
| 171 | 0 | $self->_do_pagination; | |||||||||||||||||||||||||||
| 172 | 0 | return @{$self->{PAGE_RANGES}}; | |||||||||||||||||||||||||||
| 173 | } | ||||||||||||||||||||||||||||
| 174 | |||||||||||||||||||||||||||||
| 175 | sub pages_in_spread { | ||||||||||||||||||||||||||||
| 176 | 3 | ▶ | my $self = shift; | ||||||||||||||||||||||||||
|
Subroutine
pages_in_spread: called CC=11 SCAR=25.8
Pod
documented
| |||||||||||||||||||||||||||||
| 177 | |||||||||||||||||||||||||||||
| 178 | 3 | $self->_do_pagination; | |||||||||||||||||||||||||||
| 179 | 3 | my $ranges = $self->{PAGE_RANGES}; | |||||||||||||||||||||||||||
| 180 | 3 | my $pages = []; | |||||||||||||||||||||||||||
| 181 | |||||||||||||||||||||||||||||
| 182 | 3 | ▶ | if (!defined $ranges->[0]) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 183 | 2 | ▶ | push @$pages, undef if $self->page > 1; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 184 | } | ||||||||||||||||||||||||||||
| 185 | else { | ||||||||||||||||||||||||||||
| 186 | 1 | push @$pages, $ranges->[0][0] .. $ranges->[0][1]; | |||||||||||||||||||||||||||
| 187 | 1 | ▶ | push @$pages, undef | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition33%1/3
defined $ranges->[1] and $ranges->[1][0] - $ranges->[0][1] > 1
MC/DC0%0/2
defined $ranges->[1] and $ranges->[1][0] - $ranges->[0][1] > 1
defined $ranges->[1]
$ranges->[1][0] - $ranges->[0][1] > 1
Truth table33%1/3
A and B
A= defined $ranges->[1]B= $ranges->[1][0] - $ranges->[0][1] > 1
| |||||||||||||||||||||||||||||
| 188 | if defined $ranges->[1] | ||||||||||||||||||||||||||||
| 189 | and ($ranges->[1][0] - $ranges->[0][1]) > 1; | ||||||||||||||||||||||||||||
| 190 | } | ||||||||||||||||||||||||||||
| 191 | |||||||||||||||||||||||||||||
| 192 | 3 | ▶ | push @$pages, $ranges->[1][0] .. $ranges->[1][1] if defined $ranges->[1]; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 193 | 3 | push @$pages, $self->page; | |||||||||||||||||||||||||||
| 194 | 3 | ▶ | push @$pages, $ranges->[2][0] .. $ranges->[2][1] if defined $ranges->[2]; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 195 | |||||||||||||||||||||||||||||
| 196 | 3 | ▶ | if (!defined $ranges->[3]) { | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 197 | 0 | ▶ | push @$pages, undef if $self->page < $self->last_page; | ||||||||||||||||||||||||||
|
Branch: 1 branch
| |||||||||||||||||||||||||||||
| 198 | } | ||||||||||||||||||||||||||||
| 199 | else { | ||||||||||||||||||||||||||||
| 200 | 3 | ▶ | push @$pages, undef | ||||||||||||||||||||||||||
|
Branch: 1 branch
Condition66%2/3
defined $ranges->[2] and $ranges->[3][0] - $ranges->[2][1] > 1
MC/DC50%1/2
defined $ranges->[2] and $ranges->[3][0] - $ranges->[2][1] > 1
defined $ranges->[2]
$ranges->[3][0] - $ranges->[2][1] > 1
Truth table66%2/3
A and B
A= defined $ranges->[2]B= $ranges->[3][0] - $ranges->[2][1] > 1
| |||||||||||||||||||||||||||||
| 201 | if defined $ranges->[2] | ||||||||||||||||||||||||||||
| 202 | and ($ranges->[3][0] - $ranges->[2][1]) > 1; | ||||||||||||||||||||||||||||
| 203 | 3 | push @$pages, $ranges->[3][0] .. $ranges->[3][1]; | |||||||||||||||||||||||||||
| 204 | } | ||||||||||||||||||||||||||||
| 205 | |||||||||||||||||||||||||||||
| 206 | 3 | return $pages; | |||||||||||||||||||||||||||
| 207 | } | ||||||||||||||||||||||||||||
| 208 | |||||||||||||||||||||||||||||
| 209 | 15 | 1; | |||||||||||||||||||||||||||
| 210 | |||||||||||||||||||||||||||||
| 211 | __END__ | ||||||||||||||||||||||||||||
| 212 | |||||||||||||||||||||||||||||
| 213 | =pod | ||||||||||||||||||||||||||||
| 214 | |||||||||||||||||||||||||||||
| 215 | =head1 NAME | ||||||||||||||||||||||||||||
| 216 | |||||||||||||||||||||||||||||
| 217 | Catmandu::Paged - Base class for packages that need paging result sets | ||||||||||||||||||||||||||||
| 218 | |||||||||||||||||||||||||||||
| 219 | =head1 SYNOPSIS | ||||||||||||||||||||||||||||
| 220 | |||||||||||||||||||||||||||||
| 221 | # Create a package that needs page calculation | ||||||||||||||||||||||||||||
| 222 | package MyPackage; | ||||||||||||||||||||||||||||
| 223 | |||||||||||||||||||||||||||||
| 224 | use Moo; | ||||||||||||||||||||||||||||
| 225 | |||||||||||||||||||||||||||||
| 226 | with 'Catmandu::Paged'; | ||||||||||||||||||||||||||||
| 227 | |||||||||||||||||||||||||||||
| 228 | sub start { | ||||||||||||||||||||||||||||
| 229 | 12; # Starting result | ||||||||||||||||||||||||||||
| 230 | } | ||||||||||||||||||||||||||||
| 231 | |||||||||||||||||||||||||||||
| 232 | sub limit { | ||||||||||||||||||||||||||||
| 233 | 10; # Number of results per page | ||||||||||||||||||||||||||||
| 234 | } | ||||||||||||||||||||||||||||
| 235 | |||||||||||||||||||||||||||||
| 236 | sub total { | ||||||||||||||||||||||||||||
| 237 | 131237128371; # Total number of results; | ||||||||||||||||||||||||||||
| 238 | } | ||||||||||||||||||||||||||||
| 239 | |||||||||||||||||||||||||||||
| 240 | package main; | ||||||||||||||||||||||||||||
| 241 | |||||||||||||||||||||||||||||
| 242 | my $x = MyPackage->new; | ||||||||||||||||||||||||||||
| 243 | |||||||||||||||||||||||||||||
| 244 | printf "Start page: %s\n" , $x->first_page; | ||||||||||||||||||||||||||||
| 245 | printf "Last page: %s\n" , $x->last_page; | ||||||||||||||||||||||||||||
| 246 | printf "Current page: %s\n" , $x->page; | ||||||||||||||||||||||||||||
| 247 | printf "Next page: %s\n" , $x->next_page; | ||||||||||||||||||||||||||||
| 248 | |||||||||||||||||||||||||||||
| 249 | =head1 DESCRIPTION | ||||||||||||||||||||||||||||
| 250 | |||||||||||||||||||||||||||||
| 251 | Packages that use L<Catmandu::Paged> as base class and implement the methods | ||||||||||||||||||||||||||||
| 252 | C<start>, C<limit> and C<total> get for free methods that can be used to do | ||||||||||||||||||||||||||||
| 253 | page calculation. | ||||||||||||||||||||||||||||
| 254 | |||||||||||||||||||||||||||||
| 255 | =head1 OVERWRITE METHODS | ||||||||||||||||||||||||||||
| 256 | |||||||||||||||||||||||||||||
| 257 | =over 4 | ||||||||||||||||||||||||||||
| 258 | |||||||||||||||||||||||||||||
| 259 | =item start() | ||||||||||||||||||||||||||||
| 260 | |||||||||||||||||||||||||||||
| 261 | Returns the index of the first item in a result page. | ||||||||||||||||||||||||||||
| 262 | |||||||||||||||||||||||||||||
| 263 | =item limit() | ||||||||||||||||||||||||||||
| 264 | |||||||||||||||||||||||||||||
| 265 | Returns the number of results in a page. | ||||||||||||||||||||||||||||
| 266 | |||||||||||||||||||||||||||||
| 267 | =item total() | ||||||||||||||||||||||||||||
| 268 | |||||||||||||||||||||||||||||
| 269 | Returns the total number of search results. | ||||||||||||||||||||||||||||
| 270 | |||||||||||||||||||||||||||||
| 271 | =back | ||||||||||||||||||||||||||||
| 272 | |||||||||||||||||||||||||||||
| 273 | =head1 INSTANCE METHODS | ||||||||||||||||||||||||||||
| 274 | |||||||||||||||||||||||||||||
| 275 | =over 4 | ||||||||||||||||||||||||||||
| 276 | |||||||||||||||||||||||||||||
| 277 | =item first_page | ||||||||||||||||||||||||||||
| 278 | |||||||||||||||||||||||||||||
| 279 | Returns the index the first page in a search result containing 0 or more pages. | ||||||||||||||||||||||||||||
| 280 | |||||||||||||||||||||||||||||
| 281 | =item last_page | ||||||||||||||||||||||||||||
| 282 | |||||||||||||||||||||||||||||
| 283 | Returns the index of the last page in a search result containing 0 or more pages. | ||||||||||||||||||||||||||||
| 284 | |||||||||||||||||||||||||||||
| 285 | =item page_size | ||||||||||||||||||||||||||||
| 286 | |||||||||||||||||||||||||||||
| 287 | Returns the number items on the current page. | ||||||||||||||||||||||||||||
| 288 | |||||||||||||||||||||||||||||
| 289 | =item page | ||||||||||||||||||||||||||||
| 290 | |||||||||||||||||||||||||||||
| 291 | Returns the current page index. | ||||||||||||||||||||||||||||
| 292 | |||||||||||||||||||||||||||||
| 293 | =item previous_page | ||||||||||||||||||||||||||||
| 294 | |||||||||||||||||||||||||||||
| 295 | Returns the previous page index. | ||||||||||||||||||||||||||||
| 296 | |||||||||||||||||||||||||||||
| 297 | =item next_page | ||||||||||||||||||||||||||||
| 298 | |||||||||||||||||||||||||||||
| 299 | Returns the next page index. | ||||||||||||||||||||||||||||
| 300 | |||||||||||||||||||||||||||||
| 301 | =item first_on_page | ||||||||||||||||||||||||||||
| 302 | |||||||||||||||||||||||||||||
| 303 | Returns the result index of the first result on the page. | ||||||||||||||||||||||||||||
| 304 | |||||||||||||||||||||||||||||
| 305 | =item page_ranges | ||||||||||||||||||||||||||||
| 306 | |||||||||||||||||||||||||||||
| 307 | =item pages_in_spread | ||||||||||||||||||||||||||||
| 308 | |||||||||||||||||||||||||||||
| 309 | Returns the previous pages and next pages, depending on the current position | ||||||||||||||||||||||||||||
| 310 | in the result set. | ||||||||||||||||||||||||||||
| 311 | |||||||||||||||||||||||||||||
| 312 | =back | ||||||||||||||||||||||||||||
| 313 | |||||||||||||||||||||||||||||
| 314 | =head1 SEE ALSO | ||||||||||||||||||||||||||||
| 315 | |||||||||||||||||||||||||||||
| 316 | L<Catmandu::Hits> | ||||||||||||||||||||||||||||
| 317 | |||||||||||||||||||||||||||||
| 318 | =cut | ||||||||||||||||||||||||||||