Parent

Included Modules

Class Index [+]

Quicksearch

Ramaze::Helper::Paginate::Paginator

Provides easy pagination and navigation

Attributes

css[R]

Public Class Methods

new(data = [], page = 1, limit = 10, var = 'pager', opts = {}) click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 116
116:         def initialize(data = [], page = 1, limit = 10, var = 'pager', opts = {})
117:           @data, @page, @limit, @var = data, page, limit, var
118:           @css = Paginate.trait[:paginate][:css].dup
119:           @css.merge!(opts[:css]) if opts[:css]
120:           @pager = pager_for(data)
121:           @page = @page > page_count ? page_count : @page
122:           @pager = pager_for(data)
123:         end

Public Instance Methods

count() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 207
207:         def count       ; @pager.count       ; end
current_page() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 202
202:         def current_page; @pager.current_page; end
each(&block) click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 199
199:         def each(&block); @pager.each(&block); end
empty?() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 206
206:         def empty?      ; @pager.empty?      ; end
first_page?() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 200
200:         def first_page? ; @pager.first_page? ; end
last_page() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 203
203:         def last_page   ; @pager.last_page   ; end
last_page?() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 204
204:         def last_page?  ; @pager.last_page?  ; end
needed?() click to toggle source

Useful to omit pager if it’s of no use.

     # File lib/ramaze/helper/paginate.rb, line 192
192:         def needed?
193:           @pager.page_count > 1
194:         end
next_page() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 205
205:         def next_page   ; @pager.next_page   ; end
page_count() click to toggle source

these methods are actually on the pager, but we def them here for convenience (method_missing in helper is evil and even slower)

     # File lib/ramaze/helper/paginate.rb, line 198
198:         def page_count  ; @pager.page_count  ; end
prev_page() click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 201
201:         def prev_page   ; @pager.prev_page   ; end

Private Instance Methods

pager_for(obj) click to toggle source
     # File lib/ramaze/helper/paginate.rb, line 211
211:         def pager_for(obj)
212:           @page = @page < 1 ? 1 : @page
213: 
214:           case obj
215:           when Array
216:             ArrayPager.new(obj, @page, @limit)
217:           when (defined?(DataMapper::Collection) and DataMapper::Collection)
218:             DataMapperPager.new(obj, @page, @limit)
219:           else
220:             obj.paginate(@page, @limit)
221:           end
222:         end

Disabled; run with --debug to generate this.

[Validate]

Generated with the Darkfish Rdoc Generator 1.1.6.