pagination.rb
244 lines
| 7.4 KiB
| text/x-ruby
|
RubyLexer
Jean-Philippe Lang
|
r10797 | # encoding: utf-8 | ||
| # | ||||
| # Redmine - project management software | ||||
| # Copyright (C) 2006-2012 Jean-Philippe Lang | ||||
| # | ||||
| # This program is free software; you can redistribute it and/or | ||||
| # modify it under the terms of the GNU General Public License | ||||
| # as published by the Free Software Foundation; either version 2 | ||||
| # of the License, or (at your option) any later version. | ||||
| # | ||||
| # This program is distributed in the hope that it will be useful, | ||||
| # but WITHOUT ANY WARRANTY; without even the implied warranty of | ||||
| # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | ||||
| # GNU General Public License for more details. | ||||
| # | ||||
| # You should have received a copy of the GNU General Public License | ||||
| # along with this program; if not, write to the Free Software | ||||
| # Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. | ||||
| module Redmine | ||||
| module Pagination | ||||
| class Paginator | ||||
| attr_reader :item_count, :per_page, :page, :page_param | ||||
| def initialize(*args) | ||||
| if args.first.is_a?(ActionController::Base) | ||||
| args.shift | ||||
| ActiveSupport::Deprecation.warn "Paginator no longer takes a controller instance as the first argument. Remove it from #new arguments." | ||||
| end | ||||
| item_count, per_page, page, page_param = *args | ||||
| @item_count = item_count | ||||
| @per_page = per_page | ||||
| page = (page || 1).to_i | ||||
| if page < 1 | ||||
| page = 1 | ||||
| end | ||||
| @page = page | ||||
| @page_param = page_param || :page | ||||
| end | ||||
| def offset | ||||
| (page - 1) * per_page | ||||
| end | ||||
| def first_page | ||||
| if item_count > 0 | ||||
| 1 | ||||
| end | ||||
| end | ||||
| def previous_page | ||||
| if page > 1 | ||||
| page - 1 | ||||
| end | ||||
| end | ||||
| def next_page | ||||
| if last_item < item_count | ||||
| page + 1 | ||||
| end | ||||
| end | ||||
| def last_page | ||||
| if item_count > 0 | ||||
| (item_count - 1) / per_page + 1 | ||||
| end | ||||
| end | ||||
| def first_item | ||||
| item_count == 0 ? 0 : (offset + 1) | ||||
| end | ||||
| def last_item | ||||
| l = first_item + per_page - 1 | ||||
| l > item_count ? item_count : l | ||||
| end | ||||
| def linked_pages | ||||
| pages = [] | ||||
| if item_count > 0 | ||||
| pages += [first_page, page, last_page] | ||||
| pages += ((page-2)..(page+2)).to_a.select {|p| p > first_page && p < last_page} | ||||
| end | ||||
| pages = pages.compact.uniq.sort | ||||
| if pages.size > 1 | ||||
| pages | ||||
| else | ||||
| [] | ||||
| end | ||||
| end | ||||
| def items_per_page | ||||
| ActiveSupport::Deprecation.warn "Paginator#items_per_page will be removed. Use #per_page instead." | ||||
| per_page | ||||
| end | ||||
| def current | ||||
| ActiveSupport::Deprecation.warn "Paginator#current will be removed. Use .offset instead of .current.offset." | ||||
| self | ||||
| end | ||||
| end | ||||
| # Paginates the given scope or model. Returns a Paginator instance and | ||||
| # the collection of objects for the current page. | ||||
| # | ||||
| # Options: | ||||
| # :parameter name of the page parameter | ||||
| # | ||||
| # Examples: | ||||
| # @user_pages, @users = paginate User.where(:status => 1) | ||||
| # | ||||
| def paginate(scope, options={}) | ||||
| options = options.dup | ||||
| finder_options = options.extract!( | ||||
| :conditions, | ||||
| :order, | ||||
| :joins, | ||||
| :include, | ||||
| :select | ||||
| ) | ||||
| if scope.is_a?(Symbol) || finder_options.values.compact.any? | ||||
| return deprecated_paginate(scope, finder_options, options) | ||||
| end | ||||
| paginator = paginator(scope.count, options) | ||||
| collection = scope.limit(paginator.per_page).offset(paginator.offset).to_a | ||||
| return paginator, collection | ||||
| end | ||||
| def deprecated_paginate(arg, finder_options, options={}) | ||||
| ActiveSupport::Deprecation.warn "#paginate with a Symbol and/or find options is depreceted and will be removed. Use a scope instead." | ||||
| klass = arg.is_a?(Symbol) ? arg.to_s.classify.constantize : arg | ||||
| scope = klass.scoped(finder_options) | ||||
| paginate(scope, options) | ||||
| end | ||||
| def paginator(item_count, options={}) | ||||
| options.assert_valid_keys :parameter, :per_page | ||||
| page_param = options[:parameter] || :page | ||||
| page = (params[page_param] || 1).to_i | ||||
| per_page = options[:per_page] || per_page_option | ||||
|
Jean-Philippe Lang
|
r10909 | Paginator.new(item_count, per_page, page, page_param) | ||
|
Jean-Philippe Lang
|
r10797 | end | ||
| module Helper | ||||
| include Redmine::I18n | ||||
| # Renders the pagination links for the given paginator. | ||||
| # | ||||
| # Options: | ||||
| # :per_page_links if set to false, the "Per page" links are not rendered | ||||
| # | ||||
|
Jean-Philippe Lang
|
r10800 | def pagination_links_full(*args) | ||
|
Jean-Philippe Lang
|
r10832 | pagination_links_each(*args) do |text, parameters, options| | ||
|
Jean-Philippe Lang
|
r10800 | if block_given? | ||
|
Jean-Philippe Lang
|
r10832 | yield text, parameters, options | ||
|
Jean-Philippe Lang
|
r10800 | else | ||
|
Jean-Philippe Lang
|
r10832 | link_to text, params.merge(parameters), options | ||
|
Jean-Philippe Lang
|
r10800 | end | ||
| end | ||||
| end | ||||
| # Yields the given block with the text and parameters | ||||
| # for each pagination link and returns a string that represents the links | ||||
| def pagination_links_each(paginator, count=nil, options={}, &block) | ||||
|
Jean-Philippe Lang
|
r10797 | options.assert_valid_keys :per_page_links | ||
| per_page_links = options.delete(:per_page_links) | ||||
| per_page_links = false if count.nil? | ||||
| page_param = paginator.page_param | ||||
| html = '' | ||||
| if paginator.previous_page | ||||
| # \xc2\xab(utf-8) = « | ||||
|
Jean-Philippe Lang
|
r10832 | text = "\xc2\xab " + l(:label_previous) | ||
| html << yield(text, {page_param => paginator.previous_page}, :class => 'previous') + ' ' | ||||
|
Jean-Philippe Lang
|
r10797 | end | ||
| previous = nil | ||||
| paginator.linked_pages.each do |page| | ||||
| if previous && previous != page - 1 | ||||
|
Jean-Philippe Lang
|
r10832 | html << content_tag('span', '...', :class => 'spacer') + ' ' | ||
|
Jean-Philippe Lang
|
r10797 | end | ||
| if page == paginator.page | ||||
|
Jean-Philippe Lang
|
r10832 | html << content_tag('span', page.to_s, :class => 'current page') | ||
|
Jean-Philippe Lang
|
r10797 | else | ||
|
Jean-Philippe Lang
|
r10832 | html << yield(page.to_s, {page_param => page}, :class => 'page') | ||
|
Jean-Philippe Lang
|
r10797 | end | ||
| html << ' ' | ||||
| previous = page | ||||
| end | ||||
| if paginator.next_page | ||||
| # \xc2\xbb(utf-8) = » | ||||
|
Jean-Philippe Lang
|
r10832 | text = l(:label_next) + " \xc2\xbb" | ||
| html << yield(text, {page_param => paginator.next_page}, :class => 'next') + ' ' | ||||
|
Jean-Philippe Lang
|
r10797 | end | ||
|
Jean-Philippe Lang
|
r10832 | html << content_tag('span', "(#{paginator.first_item}-#{paginator.last_item}/#{paginator.item_count})", :class => 'items') + ' ' | ||
|
Jean-Philippe Lang
|
r10797 | |||
|
Jean-Philippe Lang
|
r10803 | if per_page_links != false && links = per_page_links(paginator, &block) | ||
|
Jean-Philippe Lang
|
r10832 | html << content_tag('span', links.to_s, :class => 'per-page') | ||
|
Jean-Philippe Lang
|
r10797 | end | ||
| html.html_safe | ||||
| end | ||||
| # Renders the "Per page" links. | ||||
|
Jean-Philippe Lang
|
r10803 | def per_page_links(paginator, &block) | ||
| values = per_page_options(paginator.per_page, paginator.item_count) | ||||
|
Jean-Philippe Lang
|
r10802 | if values.any? | ||
| links = values.collect do |n| | ||||
|
Jean-Philippe Lang
|
r10832 | if n == paginator.per_page | ||
| content_tag('span', n.to_s) | ||||
| else | ||||
| yield(n, :per_page => n, paginator.page_param => nil) | ||||
| end | ||||
|
Jean-Philippe Lang
|
r10802 | end | ||
|
Jean-Philippe Lang
|
r10832 | l(:label_display_per_page, links.join(', ')).html_safe | ||
|
Jean-Philippe Lang
|
r10802 | end | ||
| end | ||||
| def per_page_options(selected=nil, item_count=nil) | ||||
| options = Setting.per_page_options_array | ||||
| if item_count && options.any? | ||||
| if item_count > options.first | ||||
| max = options.detect {|value| value >= item_count} || item_count | ||||
|
Jean-Philippe Lang
|
r10797 | else | ||
| max = item_count | ||||
| end | ||||
|
Jean-Philippe Lang
|
r10802 | options = options.select {|value| value <= max || value == selected} | ||
|
Jean-Philippe Lang
|
r10797 | end | ||
|
Jean-Philippe Lang
|
r10802 | if options.empty? || (options.size == 1 && options.first == selected) | ||
| [] | ||||
| else | ||||
| options | ||||
|
Jean-Philippe Lang
|
r10797 | end | ||
| end | ||||
| end | ||||
| end | ||||
| end | ||||