Search
Packages
- Base
- Blender
- BrowZine
- SolrAuth
- EIT
- EBSCO
- Tags
- EmptySet
- Factory
- Favorites
- LibGuides
- MixedList
- Pazpar2
- Primo
- Solr
- Search2
- SolrAuthor
- SolrAuthorFacets
- SolrReserves
- SolrWeb
- Summon
- WorldCat
Interfaces, Classes, Traits and Enums
- BackendInterface
- Search backend interface definition.
- ConnectorInterface
- Primo Central connector interface.
- DocumentInterface
- Interface for Solr document classes
- QueryBuilderInterface
- SOLR QueryBuilder interface definition.
- SerializableRecordInterface
- SOLR serializable record interface definition.
- SimilarBuilderInterface
- SOLR SimilarBuilder interface definition.
- CommandInterface
- Command interface definition.
- ExceptionInterface
- Marker interface.
- ExtraRequestDetailsInterface
- Optional backend feature: Get more information about requests.
- GetIdsInterface
- Optional backend feature: Get identifiers of records.
- RandomInterface
- Random record retrieval feature interface definition.
- RetrieveBatchInterface
- Optional backend feature: retrieve batch of records.
- SimilarInterface
- MLT feature interface definition.
- QueryInterface
- Common methods that must be shared by all query objects.
- BackendManager
- Manager for search backends.
- BackendManagerFactory
- Search Backend Manager factory.
- BackendRegistry
- Registry for search backends.
- HideFacetValueListener
- Hide single facet values from displaying.
- OptionsFactory
- Factory for Combined search Options.
- ExplanationFactory
- Generic factory for explanation objects.
- PluginManager
- Explanation plugin manager
- PluginManager
- Facet cache plugin manager
- AbstractBackendFactory
- Abstract factory for backends.
- AbstractSolrBackendFactory
- Abstract factory for SOLR backends.
- BlenderBackendFactory
- Factory for Blender backend.
- BrowZineBackendFactory
- Factory for BrowZine backend.
- EdsBackendFactory
- Factory for EDS backends.
- EITBackendFactory
- Factory for EIT backends.
- EPFBackendFactory
- Factory for EDS backends used for EPF.
- LibGuidesAZBackendFactory
- Factory for LibGuides A-Z Databases backends.
- LibGuidesBackendFactory
- Factory for LibGuides backends.
- Pazpar2BackendFactory
- Factory for Pazpar2 backends.
- PrimoBackendFactory
- Factory for Primo Central backends.
- SolrAuthBackendFactory
- Factory for the authority SOLR backend.
- SolrDefaultBackendFactory
- Factory for the default SOLR backend.
- SolrReservesBackendFactory
- Factory for the reserves SOLR backend.
- SolrWebBackendFactory
- Factory for the website SOLR backend.
- SummonBackendFactory
- Factory for Summon backends.
- UrlQueryHelperFactory
- Factory to build UrlQueryHelper.
- WorldCatBackendFactory
- Factory for WorldCat backends.
- History
- VuFind Search History Helper
- HistoryFactory
- Search history factory.
- Memory
- Wrapper class to handle search memory
- MemoryFactory
- Search memory factory.
- Minified
- A minified search object used exclusively for trimming a search object down to its barest minimum size before storage in a cookie or database.
- minSO
- This non-namespaced class exists to keep serialized search objects small by using an abbreviated name. Unfortunately, the name does not comply with coding standards, but we cannot easily change it due to legacy compatibility issues.
- NormalizedSearch
- Normalized search object.
- OptionsFactory
- Generic factory for search options objects.
- PluginFactory
- Search options plugin factory
- PluginManager
- Search options plugin manager
- ParamsFactory
- Generic factory for search params objects.
- PluginFactory
- Search params plugin factory
- PluginManager
- Search params plugin manager
- InjectOnCampusListener
- OnCampus listener.
- PrimoPermissionHandler
- Primo Permission Handler.
- RecommendListener
- Recommend listener.
- PluginFactory
- Search results plugin factory
- PluginManager
- Search results plugin manager
- ResultsFactory
- Generic factory for search results objects.
- SearchNormalizer
- Search normalizer.
- SearchNormalizerFactory
- Search normalizer factory.
- SearchRunner
- VuFind Search Runner
- SearchRunnerFactory
- Search runner factory.
- SearchTabsHelperFactory
- Search tabs helper factory.
- AbstractErrorListener
- Abstract base class of SOLR error listeners.
- CustomFilterListener
- Solr custom filter listener.
- DeduplicationListener
- Solr merged record handling listener.
- DefaultParametersListener
- Solr default parameters listener.
- FilterFieldConversionListener
- Listener to convert one field to another in filters (for legacy purposes).
- HierarchicalFacetHelper
- Functions for manipulating facets
- HierarchicalFacetHelperFactory
- Class HierarchicalFacetHelperFactory
- HierarchicalFacetListener
- Solr hierarchical facet handling listener.
- InjectConditionalFilterListener
- Conditional Filter listener.
- InjectHighlightingListener
- Solr highlighting listener.
- InjectSpellingListener
- Solr spelling listener.
- MultiIndexListener
- MultiIndex listener class file.
- ErrorListener
- SOLR 3.x error listener.
- ErrorListener
- SOLR 3.x error listener.
- UrlQueryHelper
- Class to help build URLs and forms in the view based on search settings.
- AbstractIdFetcher
- Abstract helper to get IDs for a sitemap from a backend (if supported).
- CursorMarkIdFetcher
- Plugin to get IDs for a sitemap from a backend using cursor marks (if supported).
- TermsIdFetcher
- Plugin to get IDs for a sitemap from a backend using terms (if supported).
- WriterFactory
- Solr writer factory.
- LibGuidesTest
- Unit tests for Wikipedia connector.
- WikipediaTest
- Unit tests for Wikipedia connector.
- HideFacetValueListenerTest
- Unit tests for Hide Facet Value Listener.
- OnCampusListenerTest
- Unit tests for OnCampus listener.
- ParamsTest
- Unit tests for Primo Params.
- PrimoPermissionHandlerTest
- Unit tests for Primo Permission Handler.
- ConditionalFilterListenerTest
- Unit tests for Conditional Filter listener.
- CustomFilterListenerTest
- Unit tests for Custom Filter Listener.
- DefaultParametersListenerTest
- Unit tests for DefaultParametersListener.
- ExplanationTest
- Unit tests for Explanation.
- FilterFieldConversionListenerTest
- Unit tests for FilterFieldConversionListener.
- HierarchicalFacetHelperTest
- Unit tests for Hierarchical Facet Helper.
- InjectHighlightingListenerTest
- Unit tests for inject highlighting listener.
- MultiIndexListenerTest
- Unit tests for multiindex listener.
- SpellingProcessorTest
- Unit tests for spelling processor.
- ErrorListenerTest
- Unit tests for SOLR 3.x error listener.
- ErrorListenerTest
- Unit tests for SOLR 3.x error listener.
- SocialstatsControllerTest
- Unit tests for Socialstats controller.
- DevtoolsControllerTest
- Unit tests for DevTools controller.
- LanguageHelperTest
- Unit tests for language helper.
- Module
- Code module containing the VuFind search service.
- AbstractBackend
- Abstract backend.
- AbstractHandlerMap
- Base class for search backend handler maps.
- Backend
- Blender backend.
- RecordCollection
- JSON-based record collection for records from multiple sources.
- Backend
- BrowZine backend.
- LookupDoiCommand
- Command to look up a DOI in the BrowZine backend.
- LookupIssnsCommand
- Command to look up ISSNs in the BrowZine backend.
- Connector
- BrowZine connector.
- QueryBuilder
- BrowZine QueryBuilder.
- RecordCollection
- BrowZine record collection.
- RecordCollectionFactory
- Simple factory for record collection.
- Backend
- EDS API Backend
- AutocompleteCommand
- Get autocomplete results from the EDS backend
- GetInfoCommand
- Get information from the EDS backend
- QueryBuilder
- EDS API Querybuilder
- RecordCollection
- EDS API record collection.
- RecordCollectionFactory
- Factory for record collection.
- Backend
- EIT backend.
- QueryBuilder
- EIT QueryBuilder.
- RecordCollection
- EIT record collection.
- RecordCollectionFactory
- Simple XML-based factory for record collection.
- BackendException
- BackendException.
- DeepPagingException
- Exception for paging too deep into search results.
- HttpErrorException
- HTTP error exception.
- RemoteErrorException
- RemoteErrorException.
- RequestErrorException
- RequestErrorException.
- Backend
- LibGuides backend.
- Connector
- LibGuides connector.
- QueryBuilder
- LibGuides QueryBuilder.
- RecordCollection
- WorldCat record collection.
- RecordCollectionFactory
- Simple factory for record collection.
- Backend
- Pazpar2 backend.
- QueryBuilder
- Pazpar2 QueryBuilder.
- Record
- Simple Pazpar2 record.
- RecordCollection
- Pazpar2 record collection.
- RecordCollectionFactory
- Simple factory for record collection.
- Backend
- Primo Central backend.
- Connector
- Primo Central connector.
- QueryBuilder
- Primo Central QueryBuilder.
- RecordCollection
- Primo Central record collection.
- RecordCollectionFactory
- Simple factory for record collection.
- RestConnector
- Primo Central connector (REST API).
- Backend
- SOLR backend.
- WriteDocumentCommand
- Command to write a document object to Solr.
- Connector
- SOLR connector.
- CommitDocument
- SOLR commit document class.
- DeleteDocument
- SOLR delete document class.
- OptimizeDocument
- SOLR optimize document class.
- RawCSVDocument
- SOLR "raw CSV" document class for submitting bulk data.
- RawDocument
- SOLR "raw document" class for submitting any type of data.
- RawJSONDocument
- SOLR "raw JSON" document class for manual overrides.
- RawXMLDocument
- SOLR "raw XML" document class for manual overrides.
- UpdateDocument
- SOLR update document class.
- HandlerMap
- SOLR backend handler map.
- LuceneSyntaxHelper
- Lucene query syntax helper class.
- QueryBuilder
- SOLR QueryBuilder.
- SerializableRecord
- SOLR serializable record definition.
- NamedList
- SOLR NamedList with parameter json.nl=arrarr.
- Record
- Simple, schema-less SOLR record.
- RecordCollection
- Simple JSON-based record collection.
- RecordCollectionFactory
- Simple JSON-based factory for record collection.
- Spellcheck
- SOLR spellcheck information.
- Terms
- SOLR Terms component.
- SearchHandler
- VuFind SearchHandler.
- SimilarBuilder
- SOLR SimilarBuilder.
- Backend
- Summon backend.
- QueryBuilder
- Summon QueryBuilder.
- RecordCollection
- WorldCat record collection.
- RecordCollectionFactory
- Simple factory for record collection.
- Backend
- WorldCat backend.
- GetHoldingsCommand
- Command to fetch holdings from the WorldCat backend.
- QueryBuilder
- WorldCat QueryBuilder.
- Record
- Simple WorldCat record.
- RecordCollection
- WorldCat record collection.
- RecordCollectionFactory
- Simple XML-based factory for record collection.
- AbstractBase
- Abstract base command.
- AlphabeticBrowseCommand
- Fetch alphabrowse data from the backend (currently only supported by Solr)
- CallMethodCommand
- Call method command.
- GetIdsCommand
- Get identifiers of records command.
- GetLuceneHelperCommand
- Command to fetch a Lucene helper object from a search backend.
- GetQueryBuilderCommand
- Command to fetch a query builder object from a backend (if supported).
- GetUniqueKeyCommand
- Get the backend's unique search key field (currently only supported by Solr)
- RandomCommand
- Return random records command.
- RetrieveBatchCommand
- Retrieve a batch of documents command.
- RetrieveCommand
- Retrieve a single document command.
- SearchCommand
- Perform a search and return record collection command.
- SetRecordCollectionFactoryCommand
- Perform a search and return record collection command.
- SimilarCommand
- Return similar records command.
- TermsCommand
- Fetch terms from the backend (currently only supported by Solr)
- InvalidArgumentException
- Invalid argument exception.
- LogicException
- Logic exception.
- RuntimeException
- Generic RuntimeException.
- ParamBag
- Lightweight wrapper for request parameters.
- AbstractQuery
- Abstract base class of user query components.
- Query
- A single/simple query.
- QueryGroup
- A group of single/simples queries, joined by boolean operator.
- WorkKeysQuery
- A work keys query.
- AbstractRecordCollection
- Abstract record collection (implements some shared low-level functionality).
- Service
- Search service.
- AbstractHandlerMapTest
- Unit tests for handler map base class.
- BackendTest
- Unit tests for Blender backend.
- BackendTest
- Unit tests for BrowZine backend.
- LookupDoiCommandTest
- Unit tests for LookupDoiCommand.
- LookupIssnsCommandTest
- Unit tests for LookupIssnsCommand.
- QueryBuilderTest
- Unit tests for BrowZine query builder
- RecordCollectionFactoryTest
- Unit tests for BrowZine record collection factory.
- RecordCollectionTest
- Unit tests for BrowZine record collection
- BackendTest
- Unit tests for EDS backend.
- AutocompleteCommandTest
- Unit tests for AutocompleteCommand.
- GetInfoCommandTest
- Unit tests for GetInfoCommand.
- ConnectorTest
- Unit tests for EDS connector.
- QueryBuilderTest
- Unit tests for EDS query builder
- RecordCollectionFactoryTest
- Unit tests for EDS record collection factory
- RecordCollectionTest
- Unit tests for EDS record collection
- BackendTest
- Unit tests for EIT backend.
- QueryBuilderTest
- Unit tests for EIT query builder
- RecordCollectionFactoryTest
- Unit tests for EIT record collection factory.
- RecordCollectionTest
- Unit tests for EIT record collection
- BackendTest
- Unit tests for LibGuides backend.
- QueryBuilderTest
- Unit tests for LibGuides query builder
- RecordCollectionFactoryTest
- Unit tests for LibGuides record collection factory.
- RecordCollectionTest
- Unit tests for LibGuides record collection
- BackendTest
- Unit tests for Pazpar2 backend.
- BackendTest
- Unit tests for Primo backend.
- ConnectorTest
- Unit tests for Primo connector.
- QueryBuilderTest
- Unit tests for Primo query builder
- RecordCollectionFactoryTest
- Unit tests for Primo record collection factory.
- RecordCollectionTest
- Unit tests for Primo record collection
- BackendTest
- Unit tests for SOLR backend.
- RawJsonSearchCommandTest
- Unit tests for RawJsonSearchCommand.
- WriteDocumentCommandTest
- Unit tests for WriteDocumentCommand.
- ConnectorTest
- Unit tests for SOLR connector.
- CommitDocumentTest
- Unit tests for SOLR update document class.
- DeleteDocumentTest
- Unit tests for SOLR delete document class.
- OptimizeDocumentTest
- Unit tests for SOLR update document class.
- RawCSVDocumentTest
- Unit tests for SOLR raw CSV document class.
- RawJSONDocumentTest
- Unit tests for SOLR raw JSON document class.
- RawXMLDocumentTest
- Unit tests for SOLR raw XML document class.
- UpdateDocumentTest
- Unit tests for SOLR update document class.
- HandlerMapTest
- Unit tests for SOLR HandlerMap.
- LuceneSyntaxHelperTest
- Unit tests for Lucene syntax helper
- QueryBuilderTest
- Unit tests for SOLR query builder
- SerializableRecordTest
- Unit tests for SOLR serializable record.
- NamedListTest
- Unit tests for SOLR NamedList.
- RecordCollectionFactoryTest
- Unit tests for simple JSON-based record collection factory.
- RecordCollectionTest
- Unit tests for simple JSON-based record collection.
- SpellcheckTest
- Unit tests for spellcheck information.
- TermsTest
- Unit tests for terms information.
- SearchHandlerTest
- Unit tests for SOLR search handler.
- SimilarBuilderTest
- Unit tests for SOLR similar records query builder
- BackendTest
- Unit tests for Summon Backend class.
- QueryBuilderTest
- Unit tests for Summon query builder
- RecordCollectionFactoryTest
- Unit tests for Summon record collection factory
- RecordCollectionTest
- Unit tests for Summon record collection
- BackendTest
- Unit tests for WorldCat backend.
- GetHoldingsCommandTest
- Unit tests for GetHoldingsCommand.
- ConnectorTest
- Unit tests for WorldCat backend.
- QueryBuilderTest
- Unit tests for WorldCat query builder
- RecordCollectionFactoryTest
- Unit tests for WorldCat backend.
- AlphabeticBrowseCommandTest
- Unit tests for AlphabeticBrowseCommand.
- GetIdsCommandTest
- Unit tests for GetIdsCommand.
- GetLuceneHelperCommandTest
- Unit tests for GetLuceneHelperCommand.
- GetQueryBuilderCommandTest
- Unit tests for GetQueryBuilderCommand.
- GetUniqueKeyCommandTest
- Unit tests for GetUniqueKeyCommand.
- RandomCommandTest
- Unit tests for RandomCommand.
- RetrieveBatchCommandTest
- Unit tests for RetrieveBatchCommand.
- RetrieveCommandTest
- Unit tests for RetrieveCommand.
- SearchCommandTest
- Unit tests for SearchCommand.
- SetRecordCollectionFactoryCommandTest
- Unit tests for SetRecordCollectionFactoryCommand.
- SimilarCommandTest
- Unit tests for SimilarCommand.
- TermsCommandTest
- Unit tests for TermsCommand.
- ParamBagTest
- Unit tests for ParamBag.
- QueryGroupTest
- Unit tests for QueryGroup class.
- QueryTest
- Unit tests for Query class.
- SimpleRecordTest
- Unit tests for SimpleRecord class.
- SearchServiceTest
- Unit tests for search service.
- AbstractJsonRecordCollectionFactory
- Simple factory for record collection.
- JsonRecord
- Simple, schema-less JSON record.
- SharedListenersTrait
- Trait containing methods for building shared listeners.
- ViewOptionsTrait
- Trait for setting up view options. Designed to be included in a subclass of \VuFind\Search\Base\Options.
- FacetLimitTrait
- Trait to add facet limiting settings to a Params object.
- FacetRestrictionsTrait
- Trait to add facet limiting settings to a Params object.
- ConnectorCacheTrait
- Caching support trait for connectors.
- QueryOffsetLimitTrait
- Trait for commands with search query, offset and limit arguments.
- RecordIdentifierTrait
- Trait for commands with a record identifier argument.
- SearchBackendEventManagerTrait
- Trait to compose the event manager into a search class.