Module: RSolr::Response::PaginatedDocSet

Defined in:
lib/rsolr/response.rb

Overview

A response module which gets mixed into the solr [“response”] array.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#page_start ⇒ Object Also known as: start

Returns the value of attribute page_start.



25
26
27
 
# File 'lib/rsolr/response.rb', line 25

def page_start
  @page_start
end

#page_total ⇒ Object Also known as: total

Returns the value of attribute page_total.



25
26
27
 
# File 'lib/rsolr/response.rb', line 25

def page_total
  @page_total
end

#per_page ⇒ Object

Returns the value of attribute per_page.



25
26
27
 
# File 'lib/rsolr/response.rb', line 25

def per_page
  @per_page
end

Instance Method Details

#current_page ⇒ Object

Returns the current page calculated from ‘rows’ and ‘start’



34
35
36
37
38
 
# File 'lib/rsolr/response.rb', line 34

def current_page
  return 1 if start < 1
  per_page_normalized = per_page < 1 ? 1 : per_page
  @current_page ||= (start / per_page_normalized).ceil + 1
end

#has_next? ⇒ Boolean

Returns:

  • (Boolean) 


55
56
57
 
# File 'lib/rsolr/response.rb', line 55

def has_next?
  current_page < total_pages
end

#has_previous? ⇒ Boolean

Returns:

  • (Boolean) 


59
60
61
 
# File 'lib/rsolr/response.rb', line 59

def has_previous?
  current_page > 1
end

#next_page ⇒ Object

returns the next page number or the last



51
52
53
 
# File 'lib/rsolr/response.rb', line 51

def next_page
  @next_page ||= (current_page == total_pages) ? total_pages : current_page+1
end

#previous_page ⇒ Object

returns the previous page number or 1



46
47
48
 
# File 'lib/rsolr/response.rb', line 46

def previous_page
  @previous_page ||= (current_page > 1) ? current_page - 1 : 1
end

#total_pages ⇒ Object

Calcuates the total pages from ‘numFound’ and ‘rows’



41
42
43
 
# File 'lib/rsolr/response.rb', line 41

def total_pages
  @total_pages ||= per_page > 0 ? (total / per_page.to_f).ceil : 1
end