Class: ActionController::Pagination::Paginator::Page

Inherits:
Object
  • Object
show all
Includes:
Comparable
Defined in:
lib/action_controller/pagination.rb

Overview

A class representing a single page in a paginator.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(paginator, number) ⇒ Page

Creates a new Page for the given paginator with the index number. If number is not in the range of valid page numbers or is not a number at all, it defaults to 1.



290
291
292
293
294
 
# File 'lib/action_controller/pagination.rb', line 290

def initialize(paginator, number)
  @paginator = paginator
  @number = number.to_i
  @number = 1 unless @paginator.has_page_number? @number
end

Instance Attribute Details

#number ⇒ Object (readonly) Also known as: to_i

Returns the value of attribute number.



295
296
297
 
# File 'lib/action_controller/pagination.rb', line 295

def number
  @number
end

#paginator ⇒ Object (readonly)

Returns the value of attribute paginator.



295
296
297
 
# File 'lib/action_controller/pagination.rb', line 295

def paginator
  @paginator
end

Instance Method Details

#<=>(page) ⇒ Object

Compares two Page objects and returns -1 if the left-hand page comes before the right-hand page, 0 if the pages are equal, and 1 if the left-hand page comes after the right-hand page. Raises ArgumentError if the pages do not belong to the same Paginator object.

Raises:

  • (ArgumentError) 


311
312
313
314
 
# File 'lib/action_controller/pagination.rb', line 311

def <=>(page)
  raise ArgumentError unless @paginator == page.paginator
  @number <=> page.number
end

#==(page) ⇒ Object

Compares two Page objects and returns true when they represent the same page (i.e., their paginators are the same and they have the same page number).



301
302
303
304
305
 
# File 'lib/action_controller/pagination.rb', line 301

def ==(page)
  return false if page.nil?
  @paginator == page.paginator and 
    @number == page.number
end

#first? ⇒ Boolean

Returns true if this page is the first page in the paginator.

Returns:

  • (Boolean) 


332
333
334
 
# File 'lib/action_controller/pagination.rb', line 332

def first?
  self == @paginator.first
end

#first_item ⇒ Object

Returns the number of the first item displayed.



322
323
324
 
# File 'lib/action_controller/pagination.rb', line 322

def first_item
  offset + 1
end

#last? ⇒ Boolean

Returns true if this page is the last page in the paginator.

Returns:

  • (Boolean) 


337
338
339
 
# File 'lib/action_controller/pagination.rb', line 337

def last?
  self == @paginator.last
end

#last_item ⇒ Object

Returns the number of the last item displayed.



327
328
329
 
# File 'lib/action_controller/pagination.rb', line 327

def last_item
  [@paginator.items_per_page * @number, @paginator.item_count].min
end

#next ⇒ Object

Returns a new Page object representing the page just after this page, or nil if this is the last page.



349
350
351
 
# File 'lib/action_controller/pagination.rb', line 349

def next
  if last? then nil else @paginator[@number + 1] end
end

#offset ⇒ Object

Returns the item offset for the first item in this page.



317
318
319
 
# File 'lib/action_controller/pagination.rb', line 317

def offset
  @paginator.items_per_page * (@number - 1)
end

#previous ⇒ Object

Returns a new Page object representing the page just before this page, or nil if this is the first page.



343
344
345
 
# File 'lib/action_controller/pagination.rb', line 343

def previous
  if first? then nil else @paginator[@number - 1] end
end

#to_param ⇒ Object

:nodoc:



364
365
366
 
# File 'lib/action_controller/pagination.rb', line 364

def to_param #:nodoc:
  @number.to_s
end

#to_sql ⇒ Object

Returns the limit/offset array for this page.



360
361
362
 
# File 'lib/action_controller/pagination.rb', line 360

def to_sql
  [@paginator.items_per_page, offset]
end

#window(padding = 2) ⇒ Object

Returns a new Window object for this page with the specified padding.



355
356
357
 
# File 'lib/action_controller/pagination.rb', line 355

def window(padding=2)
  Window.new(self, padding)
end