VuFind Documentation

This page is read only. You can view the source, but not change it. Ask your administrator if you think this is wrong.
====== Search Objects ======

This page describes plugins that are used during the search process. See the [[development:architecture:data_model_key_concepts|Data Model / Key Concepts]] page for additional background.

===== Options =====

**Interface:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Search/Base/Options.php|\VuFind\Search\Base\Options]]

**Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['search_options']

**Service Manager Name for Service Locator:** VuFind\SearchOptionsPluginManager (VuFind® 2.x-4.x), VuFind\Search\Options\PluginManager (VuFind® 5.0+)

See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.

===== Params =====

**Interface:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Search/Base/Params.php|\VuFind\Search\Base\Params]]

**Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['search_params']

**Service Manager Name for Service Locator:** VuFind\SearchParamsPluginManager (VuFind® 2.x-4.x), VuFind\Search\Params\PluginManager (VuFind® 5.0+)

See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.

===== Results =====

**Interface:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Search/Base/Results.php|\VuFind\Search\Base\Results]]

**Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['search_results']

**Service Manager Name for Service Locator:** VuFind\SearchResultsPluginManager (VuFind® 2.x-4.x), VuFind\Search\Results\PluginManager (VuFind® 5.0+)

See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.

===== FacetCache =====

The FacetCache plugins were introduced in VuFind® 5.0; these provide a plugin mechanism for retrieving and caching lists of facet values (for use on home pages and advanced search forms).

**Interface:** [[https://github.com/vufind-org/vufind/blob/dev/module/VuFind/src/VuFind/Search/Base/FacetCache.php|\VuFind\Search\Base\FacetCache]]

**Service Locator Configuration Section in module.config.php:** ['vufind']['plugin_managers']['search_facetcache']

**Service Manager Name for Service Locator:** VuFind\Search\FacetCache\PluginManager

See the [[development:plugins:general_information|General Plugin Information]] page for more details on VuFind® plugins.