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
-
#per_page ⇒ Object
Returns the value of attribute per_page.
-
#start ⇒ Object
Returns the value of attribute start.
-
#total ⇒ Object
Returns the value of attribute total.
Instance Method Summary collapse
-
#current_page ⇒ Object
Returns the current page calculated from ‘rows’ and ‘start’.
- #has_next? ⇒ Boolean
- #has_previous? ⇒ Boolean
-
#next_page ⇒ Object
returns the next page number or the last.
-
#previous_page ⇒ Object
returns the previous page number or 1.
-
#total_pages ⇒ Object
Calcuates the total pages from ‘numFound’ and ‘rows’.
Instance Attribute Details
#per_page ⇒ Object
Returns the value of attribute per_page.
17 18 19 |
# File 'lib/rsolr/response.rb', line 17 def per_page @per_page end |
#start ⇒ Object
Returns the value of attribute start.
17 18 19 |
# File 'lib/rsolr/response.rb', line 17 def start @start end |
#total ⇒ Object
Returns the value of attribute total.
17 18 19 |
# File 'lib/rsolr/response.rb', line 17 def total @total end |
Instance Method Details
#current_page ⇒ Object
Returns the current page calculated from ‘rows’ and ‘start’
20 21 22 23 24 |
# File 'lib/rsolr/response.rb', line 20 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
41 42 43 |
# File 'lib/rsolr/response.rb', line 41 def has_next? current_page < total_pages end |
#has_previous? ⇒ Boolean
45 46 47 |
# File 'lib/rsolr/response.rb', line 45 def has_previous? current_page > 1 end |
#next_page ⇒ Object
returns the next page number or the last
37 38 39 |
# File 'lib/rsolr/response.rb', line 37 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
32 33 34 |
# File 'lib/rsolr/response.rb', line 32 def previous_page @previous_page ||= (current_page > 1) ? current_page - 1 : 1 end |
#total_pages ⇒ Object
Calcuates the total pages from ‘numFound’ and ‘rows’
27 28 29 |
# File 'lib/rsolr/response.rb', line 27 def total_pages @total_pages ||= per_page > 0 ? (total / per_page.to_f).ceil : 1 end |