Module | Sequel::Dataset::Pagination |
In: |
lib/sequel/extensions/pagination.rb
|
Holds methods that only relate to paginated datasets. Paginated dataset have pages starting at 1 (page 1 is offset 0, page 1 is offset page_size).
current_page | [RW] | The current page of the dataset, starting at 1 and not 0. |
page_count | [RW] | The number of pages in the dataset before pagination, of which this paginated dataset is one. |
page_size | [RW] | The number of records per page (the final page may have fewer than this number of records). |
pagination_record_count | [RW] | The total number of records in the dataset before pagination. |
Returns the number of records in the current page
# File lib/sequel/extensions/pagination.rb, line 70 70: def current_page_record_count 71: return 0 if @current_page > @page_count 72: 73: a = 1 + (@current_page - 1) * @page_size 74: b = a + @page_size - 1 75: b = @pagination_record_count if b > @pagination_record_count 76: b - a + 1 77: end
Returns the record range for the current page
# File lib/sequel/extensions/pagination.rb, line 60 60: def current_page_record_range 61: return (0..0) if @current_page > @page_count 62: 63: a = 1 + (@current_page - 1) * @page_size 64: b = a + @page_size - 1 65: b = @pagination_record_count if b > @pagination_record_count 66: a..b 67: end
Returns true if the current page is the first page
# File lib/sequel/extensions/pagination.rb, line 80 80: def first_page? 81: @current_page == 1 82: end
Returns true if the current page is the last page
# File lib/sequel/extensions/pagination.rb, line 85 85: def last_page? 86: @current_page == @page_count 87: end
Returns the next page number or nil if the current page is the last page
# File lib/sequel/extensions/pagination.rb, line 90 90: def next_page 91: current_page < page_count ? (current_page + 1) : nil 92: end
Returns the page range
# File lib/sequel/extensions/pagination.rb, line 95 95: def page_range 96: 1..page_count 97: end
Returns the previous page number or nil if the current page is the first
# File lib/sequel/extensions/pagination.rb, line 100 100: def prev_page 101: current_page > 1 ? (current_page - 1) : nil 102: end
Sets the pagination info for this paginated dataset, and returns self.
# File lib/sequel/extensions/pagination.rb, line 105 105: def set_pagination_info(page_no, page_size, record_count) 106: @current_page = page_no 107: @page_size = page_size 108: @pagination_record_count = record_count 109: @page_count = (record_count / page_size.to_f).ceil 110: self 111: end