Module: Blacklight::SearchFields

Extended by:
ActiveSupport::Concern
Included in:
Blacklight, SolrHelper
Defined in:
lib/blacklight/search_fields.rb

Overview

Module to deal with accessing (and setting some defaults) in an array of hashes that describe Blacklight search fields. Requires the base class this module is added to implements a #blacklight_config method that returns a hash, where blacklight_config will be an array of hashes describing search fields.

Search Field blacklight_configuration Hash =

:key

“title”, required, unique key used in search URLs to specify search_field

:label

“Title”, # user-displayable label, optional, if not supplied :key.titlecase will be used

:qt

“search”, # Solr qt param, request handler, usually can be left blank; defaults to blacklight_config[:qt] if not specified.

:solr_parameters

=> “something” # optional hash of additional parameters to pass to solr for searches on this field.

:solr_local_parameters

=> “$something” # optional hash of additional parameters that will be passed using Solr LocalParams syntax, that can use dollar sign to reference other solr variables.

:include_in_simple_select

false. Defaults to true, but you can set to false to have a search field defined for deep-links or BL extensions, but not actually included in the HTML select for simple search choice.

Optionally you can supply a :key, which is what Blacklight will use to identify this search field in HTTP query params. If no :key is supplied, one will be computed from the :label. If that will result in a collision of keys, you should supply one explicitly.

Instance Method Summary (collapse)

Instance Method Details

- (Object) default_search_field

Returns default search field, used for simpler display in history, etc. if not set in blacklight_config, defaults to first field listed in #search_field_list



58
59
60
 
# File 'lib/blacklight/search_fields.rb', line 58

def default_search_field
  blacklight_config.default_search_field || search_field_list.first
end

- (Object) label_for_search_field(key)

Shortcut for commonly needed operation, look up display label for the key specified. Returns “Keyword” if a label can't be found.



65
66
67
68
69
70
71
72
 
# File 'lib/blacklight/search_fields.rb', line 65

def label_for_search_field(key)
  field_def = search_field_def_for_key(key)
  if field_def && field_def.label
     field_def.label
  else
     I18n.t('blacklight.search.fields.default')
  end            
end

- (Object) search_field_def_for_key(key)

Looks up a search field blacklight_config hash from search_field_list having a certain supplied :key.



52
53
54
 
# File 'lib/blacklight/search_fields.rb', line 52

def search_field_def_for_key(key)
  blacklight_config.search_fields[key]
end

- (Object) search_field_list

Looks up search field config list from blacklight_config, and 'normalizes' all field config hashes using normalize_config method.



37
38
39
 
# File 'lib/blacklight/search_fields.rb', line 37

def search_field_list
  blacklight_config.search_fields.values
end

- (Object) search_field_options_for_select

Returns suitable argument to options_for_select method, to create an html select based on #search_field_list. Skips search_fields marked :include_in_simple_select => false



44
45
46
47
48
 
# File 'lib/blacklight/search_fields.rb', line 44

def search_field_options_for_select
  blacklight_config.search_fields.collect do |key, field_def|
    [field_def.label,  field_def.key] unless field_def.include_in_simple_select == false
  end.compact
end