Module: Blacklight::Searchable
- Extended by:
- ActiveSupport::Concern
- Included in:
- Catalog
- Defined in:
- app/controllers/concerns/blacklight/searchable.rb
Overview
The Searchable module can be included onto classes that need to initialize a SearchService. There are three dependencies you must provide on the including class. Typically these would be provided by Blacklight::Controller
1. search_state
2. blacklight_config
Additionally, the including class may override the search_service_context method to provide further context to the SearchService. For example you could override this to provide the currently signed in user.
Instance Method Summary collapse
- #search_service ⇒ Blacklight::SearchService
-
#search_service_context ⇒ Hash
Override this method on the class that includes Blacklight::Searchable to provide more context to the search service if necessary.
- #suggestions_service ⇒ Blacklight::SuggestSearch
Instance Method Details
#search_service ⇒ Blacklight::SearchService
23 24 25 |
# File 'app/controllers/concerns/blacklight/searchable.rb', line 23 def search_service search_service_class.new(config: blacklight_config, search_state: search_state, user_params: search_state.to_h, **search_service_context) end |
#search_service_context ⇒ Hash
Override this method on the class that includes Blacklight::Searchable to provide more context to the search service if necessary. For example, if your search builder needs to be aware of the current user, override this method to return a hash including the current user. Then the search builder could use some property about the current user to construct a constraint on the search.
31 32 33 |
# File 'app/controllers/concerns/blacklight/searchable.rb', line 31 def search_service_context {} end |
#suggestions_service ⇒ Blacklight::SuggestSearch
36 37 38 |
# File 'app/controllers/concerns/blacklight/searchable.rb', line 36 def suggestions_service Blacklight::SuggestSearch.new(params, search_service.repository).suggestions end |