Module: Searchlogic::RailsHelpers

Defined in:
lib/searchlogic/rails_helpers.rb

Instance Method Summary (collapse)

Instance Method Details

- (Object) fields_for(*args, &block)

Automatically adds an “order” hidden field in your form to preserve how the data is being ordered.



69
70
71
72
73
74
75
76
77
78
79
80
81
# File 'lib/searchlogic/rails_helpers.rb', line 69

def fields_for(*args, &block)
  if search_obj = args.find { |arg| arg.is_a?(Searchlogic::Search) }
    args.unshift(:search) if args.first == search_obj
    options = args.extract_options!
    if !options[:skip_order_field]
      concat(("div", hidden_field_tag("#{args.first}[order]", search_obj.order), :style => "display: inline"))
    end
    args << options
    super
  else
    super
  end
end

- (Object) form_for(*args, &block)

Automatically makes the form method :get if a Searchlogic::Search and sets the params scope to :search



55
56
57
58
59
60
61
62
63
64
65
# File 'lib/searchlogic/rails_helpers.rb', line 55

def form_for(*args, &block)
  if search_obj = args.find { |arg| arg.is_a?(Searchlogic::Search) }
    options = args.extract_options!
    options[:html] ||= {}
    options[:html][:method] ||= :get
    options[:url] ||= url_for
    args.unshift(:search) if args.first == search_obj
    args << options
  end
  super
end

- (Object) order(search, options = {}, html_options = {})

Creates a link that alternates between acending and descending. It basically alternates between calling 2 named scopes: “ascend_by_*” and “descend_by_*”

By default Searchlogic gives you these named scopes for all of your columns, but if you wanted to create your own, it will work with those too.

Examples:

order @search, :by => :username
order @search, :by => :created_at, :as => "Created"

This helper accepts the following options:

  • :by - the name of the named scope. This helper will prepend this value with “ascend_by_” and “descend_by_”

  • :as - the text used in the link, defaults to whatever is passed to :by

  • :ascend_scope - what scope to call for ascending the data, defaults to “ascend_by_:by”

  • :descend_scope - what scope to call for descending the data, defaults to “descend_by_:by”

  • :params - hash with additional params which will be added to generated url

  • :params_scope - the name of the params key to scope the order condition by, defaults to :search



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
# File 'lib/searchlogic/rails_helpers.rb', line 22

def order(search, options = {}, html_options = {})
  options[:params_scope] ||= :search
  if !options[:as]
    id = options[:by].to_s.downcase == "id"
    options[:as] = id ? options[:by].to_s.upcase : options[:by].to_s.humanize
  end
  options[:ascend_scope] ||= "ascend_by_#{options[:by]}"
  options[:descend_scope] ||= "descend_by_#{options[:by]}"
  ascending = search.order.to_s == options[:ascend_scope]
  new_scope = ascending ? options[:descend_scope] : options[:ascend_scope]
  selected = [options[:ascend_scope], options[:descend_scope]].include?(search.order.to_s)
  if selected
    css_classes = html_options[:class] ? html_options[:class].split(" ") : []
    if ascending
      options[:as] = "&#9650;&nbsp;#{options[:as]}"
      css_classes << "ascending"
    else
      options[:as] = "&#9660;&nbsp;#{options[:as]}"
      css_classes << "descending"
    end
    html_options[:class] = css_classes.join(" ")
  end
  url_options = {
    options[:params_scope] => search.conditions.merge( { :order => new_scope } )
  }.deep_merge(options[:params] || {})

  options[:as] = raw(options[:as]) if defined?(RailsXss)

  link_to options[:as], url_for(url_options), html_options
end