Class: Array

Inherits:
Object
  • Object
show all
Defined in:
lib/will_paginate/array.rb

Direct Known Subclasses

WillPaginate::Collection

Instance Method Summary collapse

Instance Method Details

#paginate(options = {}) ⇒ Object

Paginates a static array (extracting a subset of it). The result is a WillPaginate::Collection instance, which is an array with a few more properties about its paginated state.

Parameters:

  • :page - current page, defaults to 1

  • :per_page - limit of items per page, defaults to 30

  • :total_entries - total number of items in the array, defaults to array.length (obviously)

Example:

arr = ['a', 'b', 'c', 'd', 'e']
paged = arr.paginate(:per_page => 2)      #->  ['a', 'b']
paged.total_entries                       #->  5
arr.paginate(:page => 2, :per_page => 2)  #->  ['c', 'd']
arr.paginate(:page => 3, :per_page => 2)  #->  ['e']

This method was originally suggested by Desi McAdam and later proved to be the most useful method of will_paginate library.

Raises:

  • (ArgumentError)

24
25
26
27
28
29
30
31
32
# File 'lib/will_paginate/array.rb', line 24

def paginate(options = {})
  raise ArgumentError, "parameter hash expected (got #{options.inspect})" unless Hash === options
  
  WillPaginate::Collection.create options[:page] || 1,
                                  options[:per_page] || 30,
                                  options[:total_entries] || self.length do |pager|
    pager.replace self[pager.offset, pager.per_page].to_a
  end
end