A class representing a paginator for an Active Record collection.
- []
- current
- current_page
- current_page=
- each
- first
- first_page
- has_page_number?
- last
- last_page
- length
- new
- page_count
- Enumerable
Class ActionController::Pagination::Paginator::Window
| [R] | controller | |
| [R] | item_count | |
| [R] | items_per_page |
Creates a new Paginator on the given controller for a set of items of size item_count and having items_per_page items per page. Raises ArgumentError if items_per_page is out of bounds (i.e., less than or equal to zero). The page CGI parameter for links defaults to "page" and can be overridden with page_parameter.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 214
214: def initialize(controller, item_count, items_per_page, current_page=1)
215: raise ArgumentError, 'must have at least one item per page' if
216: items_per_page <= 0
217:
218: @controller = controller
219: @item_count = item_count || 0
220: @items_per_page = items_per_page
221: @pages = {}
222:
223: self.current_page = current_page
224: end
Returns a new Page representing the page with the given index number.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 272
272: def [](number)
273: @pages[number] ||= Page.new(self, number)
274: end
Alias for current_page
Returns a Page object representing this paginator’s current page.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 240
240: def current_page
241: @current_page ||= self[@current_page_number]
242: end
Sets the current page number of this paginator. If page is a Page object, its number attribute is used as the value; if the page does not belong to this Paginator, an ArgumentError is raised.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 230
230: def current_page=(page)
231: if page.is_a? Page
232: raise ArgumentError, 'Page/Paginator mismatch' unless
233: page.paginator == self
234: end
235: page = page.to_i
236: @current_page_number = has_page_number?(page) ? page : 1
237: end
Successively yields all the paginator’s pages to the given block.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 277
277: def each(&block)
278: page_count.times do |n|
279: yield self[n+1]
280: end
281: end
Alias for first_page
Returns a new Page representing the first page in this paginator.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 246
246: def first_page
247: @first_page ||= self[1]
248: end
Returns true if this paginator contains the page of index number.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 266
266: def has_page_number?(number)
267: number >= 1 and number <= page_count
268: end
Alias for last_page
Returns a new Page representing the last page in this paginator.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 252
252: def last_page
253: @last_page ||= self[page_count]
254: end
Alias for page_count
Returns the number of pages in this paginator.
[ show source ]
# File vendor/rails/actionpack/lib/action_controller/pagination.rb, line 258
258: def page_count
259: @page_count ||= @item_count.zero? ? 1 :
260: (q,r=@item_count.divmod(@items_per_page); r==0? q : q+1)
261: end