Class | ActionController::Pagination::Paginator::Page |
In: |
vendor/rails/actionpack/lib/action_controller/pagination.rb
|
Parent: | Object |
A class representing a single page in a paginator.
number | -> | to_i |
number | [R] | |
paginator | [R] |
Creates a new Page for the given paginator with the index number. If number is not in the range of valid page numbers or is not a number at all, it defaults to 1.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 297 297: def initialize(paginator, number) 298: @paginator = paginator 299: @number = number.to_i 300: @number = 1 unless @paginator.has_page_number? @number 301: end
Compares two Page objects and returns -1 if the left-hand page comes before the right-hand page, 0 if the pages are equal, and 1 if the left-hand page comes after the right-hand page. Raises ArgumentError if the pages do not belong to the same Paginator object.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 318 318: def <=>(page) 319: raise ArgumentError unless @paginator == page.paginator 320: @number <=> page.number 321: end
Compares two Page objects and returns true when they represent the same page (i.e., their paginators are the same and they have the same page number).
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 308 308: def ==(page) 309: return false if page.nil? 310: @paginator == page.paginator and 311: @number == page.number 312: end
Returns true if this page is the first page in the paginator.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 339 339: def first? 340: self == @paginator.first 341: end
Returns the number of the first item displayed.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 329 329: def first_item 330: offset + 1 331: end
Returns true if this page is the last page in the paginator.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 344 344: def last? 345: self == @paginator.last 346: end
Returns the number of the last item displayed.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 334 334: def last_item 335: [@paginator.items_per_page * @number, @paginator.item_count].min 336: end
Returns the limit/offset array for this page.
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 367 367: def to_sql 368: [@paginator.items_per_page, offset] 369: end