Class: WillPaginate::LinkRenderer

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

Overview

This class does the heavy lifting of actually building the pagination links. It is used by the will_paginate helper internally.

Instance Method Summary collapse

Instance Method Details

#html_attributes ⇒ Object

Returns the subset of options this instance was initialized with that represent HTML attributes for the container element of pagination links.



229
230
231
232
233
234
235
236
237
 
# File 'lib/will_paginate/view_helpers.rb', line 229

def html_attributes
  return @html_attributes if @html_attributes
  @html_attributes = @options.except *(WillPaginate::ViewHelpers.pagination_options.keys - [:class])
  # pagination of Post models will have the ID of "posts_pagination"
  if @options[:container] and @options[:id] === true
    @html_attributes[:id] = @collection.first.class.name.underscore.pluralize + '_pagination'
  end
  @html_attributes
end

#prepare(collection, options, template) ⇒ Object

  • collection is a WillPaginate::Collection instance or any other object that conforms to that API

  • options are forwarded from will_paginate view helper

  • template is the reference to the template being rendered



205
206
207
208
209
210
211
212
 
# File 'lib/will_paginate/view_helpers.rb', line 205

def prepare(collection, options, template)
  @collection = collection
  @options    = options
  @template   = template

  # reset values in case we're re-using this instance
  @total_pages = @param_name = @url_string = nil
end

#to_html ⇒ Object

Process it! This method returns the complete HTML string which contains pagination links. Feel free to subclass LinkRenderer and change this method as you see fit.



217
218
219
220
221
222
223
224
225
 
# File 'lib/will_paginate/view_helpers.rb', line 217

def to_html
  links = @options[:page_links] ? windowed_links : []
  # previous/next buttons
  links.unshift page_link_or_span(@collection.previous_page, 'disabled prev_page', @options[:previous_label])
  links.push    page_link_or_span(@collection.next_page,     'disabled next_page', @options[:next_label])
  
  html = links.join(@options[:separator])
  @options[:container] ? @template.content_tag(:div, html, html_attributes) : html
end